From 4794a8ce65bf78b3c4174efde073308a40b3b17f Mon Sep 17 00:00:00 2001 From: darrell-thobe-sp Date: Wed, 12 Mar 2025 15:53:15 -0400 Subject: [PATCH 1/2] fix for code example overlay --- .../python_code_examples_overlay.yaml | 11018 ++++++------- .../python_code_examples_overlay.yaml | 12805 +++++++--------- .../python_code_examples_overlay.yaml | 7199 ++++----- .../developerSite_code_examples.mustache | 33 +- 4 files changed, 14229 insertions(+), 16826 deletions(-) diff --git a/sailpoint/beta/docs/Examples/python_code_examples_overlay.yaml b/sailpoint/beta/docs/Examples/python_code_examples_overlay.yaml index d95552629..6c496b387 100644 --- a/sailpoint/beta/docs/Examples/python_code_examples_overlay.yaml +++ b/sailpoint/beta/docs/Examples/python_code_examples_overlay.yaml @@ -6,16 +6,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_access_model_metadata_attribute(key) - print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute: %s\n" % e) + # Get Access Model Metadata Attribute + + results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key=key) + # Below is a request that includes all optional parameters + # results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key) + print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute: %s\n" % e) - path: /access-model-metadata/attributes/{key}/values/{value} method: GET xCodeSample: @@ -25,16 +24,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_access_model_metadata_attribute_value(key, value) - print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute_value:\n") - pprint(api_response) + # Get Access Model Metadata Value + + results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key=key, value=value) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute_value: %s\n" % e) + print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute_value: %s\n" % e) - path: /access-model-metadata/attributes method: GET xCodeSample: @@ -43,16 +41,15 @@ source: | 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_access_model_metadata_attribute(filters) - print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") - pprint(api_response) + # List Access Model Metadata Attributes + + results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute() + # Below is a request that includes all optional parameters + # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(filters) + print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") + pprint(results) except Exception as e: - print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) + print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) - path: /access-model-metadata/attributes/{key}/values method: GET xCodeSample: @@ -61,23 +58,22 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_access_model_metadata_attribute_value(key) - print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") - pprint(api_response) + # List Access Model Metadata Values + + results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key=key) + # Below is a request that includes all optional parameters + # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key) + print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") + pprint(results) except Exception as e: - print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) + print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) - path: /access-profiles method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/access-profiles#create-access-profile source: | - access_profile = { + access_profile = '''{ "owner" : { "name" : "support", "id" : "2c9180a46faadee4016fb4e018c20639", @@ -161,18 +157,17 @@ "modified" : "2021-03-02T20:22:28.104Z", "id" : "2c91808a7190d06e01719938fcd20792", "requestable" : true - } # AccessProfile | - try: - # Create Access Profile - Result = access_profile.from_json(access_profile) - api_response = api_instance.create_access_profile(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_access_profile(Result) - print("The response of AccessProfilesApi->create_access_profile:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessProfilesApi->create_access_profile: %s\n" % e) + }''' # AccessProfile | + try: + # Create Access Profile + new_access_profile = AccessProfile.from_json(access_profile) + results = AccessProfilesApi(api_client).create_access_profile(access_profile=new_access_profile) + # Below is a request that includes all optional parameters + # results = AccessProfilesApi(api_client).create_access_profile(new_access_profile) + print("The response of AccessProfilesApi->create_access_profile:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->create_access_profile: %s\n" % e) - path: /access-profiles/{id} method: DELETE xCodeSample: @@ -181,35 +176,33 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_access_profile(id) + # Delete the specified Access Profile + + AccessProfilesApi(api_client).delete_access_profile(id=id) + # Below is a request that includes all optional parameters + # AccessProfilesApi(api_client).delete_access_profile(id) except Exception as e: - print("Exception when calling AccessProfilesApi->delete_access_profile: %s\n" % e) + print("Exception when calling AccessProfilesApi->delete_access_profile: %s\n" % e) - path: /access-profiles/bulk-delete method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/access-profiles#delete-access-profiles-in-bulk source: | - access_profile_bulk_delete_request = { + access_profile_bulk_delete_request = '''{ "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], "bestEffortOnly" : true - } # AccessProfileBulkDeleteRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_access_profiles_in_bulk(Result) - print("The response of AccessProfilesApi->delete_access_profiles_in_bulk:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessProfilesApi->delete_access_profiles_in_bulk: %s\n" % e) + }''' # AccessProfileBulkDeleteRequest | + try: + # Delete Access Profile(s) + new_access_profile_bulk_delete_request = AccessProfileBulkDeleteRequest.from_json(access_profile_bulk_delete_request) + results = AccessProfilesApi(api_client).delete_access_profiles_in_bulk(access_profile_bulk_delete_request=new_access_profile_bulk_delete_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->delete_access_profiles_in_bulk: %s\n" % e) - path: /access-profiles/{id} method: GET xCodeSample: @@ -218,16 +211,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_access_profile(id) - print("The response of AccessProfilesApi->get_access_profile:\n") - pprint(api_response) + # Get an Access Profile + + results = AccessProfilesApi(api_client).get_access_profile(id=id) + # Below is a request that includes all optional parameters + # results = AccessProfilesApi(api_client).get_access_profile(id) + print("The response of AccessProfilesApi->get_access_profile:\n") + pprint(results) except Exception as e: - print("Exception when calling AccessProfilesApi->get_access_profile: %s\n" % e) + print("Exception when calling AccessProfilesApi->get_access_profile: %s\n" % e) - path: /access-profiles/{id}/entitlements method: GET xCodeSample: @@ -241,16 +233,15 @@ filters = 'attribute eq \"memberOf\"' # 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) sorters = 'name,-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-results) Sorting is supported for the following fields: **name, attribute, value, created, 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-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) try: - # List Access Profile's Entitlements - - api_response = api_instance.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) - print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") - pprint(api_response) + # List Access Profile's Entitlements + + results = AccessProfilesApi(api_client).get_access_profile_entitlements(id=id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) + print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) - path: /access-profiles method: GET xCodeSample: @@ -266,16 +257,15 @@ for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) try: - # List Access Profiles - - api_response = api_instance.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) - print("The response of AccessProfilesApi->list_access_profiles:\n") - pprint(api_response) + # List Access Profiles + + results = AccessProfilesApi(api_client).list_access_profiles() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) + print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) - path: /access-profiles/{id} method: PATCH xCodeSample: @@ -283,44 +273,34 @@ label: SDK_tools/sdk/python/beta/methods/access-profiles#patch-access-profile source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | - - try: - # Patch a specified Access Profile - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_access_profile(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_access_profile(id, Result) - print("The response of AccessProfilesApi->patch_access_profile:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e) + json_patch_operation = '''[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}]''' # List[JsonPatchOperation] | + try: + # Patch a specified Access Profile + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = AccessProfilesApi(api_client).patch_access_profile(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = AccessProfilesApi(api_client).patch_access_profile(id, new_json_patch_operation) + print("The response of AccessProfilesApi->patch_access_profile:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e) - path: /access-profiles/bulk-update-requestable method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/access-profiles#update-access-profiles-in-bulk source: | - [{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] | - + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_access_profiles_in_bulk(Result) - print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") - pprint(api_response) + # Update Access Profile(s) requestable field. + new_access_profile_bulk_update_request_inner = AccessProfileBulkUpdateRequestInner.from_json(access_profile_bulk_update_request_inner) + results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(access_profile_bulk_update_request_inner=new_access_profile_bulk_update_request_inner) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) + print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) - path: /access-request-approvals/{approvalId}/approve method: POST xCodeSample: @@ -328,7 +308,7 @@ label: SDK_tools/sdk/python/beta/methods/access-request-approvals#approve-access-request source: | approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. - comment_dto = { + comment_dto = '''{ "author" : { "name" : "Adam Kennedy", "id" : "2c91808568c529c60168cca6f90c1313", @@ -336,18 +316,17 @@ }, "created" : "2017-07-11T18:45:37.098Z", "comment" : "This is a comment." - } # CommentDto | Reviewer's comment. - try: - # Approve Access Request Approval - Result = comment_dto.from_json(comment_dto) - api_response = api_instance.approve_access_request(approval_id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.approve_access_request(approval_id, Result) - print("The response of AccessRequestApprovalsApi->approve_access_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->approve_access_request: %s\n" % e) + }''' # CommentDto | Reviewer's comment. + try: + # Approve Access Request Approval + new_comment_dto = CommentDto.from_json(comment_dto) + results = AccessRequestApprovalsApi(api_client).approve_access_request(approval_id=approval_id, comment_dto=new_comment_dto) + # Below is a request that includes all optional parameters + # results = AccessRequestApprovalsApi(api_client).approve_access_request(approval_id, new_comment_dto) + print("The response of AccessRequestApprovalsApi->approve_access_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->approve_access_request: %s\n" % e) - path: /access-request-approvals/{approvalId}/forward method: POST xCodeSample: @@ -355,21 +334,20 @@ label: SDK_tools/sdk/python/beta/methods/access-request-approvals#forward-access-request source: | approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. - forward_approval_dto = { + forward_approval_dto = '''{ "newOwnerId" : "newOwnerId", "comment" : "comment" - } # ForwardApprovalDto | Information about the forwarded approval. - try: - # Forward Access Request Approval - Result = forward_approval_dto.from_json(forward_approval_dto) - api_response = api_instance.forward_access_request(approval_id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.forward_access_request(approval_id, Result) - print("The response of AccessRequestApprovalsApi->forward_access_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->forward_access_request: %s\n" % e) + }''' # ForwardApprovalDto | Information about the forwarded approval. + try: + # Forward Access Request Approval + new_forward_approval_dto = ForwardApprovalDto.from_json(forward_approval_dto) + results = AccessRequestApprovalsApi(api_client).forward_access_request(approval_id=approval_id, forward_approval_dto=new_forward_approval_dto) + # Below is a request that includes all optional parameters + # results = AccessRequestApprovalsApi(api_client).forward_access_request(approval_id, new_forward_approval_dto) + print("The response of AccessRequestApprovalsApi->forward_access_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->forward_access_request: %s\n" % e) - path: /access-request-approvals/approval-summary method: GET xCodeSample: @@ -379,16 +357,15 @@ 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_access_request_approval_summary(owner_id, from_date) - print("The response of AccessRequestApprovalsApi->get_access_request_approval_summary:\n") - pprint(api_response) + # Get Access Requests Approvals Number + + results = AccessRequestApprovalsApi(api_client).get_access_request_approval_summary() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->get_access_request_approval_summary: %s\n" % e) + print("Exception when calling AccessRequestApprovalsApi->get_access_request_approval_summary: %s\n" % e) - path: /access-request-approvals/completed method: GET xCodeSample: @@ -402,16 +379,15 @@ filters = 'filters_example' # 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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, 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: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) 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: **created, 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-results) Sorting is supported for the following fields: **created, modified** (optional) try: - # Completed Access Request Approvals List - - api_response = api_instance.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) - print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") - pprint(api_response) + # Completed Access Request Approvals List + + results = AccessRequestApprovalsApi(api_client).list_completed_approvals() + # Below is a request that includes all optional parameters + # results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") + pprint(results) except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) + print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) - path: /access-request-approvals/pending method: GET xCodeSample: @@ -425,16 +401,15 @@ filters = 'filters_example' # 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, 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: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional) 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: **created, 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-results) Sorting is supported for the following fields: **created, modified** (optional) try: - # Pending Access Request Approvals List - - api_response = api_instance.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) - print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") - pprint(api_response) + # Pending Access Request Approvals List + + results = AccessRequestApprovalsApi(api_client).list_pending_approvals() + # Below is a request that includes all optional parameters + # results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") + pprint(results) except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) + print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) - path: /access-request-approvals/{approvalId}/reject method: POST xCodeSample: @@ -442,7 +417,7 @@ label: SDK_tools/sdk/python/beta/methods/access-request-approvals#reject-access-request source: | approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. - comment_dto = { + comment_dto = '''{ "author" : { "name" : "Adam Kennedy", "id" : "2c91808568c529c60168cca6f90c1313", @@ -450,18 +425,17 @@ }, "created" : "2017-07-11T18:45:37.098Z", "comment" : "This is a comment." - } # CommentDto | Reviewer's comment. - try: - # Reject Access Request Approval - Result = comment_dto.from_json(comment_dto) - api_response = api_instance.reject_access_request(approval_id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.reject_access_request(approval_id, Result) - print("The response of AccessRequestApprovalsApi->reject_access_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e) + }''' # CommentDto | Reviewer's comment. + try: + # Reject Access Request Approval + new_comment_dto = CommentDto.from_json(comment_dto) + results = AccessRequestApprovalsApi(api_client).reject_access_request(approval_id=approval_id, comment_dto=new_comment_dto) + # Below is a request that includes all optional parameters + # results = AccessRequestApprovalsApi(api_client).reject_access_request(approval_id, new_comment_dto) + print("The response of AccessRequestApprovalsApi->reject_access_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e) - path: /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type} method: GET xCodeSample: @@ -472,67 +446,64 @@ 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. try: - # Return access request identity metrics - - api_response = api_instance.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) - print("The response of AccessRequestIdentityMetricsApi->get_access_request_identity_metrics:\n") - pprint(api_response) + # Return access request identity metrics + + results = AccessRequestIdentityMetricsApi(api_client).get_access_request_identity_metrics(identity_id=identity_id, requested_object_id=requested_object_id, type=type) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccessRequestIdentityMetricsApi->get_access_request_identity_metrics: %s\n" % e) + print("Exception when calling AccessRequestIdentityMetricsApi->get_access_request_identity_metrics: %s\n" % e) - path: /access-requests/cancel method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/access-requests#cancel-access-request source: | - cancel_access_request = { + cancel_access_request = '''{ "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", "comment" : "I requested this role by mistake." - } # CancelAccessRequest | - try: - # Cancel Access Request - Result = cancel_access_request.from_json(cancel_access_request) - api_response = api_instance.cancel_access_request(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.cancel_access_request(Result) - print("The response of AccessRequestsApi->cancel_access_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e) + }''' # CancelAccessRequest | + try: + # Cancel Access Request + new_cancel_access_request = CancelAccessRequest.from_json(cancel_access_request) + results = AccessRequestsApi(api_client).cancel_access_request(cancel_access_request=new_cancel_access_request) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).cancel_access_request(new_cancel_access_request) + print("The response of AccessRequestsApi->cancel_access_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e) - path: /access-requests/close method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/access-requests#close-access-request source: | - close_access_request = { + close_access_request = '''{ "executionStatus" : "Terminated", "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], "completionStatus" : "Failure", "message" : "The IdentityNow Administrator manually closed this request." - } # CloseAccessRequest | - try: - # Close Access Request - Result = close_access_request.from_json(close_access_request) - api_response = api_instance.close_access_request(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.close_access_request(Result) - print("The response of AccessRequestsApi->close_access_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessRequestsApi->close_access_request: %s\n" % e) + }''' # CloseAccessRequest | + try: + # Close Access Request + new_close_access_request = CloseAccessRequest.from_json(close_access_request) + results = AccessRequestsApi(api_client).close_access_request(close_access_request=new_close_access_request) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).close_access_request(new_close_access_request) + print("The response of AccessRequestsApi->close_access_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->close_access_request: %s\n" % e) - path: /access-requests method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/access-requests#create-access-request source: | - access_request = { + access_request = '''{ "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", @@ -585,18 +556,17 @@ "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" } ] - } # AccessRequest | - try: - # Submit Access Request - Result = access_request.from_json(access_request) - api_response = api_instance.create_access_request(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_access_request(Result) - print("The response of AccessRequestsApi->create_access_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessRequestsApi->create_access_request: %s\n" % e) + }''' # AccessRequest | + try: + # Submit Access Request + new_access_request = AccessRequest.from_json(access_request) + results = AccessRequestsApi(api_client).create_access_request(access_request=new_access_request) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).create_access_request(new_access_request) + print("The response of AccessRequestsApi->create_access_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->create_access_request: %s\n" % e) - path: /access-request-config method: GET xCodeSample: @@ -604,16 +574,15 @@ label: SDK_tools/sdk/python/beta/methods/access-requests#get-access-request-config source: | try: - # Get Access Request Configuration - - api_response = api_instance.get_access_request_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_access_request_config() - print("The response of AccessRequestsApi->get_access_request_config:\n") - pprint(api_response) + # Get Access Request Configuration + + results = AccessRequestsApi(api_client).get_access_request_config() + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).get_access_request_config() + print("The response of AccessRequestsApi->get_access_request_config:\n") + pprint(results) except Exception as e: - print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e) + print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e) - path: /access-request-status method: GET xCodeSample: @@ -631,23 +600,22 @@ sorters = 'created' # 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: **created, modified, accountActivityItemId, 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: **created, modified, accountActivityItemId, name** (optional) request_state = 'request-state=EXECUTING' # str | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) # str | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) try: - # Access Request Status - - api_response = api_instance.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) - print("The response of AccessRequestsApi->list_access_request_status:\n") - pprint(api_response) + # Access Request Status + + results = AccessRequestsApi(api_client).list_access_request_status() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) + print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) - path: /access-request-config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/access-requests#set-access-request-config source: | - access_request_config = { + access_request_config = '''{ "requestOnBehalfOfConfig" : { "allowRequestOnBehalfOfEmployeeByManager" : true, "allowRequestOnBehalfOfAnyoneByAnyone" : true @@ -672,18 +640,17 @@ }, "reauthorizationEnabled" : true, "approvalsMustBeExternal" : true - } # AccessRequestConfig | - try: - # Update Access Request Configuration - Result = access_request_config.from_json(access_request_config) - api_response = api_instance.set_access_request_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_access_request_config(Result) - print("The response of AccessRequestsApi->set_access_request_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessRequestsApi->set_access_request_config: %s\n" % e) + }''' # AccessRequestConfig | + try: + # Update Access Request Configuration + new_access_request_config = AccessRequestConfig.from_json(access_request_config) + results = AccessRequestsApi(api_client).set_access_request_config(access_request_config=new_access_request_config) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).set_access_request_config(new_access_request_config) + print("The response of AccessRequestsApi->set_access_request_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->set_access_request_config: %s\n" % e) - path: /account-activities/{id} method: GET xCodeSample: @@ -692,16 +659,15 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account activity id # str | The account activity id try: - # Get Account Activity - - api_response = api_instance.get_account_activity(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_account_activity(id) - print("The response of AccountActivitiesApi->get_account_activity:\n") - pprint(api_response) + # Get Account Activity + + results = AccountActivitiesApi(api_client).get_account_activity(id=id) + # Below is a request that includes all optional parameters + # results = AccountActivitiesApi(api_client).get_account_activity(id) + print("The response of AccountActivitiesApi->get_account_activity:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountActivitiesApi->get_account_activity: %s\n" % e) + print("Exception when calling AccountActivitiesApi->get_account_activity: %s\n" % e) - path: /account-activities method: GET xCodeSample: @@ -718,16 +684,15 @@ filters = 'filters_example' # 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: **type**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, 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: **type**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) 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: **type, created, 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-results) Sorting is supported for the following fields: **type, created, modified** (optional) try: - # List Account Activities - - api_response = api_instance.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) - print("The response of AccountActivitiesApi->list_account_activities:\n") - pprint(api_response) + # List Account Activities + + results = AccountActivitiesApi(api_client).list_account_activities() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) + print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) - path: /account-aggregations/{id}/status method: GET xCodeSample: @@ -736,23 +701,22 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_account_aggregation_status(id) - print("The response of AccountAggregationsApi->get_account_aggregation_status:\n") - pprint(api_response) + # In-progress Account Aggregation status + + results = AccountAggregationsApi(api_client).get_account_aggregation_status(id=id) + # Below is a request that includes all optional parameters + # results = AccountAggregationsApi(api_client).get_account_aggregation_status(id) + print("The response of AccountAggregationsApi->get_account_aggregation_status:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) + print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) - path: /accounts method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#create-account source: | - account_attributes_create = { + account_attributes_create = '''{ "attributes" : { "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", "city" : "Austin", @@ -761,18 +725,17 @@ "sAMAccountName" : "jDoe", "mail" : "john.doe@sailpoint.com" } - } # AccountAttributesCreate | - try: - # Create Account - Result = account_attributes_create.from_json(account_attributes_create) - api_response = api_instance.create_account(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_account(Result) - print("The response of AccountsApi->create_account:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccountsApi->create_account: %s\n" % e) + }''' # AccountAttributesCreate | + try: + # Create Account + new_account_attributes_create = AccountAttributesCreate.from_json(account_attributes_create) + results = AccountsApi(api_client).create_account(account_attributes_create=new_account_attributes_create) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).create_account(new_account_attributes_create) + print("The response of AccountsApi->create_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->create_account: %s\n" % e) - path: /accounts/{id} method: DELETE xCodeSample: @@ -781,16 +744,15 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. try: - # Delete Account - - api_response = api_instance.delete_account(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_account(id) - print("The response of AccountsApi->delete_account:\n") - pprint(api_response) + # Delete Account + + results = AccountsApi(api_client).delete_account(id=id) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).delete_account(id) + print("The response of AccountsApi->delete_account:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountsApi->delete_account: %s\n" % e) + print("Exception when calling AccountsApi->delete_account: %s\n" % e) - path: /accounts/{id}/remove method: POST xCodeSample: @@ -799,16 +761,15 @@ source: | id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account id try: - # Remove Account - - api_response = api_instance.delete_account_async(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_account_async(id) - print("The response of AccountsApi->delete_account_async:\n") - pprint(api_response) + # Remove Account + + results = AccountsApi(api_client).delete_account_async(id=id) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).delete_account_async(id) + print("The response of AccountsApi->delete_account_async:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountsApi->delete_account_async: %s\n" % e) + print("Exception when calling AccountsApi->delete_account_async: %s\n" % e) - path: /accounts/{id}/disable method: POST xCodeSample: @@ -816,21 +777,20 @@ label: SDK_tools/sdk/python/beta/methods/accounts#disable-account source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id - account_toggle_request = { + account_toggle_request = '''{ "forceProvisioning" : false, "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" - } # AccountToggleRequest | - try: - # Disable Account - Result = account_toggle_request.from_json(account_toggle_request) - api_response = api_instance.disable_account(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.disable_account(id, Result) - print("The response of AccountsApi->disable_account:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccountsApi->disable_account: %s\n" % e) + }''' # AccountToggleRequest | + try: + # Disable Account + new_account_toggle_request = AccountToggleRequest.from_json(account_toggle_request) + results = AccountsApi(api_client).disable_account(id=id, account_toggle_request=new_account_toggle_request) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).disable_account(id, new_account_toggle_request) + print("The response of AccountsApi->disable_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->disable_account: %s\n" % e) - path: /identities-accounts/{id}/disable method: POST xCodeSample: @@ -839,36 +799,34 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.disable_account_for_identity(id) - print("The response of AccountsApi->disable_account_for_identity:\n") - pprint(api_response) + # Disable IDN Account for Identity + + results = AccountsApi(api_client).disable_account_for_identity(id=id) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).disable_account_for_identity(id) + print("The response of AccountsApi->disable_account_for_identity:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountsApi->disable_account_for_identity: %s\n" % e) + print("Exception when calling AccountsApi->disable_account_for_identity: %s\n" % e) - path: /identities-accounts/disable method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#disable-accounts-for-identities source: | - identities_accounts_bulk_request = { + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.disable_accounts_for_identities(Result) - print("The response of AccountsApi->disable_accounts_for_identities:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) + }''' # IdentitiesAccountsBulkRequest | + try: + # Disable IDN Accounts for Identities + new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest.from_json(identities_accounts_bulk_request) + results = AccountsApi(api_client).disable_accounts_for_identities(identities_accounts_bulk_request=new_identities_accounts_bulk_request) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).disable_accounts_for_identities(new_identities_accounts_bulk_request) + print("The response of AccountsApi->disable_accounts_for_identities:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) - path: /accounts/{id}/enable method: POST xCodeSample: @@ -876,21 +834,20 @@ label: SDK_tools/sdk/python/beta/methods/accounts#enable-account source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id - account_toggle_request = { + account_toggle_request = '''{ "forceProvisioning" : false, "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" - } # AccountToggleRequest | - try: - # Enable Account - Result = account_toggle_request.from_json(account_toggle_request) - api_response = api_instance.enable_account(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.enable_account(id, Result) - print("The response of AccountsApi->enable_account:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccountsApi->enable_account: %s\n" % e) + }''' # AccountToggleRequest | + try: + # Enable Account + new_account_toggle_request = AccountToggleRequest.from_json(account_toggle_request) + results = AccountsApi(api_client).enable_account(id=id, account_toggle_request=new_account_toggle_request) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).enable_account(id, new_account_toggle_request) + print("The response of AccountsApi->enable_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->enable_account: %s\n" % e) - path: /identities-accounts/{id}/enable method: POST xCodeSample: @@ -899,36 +856,34 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.enable_account_for_identity(id) - print("The response of AccountsApi->enable_account_for_identity:\n") - pprint(api_response) + # Enable IDN Account for Identity + + results = AccountsApi(api_client).enable_account_for_identity(id=id) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).enable_account_for_identity(id) + print("The response of AccountsApi->enable_account_for_identity:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountsApi->enable_account_for_identity: %s\n" % e) + print("Exception when calling AccountsApi->enable_account_for_identity: %s\n" % e) - path: /identities-accounts/enable method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#enable-accounts-for-identities source: | - identities_accounts_bulk_request = { + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.enable_accounts_for_identities(Result) - print("The response of AccountsApi->enable_accounts_for_identities:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) + }''' # IdentitiesAccountsBulkRequest | + try: + # Enable IDN Accounts for Identities + new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest.from_json(identities_accounts_bulk_request) + results = AccountsApi(api_client).enable_accounts_for_identities(identities_accounts_bulk_request=new_identities_accounts_bulk_request) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).enable_accounts_for_identities(new_identities_accounts_bulk_request) + print("The response of AccountsApi->enable_accounts_for_identities:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) - path: /accounts/{id} method: GET xCodeSample: @@ -937,16 +892,15 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. try: - # Account Details - - api_response = api_instance.get_account(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_account(id) - print("The response of AccountsApi->get_account:\n") - pprint(api_response) + # Account Details + + results = AccountsApi(api_client).get_account(id=id) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).get_account(id) + print("The response of AccountsApi->get_account:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountsApi->get_account: %s\n" % e) + print("Exception when calling AccountsApi->get_account: %s\n" % e) - path: /accounts/{id}/entitlements method: GET xCodeSample: @@ -958,16 +912,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) try: - # Account Entitlements - - api_response = api_instance.get_account_entitlements(id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_account_entitlements(id, offset, limit, count) - print("The response of AccountsApi->get_account_entitlements:\n") - pprint(api_response) + # Account Entitlements + + results = AccountsApi(api_client).get_account_entitlements(id=id) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).get_account_entitlements(id, offset, limit, count) + print("The response of AccountsApi->get_account_entitlements:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) + print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) - path: /accounts method: GET xCodeSample: @@ -981,16 +934,15 @@ filters = 'identityId eq \"2c9180858082150f0180893dbaf44201\"' # 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* (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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* (optional) sorters = 'id,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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional) try: - # Accounts List - - api_response = api_instance.list_accounts() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_accounts(detail_level, limit, offset, count, filters, sorters) - print("The response of AccountsApi->list_accounts:\n") - pprint(api_response) + # Accounts List + + results = AccountsApi(api_client).list_accounts() + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).list_accounts(detail_level, limit, offset, count, filters, sorters) + print("The response of AccountsApi->list_accounts:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountsApi->list_accounts: %s\n" % e) + print("Exception when calling AccountsApi->list_accounts: %s\n" % e) - path: /accounts/{id} method: PUT xCodeSample: @@ -998,7 +950,7 @@ label: SDK_tools/sdk/python/beta/methods/accounts#put-account source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. - account_attributes = { + account_attributes = '''{ "attributes" : { "city" : "Austin", "displayName" : "John Doe", @@ -1006,18 +958,17 @@ "sAMAccountName" : "jDoe", "mail" : "john.doe@sailpoint.com" } - } # AccountAttributes | - try: - # Update Account - Result = account_attributes.from_json(account_attributes) - api_response = api_instance.put_account(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_account(id, Result) - print("The response of AccountsApi->put_account:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccountsApi->put_account: %s\n" % e) + }''' # AccountAttributes | + try: + # Update Account + new_account_attributes = AccountAttributes.from_json(account_attributes) + results = AccountsApi(api_client).put_account(id=id, account_attributes=new_account_attributes) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).put_account(id, new_account_attributes) + print("The response of AccountsApi->put_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->put_account: %s\n" % e) - path: /accounts/{id}/reload method: POST xCodeSample: @@ -1026,16 +977,15 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id try: - # Reload Account - - api_response = api_instance.submit_reload_account(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.submit_reload_account(id) - print("The response of AccountsApi->submit_reload_account:\n") - pprint(api_response) + # Reload Account + + results = AccountsApi(api_client).submit_reload_account(id=id) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).submit_reload_account(id) + print("The response of AccountsApi->submit_reload_account:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountsApi->submit_reload_account: %s\n" % e) + print("Exception when calling AccountsApi->submit_reload_account: %s\n" % e) - path: /accounts/{id}/unlock method: POST xCodeSample: @@ -1043,22 +993,21 @@ label: SDK_tools/sdk/python/beta/methods/accounts#unlock-account source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. # str | The account ID. - account_unlock_request = { + account_unlock_request = '''{ "forceProvisioning" : false, "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", "unlockIDNAccount" : false - } # AccountUnlockRequest | - try: - # Unlock Account - Result = account_unlock_request.from_json(account_unlock_request) - api_response = api_instance.unlock_account(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.unlock_account(id, Result) - print("The response of AccountsApi->unlock_account:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccountsApi->unlock_account: %s\n" % e) + }''' # AccountUnlockRequest | + try: + # Unlock Account + new_account_unlock_request = AccountUnlockRequest.from_json(account_unlock_request) + results = AccountsApi(api_client).unlock_account(id=id, account_unlock_request=new_account_unlock_request) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).unlock_account(id, new_account_unlock_request) + print("The response of AccountsApi->unlock_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->unlock_account: %s\n" % e) - path: /accounts/{id} method: PATCH xCodeSample: @@ -1066,20 +1015,17 @@ label: SDK_tools/sdk/python/beta/methods/accounts#update-account source: | 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. - - try: - # Update Account - Result = request_body.from_json(request_body) - api_response = api_instance.update_account(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_account(id, Result) - print("The response of AccountsApi->update_account:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccountsApi->update_account: %s\n" % e) + 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. + try: + # Update Account + new_request_body = RequestBody.from_json(request_body) + results = AccountsApi(api_client).update_account(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).update_account(id, new_request_body) + print("The response of AccountsApi->update_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->update_account: %s\n" % e) - path: /account-usages/{accountId}/summaries method: GET xCodeSample: @@ -1092,16 +1038,15 @@ 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) sorters = '-date' # 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: **date** (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: **date** (optional) try: - # Returns account usage insights - - api_response = api_instance.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) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - pprint(api_response) + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications/{id} method: GET xCodeSample: @@ -1110,14 +1055,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.get_discovered_application_by_id(id) + # Get Discovered Application by ID + + ApplicationDiscoveryApi(api_client).get_discovered_application_by_id(id=id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling ApplicationDiscoveryApi->get_discovered_application_by_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: @@ -1130,16 +1074,15 @@ filter = 'name eq \"Okta\" and description co \"Okta\" and discoverySource in (\"csv\", \"Okta Saas\")' # 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, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) 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, description, discoveredAt, discoverySource** (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, description, discoveredAt, discoverySource** (optional) try: - # Retrieve discovered applications for tenant - - api_response = api_instance.get_discovered_applications() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_discovered_applications(limit, offset, detail, filter, sorters) - print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") - pprint(api_response) + # Retrieve discovered applications for tenant + + results = ApplicationDiscoveryApi(api_client).get_discovered_applications() + # Below is a request that includes all optional parameters + # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) + print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") + pprint(results) except Exception as e: - print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) + print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) - path: /manual-discover-applications-template method: GET xCodeSample: @@ -1147,16 +1090,15 @@ label: SDK_tools/sdk/python/beta/methods/application-discovery#get-manual-discover-applications-csv-template source: | try: - # Download CSV Template for Discovery - - api_response = api_instance.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() - print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n") - pprint(api_response) + # Download CSV Template for Discovery + + results = ApplicationDiscoveryApi(api_client).get_manual_discover_applications_csv_template() + # Below is a request that includes all optional parameters + # results = ApplicationDiscoveryApi(api_client).get_manual_discover_applications_csv_template() + print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n") + pprint(results) except Exception as e: - print("Exception when calling ApplicationDiscoveryApi->get_manual_discover_applications_csv_template: %s\n" % e) + print("Exception when calling ApplicationDiscoveryApi->get_manual_discover_applications_csv_template: %s\n" % e) - path: /discovered-applications/{id} method: PATCH xCodeSample: @@ -1164,22 +1106,15 @@ label: SDK_tools/sdk/python/beta/methods/application-discovery#patch-discovered-application-by-id source: | 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 = { - "op" : "replace", - "path" : "/dismissed", - "value" : true - } # List[JsonPatchOperations] | (optional) - - try: - # Patch Discovered Application by ID - - api_instance.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: - print("Exception when calling ApplicationDiscoveryApi->patch_discovered_application_by_id: %s\n" % e) + json_patch_operations = '''[{op=replace, path=/dismissed, value=true}]''' # List[JsonPatchOperations] | (optional) + try: + # Patch Discovered Application by ID + + ApplicationDiscoveryApi(api_client).patch_discovered_application_by_id(id=id) + # Below is a request that includes all optional parameters + # 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) - path: /manual-discover-applications method: POST xCodeSample: @@ -1188,14 +1123,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.send_manual_discover_applications_csv_template(file) + # Upload CSV to Discover Applications + + ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file=file) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling ApplicationDiscoveryApi->send_manual_discover_applications_csv_template: %s\n" % e) - path: /generic-approvals/{id} method: GET xCodeSample: @@ -1204,16 +1138,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_approval(id) - print("The response of ApprovalsApi->get_approval:\n") - pprint(api_response) + # Get Approval + + results = ApprovalsApi(api_client).get_approval(id=id) + # Below is a request that includes all optional parameters + # results = ApprovalsApi(api_client).get_approval(id) + print("The response of ApprovalsApi->get_approval:\n") + pprint(results) except Exception as e: - print("Exception when calling ApprovalsApi->get_approval: %s\n" % e) + print("Exception when calling ApprovalsApi->get_approval: %s\n" % e) - path: /generic-approvals method: GET xCodeSample: @@ -1224,23 +1157,22 @@ 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) try: - # Get Approvals - - api_response = api_instance.get_approvals() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_approvals(mine, requester_id, filters) - print("The response of ApprovalsApi->get_approvals:\n") - pprint(api_response) + # Get Approvals + + results = ApprovalsApi(api_client).get_approvals() + # Below is a request that includes all optional parameters + # results = ApprovalsApi(api_client).get_approvals(mine, requester_id, filters) + print("The response of ApprovalsApi->get_approvals:\n") + pprint(results) except Exception as e: - print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) + print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) - path: /source-apps method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#create-source-app source: | - source_app_create_dto = { + source_app_create_dto = '''{ "name" : "my app", "description" : "the source app for engineers", "accountSource" : { @@ -1249,18 +1181,17 @@ "type" : "SOURCE" }, "matchAllAccounts" : true - } # SourceAppCreateDto | - try: - # Create source app - Result = source_app_create_dto.from_json(source_app_create_dto) - api_response = api_instance.create_source_app(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_source_app(Result) - print("The response of AppsApi->create_source_app:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AppsApi->create_source_app: %s\n" % e) + }''' # SourceAppCreateDto | + try: + # Create source app + new_source_app_create_dto = SourceAppCreateDto.from_json(source_app_create_dto) + results = AppsApi(api_client).create_source_app(source_app_create_dto=new_source_app_create_dto) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).create_source_app(new_source_app_create_dto) + print("The response of AppsApi->create_source_app:\n") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->create_source_app: %s\n" % e) - path: /source-apps/{id}/access-profiles/bulk-remove method: POST xCodeSample: @@ -1268,21 +1199,18 @@ label: SDK_tools/sdk/python/beta/methods/apps#delete-access-profiles-from-source-app-by-bulk source: | 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] | - + request_body = '''['request_body_example']''' # List[str] | limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_access_profiles_from_source_app_by_bulk(id, Result, limit) - print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") - pprint(api_response) + # Bulk remove access profiles from the specified source app + new_request_body = RequestBody.from_json(request_body) + results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) + print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) - path: /source-apps/{id} method: DELETE xCodeSample: @@ -1291,16 +1219,15 @@ source: | id = '2c9180835d191a86015d28455b4a2329' # str | source app ID. # str | source app ID. try: - # Delete source app by ID - - api_response = api_instance.delete_source_app(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_source_app(id) - print("The response of AppsApi->delete_source_app:\n") - pprint(api_response) + # Delete source app by ID + + results = AppsApi(api_client).delete_source_app(id=id) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).delete_source_app(id) + print("The response of AppsApi->delete_source_app:\n") + pprint(results) except Exception as e: - print("Exception when calling AppsApi->delete_source_app: %s\n" % e) + print("Exception when calling AppsApi->delete_source_app: %s\n" % e) - path: /source-apps/{id} method: GET xCodeSample: @@ -1309,16 +1236,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_app(id) - print("The response of AppsApi->get_source_app:\n") - pprint(api_response) + # Get source app by ID + + results = AppsApi(api_client).get_source_app(id=id) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).get_source_app(id) + print("The response of AppsApi->get_source_app:\n") + pprint(results) except Exception as e: - print("Exception when calling AppsApi->get_source_app: %s\n" % e) + print("Exception when calling AppsApi->get_source_app: %s\n" % e) - path: /source-apps/{id}/access-profiles method: GET xCodeSample: @@ -1330,16 +1256,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) filters = 'name eq \"developer access profile\"' # 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, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) try: - # List access profiles for the specified source app - - api_response = api_instance.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) - print("The response of AppsApi->list_access_profiles_for_source_app:\n") - pprint(api_response) + # List access profiles for the specified source app + + results = AppsApi(api_client).list_access_profiles_for_source_app(id=id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) + print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) - path: /source-apps/all method: GET xCodeSample: @@ -1352,16 +1277,15 @@ sorters = 'name,-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-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (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: **id, name, created, modified, owner.id, accountSource.id** (optional) filters = 'enabled 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) try: - # List all source apps - - api_response = api_instance.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) - print("The response of AppsApi->list_all_source_app:\n") - pprint(api_response) + # List all source apps + + results = AppsApi(api_client).list_all_source_app() + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).list_all_source_app(limit, count, offset, sorters, filters) + print("The response of AppsApi->list_all_source_app:\n") + pprint(results) except Exception as e: - print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) + print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) - path: /user-apps/all method: GET xCodeSample: @@ -1373,16 +1297,15 @@ 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) try: - # List all user apps - - api_response = api_instance.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) - print("The response of AppsApi->list_all_user_apps:\n") - pprint(api_response) + # List all user apps + + results = AppsApi(api_client).list_all_user_apps(filters=filters) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).list_all_user_apps(filters, limit, count, offset) + print("The response of AppsApi->list_all_user_apps:\n") + pprint(results) except Exception as e: - print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) + print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) - path: /source-apps/assigned method: GET xCodeSample: @@ -1395,16 +1318,15 @@ sorters = 'name,-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-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (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: **id, name, created, modified, accountSource.id** (optional) filters = 'name eq \"source 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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) try: - # List assigned source apps - - api_response = api_instance.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) - print("The response of AppsApi->list_assigned_source_app:\n") - pprint(api_response) + # List assigned source apps + + results = AppsApi(api_client).list_assigned_source_app() + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).list_assigned_source_app(limit, count, offset, sorters, filters) + print("The response of AppsApi->list_assigned_source_app:\n") + pprint(results) except Exception as e: - print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) + print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) - path: /user-apps/{id}/available-accounts method: GET xCodeSample: @@ -1416,16 +1338,15 @@ 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) try: - # List available accounts for user app - - api_response = api_instance.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) - print("The response of AppsApi->list_available_accounts_for_user_app:\n") - pprint(api_response) + # List available accounts for user app + + results = AppsApi(api_client).list_available_accounts_for_user_app(id=id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) + print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) - path: /source-apps method: GET xCodeSample: @@ -1438,16 +1359,15 @@ sorters = 'name,-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-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (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: **id, name, created, modified, owner.id, accountSource.id** (optional) filters = 'name eq \"source 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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) try: - # List available source apps - - api_response = api_instance.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) - print("The response of AppsApi->list_available_source_apps:\n") - pprint(api_response) + # List available source apps + + results = AppsApi(api_client).list_available_source_apps() + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).list_available_source_apps(limit, count, offset, sorters, filters) + print("The response of AppsApi->list_available_source_apps:\n") + pprint(results) except Exception as e: - print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) + print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) - path: /user-apps method: GET xCodeSample: @@ -1459,16 +1379,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) 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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) try: - # List owned user apps - - api_response = api_instance.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) - print("The response of AppsApi->list_owned_user_apps:\n") - pprint(api_response) + # List owned user apps + + results = AppsApi(api_client).list_owned_user_apps() + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).list_owned_user_apps(limit, count, offset, filters) + print("The response of AppsApi->list_owned_user_apps:\n") + pprint(results) except Exception as e: - print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) + print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) - path: /source-apps/{id} method: PATCH xCodeSample: @@ -1476,24 +1395,17 @@ label: SDK_tools/sdk/python/beta/methods/apps#patch-source-app source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | (optional) - - try: - # Patch source app by ID - - api_response = api_instance.patch_source_app(id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_source_app(id, Result) - print("The response of AppsApi->patch_source_app:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AppsApi->patch_source_app: %s\n" % e) + json_patch_operation = '''[{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}]''' # List[JsonPatchOperation] | (optional) + try: + # Patch source app by ID + + results = AppsApi(api_client).patch_source_app(id=id) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).patch_source_app(id, new_json_patch_operation) + print("The response of AppsApi->patch_source_app:\n") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->patch_source_app: %s\n" % e) - path: /user-apps/{id} method: PATCH xCodeSample: @@ -1501,31 +1413,24 @@ label: SDK_tools/sdk/python/beta/methods/apps#patch-user-app source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | (optional) - - try: - # Patch user app by ID - - api_response = api_instance.patch_user_app(id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_user_app(id, Result) - print("The response of AppsApi->patch_user_app:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AppsApi->patch_user_app: %s\n" % e) + json_patch_operation = '''[sailpoint.beta.JsonPatchOperation()]''' # List[JsonPatchOperation] | (optional) + try: + # Patch user app by ID + + results = AppsApi(api_client).patch_user_app(id=id) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).patch_user_app(id, new_json_patch_operation) + print("The response of AppsApi->patch_user_app:\n") + pprint(results) + except Exception as e: + print("Exception when calling AppsApi->patch_user_app: %s\n" % e) - path: /source-apps/bulk-update method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#update-source-apps-in-bulk source: | - source_app_bulk_update_request = { + source_app_bulk_update_request = '''{ "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], "jsonPatch" : [ { "op" : "replace", @@ -1536,16 +1441,15 @@ "path" : "/matchAllAccounts", "value" : false } ] - } # SourceAppBulkUpdateRequest | (optional) + }''' # SourceAppBulkUpdateRequest | (optional) try: - # Bulk update source apps - - api_instance.update_source_apps_in_bulk() - - # Below is a request that includes all optional parameters - # api_instance.update_source_apps_in_bulk(Result) + # Bulk update source apps + + AppsApi(api_client).update_source_apps_in_bulk() + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling AppsApi->update_source_apps_in_bulk: %s\n" % e) - path: /auth-profiles/{id} method: GET xCodeSample: @@ -1554,16 +1458,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_profile_config(id) - print("The response of AuthProfileApi->get_profile_config:\n") - pprint(api_response) + # Get Auth Profile. + + results = AuthProfileApi(api_client).get_profile_config(id=id) + # Below is a request that includes all optional parameters + # results = AuthProfileApi(api_client).get_profile_config(id) + print("The response of AuthProfileApi->get_profile_config:\n") + pprint(results) except Exception as e: - print("Exception when calling AuthProfileApi->get_profile_config: %s\n" % e) + print("Exception when calling AuthProfileApi->get_profile_config: %s\n" % e) - path: /auth-profiles method: GET xCodeSample: @@ -1571,16 +1474,15 @@ label: SDK_tools/sdk/python/beta/methods/auth-profile#get-profile-config-list source: | try: - # Get list of Auth Profiles. - - api_response = api_instance.get_profile_config_list() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_profile_config_list() - print("The response of AuthProfileApi->get_profile_config_list:\n") - pprint(api_response) + # Get list of Auth Profiles. + + results = AuthProfileApi(api_client).get_profile_config_list() + # Below is a request that includes all optional parameters + # results = AuthProfileApi(api_client).get_profile_config_list() + print("The response of AuthProfileApi->get_profile_config_list:\n") + pprint(results) except Exception as e: - print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) + print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) - path: /auth-profiles/{id} method: PATCH xCodeSample: @@ -1588,24 +1490,17 @@ label: SDK_tools/sdk/python/beta/methods/auth-profile#patch-profile-config source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | - - try: - # Patch a specified Auth Profile - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_profile_config(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_profile_config(id, Result) - print("The response of AuthProfileApi->patch_profile_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AuthProfileApi->patch_profile_config: %s\n" % e) + json_patch_operation = '''[sailpoint.beta.JsonPatchOperation()]''' # List[JsonPatchOperation] | + try: + # Patch a specified Auth Profile + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = AuthProfileApi(api_client).patch_profile_config(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = AuthProfileApi(api_client).patch_profile_config(id, new_json_patch_operation) + print("The response of AuthProfileApi->patch_profile_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling AuthProfileApi->patch_profile_config: %s\n" % e) - path: /campaigns/{id}/complete method: POST xCodeSample: @@ -1613,27 +1508,26 @@ label: SDK_tools/sdk/python/beta/methods/certification-campaigns#complete-campaign source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID. - complete_campaign_options = { + complete_campaign_options = '''{ "autoCompleteAction" : "REVOKE" - } # CompleteCampaignOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) - try: - # Complete a Campaign - - api_response = api_instance.complete_campaign(id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.complete_campaign(id, Result) - print("The response of CertificationCampaignsApi->complete_campaign:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e) + }''' # CompleteCampaignOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) + try: + # Complete a Campaign + + results = CertificationCampaignsApi(api_client).complete_campaign(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).complete_campaign(id, new_complete_campaign_options) + print("The response of CertificationCampaignsApi->complete_campaign:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e) - path: /campaigns method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#create-campaign source: | - campaign = { + campaign = '''{ "totalCertifications" : 100, "sourcesWithOrphanEntitlements" : [ { "name" : "Source with orphan entitlements", @@ -1741,25 +1635,24 @@ "deadline" : "2020-03-15T10:00:01.456Z", "status" : "ACTIVE", "correlatedStatus" : "CORRELATED" - } # Campaign | - try: - # Create Campaign - Result = campaign.from_json(campaign) - api_response = api_instance.create_campaign(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_campaign(Result) - print("The response of CertificationCampaignsApi->create_campaign:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->create_campaign: %s\n" % e) + }''' # Campaign | + try: + # Create Campaign + new_campaign = Campaign.from_json(campaign) + results = CertificationCampaignsApi(api_client).create_campaign(campaign=new_campaign) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).create_campaign(new_campaign) + print("The response of CertificationCampaignsApi->create_campaign:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign: %s\n" % e) - path: /campaign-templates method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#create-campaign-template source: | - campaign_template = { + campaign_template = '''{ "ownerRef" : { "name" : "Mister Manager", "id" : "2c918086676d3e0601677611dbde220f", @@ -1882,18 +1775,17 @@ "correlatedStatus" : "CORRELATED" }, "id" : "2c9079b270a266a60170a277bb960008" - } # CampaignTemplate | - try: - # Create a Campaign Template - Result = campaign_template.from_json(campaign_template) - api_response = api_instance.create_campaign_template(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_campaign_template(Result) - print("The response of CertificationCampaignsApi->create_campaign_template:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->create_campaign_template: %s\n" % e) + }''' # CampaignTemplate | + try: + # Create a Campaign Template + new_campaign_template = CampaignTemplate.from_json(campaign_template) + results = CertificationCampaignsApi(api_client).create_campaign_template(campaign_template=new_campaign_template) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).create_campaign_template(new_campaign_template) + print("The response of CertificationCampaignsApi->create_campaign_template:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign_template: %s\n" % e) - path: /campaign-templates/{id} method: DELETE xCodeSample: @@ -1902,14 +1794,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_campaign_template(id) + # Delete a Campaign Template + + CertificationCampaignsApi(api_client).delete_campaign_template(id=id) + # Below is a request that includes all optional parameters + # CertificationCampaignsApi(api_client).delete_campaign_template(id) except Exception as e: - print("Exception when calling CertificationCampaignsApi->delete_campaign_template: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->delete_campaign_template: %s\n" % e) - path: /campaign-templates/{id}/schedule method: DELETE xCodeSample: @@ -1918,34 +1809,32 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_campaign_template_schedule(id) + # Delete Campaign Template Schedule + + CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id=id) + # Below is a request that includes all optional parameters + # CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id) except Exception as e: - print("Exception when calling CertificationCampaignsApi->delete_campaign_template_schedule: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->delete_campaign_template_schedule: %s\n" % e) - path: /campaigns/delete method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#delete-campaigns source: | - delete_campaigns_request = { + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_campaigns(Result) - print("The response of CertificationCampaignsApi->delete_campaigns:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e) + }''' # DeleteCampaignsRequest | IDs of the campaigns to delete. + try: + # Delete Campaigns + new_delete_campaigns_request = DeleteCampaignsRequest.from_json(delete_campaigns_request) + results = CertificationCampaignsApi(api_client).delete_campaigns(delete_campaigns_request=new_delete_campaigns_request) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).delete_campaigns(new_delete_campaigns_request) + print("The response of CertificationCampaignsApi->delete_campaigns:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e) - path: /campaigns method: GET xCodeSample: @@ -1959,16 +1848,15 @@ filters = 'name eq \"Manager 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, in* **name**: *eq, sw* **status**: *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: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) 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, created** (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, created** (optional) try: - # List Campaigns - - api_response = api_instance.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) - print("The response of CertificationCampaignsApi->get_active_campaigns:\n") - pprint(api_response) + # List Campaigns + + results = CertificationCampaignsApi(api_client).get_active_campaigns() + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters) + print("The response of CertificationCampaignsApi->get_active_campaigns:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) - path: /campaigns/{id} method: GET xCodeSample: @@ -1977,16 +1865,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_campaign(id) - print("The response of CertificationCampaignsApi->get_campaign:\n") - pprint(api_response) + # Get Campaign + + results = CertificationCampaignsApi(api_client).get_campaign(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign(id) + print("The response of CertificationCampaignsApi->get_campaign:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e) - path: /campaigns/{id}/reports method: GET xCodeSample: @@ -1995,16 +1882,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_campaign_reports(id) - print("The response of CertificationCampaignsApi->get_campaign_reports:\n") - pprint(api_response) + # Get Campaign Reports + + results = CertificationCampaignsApi(api_client).get_campaign_reports(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign_reports(id) + print("The response of CertificationCampaignsApi->get_campaign_reports:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) - path: /campaigns/reports-configuration method: GET xCodeSample: @@ -2012,16 +1898,15 @@ label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-campaign-reports-config source: | try: - # Get Campaign Reports Configuration - - api_response = api_instance.get_campaign_reports_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_campaign_reports_config() - print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n") - pprint(api_response) + # Get Campaign Reports Configuration + + results = CertificationCampaignsApi(api_client).get_campaign_reports_config() + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign_reports_config() + print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e) - path: /campaign-templates/{id} method: GET xCodeSample: @@ -2030,16 +1915,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_campaign_template(id) - print("The response of CertificationCampaignsApi->get_campaign_template:\n") - pprint(api_response) + # Get a Campaign Template + + results = CertificationCampaignsApi(api_client).get_campaign_template(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign_template(id) + print("The response of CertificationCampaignsApi->get_campaign_template:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e) - path: /campaign-templates/{id}/schedule method: GET xCodeSample: @@ -2048,16 +1932,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_campaign_template_schedule(id) - print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n") - pprint(api_response) + # Get Campaign Template Schedule + + results = CertificationCampaignsApi(api_client).get_campaign_template_schedule(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign_template_schedule(id) + print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e) - path: /campaign-templates method: GET xCodeSample: @@ -2070,16 +1953,15 @@ 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, created, 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-results) Sorting is supported for the following fields: **name, created, modified** (optional) filters = 'name eq \"manager template\"' # 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, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, 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**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) try: - # List Campaign Templates - - api_response = api_instance.get_campaign_templates() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_campaign_templates(limit, offset, count, sorters, filters) - print("The response of CertificationCampaignsApi->get_campaign_templates:\n") - pprint(api_response) + # List Campaign Templates + + results = CertificationCampaignsApi(api_client).get_campaign_templates() + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters) + print("The response of CertificationCampaignsApi->get_campaign_templates:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) - path: /campaigns/{id}/reassign method: POST xCodeSample: @@ -2087,25 +1969,24 @@ label: SDK_tools/sdk/python/beta/methods/certification-campaigns#move source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification campaign ID # str | The certification campaign ID - admin_review_reassign = { + admin_review_reassign = '''{ "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], "reason" : "reassigned for some reason", "reassignTo" : { "id" : "ef38f94347e94562b5bb8424a56397d8", "type" : "IDENTITY" } - } # AdminReviewReassign | - try: - # Reassign Certifications - Result = admin_review_reassign.from_json(admin_review_reassign) - api_response = api_instance.move(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.move(id, Result) - print("The response of CertificationCampaignsApi->move:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->move: %s\n" % e) + }''' # AdminReviewReassign | + try: + # Reassign Certifications + new_admin_review_reassign = AdminReviewReassign.from_json(admin_review_reassign) + results = CertificationCampaignsApi(api_client).move(id=id, admin_review_reassign=new_admin_review_reassign) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).move(id, new_admin_review_reassign) + print("The response of CertificationCampaignsApi->move:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->move: %s\n" % e) - path: /campaign-templates/{id} method: PATCH xCodeSample: @@ -2113,44 +1994,36 @@ label: SDK_tools/sdk/python/beta/methods/certification-campaigns#patch-campaign-template source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # 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) - - try: - # Update a Campaign Template - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_campaign_template(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_campaign_template(id, Result) - print("The response of CertificationCampaignsApi->patch_campaign_template:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e) + json_patch_operation = '''[{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) + try: + # Update a Campaign Template + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = CertificationCampaignsApi(api_client).patch_campaign_template(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).patch_campaign_template(id, new_json_patch_operation) + print("The response of CertificationCampaignsApi->patch_campaign_template:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e) - path: /campaigns/reports-configuration method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#set-campaign-reports-config source: | - campaign_reports_config = { + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_campaign_reports_config(Result) - print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->set_campaign_reports_config: %s\n" % e) + }''' # CampaignReportsConfig | Campaign report configuration. + try: + # Set Campaign Reports Configuration + new_campaign_reports_config = CampaignReportsConfig.from_json(campaign_reports_config) + results = CertificationCampaignsApi(api_client).set_campaign_reports_config(campaign_reports_config=new_campaign_reports_config) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).set_campaign_reports_config(new_campaign_reports_config) + print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->set_campaign_reports_config: %s\n" % e) - path: /campaign-templates/{id}/schedule method: PUT xCodeSample: @@ -2158,7 +2031,7 @@ label: SDK_tools/sdk/python/beta/methods/certification-campaigns#set-campaign-template-schedule source: | id = '04bedce387bd47b2ae1f86eb0bb36dee' # str | ID of the campaign template being scheduled. # str | ID of the campaign template being scheduled. - schedule = { + schedule = '''{ "hours" : { "values" : [ "1" ], "interval" : 2, @@ -2177,16 +2050,15 @@ }, "expiration" : "2000-01-23T04:56:07.000+00:00", "type" : "WEEKLY" - } # Schedule | (optional) + }''' # Schedule | (optional) try: - # Set Campaign Template Schedule - - api_instance.set_campaign_template_schedule(id, ) - - # Below is a request that includes all optional parameters - # api_instance.set_campaign_template_schedule(id, Result) + # Set Campaign Template Schedule + + CertificationCampaignsApi(api_client).set_campaign_template_schedule(id=id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling CertificationCampaignsApi->set_campaign_template_schedule: %s\n" % e) - path: /campaigns/{id}/activate method: POST xCodeSample: @@ -2194,20 +2066,19 @@ label: SDK_tools/sdk/python/beta/methods/certification-campaigns#start-campaign source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID. - activate_campaign_options = { + activate_campaign_options = '''{ "timeZone" : "-05:00" - } # ActivateCampaignOptions | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional) - try: - # Activate a Campaign - - api_response = api_instance.start_campaign(id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_campaign(id, Result) - print("The response of CertificationCampaignsApi->start_campaign:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->start_campaign: %s\n" % e) + }''' # ActivateCampaignOptions | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional) + try: + # Activate a Campaign + + results = CertificationCampaignsApi(api_client).start_campaign(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).start_campaign(id, new_activate_campaign_options) + print("The response of CertificationCampaignsApi->start_campaign:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign: %s\n" % e) - path: /campaigns/{id}/run-remediation-scan method: POST xCodeSample: @@ -2216,16 +2087,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_campaign_remediation_scan(id) - print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n") - pprint(api_response) + # Run Campaign Remediation Scan + + results = CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id) + print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->start_campaign_remediation_scan: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->start_campaign_remediation_scan: %s\n" % e) - path: /campaigns/{id}/run-report/{type} method: POST xCodeSample: @@ -2235,16 +2105,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_campaign_report(id, type) - print("The response of CertificationCampaignsApi->start_campaign_report:\n") - pprint(api_response) + # Run Campaign Report + + results = CertificationCampaignsApi(api_client).start_campaign_report(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).start_campaign_report(id, type) + print("The response of CertificationCampaignsApi->start_campaign_report:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e) - path: /campaign-templates/{id}/generate method: POST xCodeSample: @@ -2253,16 +2122,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_generate_campaign_template(id) - print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n") - pprint(api_response) + # Generate a Campaign from Template + + results = CertificationCampaignsApi(api_client).start_generate_campaign_template(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).start_generate_campaign_template(id) + print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e) - path: /campaigns/{id} method: PATCH xCodeSample: @@ -2270,20 +2138,17 @@ label: SDK_tools/sdk/python/beta/methods/certification-campaigns#update-campaign source: | 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 - - try: - # Update a Campaign - Result = request_body.from_json(request_body) - api_response = api_instance.update_campaign(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_campaign(id, Result) - print("The response of CertificationCampaignsApi->update_campaign:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) + 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 + try: + # Update a Campaign + new_request_body = RequestBody.from_json(request_body) + results = CertificationCampaignsApi(api_client).update_campaign(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).update_campaign(id, new_request_body) + print("The response of CertificationCampaignsApi->update_campaign:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) - path: /certifications/{certificationId}/access-review-items/{itemId}/permissions method: GET xCodeSample: @@ -2297,16 +2162,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) 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) try: - # Permissions for Entitlement Certification Item - - api_response = api_instance.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) - print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") - pprint(api_response) + # Permissions for Entitlement Certification Item + + results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id=certification_id, item_id=item_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) + print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) - path: /certifications/{id}/tasks-pending method: GET xCodeSample: @@ -2315,16 +2179,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_certification_pending_tasks(id) - print("The response of CertificationsApi->get_identity_certification_pending_tasks:\n") - pprint(api_response) + # Pending Certification Tasks + + results = CertificationsApi(api_client).get_identity_certification_pending_tasks(id=id) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).get_identity_certification_pending_tasks(id) + print("The response of CertificationsApi->get_identity_certification_pending_tasks:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationsApi->get_identity_certification_pending_tasks: %s\n" % e) + print("Exception when calling CertificationsApi->get_identity_certification_pending_tasks: %s\n" % e) - path: /certifications/{id}/tasks/{taskId} method: GET xCodeSample: @@ -2334,16 +2197,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_certification_task_status(id, task_id) - print("The response of CertificationsApi->get_identity_certification_task_status:\n") - pprint(api_response) + # Certification Task Status + + results = CertificationsApi(api_client).get_identity_certification_task_status(id=id, task_id=task_id) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).get_identity_certification_task_status(id, task_id) + print("The response of CertificationsApi->get_identity_certification_task_status:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationsApi->get_identity_certification_task_status: %s\n" % e) + print("Exception when calling CertificationsApi->get_identity_certification_task_status: %s\n" % e) - path: /certifications/{id}/reviewers method: GET xCodeSample: @@ -2357,16 +2219,15 @@ filters = 'name eq \"Bob\"' # 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* **email**: *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: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) 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, email** (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, email** (optional) try: - # List of Reviewers for certification - - api_response = api_instance.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) - print("The response of CertificationsApi->list_certification_reviewers:\n") - pprint(api_response) + # List of Reviewers for certification + + results = CertificationsApi(api_client).list_certification_reviewers(id=id) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_certification_reviewers:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) + print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) - path: /certifications method: GET xCodeSample: @@ -2380,16 +2241,15 @@ filters = 'filters_example' # 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* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.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: **id**: *eq, in* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* (optional) 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: **name, due, signed** (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, due, signed** (optional) try: - # Certifications by IDs - - api_response = api_instance.list_certifications() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_certifications(reviewer_identitiy, limit, offset, count, filters, sorters) - print("The response of CertificationsApi->list_certifications:\n") - pprint(api_response) + # Certifications by IDs + + results = CertificationsApi(api_client).list_certifications() + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).list_certifications(reviewer_identitiy, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_certifications:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationsApi->list_certifications: %s\n" % e) + print("Exception when calling CertificationsApi->list_certifications: %s\n" % e) - path: /certifications/{id}/reassign-async method: POST xCodeSample: @@ -2397,7 +2257,7 @@ label: SDK_tools/sdk/python/beta/methods/certifications#submit-reassign-certs-async source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - review_reassign = { + review_reassign = '''{ "reason" : "reassigned for some reason", "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", "reassign" : [ { @@ -2407,25 +2267,24 @@ "id" : "ef38f94347e94562b5bb8424a56397d8", "type" : "ITEM" } ] - } # ReviewReassign | - try: - # Reassign Certifications Asynchronously - Result = review_reassign.from_json(review_reassign) - api_response = api_instance.submit_reassign_certs_async(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.submit_reassign_certs_async(id, Result) - print("The response of CertificationsApi->submit_reassign_certs_async:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) + }''' # ReviewReassign | + try: + # Reassign Certifications Asynchronously + new_review_reassign = ReviewReassign.from_json(review_reassign) + results = CertificationsApi(api_client).submit_reassign_certs_async(id=id, review_reassign=new_review_reassign) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).submit_reassign_certs_async(id, new_review_reassign) + print("The response of CertificationsApi->submit_reassign_certs_async:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) - path: /connector-rules method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/connector-rule-management#create-connector-rule source: | - connector_rule_create_request = { + connector_rule_create_request = '''{ "sourceCode" : { "version" : "1.0", "script" : "return \"Mr. \" + firstName;" @@ -2450,18 +2309,17 @@ "description" : "This rule does that", "attributes" : { }, "type" : "BuildMap" - } # ConnectorRuleCreateRequest | The connector rule to create - try: - # Create Connector Rule - Result = connector_rule_create_request.from_json(connector_rule_create_request) - api_response = api_instance.create_connector_rule(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_connector_rule(Result) - print("The response of ConnectorRuleManagementApi->create_connector_rule:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->create_connector_rule: %s\n" % e) + }''' # ConnectorRuleCreateRequest | The connector rule to create + try: + # Create Connector Rule + new_connector_rule_create_request = ConnectorRuleCreateRequest.from_json(connector_rule_create_request) + results = ConnectorRuleManagementApi(api_client).create_connector_rule(connector_rule_create_request=new_connector_rule_create_request) + # Below is a request that includes all optional parameters + # results = ConnectorRuleManagementApi(api_client).create_connector_rule(new_connector_rule_create_request) + print("The response of ConnectorRuleManagementApi->create_connector_rule:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->create_connector_rule: %s\n" % e) - path: /connector-rules/{id} method: DELETE xCodeSample: @@ -2470,14 +2328,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_connector_rule(id) + # Delete a Connector-Rule + + ConnectorRuleManagementApi(api_client).delete_connector_rule(id=id) + # Below is a request that includes all optional parameters + # ConnectorRuleManagementApi(api_client).delete_connector_rule(id) except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->delete_connector_rule: %s\n" % e) + print("Exception when calling ConnectorRuleManagementApi->delete_connector_rule: %s\n" % e) - path: /connector-rules/{id} method: GET xCodeSample: @@ -2486,16 +2343,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_connector_rule(id) - print("The response of ConnectorRuleManagementApi->get_connector_rule:\n") - pprint(api_response) + # Connector-Rule by ID + + results = ConnectorRuleManagementApi(api_client).get_connector_rule(id=id) + # Below is a request that includes all optional parameters + # results = ConnectorRuleManagementApi(api_client).get_connector_rule(id) + print("The response of ConnectorRuleManagementApi->get_connector_rule:\n") + pprint(results) except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->get_connector_rule: %s\n" % e) + print("Exception when calling ConnectorRuleManagementApi->get_connector_rule: %s\n" % e) - path: /connector-rules method: GET xCodeSample: @@ -2503,16 +2359,15 @@ label: SDK_tools/sdk/python/beta/methods/connector-rule-management#get-connector-rule-list source: | try: - # List Connector Rules - - api_response = api_instance.get_connector_rule_list() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_connector_rule_list() - print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") - pprint(api_response) + # List Connector Rules + + results = ConnectorRuleManagementApi(api_client).get_connector_rule_list() + # Below is a request that includes all optional parameters + # results = ConnectorRuleManagementApi(api_client).get_connector_rule_list() + print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") + pprint(results) except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) + print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) - path: /connector-rules/{id} method: PUT xCodeSample: @@ -2520,7 +2375,7 @@ label: SDK_tools/sdk/python/beta/methods/connector-rule-management#update-connector-rule source: | id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to update # str | ID of the connector rule to update - connector_rule_update_request = { + connector_rule_update_request = '''{ "sourceCode" : { "version" : "1.0", "script" : "return \"Mr. \" + firstName;" @@ -2546,39 +2401,37 @@ "attributes" : { }, "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", "type" : "BuildMap" - } # ConnectorRuleUpdateRequest | The connector rule with updated data (optional) - try: - # Update a Connector Rule - - api_response = api_instance.update_connector_rule(id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_connector_rule(id, Result) - print("The response of ConnectorRuleManagementApi->update_connector_rule:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->update_connector_rule: %s\n" % e) + }''' # ConnectorRuleUpdateRequest | The connector rule with updated data (optional) + try: + # Update a Connector Rule + + results = ConnectorRuleManagementApi(api_client).update_connector_rule(id=id) + # Below is a request that includes all optional parameters + # results = ConnectorRuleManagementApi(api_client).update_connector_rule(id, new_connector_rule_update_request) + print("The response of ConnectorRuleManagementApi->update_connector_rule:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->update_connector_rule: %s\n" % e) - path: /connector-rules/validate method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/connector-rule-management#validate-connector-rule source: | - source_code = { + source_code = '''{ "version" : "1.0", "script" : "return \"Mr. \" + firstName;" - } # SourceCode | The code to validate - try: - # Validate Connector Rule - Result = source_code.from_json(source_code) - api_response = api_instance.validate_connector_rule(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.validate_connector_rule(Result) - print("The response of ConnectorRuleManagementApi->validate_connector_rule:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->validate_connector_rule: %s\n" % e) + }''' # SourceCode | The code to validate + try: + # Validate Connector Rule + new_source_code = SourceCode.from_json(source_code) + results = ConnectorRuleManagementApi(api_client).validate_connector_rule(source_code=new_source_code) + # Below is a request that includes all optional parameters + # results = ConnectorRuleManagementApi(api_client).validate_connector_rule(new_source_code) + print("The response of ConnectorRuleManagementApi->validate_connector_rule:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->validate_connector_rule: %s\n" % e) - path: /connectors method: GET xCodeSample: @@ -2591,23 +2444,22 @@ 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) 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 List - - api_response = api_instance.get_connector_list() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_connector_list(filters, limit, offset, count, locale) - print("The response of ConnectorsApi->get_connector_list:\n") - pprint(api_response) + # Get Connector List + + results = ConnectorsApi(api_client).get_connector_list() + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale) + print("The response of ConnectorsApi->get_connector_list:\n") + pprint(results) except Exception as e: - print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) + print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) - path: /form-definitions method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-definition source: | - create_form_definition_request = { + create_form_definition_request = '''{ "owner" : { "name" : "Grant Smith", "id" : "2c9180867624cbd7017642d8c8c81f67", @@ -2717,25 +2569,24 @@ }, "key" : "department" } ] - } # CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional) - try: - # Creates a form definition. - - api_response = api_instance.create_form_definition() - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_form_definition(Result) - print("The response of CustomFormsApi->create_form_definition:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CustomFormsApi->create_form_definition: %s\n" % e) + }''' # CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional) + try: + # Creates a form definition. + + results = CustomFormsApi(api_client).create_form_definition() + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).create_form_definition(new_create_form_definition_request) + print("The response of CustomFormsApi->create_form_definition:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition: %s\n" % e) - path: /form-definitions/template method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-definition-by-template source: | - create_form_definition_request = { + create_form_definition_request = '''{ "owner" : { "name" : "Grant Smith", "id" : "2c9180867624cbd7017642d8c8c81f67", @@ -2845,25 +2696,24 @@ }, "key" : "department" } ] - } # CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional) - try: - # Create a form definition by template. - - api_response = api_instance.create_form_definition_by_template() - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_form_definition_by_template(Result) - print("The response of CustomFormsApi->create_form_definition_by_template:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CustomFormsApi->create_form_definition_by_template: %s\n" % e) + }''' # CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional) + try: + # Create a form definition by template. + + results = CustomFormsApi(api_client).create_form_definition_by_template() + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_by_template: %s\n" % e) - path: /form-definitions/forms-action-dynamic-schema method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-definition-dynamic-schema source: | - body = { + body = '''{ "description" : "A description", "attributes" : { "formDefinitionId" : "00000000-0000-0000-0000-000000000000" @@ -2871,18 +2721,17 @@ "id" : "00000000-0000-0000-0000-000000000000", "type" : "action", "versionNumber" : 1 - } # FormDefinitionDynamicSchemaRequest | Body is the request payload to create a form definition dynamic schema (optional) - try: - # Generate JSON Schema dynamically. - - api_response = api_instance.create_form_definition_dynamic_schema() - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_form_definition_dynamic_schema(Result) - print("The response of CustomFormsApi->create_form_definition_dynamic_schema:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CustomFormsApi->create_form_definition_dynamic_schema: %s\n" % e) + }''' # FormDefinitionDynamicSchemaRequest | Body is the request payload to create a form definition dynamic schema (optional) + try: + # Generate JSON Schema dynamically. + + results = CustomFormsApi(api_client).create_form_definition_dynamic_schema() + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).create_form_definition_dynamic_schema(new_body) + print("The response of CustomFormsApi->create_form_definition_dynamic_schema:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_dynamic_schema: %s\n" % e) - path: /form-definitions/{formDefinitionID}/upload method: POST xCodeSample: @@ -2892,23 +2741,22 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_form_definition_file_request(form_definition_id, file) - print("The response of CustomFormsApi->create_form_definition_file_request:\n") - pprint(api_response) + # Upload new form definition file. + + results = CustomFormsApi(api_client).create_form_definition_file_request(form_definition_id=form_definition_id, file=file) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CustomFormsApi->create_form_definition_file_request: %s\n" % e) + print("Exception when calling CustomFormsApi->create_form_definition_file_request: %s\n" % e) - path: /form-instances method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-instance source: | - body = { + body = '''{ "formInput" : { "input1" : "Sales" }, @@ -2928,18 +2776,17 @@ "formDefinitionId" : "00000000-0000-0000-0000-000000000000", "state" : "ASSIGNED", "ttl" : 1571827560 - } # CreateFormInstanceRequest | Body is the request payload to create a form instance (optional) - try: - # Creates a form instance. - - api_response = api_instance.create_form_instance() - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_form_instance(Result) - print("The response of CustomFormsApi->create_form_instance:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CustomFormsApi->create_form_instance: %s\n" % e) + }''' # CreateFormInstanceRequest | Body is the request payload to create a form instance (optional) + try: + # Creates a form instance. + + results = CustomFormsApi(api_client).create_form_instance() + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).create_form_instance(new_body) + print("The response of CustomFormsApi->create_form_instance:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_instance: %s\n" % e) - path: /form-definitions/{formDefinitionID} method: DELETE xCodeSample: @@ -2948,16 +2795,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_form_definition(form_definition_id) - print("The response of CustomFormsApi->delete_form_definition:\n") - pprint(api_response) + # Deletes a form definition. + + results = CustomFormsApi(api_client).delete_form_definition(form_definition_id=form_definition_id) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).delete_form_definition(form_definition_id) + print("The response of CustomFormsApi->delete_form_definition:\n") + pprint(results) except Exception as e: - print("Exception when calling CustomFormsApi->delete_form_definition: %s\n" % e) + print("Exception when calling CustomFormsApi->delete_form_definition: %s\n" % e) - path: /form-definitions/export method: GET xCodeSample: @@ -2969,16 +2815,15 @@ 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) 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, description, created, modified** (optional) (default to '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, description, created, modified** (optional) (default to 'name') try: - # List form definitions by tenant. - - api_response = api_instance.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) - print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") - pprint(api_response) + # List form definitions by tenant. + + results = CustomFormsApi(api_client).export_form_definitions_by_tenant() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) + print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) - path: /form-definitions/{formDefinitionID}/file/{fileID} method: GET xCodeSample: @@ -2988,16 +2833,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_file_from_s3(form_definition_id, file_id) - print("The response of CustomFormsApi->get_file_from_s3:\n") - pprint(api_response) + # Download definition file by fileId. + + results = CustomFormsApi(api_client).get_file_from_s3(form_definition_id=form_definition_id, file_id=file_id) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).get_file_from_s3(form_definition_id, file_id) + print("The response of CustomFormsApi->get_file_from_s3:\n") + pprint(results) except Exception as e: - print("Exception when calling CustomFormsApi->get_file_from_s3: %s\n" % e) + print("Exception when calling CustomFormsApi->get_file_from_s3: %s\n" % e) - path: /form-definitions/{formDefinitionID} method: GET xCodeSample: @@ -3006,16 +2850,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_form_definition_by_key(form_definition_id) - print("The response of CustomFormsApi->get_form_definition_by_key:\n") - pprint(api_response) + # Return a form definition. + + results = CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id=form_definition_id) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id) + print("The response of CustomFormsApi->get_form_definition_by_key:\n") + pprint(results) except Exception as e: - print("Exception when calling CustomFormsApi->get_form_definition_by_key: %s\n" % e) + print("Exception when calling CustomFormsApi->get_form_definition_by_key: %s\n" % e) - path: /form-instances/{formInstanceID} method: GET xCodeSample: @@ -3024,16 +2867,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_form_instance_by_key(form_instance_id) - print("The response of CustomFormsApi->get_form_instance_by_key:\n") - pprint(api_response) + # Returns a form instance. + + results = CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id=form_instance_id) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id) + print("The response of CustomFormsApi->get_form_instance_by_key:\n") + pprint(results) except Exception as e: - print("Exception when calling CustomFormsApi->get_form_instance_by_key: %s\n" % e) + print("Exception when calling CustomFormsApi->get_form_instance_by_key: %s\n" % e) - path: /form-instances/{formInstanceID}/file/{fileID} method: GET xCodeSample: @@ -3043,36 +2885,32 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_form_instance_file(form_instance_id, file_id) - print("The response of CustomFormsApi->get_form_instance_file:\n") - pprint(api_response) + # Download instance file by fileId. + + results = CustomFormsApi(api_client).get_form_instance_file(form_instance_id=form_instance_id, file_id=file_id) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).get_form_instance_file(form_instance_id, file_id) + print("The response of CustomFormsApi->get_form_instance_file:\n") + pprint(results) except Exception as e: - print("Exception when calling CustomFormsApi->get_form_instance_file: %s\n" % e) + print("Exception when calling CustomFormsApi->get_form_instance_file: %s\n" % e) - path: /form-definitions/import method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#import-form-definitions source: | - [{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) - + 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) try: - # Import form definitions from export. - - api_response = api_instance.import_form_definitions() - - # Below is a request that includes all optional parameters - # api_response = api_instance.import_form_definitions(Result) - print("The response of CustomFormsApi->import_form_definitions:\n") - pprint(api_response) + # Import form definitions from export. + + results = CustomFormsApi(api_client).import_form_definitions() + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).import_form_definitions(new_body) + print("The response of CustomFormsApi->import_form_definitions:\n") + pprint(results) except Exception as e: - print("Exception when calling CustomFormsApi->import_form_definitions: %s\n" % e) + print("Exception when calling CustomFormsApi->import_form_definitions: %s\n" % e) - path: /form-definitions/{formDefinitionID} method: PATCH xCodeSample: @@ -3080,20 +2918,17 @@ label: SDK_tools/sdk/python/beta/methods/custom-forms#patch-form-definition source: | 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) - - try: - # Patch a form definition. - - api_response = api_instance.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) - print("The response of CustomFormsApi->patch_form_definition:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CustomFormsApi->patch_form_definition: %s\n" % e) + 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) + try: + # Patch a form definition. + + results = CustomFormsApi(api_client).patch_form_definition(form_definition_id=form_definition_id) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).patch_form_definition(form_definition_id, new_body) + print("The response of CustomFormsApi->patch_form_definition:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->patch_form_definition: %s\n" % e) - path: /form-instances/{formInstanceID} method: PATCH xCodeSample: @@ -3101,20 +2936,17 @@ label: SDK_tools/sdk/python/beta/methods/custom-forms#patch-form-instance source: | 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) - - try: - # Patch a form instance. - - api_response = api_instance.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) - print("The response of CustomFormsApi->patch_form_instance:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CustomFormsApi->patch_form_instance: %s\n" % e) + 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) + try: + # Patch a form instance. + + results = CustomFormsApi(api_client).patch_form_instance(form_instance_id=form_instance_id) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).patch_form_instance(form_instance_id, new_body) + print("The response of CustomFormsApi->patch_form_instance:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->patch_form_instance: %s\n" % e) - path: /form-definitions method: GET xCodeSample: @@ -3126,16 +2958,15 @@ 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) 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, description, created, modified** (optional) (default to '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, description, created, modified** (optional) (default to 'name') try: - # Export form definitions by tenant. - - api_response = api_instance.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) - print("The response of CustomFormsApi->search_form_definitions_by_tenant:\n") - pprint(api_response) + # Export form definitions by tenant. + + results = CustomFormsApi(api_client).search_form_definitions_by_tenant() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CustomFormsApi->search_form_definitions_by_tenant: %s\n" % e) + print("Exception when calling CustomFormsApi->search_form_definitions_by_tenant: %s\n" % e) - path: /form-instances/{formInstanceID}/data-source/{formElementID} method: GET xCodeSample: @@ -3148,16 +2979,15 @@ 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) query = 'support' # str | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # str | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) try: - # Retrieves dynamic data by element. - - api_response = api_instance.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) - print("The response of CustomFormsApi->search_form_element_data_by_element_id:\n") - pprint(api_response) + # Retrieves dynamic data by element. + + results = CustomFormsApi(api_client).search_form_element_data_by_element_id(form_instance_id=form_instance_id, form_element_id=form_element_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CustomFormsApi->search_form_element_data_by_element_id: %s\n" % e) + print("Exception when calling CustomFormsApi->search_form_element_data_by_element_id: %s\n" % e) - path: /form-instances method: GET xCodeSample: @@ -3165,16 +2995,15 @@ label: SDK_tools/sdk/python/beta/methods/custom-forms#search-form-instances-by-tenant source: | try: - # List form instances by tenant. - - api_response = api_instance.search_form_instances_by_tenant() - - # Below is a request that includes all optional parameters - # api_response = api_instance.search_form_instances_by_tenant() - print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") - pprint(api_response) + # List form instances by tenant. + + results = CustomFormsApi(api_client).search_form_instances_by_tenant() + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).search_form_instances_by_tenant() + print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") + pprint(results) except Exception as e: - print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) + print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) - path: /form-definitions/predefined-select-options method: GET xCodeSample: @@ -3182,16 +3011,15 @@ label: SDK_tools/sdk/python/beta/methods/custom-forms#search-pre-defined-select-options source: | try: - # List predefined select options. - - api_response = api_instance.search_pre_defined_select_options() - - # Below is a request that includes all optional parameters - # api_response = api_instance.search_pre_defined_select_options() - print("The response of CustomFormsApi->search_pre_defined_select_options:\n") - pprint(api_response) + # List predefined select options. + + results = CustomFormsApi(api_client).search_pre_defined_select_options() + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).search_pre_defined_select_options() + print("The response of CustomFormsApi->search_pre_defined_select_options:\n") + pprint(results) except Exception as e: - print("Exception when calling CustomFormsApi->search_pre_defined_select_options: %s\n" % e) + print("Exception when calling CustomFormsApi->search_pre_defined_select_options: %s\n" % e) - path: /form-definitions/{formDefinitionID}/data-source method: POST xCodeSample: @@ -3202,7 +3030,7 @@ 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) query = 'ac' # str | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # str | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) - form_element_preview_request = { + form_element_preview_request = '''{ "dataSource" : { "config" : { "indices" : [ "identities" ], @@ -3212,40 +3040,38 @@ }, "dataSourceType" : "STATIC" } - } # FormElementPreviewRequest | Body is the request payload to create a form definition dynamic schema (optional) - try: - # Preview form definition data source. - - api_response = api_instance.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) - print("The response of CustomFormsApi->show_preview_data_source:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CustomFormsApi->show_preview_data_source: %s\n" % e) + }''' # FormElementPreviewRequest | Body is the request payload to create a form definition dynamic schema (optional) + try: + # Preview form definition data source. + + results = CustomFormsApi(api_client).show_preview_data_source(form_definition_id=form_definition_id) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling CustomFormsApi->show_preview_data_source: %s\n" % e) - path: /custom-password-instructions method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-password-instructions#create-custom-password-instructions source: | - custom_password_instruction = { + 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", "locale" : "en" - } # CustomPasswordInstruction | - try: - # Create Custom Password Instructions - Result = custom_password_instruction.from_json(custom_password_instruction) - api_response = api_instance.create_custom_password_instructions(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_custom_password_instructions(Result) - print("The response of CustomPasswordInstructionsApi->create_custom_password_instructions:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CustomPasswordInstructionsApi->create_custom_password_instructions: %s\n" % e) + }''' # CustomPasswordInstruction | + try: + # Create Custom Password Instructions + new_custom_password_instruction = CustomPasswordInstruction.from_json(custom_password_instruction) + results = CustomPasswordInstructionsApi(api_client).create_custom_password_instructions(custom_password_instruction=new_custom_password_instruction) + # Below is a request that includes all optional parameters + # results = CustomPasswordInstructionsApi(api_client).create_custom_password_instructions(new_custom_password_instruction) + print("The response of CustomPasswordInstructionsApi->create_custom_password_instructions:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->create_custom_password_instructions: %s\n" % e) - path: /custom-password-instructions/{pageId} method: DELETE xCodeSample: @@ -3255,14 +3081,13 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_instance.delete_custom_password_instructions(page_id, locale) + # Delete Custom Password Instructions by page ID + + CustomPasswordInstructionsApi(api_client).delete_custom_password_instructions(page_id=page_id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling CustomPasswordInstructionsApi->delete_custom_password_instructions: %s\n" % e) - path: /custom-password-instructions/{pageId} method: GET xCodeSample: @@ -3272,16 +3097,15 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_custom_password_instructions(page_id, locale) - print("The response of CustomPasswordInstructionsApi->get_custom_password_instructions:\n") - pprint(api_response) + # Get Custom Password Instructions by Page ID + + results = CustomPasswordInstructionsApi(api_client).get_custom_password_instructions(page_id=page_id) + # Below is a request that includes all optional parameters + # results = CustomPasswordInstructionsApi(api_client).get_custom_password_instructions(page_id, locale) + print("The response of CustomPasswordInstructionsApi->get_custom_password_instructions:\n") + pprint(results) except Exception as e: - print("Exception when calling CustomPasswordInstructionsApi->get_custom_password_instructions: %s\n" % e) + print("Exception when calling CustomPasswordInstructionsApi->get_custom_password_instructions: %s\n" % e) - path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} method: POST xCodeSample: @@ -3292,16 +3116,15 @@ 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. try: - # Add metadata to an entitlement. - - api_response = api_instance.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) - print("The response of EntitlementsApi->create_access_model_metadata_for_entitlement:\n") - pprint(api_response) + # Add metadata to an entitlement. + + results = EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id=id, attribute_key=attribute_key, attribute_value=attribute_value) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling EntitlementsApi->create_access_model_metadata_for_entitlement: %s\n" % e) + print("Exception when calling EntitlementsApi->create_access_model_metadata_for_entitlement: %s\n" % e) - path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} method: DELETE xCodeSample: @@ -3312,14 +3135,13 @@ 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. try: - # Remove metadata from an entitlement. - - api_instance.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) + # Remove metadata from an entitlement. + + EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id=id, attribute_key=attribute_key, attribute_value=attribute_value) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling EntitlementsApi->delete_access_model_metadata_from_entitlement: %s\n" % e) - path: /entitlements/{id} method: GET xCodeSample: @@ -3328,16 +3150,15 @@ source: | id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID try: - # Get an entitlement - - api_response = api_instance.get_entitlement(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_entitlement(id) - print("The response of EntitlementsApi->get_entitlement:\n") - pprint(api_response) + # Get an entitlement + + results = EntitlementsApi(api_client).get_entitlement(id=id) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).get_entitlement(id) + print("The response of EntitlementsApi->get_entitlement:\n") + pprint(results) except Exception as e: - print("Exception when calling EntitlementsApi->get_entitlement: %s\n" % e) + print("Exception when calling EntitlementsApi->get_entitlement: %s\n" % e) - path: /entitlements/{id}/entitlement-request-config method: GET xCodeSample: @@ -3346,16 +3167,15 @@ source: | id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id try: - # Get Entitlement Request Config - - api_response = api_instance.get_entitlement_request_config(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_entitlement_request_config(id) - print("The response of EntitlementsApi->get_entitlement_request_config:\n") - pprint(api_response) + # Get Entitlement Request Config + + results = EntitlementsApi(api_client).get_entitlement_request_config(id=id) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).get_entitlement_request_config(id) + print("The response of EntitlementsApi->get_entitlement_request_config:\n") + pprint(results) except Exception as e: - print("Exception when calling EntitlementsApi->get_entitlement_request_config: %s\n" % e) + print("Exception when calling EntitlementsApi->get_entitlement_request_config: %s\n" % e) - path: /entitlements/aggregate/sources/{id} method: POST xCodeSample: @@ -3365,16 +3185,15 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.import_entitlements_by_source(id, csv_file) - print("The response of EntitlementsApi->import_entitlements_by_source:\n") - pprint(api_response) + # Aggregate Entitlements + + results = EntitlementsApi(api_client).import_entitlements_by_source(id=id) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).import_entitlements_by_source(id, csv_file) + print("The response of EntitlementsApi->import_entitlements_by_source:\n") + pprint(results) except Exception as e: - print("Exception when calling EntitlementsApi->import_entitlements_by_source: %s\n" % e) + print("Exception when calling EntitlementsApi->import_entitlements_by_source: %s\n" % e) - path: /entitlements/{id}/children method: GET xCodeSample: @@ -3388,16 +3207,15 @@ sorters = 'name,-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-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (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: **id, name, created, modified, type, attribute, value, source.id** (optional) filters = 'attribute eq \"memberOf\"' # 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) try: - # List of entitlements children - - api_response = api_instance.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) - print("The response of EntitlementsApi->list_entitlement_children:\n") - pprint(api_response) + # List of entitlements children + + results = EntitlementsApi(api_client).list_entitlement_children(id=id) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).list_entitlement_children(id, limit, offset, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlement_children:\n") + pprint(results) except Exception as e: - print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) + print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) - path: /entitlements/{id}/parents method: GET xCodeSample: @@ -3411,16 +3229,15 @@ sorters = 'name,-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-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (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: **id, name, created, modified, type, attribute, value, source.id** (optional) filters = 'attribute eq \"memberOf\"' # 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) try: - # List of entitlements parents - - api_response = api_instance.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) - print("The response of EntitlementsApi->list_entitlement_parents:\n") - pprint(api_response) + # List of entitlements parents + + results = EntitlementsApi(api_client).list_entitlement_parents(id=id) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).list_entitlement_parents(id, limit, offset, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlement_parents:\n") + pprint(results) except Exception as e: - print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) + print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) - path: /entitlements method: GET xCodeSample: @@ -3437,16 +3254,15 @@ sorters = 'name,-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-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (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: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) filters = 'attribute eq \"memberOf\"' # 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) try: - # Gets a list of entitlements. - - api_response = api_instance.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) - print("The response of EntitlementsApi->list_entitlements:\n") - pprint(api_response) + # Gets a list of entitlements. + + results = EntitlementsApi(api_client).list_entitlements() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) + print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) - path: /entitlements/{id} method: PATCH xCodeSample: @@ -3454,24 +3270,17 @@ label: SDK_tools/sdk/python/beta/methods/entitlements#patch-entitlement source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | (optional) - - try: - # Patch an entitlement - - api_response = api_instance.patch_entitlement(id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_entitlement(id, Result) - print("The response of EntitlementsApi->patch_entitlement:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling EntitlementsApi->patch_entitlement: %s\n" % e) + json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}]''' # List[JsonPatchOperation] | (optional) + try: + # Patch an entitlement + + results = EntitlementsApi(api_client).patch_entitlement(id=id) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).patch_entitlement(id, new_json_patch_operation) + print("The response of EntitlementsApi->patch_entitlement:\n") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->patch_entitlement: %s\n" % e) - path: /entitlements/{id}/entitlement-request-config method: PUT xCodeSample: @@ -3479,7 +3288,7 @@ label: SDK_tools/sdk/python/beta/methods/entitlements#put-entitlement-request-config source: | id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID - entitlement_request_config = { + entitlement_request_config = '''{ "accessRequestConfig" : { "denialCommentRequired" : false, "approvalSchemes" : [ { @@ -3491,18 +3300,17 @@ } ], "requestCommentRequired" : true } - } # EntitlementRequestConfig | - try: - # Replace Entitlement Request Config - Result = entitlement_request_config.from_json(entitlement_request_config) - api_response = api_instance.put_entitlement_request_config(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_entitlement_request_config(id, Result) - print("The response of EntitlementsApi->put_entitlement_request_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling EntitlementsApi->put_entitlement_request_config: %s\n" % e) + }''' # EntitlementRequestConfig | + try: + # Replace Entitlement Request Config + new_entitlement_request_config = EntitlementRequestConfig.from_json(entitlement_request_config) + results = EntitlementsApi(api_client).put_entitlement_request_config(id=id, entitlement_request_config=new_entitlement_request_config) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).put_entitlement_request_config(id, new_entitlement_request_config) + print("The response of EntitlementsApi->put_entitlement_request_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->put_entitlement_request_config: %s\n" % e) - path: /entitlements/reset/sources/{sourceId} method: POST xCodeSample: @@ -3511,23 +3319,22 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.reset_source_entitlements(source_id) - print("The response of EntitlementsApi->reset_source_entitlements:\n") - pprint(api_response) + # Reset Source Entitlements + + results = EntitlementsApi(api_client).reset_source_entitlements(source_id=source_id) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).reset_source_entitlements(source_id) + print("The response of EntitlementsApi->reset_source_entitlements:\n") + pprint(results) except Exception as e: - print("Exception when calling EntitlementsApi->reset_source_entitlements: %s\n" % e) + print("Exception when calling EntitlementsApi->reset_source_entitlements: %s\n" % e) - path: /entitlements/bulk-update method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#update-entitlements-in-bulk source: | - entitlement_bulk_update_request = { + entitlement_bulk_update_request = '''{ "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], "jsonPatch" : [ { "op" : "replace", @@ -3538,23 +3345,22 @@ "path" : "/requestable", "value" : false } ] - } # EntitlementBulkUpdateRequest | + }''' # EntitlementBulkUpdateRequest | try: - # Bulk update an entitlement list - Result = entitlement_bulk_update_request.from_json(entitlement_bulk_update_request) - api_instance.update_entitlements_in_bulk(Result) - - # Below is a request that includes all optional parameters - # api_instance.update_entitlements_in_bulk(Result) + # Bulk update an entitlement list + new_entitlement_bulk_update_request = EntitlementBulkUpdateRequest.from_json(entitlement_bulk_update_request) + EntitlementsApi(api_client).update_entitlements_in_bulk(entitlement_bulk_update_request=new_entitlement_bulk_update_request) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling EntitlementsApi->update_entitlements_in_bulk: %s\n" % e) - path: /workgroups method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/governance-groups#create-workgroup source: | - workgroup_dto = { + workgroup_dto = '''{ "owner" : { "emailAddress" : "support@sailpoint.com", "displayName" : "Support", @@ -3569,18 +3375,17 @@ "description" : "Description of the Governance Group", "modified" : "2022-01-06T19:51:13Z", "id" : "2c91808568c529c60168cca6f90c1313" - } # WorkgroupDto | - try: - # Create a new Governance Group. - Result = workgroup_dto.from_json(workgroup_dto) - api_response = api_instance.create_workgroup(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_workgroup(Result) - print("The response of GovernanceGroupsApi->create_workgroup:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->create_workgroup: %s\n" % e) + }''' # WorkgroupDto | + try: + # Create a new Governance Group. + new_workgroup_dto = WorkgroupDto.from_json(workgroup_dto) + results = GovernanceGroupsApi(api_client).create_workgroup(workgroup_dto=new_workgroup_dto) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).create_workgroup(new_workgroup_dto) + print("The response of GovernanceGroupsApi->create_workgroup:\n") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->create_workgroup: %s\n" % e) - path: /workgroups/{id} method: DELETE xCodeSample: @@ -3589,14 +3394,13 @@ source: | id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group try: - # Delete a Governance Group - - api_instance.delete_workgroup(id) - - # Below is a request that includes all optional parameters - # api_instance.delete_workgroup(id) + # Delete a Governance Group + + GovernanceGroupsApi(api_client).delete_workgroup(id=id) + # Below is a request that includes all optional parameters + # GovernanceGroupsApi(api_client).delete_workgroup(id) except Exception as e: - print("Exception when calling GovernanceGroupsApi->delete_workgroup: %s\n" % e) + print("Exception when calling GovernanceGroupsApi->delete_workgroup: %s\n" % e) - path: /workgroups/{workgroupId}/members/bulk-delete method: POST xCodeSample: @@ -3604,40 +3408,36 @@ label: SDK_tools/sdk/python/beta/methods/governance-groups#delete-workgroup-members source: | 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. - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_workgroup_members(workgroup_id, Result) - print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) + bulk_workgroup_members_request_inner = '''[sailpoint.beta.BulkWorkgroupMembersRequestInner()]''' # List[BulkWorkgroupMembersRequestInner] | List of identities to be removed from a Governance Group members list. + try: + # Remove members from Governance Group + new_bulk_workgroup_members_request_inner = BulkWorkgroupMembersRequestInner.from_json(bulk_workgroup_members_request_inner) + results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id=workgroup_id, bulk_workgroup_members_request_inner=new_bulk_workgroup_members_request_inner) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) - path: /workgroups/bulk-delete method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/governance-groups#delete-workgroups-in-bulk source: | - workgroup_bulk_delete_request = { + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_workgroups_in_bulk(Result) - print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) + }''' # WorkgroupBulkDeleteRequest | + try: + # Delete Governance Group(s) + new_workgroup_bulk_delete_request = WorkgroupBulkDeleteRequest.from_json(workgroup_bulk_delete_request) + results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(workgroup_bulk_delete_request=new_workgroup_bulk_delete_request) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(new_workgroup_bulk_delete_request) + print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) - path: /workgroups/{id} method: GET xCodeSample: @@ -3646,16 +3446,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_workgroup(id) - print("The response of GovernanceGroupsApi->get_workgroup:\n") - pprint(api_response) + # Get Governance Group by Id + + results = GovernanceGroupsApi(api_client).get_workgroup(id=id) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).get_workgroup(id) + print("The response of GovernanceGroupsApi->get_workgroup:\n") + pprint(results) except Exception as e: - print("Exception when calling GovernanceGroupsApi->get_workgroup: %s\n" % e) + print("Exception when calling GovernanceGroupsApi->get_workgroup: %s\n" % e) - path: /workgroups/{workgroupId}/connections method: GET xCodeSample: @@ -3668,16 +3467,15 @@ 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) sorters = 'name,-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-results) Sorting is supported for the following fields: **name, created, 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-results) Sorting is supported for the following fields: **name, created, modified** (optional) try: - # List connections for Governance Group - - api_response = api_instance.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) - print("The response of GovernanceGroupsApi->list_connections:\n") - pprint(api_response) + # List connections for Governance Group + + results = GovernanceGroupsApi(api_client).list_connections(workgroup_id=workgroup_id) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).list_connections(workgroup_id, offset, limit, count, sorters) + print("The response of GovernanceGroupsApi->list_connections:\n") + pprint(results) except Exception as e: - print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) + print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) - path: /workgroups/{workgroupId}/members method: GET xCodeSample: @@ -3690,16 +3488,15 @@ 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) sorters = 'name,-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-results) Sorting is supported for the following fields: **name, created, 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-results) Sorting is supported for the following fields: **name, created, modified** (optional) try: - # List Governance Group Members - - api_response = api_instance.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) - print("The response of GovernanceGroupsApi->list_workgroup_members:\n") - pprint(api_response) + # List Governance Group Members + + results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id=workgroup_id) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, offset, limit, count, sorters) + print("The response of GovernanceGroupsApi->list_workgroup_members:\n") + pprint(results) except Exception as e: - print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) + print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) - path: /workgroups method: GET xCodeSample: @@ -3712,16 +3509,15 @@ filters = '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: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *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: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) sorters = 'name,-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-results) Sorting is supported for the following fields: **name, created, modified, id, description** (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, created, modified, id, description** (optional) try: - # List Governance Groups - - api_response = api_instance.list_workgroups() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_workgroups(offset, limit, count, filters, sorters) - print("The response of GovernanceGroupsApi->list_workgroups:\n") - pprint(api_response) + # List Governance Groups + + results = GovernanceGroupsApi(api_client).list_workgroups() + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).list_workgroups(offset, limit, count, filters, sorters) + print("The response of GovernanceGroupsApi->list_workgroups:\n") + pprint(results) except Exception as e: - print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) + print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) - path: /workgroups/{id} method: PATCH xCodeSample: @@ -3729,24 +3525,17 @@ label: SDK_tools/sdk/python/beta/methods/governance-groups#patch-workgroup source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | (optional) - - try: - # Patch a Governance Group - - api_response = api_instance.patch_workgroup(id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_workgroup(id, Result) - print("The response of GovernanceGroupsApi->patch_workgroup:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->patch_workgroup: %s\n" % e) + json_patch_operation = '''[{op=replace, path=/description, value=Governance Group new description.}]''' # List[JsonPatchOperation] | (optional) + try: + # Patch a Governance Group + + results = GovernanceGroupsApi(api_client).patch_workgroup(id=id) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).patch_workgroup(id, new_json_patch_operation) + print("The response of GovernanceGroupsApi->patch_workgroup:\n") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->patch_workgroup: %s\n" % e) - path: /workgroups/{workgroupId}/members/bulk-add method: POST xCodeSample: @@ -3754,118 +3543,103 @@ label: SDK_tools/sdk/python/beta/methods/governance-groups#update-workgroup-members source: | 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. - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_workgroup_members(workgroup_id, Result) - print("The response of GovernanceGroupsApi->update_workgroup_members:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) + bulk_workgroup_members_request_inner = '''[sailpoint.beta.BulkWorkgroupMembersRequestInner()]''' # List[BulkWorkgroupMembersRequestInner] | List of identities to be added to a Governance Group members list. + try: + # Add members to Governance Group + new_bulk_workgroup_members_request_inner = BulkWorkgroupMembersRequestInner.from_json(bulk_workgroup_members_request_inner) + results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id=workgroup_id, bulk_workgroup_members_request_inner=new_bulk_workgroup_members_request_inner) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) - path: /ai-access-request-recommendations/ignored-items method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item source: | - access_request_recommendation_action_item_dto = { + access_request_recommendation_action_item_dto = '''{ "access" : { "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" }, "identityId" : "2c91808570313110017040b06f344ec9" - } # AccessRequestRecommendationActionItemDto | The recommended access item to ignore for an identity. - try: - # Ignore Access Request Recommendation - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.add_access_request_recommendations_ignored_item(Result) - print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item: %s\n" % e) + }''' # AccessRequestRecommendationActionItemDto | The recommended access item to ignore for an identity. + try: + # Ignore Access Request Recommendation + new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto) + results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_ignored_item(access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item: %s\n" % e) - path: /ai-access-request-recommendations/requested-items method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item source: | - access_request_recommendation_action_item_dto = { + access_request_recommendation_action_item_dto = '''{ "access" : { "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" }, "identityId" : "2c91808570313110017040b06f344ec9" - } # AccessRequestRecommendationActionItemDto | The recommended access item that was requested for an identity. - try: - # Accept Access Request Recommendation - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.add_access_request_recommendations_requested_item(Result) - print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item: %s\n" % e) + }''' # AccessRequestRecommendationActionItemDto | The recommended access item that was requested for an identity. + try: + # Accept Access Request Recommendation + new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto) + results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_requested_item(access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item: %s\n" % e) - path: /ai-access-request-recommendations/viewed-items method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item source: | - access_request_recommendation_action_item_dto = { + access_request_recommendation_action_item_dto = '''{ "access" : { "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" }, "identityId" : "2c91808570313110017040b06f344ec9" - } # AccessRequestRecommendationActionItemDto | The recommended access that was viewed for an identity. - try: - # Mark 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.add_access_request_recommendations_viewed_item(Result) - print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item: %s\n" % e) + }''' # AccessRequestRecommendationActionItemDto | The recommended access that was viewed for an identity. + try: + # Mark Viewed Access Request Recommendations + new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto) + results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_item(access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item: %s\n" % e) - path: /ai-access-request-recommendations/viewed-items/bulk-create method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items source: | - [sailpoint.beta.AccessRequestRecommendationActionItemDto()] # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. - access_request_recommendation_action_item_dto = { - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - } # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. - - try: - # Bulk Mark 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_items(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.add_access_request_recommendations_viewed_items(Result) - print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) + access_request_recommendation_action_item_dto = '''[sailpoint.beta.AccessRequestRecommendationActionItemDto()]''' # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. + try: + # Bulk Mark Viewed Access Request Recommendations + new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto) + results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) - path: /ai-access-request-recommendations method: GET xCodeSample: @@ -3880,16 +3654,15 @@ filters = 'access.name co \"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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) sorters = 'access.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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) try: - # Identity Access Request Recommendations - - api_response = api_instance.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) - print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n") - pprint(api_response) + # Identity Access Request Recommendations + + results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) - path: /ai-access-request-recommendations/ignored-items method: GET xCodeSample: @@ -3902,16 +3675,15 @@ filters = 'identityId eq \"2c9180846b0a0583016b299f210c1314\"' # 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) sorters = 'access.id' # 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) try: - # List Ignored Access Request Recommendations - - api_response = api_instance.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) - print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n") - pprint(api_response) + # List Ignored Access Request Recommendations + + results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) - path: /ai-access-request-recommendations/requested-items method: GET xCodeSample: @@ -3924,16 +3696,15 @@ filters = 'access.id eq \"2c9180846b0a0583016b299f210c1314\"' # 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) sorters = 'access.id' # 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) try: - # List Accepted Access Request Recommendations - - api_response = api_instance.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) - print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n") - pprint(api_response) + # List Accepted Access Request Recommendations + + results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) - path: /ai-access-request-recommendations/viewed-items method: GET xCodeSample: @@ -3946,23 +3717,22 @@ filters = 'access.id eq \"2c9180846b0a0583016b299f210c1314\"' # 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) sorters = 'access.id' # 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) try: - # List Viewed Access Request Recommendations - - api_response = api_instance.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) - print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n") - pprint(api_response) + # List Viewed Access Request Recommendations + + results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) - path: /common-access method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-common-access#create-common-access source: | - common_access_item_request = { + common_access_item_request = '''{ "access" : { "ownerName" : "ownerName", "name" : "name", @@ -3972,18 +3742,17 @@ "ownerId" : "ownerId" }, "status" : "CONFIRMED" - } # CommonAccessItemRequest | - try: - # Create common access items - Result = common_access_item_request.from_json(common_access_item_request) - api_response = api_instance.create_common_access(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_common_access(Result) - print("The response of IAICommonAccessApi->create_common_access:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAICommonAccessApi->create_common_access: %s\n" % e) + }''' # CommonAccessItemRequest | + try: + # Create common access items + new_common_access_item_request = CommonAccessItemRequest.from_json(common_access_item_request) + results = IAICommonAccessApi(api_client).create_common_access(common_access_item_request=new_common_access_item_request) + # Below is a request that includes all optional parameters + # results = IAICommonAccessApi(api_client).create_common_access(new_common_access_item_request) + print("The response of IAICommonAccessApi->create_common_access:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAICommonAccessApi->create_common_access: %s\n" % e) - path: /common-access method: GET xCodeSample: @@ -3996,39 +3765,32 @@ filters = 'access.type eq \"ROLE\"' # 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, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, 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, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) sorters = 'access.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: **access.name, status** By default the common access items are sorted by name, ascending. (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: **access.name, status** By default the common access items are sorted by name, ascending. (optional) try: - # Get a paginated list of common access - - api_response = api_instance.get_common_access() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_common_access(offset, limit, count, filters, sorters) - print("The response of IAICommonAccessApi->get_common_access:\n") - pprint(api_response) + # Get a paginated list of common access + + results = IAICommonAccessApi(api_client).get_common_access() + # Below is a request that includes all optional parameters + # results = IAICommonAccessApi(api_client).get_common_access(offset, limit, count, filters, sorters) + print("The response of IAICommonAccessApi->get_common_access:\n") + pprint(results) except Exception as e: - print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) + print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) - path: /common-access/update-status method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-common-access#update-common-access-status-in-bulk source: | - [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" ], - "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] - } # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_common_access_status_in_bulk(Result) - print("The response of IAICommonAccessApi->update_common_access_status_in_bulk:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAICommonAccessApi->update_common_access_status_in_bulk: %s\n" % e) + common_access_id_status = '''[sailpoint.beta.CommonAccessIDStatus()]''' # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access + try: + # Bulk update common access status + new_common_access_id_status = CommonAccessIdStatus.from_json(common_access_id_status) + results = IAICommonAccessApi(api_client).update_common_access_status_in_bulk(common_access_id_status=new_common_access_id_status) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling IAICommonAccessApi->update_common_access_status_in_bulk: %s\n" % e) - path: /translation-catalogs/{catalog-id} method: GET xCodeSample: @@ -4037,16 +3799,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_message_catalogs(catalog_id) - print("The response of IAIMessageCatalogsApi->get_message_catalogs:\n") - pprint(api_response) + # Get Message catalogs + + results = IAIMessageCatalogsApi(api_client).get_message_catalogs(catalog_id=catalog_id) + # Below is a request that includes all optional parameters + # results = IAIMessageCatalogsApi(api_client).get_message_catalogs(catalog_id) + print("The response of IAIMessageCatalogsApi->get_message_catalogs:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIMessageCatalogsApi->get_message_catalogs: %s\n" % e) + print("Exception when calling IAIMessageCatalogsApi->get_message_catalogs: %s\n" % e) - path: /outliers/export method: GET xCodeSample: @@ -4055,16 +3816,15 @@ source: | 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.export_outliers_zip(type) - print("The response of IAIOutliersApi->export_outliers_zip:\n") - pprint(api_response) + # IAI Identity Outliers Export + + results = IAIOutliersApi(api_client).export_outliers_zip() + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).export_outliers_zip(type) + print("The response of IAIOutliersApi->export_outliers_zip:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIOutliersApi->export_outliers_zip: %s\n" % e) + print("Exception when calling IAIOutliersApi->export_outliers_zip: %s\n" % e) - path: /outlier-summaries method: GET xCodeSample: @@ -4077,16 +3837,15 @@ filters = 'snapshotDate ge \"2022-02-07T20:13:29.356648026Z\"' # 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: **snapshotDate**: *ge, le* (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: **snapshotDate**: *ge, le* (optional) sorters = 'snapshotDate' # 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: **snapshotDate** (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: **snapshotDate** (optional) try: - # IAI Identity Outliers Summary - - api_response = api_instance.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) - print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") - pprint(api_response) + # IAI Identity Outliers Summary + + results = IAIOutliersApi(api_client).get_identity_outlier_snapshots() + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(limit, offset, type, filters, sorters) + print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) + print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) - path: /outliers method: GET xCodeSample: @@ -4100,16 +3859,15 @@ filters = 'attributes.displayName sw \"John\" and certStatus 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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) sorters = 'attributes.displayName,firstDetectionDate,-score' # 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: **firstDetectionDate, attributes, score** (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: **firstDetectionDate, attributes, score** (optional) try: - # IAI Get Identity Outliers - - api_response = api_instance.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) - print("The response of IAIOutliersApi->get_identity_outliers:\n") - pprint(api_response) + # IAI Get Identity Outliers + + results = IAIOutliersApi(api_client).get_identity_outliers() + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).get_identity_outliers(limit, offset, count, type, filters, sorters) + print("The response of IAIOutliersApi->get_identity_outliers:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) + print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) - path: /outlier-summaries/latest method: GET xCodeSample: @@ -4118,16 +3876,15 @@ source: | 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_latest_identity_outlier_snapshots(type) - print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") - pprint(api_response) + # IAI Identity Outliers Latest Summary + + results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots() + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(type) + print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) + print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) - path: /outlier-feature-summaries/{outlierFeatureId} method: GET xCodeSample: @@ -4136,16 +3893,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_outlier_contributing_feature_summary(outlier_feature_id) - print("The response of IAIOutliersApi->get_outlier_contributing_feature_summary:\n") - pprint(api_response) + # Get identity outlier contibuting feature summary + + results = IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id=outlier_feature_id) + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id) + print("The response of IAIOutliersApi->get_outlier_contributing_feature_summary:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIOutliersApi->get_outlier_contributing_feature_summary: %s\n" % e) + print("Exception when calling IAIOutliersApi->get_outlier_contributing_feature_summary: %s\n" % e) - path: /outliers/{outlierId}/contributing-features method: GET xCodeSample: @@ -4159,34 +3915,30 @@ include_translation_messages = 'include-translation-messages=' # str | Whether or not to include translation messages object in returned response (optional) # str | Whether or not to include translation messages object in returned response (optional) sorters = 'importance' # 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: **importance** (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: **importance** (optional) try: - # Get identity outlier's contibuting features - - api_response = api_instance.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) - print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") - pprint(api_response) + # Get identity outlier's contibuting features + + results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id=outlier_id) + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, limit, offset, count, include_translation_messages, sorters) + print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) + print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) - path: /outliers/ignore method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-outliers#ignore-identity-outliers source: | - request_body = ['request_body_example'] # List[str] | - request_body = ['request_body_example'] # List[str] | - + request_body = '''['request_body_example']''' # List[str] | try: - # IAI Identity Outliers Ignore - Result = request_body.from_json(request_body) - api_instance.ignore_identity_outliers(Result) - - # Below is a request that includes all optional parameters - # api_instance.ignore_identity_outliers(Result) + # IAI Identity Outliers Ignore + new_request_body = RequestBody.from_json(request_body) + IAIOutliersApi(api_client).ignore_identity_outliers(request_body=new_request_body) + # Below is a request that includes all optional parameters + # IAIOutliersApi(api_client).ignore_identity_outliers(new_request_body) except Exception as e: - print("Exception when calling IAIOutliersApi->ignore_identity_outliers: %s\n" % e) + print("Exception when calling IAIOutliersApi->ignore_identity_outliers: %s\n" % e) - path: /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items method: GET xCodeSample: @@ -4201,34 +3953,30 @@ access_type = 'ENTITLEMENT' # str | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) # str | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) 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** (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** (optional) 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, ) - - # 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) - print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") - pprint(api_response) + # Gets a list of access items associated with each identity outlier contributing feature + + results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id=outlier_id, contributing_feature_name=contributing_feature_name) + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, limit, offset, count, access_type, sorters) + print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) + print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) - path: /outliers/unignore method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-outliers#un-ignore-identity-outliers source: | - request_body = ['request_body_example'] # List[str] | - request_body = ['request_body_example'] # List[str] | - + request_body = '''['request_body_example']''' # List[str] | try: - # IAI Identity Outliers Unignore - Result = request_body.from_json(request_body) - api_instance.un_ignore_identity_outliers(Result) - - # Below is a request that includes all optional parameters - # api_instance.un_ignore_identity_outliers(Result) + # IAI Identity Outliers Unignore + new_request_body = RequestBody.from_json(request_body) + IAIOutliersApi(api_client).un_ignore_identity_outliers(request_body=new_request_body) + # Below is a request that includes all optional parameters + # IAIOutliersApi(api_client).un_ignore_identity_outliers(new_request_body) except Exception as e: - print("Exception when calling IAIOutliersApi->un_ignore_identity_outliers: %s\n" % e) + print("Exception when calling IAIOutliersApi->un_ignore_identity_outliers: %s\n" % e) - path: /peer-group-strategies/{strategy}/identity-outliers method: GET xCodeSample: @@ -4240,23 +3988,22 @@ 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) try: - # Identity Outliers List - - api_response = api_instance.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) - print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") - pprint(api_response) + # Identity Outliers List + + results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy=strategy) + # Below is a request that includes all optional parameters + # results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, limit, offset, count) + print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) + print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) - path: /recommendations/request method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-recommendations#get-recommendations source: | - recommendation_request_dto = { + recommendation_request_dto = '''{ "prescribeMode" : false, "excludeInterpretations" : false, "requests" : [ { @@ -4274,18 +4021,17 @@ } ], "includeTranslationMessages" : false, "includeDebugInformation" : true - } # RecommendationRequestDto | - try: - # Returns Recommendation Based on Object - Result = recommendation_request_dto.from_json(recommendation_request_dto) - api_response = api_instance.get_recommendations(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_recommendations(Result) - print("The response of IAIRecommendationsApi->get_recommendations:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIRecommendationsApi->get_recommendations: %s\n" % e) + }''' # RecommendationRequestDto | + try: + # Returns Recommendation Based on Object + new_recommendation_request_dto = RecommendationRequestDto.from_json(recommendation_request_dto) + results = IAIRecommendationsApi(api_client).get_recommendations(recommendation_request_dto=new_recommendation_request_dto) + # Below is a request that includes all optional parameters + # results = IAIRecommendationsApi(api_client).get_recommendations(new_recommendation_request_dto) + print("The response of IAIRecommendationsApi->get_recommendations:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->get_recommendations: %s\n" % e) - path: /recommendations/config method: GET xCodeSample: @@ -4293,39 +4039,37 @@ label: SDK_tools/sdk/python/beta/methods/iai-recommendations#get-recommendations-config source: | try: - # Get certification recommendation config values - - api_response = api_instance.get_recommendations_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_recommendations_config() - print("The response of IAIRecommendationsApi->get_recommendations_config:\n") - pprint(api_response) + # Get certification recommendation config values + + results = IAIRecommendationsApi(api_client).get_recommendations_config() + # Below is a request that includes all optional parameters + # results = IAIRecommendationsApi(api_client).get_recommendations_config() + print("The response of IAIRecommendationsApi->get_recommendations_config:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIRecommendationsApi->get_recommendations_config: %s\n" % e) + print("Exception when calling IAIRecommendationsApi->get_recommendations_config: %s\n" % e) - path: /recommendations/config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-recommendations#update-recommendations-config source: | - recommendation_config_dto = { + recommendation_config_dto = '''{ "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], "peerGroupPercentageThreshold" : 0.5, "runAutoSelectOnce" : false, "onlyTuneThreshold" : false - } # RecommendationConfigDto | - try: - # Update certification recommendation config values - Result = recommendation_config_dto.from_json(recommendation_config_dto) - api_response = api_instance.update_recommendations_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_recommendations_config(Result) - print("The response of IAIRecommendationsApi->update_recommendations_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIRecommendationsApi->update_recommendations_config: %s\n" % e) + }''' # RecommendationConfigDto | + try: + # Update certification recommendation config values + new_recommendation_config_dto = RecommendationConfigDto.from_json(recommendation_config_dto) + results = IAIRecommendationsApi(api_client).update_recommendations_config(recommendation_config_dto=new_recommendation_config_dto) + # Below is a request that includes all optional parameters + # results = IAIRecommendationsApi(api_client).update_recommendations_config(new_recommendation_config_dto) + print("The response of IAIRecommendationsApi->update_recommendations_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->update_recommendations_config: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision method: POST xCodeSample: @@ -4336,31 +4080,30 @@ 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) include_common_access = True # bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to True) # bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to True) - role_mining_potential_role_provision_request = { + role_mining_potential_role_provision_request = '''{ "includeIdentities" : true, "roleName" : "Finance - Accounting", "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", "roleDescription" : "General access for accounting department", "directlyAssignedEntitlements" : false - } # RoleMiningPotentialRoleProvisionRequest | Required information to create a new role (optional) - 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, ) - - # 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) - print("The response of IAIRoleMiningApi->create_potential_role_provision_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->create_potential_role_provision_request: %s\n" % e) + }''' # RoleMiningPotentialRoleProvisionRequest | Required information to create a new role (optional) + try: + # Create request to provision a potential role into an actual role. + + results = IAIRoleMiningApi(api_client).create_potential_role_provision_request(session_id=session_id, potential_role_id=potential_role_id) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).create_potential_role_provision_request(session_id, potential_role_id, min_entitlement_popularity, include_common_access, new_role_mining_potential_role_provision_request) + print("The response of IAIRoleMiningApi->create_potential_role_provision_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->create_potential_role_provision_request: %s\n" % e) - path: /role-mining-sessions method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#create-role-mining-sessions source: | - role_mining_session_dto = { + role_mining_session_dto = '''{ "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", "prescribedPruneThreshold" : 10, "pruneThreshold" : 50, @@ -4391,18 +4134,17 @@ "minNumIdentitiesInPotentialRole" : 20, "identityCount" : 0, "type" : "SPECIALIZED" - } # RoleMiningSessionDto | Role mining session parameters - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_role_mining_sessions(Result) - print("The response of IAIRoleMiningApi->create_role_mining_sessions:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->create_role_mining_sessions: %s\n" % e) + }''' # RoleMiningSessionDto | Role mining session parameters + try: + # Create a role mining session + new_role_mining_session_dto = RoleMiningSessionDto.from_json(role_mining_session_dto) + results = IAIRoleMiningApi(api_client).create_role_mining_sessions(role_mining_session_dto=new_role_mining_session_dto) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).create_role_mining_sessions(new_role_mining_session_dto) + print("The response of IAIRoleMiningApi->create_role_mining_sessions:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->create_role_mining_sessions: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download method: GET xCodeSample: @@ -4413,16 +4155,15 @@ 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 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) - - # 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) - print("The response of IAIRoleMiningApi->download_role_mining_potential_role_zip:\n") - pprint(api_response) + # Export (download) details for a potential role in a role mining session + + results = IAIRoleMiningApi(api_client).download_role_mining_potential_role_zip(session_id=session_id, potential_role_id=potential_role_id, export_id=export_id) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).download_role_mining_potential_role_zip(session_id, potential_role_id, export_id) + print("The response of IAIRoleMiningApi->download_role_mining_potential_role_zip:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->download_role_mining_potential_role_zip: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->download_role_mining_potential_role_zip: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export method: GET xCodeSample: @@ -4432,16 +4173,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.export_role_mining_potential_role(session_id, potential_role_id) - print("The response of IAIRoleMiningApi->export_role_mining_potential_role:\n") - pprint(api_response) + # Export (download) details for a potential role in a role mining session + + results = IAIRoleMiningApi(api_client).export_role_mining_potential_role(session_id=session_id, potential_role_id=potential_role_id) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).export_role_mining_potential_role(session_id, potential_role_id) + print("The response of IAIRoleMiningApi->export_role_mining_potential_role:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async method: POST xCodeSample: @@ -4450,21 +4190,20 @@ source: | 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 = { + role_mining_potential_role_export_request = '''{ "minEntitlementPopularity" : 0, "includeCommonAccess" : true - } # RoleMiningPotentialRoleExportRequest | (optional) - 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, ) - - # 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) - print("The response of IAIRoleMiningApi->export_role_mining_potential_role_async:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_async: %s\n" % e) + }''' # RoleMiningPotentialRoleExportRequest | (optional) + try: + # Asynchronously export details for a potential role in a role mining session and upload to S3 + + results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_async(session_id=session_id, potential_role_id=potential_role_id) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_async(session_id, potential_role_id, new_role_mining_potential_role_export_request) + print("The response of IAIRoleMiningApi->export_role_mining_potential_role_async:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_async: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} method: GET xCodeSample: @@ -4475,16 +4214,15 @@ 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 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) - - # 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) - print("The response of IAIRoleMiningApi->export_role_mining_potential_role_status:\n") - pprint(api_response) + # Retrieve status of a potential role export job + + results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_status(session_id=session_id, potential_role_id=potential_role_id, export_id=export_id) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_status(session_id, potential_role_id, export_id) + print("The response of IAIRoleMiningApi->export_role_mining_potential_role_status:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_status: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_status: %s\n" % e) - path: /role-mining-potential-roles method: GET xCodeSample: @@ -4497,16 +4235,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) try: - # Retrieves all potential role summaries - - api_response = api_instance.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) - print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") - pprint(api_response) + # Retrieves all potential role summaries + + results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries() + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution method: GET xCodeSample: @@ -4517,16 +4254,15 @@ 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) 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, ) - - # 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) - print("The response of IAIRoleMiningApi->get_entitlement_distribution_potential_role:\n") - pprint(api_response) + # Retrieves entitlement popularity distribution for a potential role in a role mining session + + results = IAIRoleMiningApi(api_client).get_entitlement_distribution_potential_role(session_id=session_id, potential_role_id=potential_role_id) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_entitlement_distribution_potential_role(session_id, potential_role_id, include_common_access) + print("The response of IAIRoleMiningApi->get_entitlement_distribution_potential_role:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_entitlement_distribution_potential_role: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_entitlement_distribution_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities method: GET xCodeSample: @@ -4542,16 +4278,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) 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, ) - - # 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) - print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") - pprint(api_response) + # Retrieves entitlements for a potential role in a role mining session + + results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id=session_id, potential_role_id=potential_role_id) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, include_common_access, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements method: GET xCodeSample: @@ -4566,16 +4301,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) 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, ) - - # 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) - print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") - pprint(api_response) + # Retrieves excluded entitlements for a potential role in a role mining session + + results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id=session_id, potential_role_id=potential_role_id) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities method: GET xCodeSample: @@ -4590,16 +4324,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) 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, ) - - # 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) - print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") - pprint(api_response) + # Retrieves identities for a potential role in a role mining session + + results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id=session_id, potential_role_id=potential_role_id) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} method: GET xCodeSample: @@ -4609,16 +4342,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_potential_role(session_id, potential_role_id) - print("The response of IAIRoleMiningApi->get_potential_role:\n") - pprint(api_response) + # Retrieve potential role in session + + results = IAIRoleMiningApi(api_client).get_potential_role(session_id=session_id, potential_role_id=potential_role_id) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_potential_role(session_id, potential_role_id) + print("The response of IAIRoleMiningApi->get_potential_role:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_potential_role: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications method: GET xCodeSample: @@ -4632,16 +4364,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) 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, ) - - # 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) - print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") - pprint(api_response) + # Retrieves the applications of a potential role for a role mining session + + results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id=session_id, potential_role_id=potential_role_id) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements method: GET xCodeSample: @@ -4655,16 +4386,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) 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, ) - - # 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) - print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") - pprint(api_response) + # Retrieves the entitlements of a potential role for a role mining session + + results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id=session_id, potential_role_id=potential_role_id) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) - path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage method: GET xCodeSample: @@ -4678,16 +4408,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) try: - # Retrieves potential role source usage - - api_response = api_instance.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) - print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") - pprint(api_response) + # Retrieves potential role source usage + + results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id=potential_role_id, source_id=source_id) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries method: GET xCodeSample: @@ -4701,16 +4430,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) try: - # Retrieve session's potential role summaries - - api_response = api_instance.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) - print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") - pprint(api_response) + # Retrieve session's potential role summaries + + results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id=session_id) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) - path: /role-mining-potential-roles/{potentialRoleId} method: GET xCodeSample: @@ -4719,16 +4447,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_mining_potential_role(potential_role_id) - print("The response of IAIRoleMiningApi->get_role_mining_potential_role:\n") - pprint(api_response) + # Retrieves a specific potential role + + results = IAIRoleMiningApi(api_client).get_role_mining_potential_role(potential_role_id=potential_role_id) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_role_mining_potential_role(potential_role_id) + print("The response of IAIRoleMiningApi->get_role_mining_potential_role:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_role_mining_potential_role: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_role_mining_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId} method: GET xCodeSample: @@ -4737,16 +4464,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_mining_session(session_id) - print("The response of IAIRoleMiningApi->get_role_mining_session:\n") - pprint(api_response) + # Get a role mining session + + results = IAIRoleMiningApi(api_client).get_role_mining_session(session_id=session_id) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_role_mining_session(session_id) + print("The response of IAIRoleMiningApi->get_role_mining_session:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_role_mining_session: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_role_mining_session: %s\n" % e) - path: /role-mining-sessions/{sessionId}/status method: GET xCodeSample: @@ -4755,16 +4481,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_mining_session_status(session_id) - print("The response of IAIRoleMiningApi->get_role_mining_session_status:\n") - pprint(api_response) + # Get role mining session status state + + results = IAIRoleMiningApi(api_client).get_role_mining_session_status(session_id=session_id) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_role_mining_session_status(session_id) + print("The response of IAIRoleMiningApi->get_role_mining_session_status:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_role_mining_session_status: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_role_mining_session_status: %s\n" % e) - path: /role-mining-sessions method: GET xCodeSample: @@ -4777,16 +4502,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) try: - # Retrieves all role mining sessions - - api_response = api_instance.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) - print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") - pprint(api_response) + # Retrieves all role mining sessions + + results = IAIRoleMiningApi(api_client).get_role_mining_sessions() + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_role_mining_sessions(filters, sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) - path: /role-mining-potential-roles/saved method: GET xCodeSample: @@ -4798,16 +4522,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) try: - # Retrieves all saved potential roles - - api_response = api_instance.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) - print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") - pprint(api_response) + # Retrieves all saved potential roles + + results = IAIRoleMiningApi(api_client).get_saved_potential_roles() + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_saved_potential_roles(sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} method: PATCH xCodeSample: @@ -4816,20 +4539,17 @@ source: | 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] | - 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] | - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_potential_role(session_id, potential_role_id, Result) - print("The response of IAIRoleMiningApi->patch_potential_role:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->patch_potential_role: %s\n" % e) + 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] | + try: + # Update a potential role in session + new_patch_potential_role_request_inner = PatchPotentialRoleRequestInner.from_json(patch_potential_role_request_inner) + results = IAIRoleMiningApi(api_client).patch_potential_role(session_id=session_id, potential_role_id=potential_role_id, patch_potential_role_request_inner=new_patch_potential_role_request_inner) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).patch_potential_role(session_id, potential_role_id, new_patch_potential_role_request_inner) + print("The response of IAIRoleMiningApi->patch_potential_role:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_potential_role: %s\n" % e) - path: /role-mining-potential-roles/{potentialRoleId} method: PATCH xCodeSample: @@ -4837,20 +4557,17 @@ label: SDK_tools/sdk/python/beta/methods/iai-role-mining#patch-role-mining-potential-role source: | 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] | - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_role_mining_potential_role(potential_role_id, Result) - print("The response of IAIRoleMiningApi->patch_role_mining_potential_role:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->patch_role_mining_potential_role: %s\n" % e) + 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] | + try: + # Update a potential role + new_patch_potential_role_request_inner = PatchPotentialRoleRequestInner.from_json(patch_potential_role_request_inner) + results = IAIRoleMiningApi(api_client).patch_role_mining_potential_role(potential_role_id=potential_role_id, patch_potential_role_request_inner=new_patch_potential_role_request_inner) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).patch_role_mining_potential_role(potential_role_id, new_patch_potential_role_request_inner) + print("The response of IAIRoleMiningApi->patch_role_mining_potential_role:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_role_mining_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId} method: PATCH xCodeSample: @@ -4858,24 +4575,17 @@ label: SDK_tools/sdk/python/beta/methods/iai-role-mining#patch-role-mining-session source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_role_mining_session(session_id, Result) - print("The response of IAIRoleMiningApi->patch_role_mining_session:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->patch_role_mining_session: %s\n" % e) + json_patch_operation = '''[{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. + try: + # Patch a role mining session + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = IAIRoleMiningApi(api_client).patch_role_mining_session(session_id=session_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).patch_role_mining_session(session_id, new_json_patch_operation) + print("The response of IAIRoleMiningApi->patch_role_mining_session:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_role_mining_session: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements method: POST xCodeSample: @@ -4884,21 +4594,20 @@ source: | 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 = { + role_mining_potential_role_edit_entitlements = '''{ "ids" : [ "entId1", "entId2" ], "exclude" : true - } # RoleMiningPotentialRoleEditEntitlements | Role mining session parameters - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_entitlements_potential_role(session_id, potential_role_id, Result) - print("The response of IAIRoleMiningApi->update_entitlements_potential_role:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->update_entitlements_potential_role: %s\n" % e) + }''' # RoleMiningPotentialRoleEditEntitlements | Role mining session parameters + try: + # Edit entitlements for a potential role to exclude some entitlements + new_role_mining_potential_role_edit_entitlements = RoleMiningPotentialRoleEditEntitlements.from_json(role_mining_potential_role_edit_entitlements) + results = IAIRoleMiningApi(api_client).update_entitlements_potential_role(session_id=session_id, potential_role_id=potential_role_id, role_mining_potential_role_edit_entitlements=new_role_mining_potential_role_edit_entitlements) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).update_entitlements_potential_role(session_id, potential_role_id, new_role_mining_potential_role_edit_entitlements) + print("The response of IAIRoleMiningApi->update_entitlements_potential_role:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->update_entitlements_potential_role: %s\n" % e) - path: /icons/{objectType}/{objectId} method: DELETE xCodeSample: @@ -4908,14 +4617,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_icon(object_type, object_id) + # Delete an icon + + IconsApi(api_client).delete_icon(object_type=object_type, object_id=object_id) + # Below is a request that includes all optional parameters + # IconsApi(api_client).delete_icon(object_type, object_id) except Exception as e: - print("Exception when calling IconsApi->delete_icon: %s\n" % e) + print("Exception when calling IconsApi->delete_icon: %s\n" % e) - path: /icons/{objectType}/{objectId} method: PUT xCodeSample: @@ -4926,16 +4634,15 @@ 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'] try: - # Update an icon - - api_response = api_instance.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) - print("The response of IconsApi->set_icon:\n") - pprint(api_response) + # Update an icon + + results = IconsApi(api_client).set_icon(object_type=object_type, object_id=object_id, image=image) + # Below is a request that includes all optional parameters + # results = IconsApi(api_client).set_icon(object_type, object_id, image) + print("The response of IconsApi->set_icon:\n") + pprint(results) except Exception as e: - print("Exception when calling IconsApi->set_icon: %s\n" % e) + print("Exception when calling IconsApi->set_icon: %s\n" % e) - path: /identities/{id} method: DELETE xCodeSample: @@ -4944,14 +4651,13 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id try: - # Delete identity - - api_instance.delete_identity(id) - - # Below is a request that includes all optional parameters - # api_instance.delete_identity(id) + # Delete identity + + IdentitiesApi(api_client).delete_identity(id=id) + # Below is a request that includes all optional parameters + # IdentitiesApi(api_client).delete_identity(id) except Exception as e: - print("Exception when calling IdentitiesApi->delete_identity: %s\n" % e) + print("Exception when calling IdentitiesApi->delete_identity: %s\n" % e) - path: /identities/{id} method: GET xCodeSample: @@ -4960,16 +4666,15 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id try: - # Identity Details - - api_response = api_instance.get_identity(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity(id) - print("The response of IdentitiesApi->get_identity:\n") - pprint(api_response) + # Identity Details + + results = IdentitiesApi(api_client).get_identity(id=id) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).get_identity(id) + print("The response of IdentitiesApi->get_identity:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentitiesApi->get_identity: %s\n" % e) + print("Exception when calling IdentitiesApi->get_identity: %s\n" % e) - path: /identities/{identityId}/ownership method: GET xCodeSample: @@ -4978,16 +4683,15 @@ source: | identity_id = 'ff8081814d2a8036014d701f3fbf53fa' # str | Identity ID. # str | Identity ID. try: - # Get ownership details - - api_response = api_instance.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) - print("The response of IdentitiesApi->get_identity_ownership_details:\n") - pprint(api_response) + # Get ownership details + + results = IdentitiesApi(api_client).get_identity_ownership_details(identity_id=identity_id) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).get_identity_ownership_details(identity_id) + print("The response of IdentitiesApi->get_identity_ownership_details:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentitiesApi->get_identity_ownership_details: %s\n" % e) + print("Exception when calling IdentitiesApi->get_identity_ownership_details: %s\n" % e) - path: /identities/{identityId}/role-assignments/{assignmentId} method: GET xCodeSample: @@ -4997,16 +4701,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_assignment(identity_id, assignment_id) - print("The response of IdentitiesApi->get_role_assignment:\n") - pprint(api_response) + # Role assignment details + + results = IdentitiesApi(api_client).get_role_assignment(identity_id=identity_id, assignment_id=assignment_id) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).get_role_assignment(identity_id, assignment_id) + print("The response of IdentitiesApi->get_role_assignment:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentitiesApi->get_role_assignment: %s\n" % e) + print("Exception when calling IdentitiesApi->get_role_assignment: %s\n" % e) - path: /identities/{identityId}/role-assignments method: GET xCodeSample: @@ -5017,16 +4720,15 @@ 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) try: - # List role assignments - - api_response = api_instance.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) - print("The response of IdentitiesApi->get_role_assignments:\n") - pprint(api_response) + # List role assignments + + results = IdentitiesApi(api_client).get_role_assignments(identity_id=identity_id) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).get_role_assignments(identity_id, role_id, role_name) + print("The response of IdentitiesApi->get_role_assignments:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) + print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) - path: /identities method: GET xCodeSample: @@ -5040,16 +4742,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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 Identities - - api_response = api_instance.list_identities() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_identities(filters, sorters, default_filter, count, limit, offset) - print("The response of IdentitiesApi->list_identities:\n") - pprint(api_response) + # List Identities + + results = IdentitiesApi(api_client).list_identities() + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).list_identities(filters, sorters, default_filter, count, limit, offset) + print("The response of IdentitiesApi->list_identities:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) + print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) - path: /identities/{identityId}/reset method: POST xCodeSample: @@ -5058,14 +4759,13 @@ source: | identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id try: - # Reset an identity - - api_instance.reset_identity(identity_id) - - # Below is a request that includes all optional parameters - # api_instance.reset_identity(identity_id) + # Reset an identity + + IdentitiesApi(api_client).reset_identity(identity_id=identity_id) + # Below is a request that includes all optional parameters + # IdentitiesApi(api_client).reset_identity(identity_id) except Exception as e: - print("Exception when calling IdentitiesApi->reset_identity: %s\n" % e) + print("Exception when calling IdentitiesApi->reset_identity: %s\n" % e) - path: /identities/{id}/verification/account/send method: POST xCodeSample: @@ -5073,60 +4773,57 @@ label: SDK_tools/sdk/python/beta/methods/identities#send-identity-verification-account-token source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID - send_account_verification_request = { + send_account_verification_request = '''{ "sourceName" : "Active Directory Source", "via" : "EMAIL_WORK" - } # SendAccountVerificationRequest | + }''' # SendAccountVerificationRequest | 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) - - # Below is a request that includes all optional parameters - # api_instance.send_identity_verification_account_token(id, Result) + # Send password reset email + new_send_account_verification_request = SendAccountVerificationRequest.from_json(send_account_verification_request) + IdentitiesApi(api_client).send_identity_verification_account_token(id=id, send_account_verification_request=new_send_account_verification_request) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling IdentitiesApi->send_identity_verification_account_token: %s\n" % e) - path: /identities/invite method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#start-identities-invite source: | - invite_identities_request = { + invite_identities_request = '''{ "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], "uninvited" : false - } # InviteIdentitiesRequest | - try: - # Invite identities to register - Result = invite_identities_request.from_json(invite_identities_request) - api_response = api_instance.start_identities_invite(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_identities_invite(Result) - print("The response of IdentitiesApi->start_identities_invite:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IdentitiesApi->start_identities_invite: %s\n" % e) + }''' # InviteIdentitiesRequest | + try: + # Invite identities to register + new_invite_identities_request = InviteIdentitiesRequest.from_json(invite_identities_request) + results = IdentitiesApi(api_client).start_identities_invite(invite_identities_request=new_invite_identities_request) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).start_identities_invite(new_invite_identities_request) + print("The response of IdentitiesApi->start_identities_invite:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentitiesApi->start_identities_invite: %s\n" % e) - path: /identities/process method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#start-identity-processing source: | - process_identities_request = { + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_identity_processing(Result) - print("The response of IdentitiesApi->start_identity_processing:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IdentitiesApi->start_identity_processing: %s\n" % e) + }''' # ProcessIdentitiesRequest | + try: + # Process a list of identityIds + new_process_identities_request = ProcessIdentitiesRequest.from_json(process_identities_request) + results = IdentitiesApi(api_client).start_identity_processing(process_identities_request=new_process_identities_request) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).start_identity_processing(new_process_identities_request) + print("The response of IdentitiesApi->start_identity_processing:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentitiesApi->start_identity_processing: %s\n" % e) - path: /identities/{identityId}/synchronize-attributes method: POST xCodeSample: @@ -5135,23 +4832,22 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.synchronize_attributes_for_identity(identity_id) - print("The response of IdentitiesApi->synchronize_attributes_for_identity:\n") - pprint(api_response) + # Attribute synchronization for single identity. + + results = IdentitiesApi(api_client).synchronize_attributes_for_identity(identity_id=identity_id) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).synchronize_attributes_for_identity(identity_id) + print("The response of IdentitiesApi->synchronize_attributes_for_identity:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentitiesApi->synchronize_attributes_for_identity: %s\n" % e) + print("Exception when calling IdentitiesApi->synchronize_attributes_for_identity: %s\n" % e) - path: /identity-attributes method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-attributes#create-identity-attribute source: | - identity_attribute = { + identity_attribute = '''{ "standard" : false, "system" : false, "sources" : [ { @@ -5172,18 +4868,17 @@ "type" : "string", "searchable" : false, "multi" : false - } # IdentityAttribute | - try: - # Create Identity Attribute - Result = identity_attribute.from_json(identity_attribute) - api_response = api_instance.create_identity_attribute(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_identity_attribute(Result) - print("The response of IdentityAttributesApi->create_identity_attribute:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IdentityAttributesApi->create_identity_attribute: %s\n" % e) + }''' # IdentityAttribute | + try: + # Create Identity Attribute + new_identity_attribute = IdentityAttribute.from_json(identity_attribute) + results = IdentityAttributesApi(api_client).create_identity_attribute(identity_attribute=new_identity_attribute) + # Below is a request that includes all optional parameters + # results = IdentityAttributesApi(api_client).create_identity_attribute(new_identity_attribute) + print("The response of IdentityAttributesApi->create_identity_attribute:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityAttributesApi->create_identity_attribute: %s\n" % e) - path: /identity-attributes/{name} method: DELETE xCodeSample: @@ -5192,32 +4887,30 @@ source: | name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. try: - # Delete Identity Attribute - - api_instance.delete_identity_attribute(name) - - # Below is a request that includes all optional parameters - # api_instance.delete_identity_attribute(name) + # Delete Identity Attribute + + IdentityAttributesApi(api_client).delete_identity_attribute(name=name) + # Below is a request that includes all optional parameters + # IdentityAttributesApi(api_client).delete_identity_attribute(name) except Exception as e: - print("Exception when calling IdentityAttributesApi->delete_identity_attribute: %s\n" % e) + print("Exception when calling IdentityAttributesApi->delete_identity_attribute: %s\n" % e) - path: /identity-attributes/bulk-delete method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-attributes#delete-identity-attributes-in-bulk source: | - identity_attribute_names = { + identity_attribute_names = '''{ "ids" : [ "name", "displayName" ] - } # IdentityAttributeNames | + }''' # IdentityAttributeNames | try: - # Bulk delete Identity Attributes - Result = identity_attribute_names.from_json(identity_attribute_names) - api_instance.delete_identity_attributes_in_bulk(Result) - - # Below is a request that includes all optional parameters - # api_instance.delete_identity_attributes_in_bulk(Result) + # Bulk delete Identity Attributes + new_identity_attribute_names = IdentityAttributeNames.from_json(identity_attribute_names) + IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(identity_attribute_names=new_identity_attribute_names) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling IdentityAttributesApi->delete_identity_attributes_in_bulk: %s\n" % e) - path: /identity-attributes/{name} method: GET xCodeSample: @@ -5226,16 +4919,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_attribute(name) - print("The response of IdentityAttributesApi->get_identity_attribute:\n") - pprint(api_response) + # Get Identity Attribute + + results = IdentityAttributesApi(api_client).get_identity_attribute(name=name) + # Below is a request that includes all optional parameters + # results = IdentityAttributesApi(api_client).get_identity_attribute(name) + print("The response of IdentityAttributesApi->get_identity_attribute:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityAttributesApi->get_identity_attribute: %s\n" % e) + print("Exception when calling IdentityAttributesApi->get_identity_attribute: %s\n" % e) - path: /identity-attributes method: GET xCodeSample: @@ -5247,16 +4939,15 @@ 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) 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) try: - # List Identity Attributes - - api_response = api_instance.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) - print("The response of IdentityAttributesApi->list_identity_attributes:\n") - pprint(api_response) + # List Identity Attributes + + results = IdentityAttributesApi(api_client).list_identity_attributes() + # Below is a request that includes all optional parameters + # results = IdentityAttributesApi(api_client).list_identity_attributes(include_system, include_silent, searchable_only, count) + print("The response of IdentityAttributesApi->list_identity_attributes:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) + print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) - path: /identity-attributes/{name} method: PUT xCodeSample: @@ -5264,7 +4955,7 @@ label: SDK_tools/sdk/python/beta/methods/identity-attributes#put-identity-attribute source: | name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. - identity_attribute = { + identity_attribute = '''{ "standard" : false, "system" : false, "sources" : [ { @@ -5285,18 +4976,17 @@ "type" : "string", "searchable" : false, "multi" : false - } # IdentityAttribute | - try: - # Update Identity Attribute - Result = identity_attribute.from_json(identity_attribute) - api_response = api_instance.put_identity_attribute(name, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_identity_attribute(name, Result) - print("The response of IdentityAttributesApi->put_identity_attribute:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IdentityAttributesApi->put_identity_attribute: %s\n" % e) + }''' # IdentityAttribute | + try: + # Update Identity Attribute + new_identity_attribute = IdentityAttribute.from_json(identity_attribute) + results = IdentityAttributesApi(api_client).put_identity_attribute(name=name, identity_attribute=new_identity_attribute) + # Below is a request that includes all optional parameters + # results = IdentityAttributesApi(api_client).put_identity_attribute(name, new_identity_attribute) + print("The response of IdentityAttributesApi->put_identity_attribute:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityAttributesApi->put_identity_attribute: %s\n" % e) - path: /historical-identities/{id}/compare method: GET xCodeSample: @@ -5306,23 +4996,20 @@ 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) - access_item_types = ['access_item_types_example'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) - - access_item_types = ['access_item_types_example'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) + access_item_types = '''['access_item_types_example']''' # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (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) 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) 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, ) - - # 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) - print("The response of IdentityHistoryApi->compare_identity_snapshots:\n") - pprint(api_response) + # Gets a difference of count for each access item types for the given identity between 2 snapshots + + results = IdentityHistoryApi(api_client).compare_identity_snapshots(id=id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) + print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) - path: /historical-identities/{id}/compare/{accessType} method: GET xCodeSample: @@ -5338,16 +5025,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) 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) 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, ) - - # 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) - print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n") - pprint(api_response) + # Gets a list of differences of specific accessType for the given identity between 2 snapshots + + results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id=id, access_type=access_type) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) + print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) - path: /historical-identities/{id} method: GET xCodeSample: @@ -5356,16 +5042,15 @@ source: | id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id try: - # Get latest snapshot of identity - - api_response = api_instance.get_historical_identity(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_historical_identity(id) - print("The response of IdentityHistoryApi->get_historical_identity:\n") - pprint(api_response) + # Get latest snapshot of identity + + results = IdentityHistoryApi(api_client).get_historical_identity(id=id) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).get_historical_identity(id) + print("The response of IdentityHistoryApi->get_historical_identity:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityHistoryApi->get_historical_identity: %s\n" % e) + print("Exception when calling IdentityHistoryApi->get_historical_identity: %s\n" % e) - path: /historical-identities/{id}/events method: GET xCodeSample: @@ -5374,26 +5059,21 @@ source: | 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) - - event_types = ['[AccessAddedEvent, AccessRemovedEvent]'] # List[str] | An optional list of event types to return. If null or empty, all events are returned (optional) - access_item_types = ['[entitlement, account]'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) - - access_item_types = ['[entitlement, account]'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types 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) + access_item_types = '''['[entitlement, account]']''' # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (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) 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) try: - # Lists all events for the given identity - - api_response = api_instance.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) - print("The response of IdentityHistoryApi->get_historical_identity_events:\n") - pprint(api_response) + # Lists all events for the given identity + + results = IdentityHistoryApi(api_client).get_historical_identity_events(id=id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) + print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) - path: /historical-identities/{id}/snapshots/{date} method: GET xCodeSample: @@ -5403,16 +5083,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_snapshot(id, var_date) - print("The response of IdentityHistoryApi->get_identity_snapshot:\n") - pprint(api_response) + # Gets an identity snapshot at a given date + + results = IdentityHistoryApi(api_client).get_identity_snapshot(id=id, var_date=var_date) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).get_identity_snapshot(id, var_date) + print("The response of IdentityHistoryApi->get_identity_snapshot:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityHistoryApi->get_identity_snapshot: %s\n" % e) + print("Exception when calling IdentityHistoryApi->get_identity_snapshot: %s\n" % e) - path: /historical-identities/{id}/snapshot-summary method: GET xCodeSample: @@ -5427,16 +5106,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) 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) try: - # Gets the summary for the event count for a specific identity - - api_response = api_instance.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) - print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n") - pprint(api_response) + # Gets the summary for the event count for a specific identity + + results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id=id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) + print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) - path: /historical-identities/{id}/start-date method: GET xCodeSample: @@ -5445,16 +5123,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_start_date(id) - print("The response of IdentityHistoryApi->get_identity_start_date:\n") - pprint(api_response) + # Gets the start date of the identity + + results = IdentityHistoryApi(api_client).get_identity_start_date(id=id) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).get_identity_start_date(id) + print("The response of IdentityHistoryApi->get_identity_start_date:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityHistoryApi->get_identity_start_date: %s\n" % e) + print("Exception when calling IdentityHistoryApi->get_identity_start_date: %s\n" % e) - path: /historical-identities method: GET xCodeSample: @@ -5467,16 +5144,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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: - # Lists all the identities - - api_response = api_instance.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) - print("The response of IdentityHistoryApi->list_historical_identities:\n") - pprint(api_response) + # Lists all the identities + + results = IdentityHistoryApi(api_client).list_historical_identities() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) + print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) - path: /historical-identities/{id}/access-items method: GET xCodeSample: @@ -5492,16 +5168,15 @@ 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) try: - # List Access Items by Identity - - api_response = api_instance.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) - print("The response of IdentityHistoryApi->list_identity_access_items:\n") - pprint(api_response) + # List Access Items by Identity + + results = IdentityHistoryApi(api_client).list_identity_access_items(id=id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) + print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) - path: /historical-identities/{id}/snapshots/{date}/access-items method: GET xCodeSample: @@ -5512,16 +5187,15 @@ 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) try: - # Get Identity Access Items Snapshot - - api_response = api_instance.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) - print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") - pprint(api_response) + # Get Identity Access Items Snapshot + + results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id=id, var_date=var_date) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) + print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) - path: /historical-identities/{id}/snapshots method: GET xCodeSample: @@ -5535,23 +5209,22 @@ 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) try: - # Lists all the snapshots for the identity - - api_response = api_instance.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) - print("The response of IdentityHistoryApi->list_identity_snapshots:\n") - pprint(api_response) + # Lists all the snapshots for the identity + + results = IdentityHistoryApi(api_client).list_identity_snapshots(id=id) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).list_identity_snapshots(id, start, interval, limit, offset, count) + print("The response of IdentityHistoryApi->list_identity_snapshots:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) + print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) - path: /identity-profiles method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-profiles#create-identity-profile source: | - identity_profile = { + identity_profile = '''{ "owner" : { "name" : "William Wilson", "id" : "2c9180835d191a86015d28455b4b232a", @@ -5599,18 +5272,17 @@ "name" : "aName", "modified" : "2023-01-03T21:16:22.432Z", "id" : "id12345" - } # IdentityProfile | - try: - # Create Identity Profile - Result = identity_profile.from_json(identity_profile) - api_response = api_instance.create_identity_profile(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_identity_profile(Result) - print("The response of IdentityProfilesApi->create_identity_profile:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IdentityProfilesApi->create_identity_profile: %s\n" % e) + }''' # IdentityProfile | + try: + # Create Identity Profile + new_identity_profile = IdentityProfile.from_json(identity_profile) + results = IdentityProfilesApi(api_client).create_identity_profile(identity_profile=new_identity_profile) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).create_identity_profile(new_identity_profile) + print("The response of IdentityProfilesApi->create_identity_profile:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->create_identity_profile: %s\n" % e) - path: /identity-profiles/{identity-profile-id} method: DELETE xCodeSample: @@ -5619,36 +5291,32 @@ source: | identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. try: - # Delete Identity Profile - - api_response = api_instance.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) - print("The response of IdentityProfilesApi->delete_identity_profile:\n") - pprint(api_response) + # Delete Identity Profile + + results = IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id=identity_profile_id) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->delete_identity_profile:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityProfilesApi->delete_identity_profile: %s\n" % e) + print("Exception when calling IdentityProfilesApi->delete_identity_profile: %s\n" % e) - path: /identity-profiles/bulk-delete method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-profiles#delete-identity-profiles source: | - 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. - + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_identity_profiles(Result) - print("The response of IdentityProfilesApi->delete_identity_profiles:\n") - pprint(api_response) + # Delete Identity Profiles + new_request_body = RequestBody.from_json(request_body) + results = IdentityProfilesApi(api_client).delete_identity_profiles(request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).delete_identity_profiles(new_request_body) + print("The response of IdentityProfilesApi->delete_identity_profiles:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityProfilesApi->delete_identity_profiles: %s\n" % e) + print("Exception when calling IdentityProfilesApi->delete_identity_profiles: %s\n" % e) - path: /identity-profiles/export method: GET xCodeSample: @@ -5661,16 +5329,15 @@ filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb' # 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, ne* **name**: *eq, ne* **priority**: *eq, ne* (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, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) sorters = 'name,-priority' # 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: **id, name, priority** (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: **id, name, priority** (optional) try: - # Export Identity Profiles - - api_response = api_instance.export_identity_profiles() - - # Below is a request that includes all optional parameters - # api_response = api_instance.export_identity_profiles(limit, offset, count, filters, sorters) - print("The response of IdentityProfilesApi->export_identity_profiles:\n") - pprint(api_response) + # Export Identity Profiles + + results = IdentityProfilesApi(api_client).export_identity_profiles() + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->export_identity_profiles:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) + print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config method: GET xCodeSample: @@ -5679,16 +5346,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) - print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n") - pprint(api_response) + # Default identity attribute config + + results = IdentityProfilesApi(api_client).get_default_identity_attribute_config(identity_profile_id=identity_profile_id) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).get_default_identity_attribute_config(identity_profile_id) + print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e) + print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e) - path: /identity-profiles/{identity-profile-id} method: GET xCodeSample: @@ -5697,92 +5363,32 @@ source: | identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. try: - # Get Identity Profile - - api_response = api_instance.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) - print("The response of IdentityProfilesApi->get_identity_profile:\n") - pprint(api_response) + # Get Identity Profile + + results = IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id=identity_profile_id) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->get_identity_profile:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityProfilesApi->get_identity_profile: %s\n" % e) + print("Exception when calling IdentityProfilesApi->get_identity_profile: %s\n" % e) - path: /identity-profiles/import method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-profiles#import-identity-profiles source: | - [sailpoint.beta.IdentityProfileExportedObject()] # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. - identity_profile_exported_object = { - "self" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "version" : 1, - "object" : { - "owner" : { - "name" : "William Wilson", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "IDENTITY" - }, - "identityExceptionReportReference" : { - "reportName" : "My annual report", - "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" - }, - "authoritativeSource" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "hasTimeBasedAttr" : true, - "created" : "2015-05-28T14:07:17Z", - "description" : "My custom flat file profile", - "identityRefreshRequired" : true, - "identityCount" : 8, - "priority" : 10, - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - }, - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "id" : "id12345" - } - } # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. - - try: - # Import Identity Profiles - Result = identity_profile_exported_object.from_json(identity_profile_exported_object) - api_response = api_instance.import_identity_profiles(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.import_identity_profiles(Result) - print("The response of IdentityProfilesApi->import_identity_profiles:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IdentityProfilesApi->import_identity_profiles: %s\n" % e) + identity_profile_exported_object = '''[sailpoint.beta.IdentityProfileExportedObject()]''' # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + try: + # Import Identity Profiles + new_identity_profile_exported_object = IdentityProfileExportedObject.from_json(identity_profile_exported_object) + results = IdentityProfilesApi(api_client).import_identity_profiles(identity_profile_exported_object=new_identity_profile_exported_object) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).import_identity_profiles(new_identity_profile_exported_object) + print("The response of IdentityProfilesApi->import_identity_profiles:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->import_identity_profiles: %s\n" % e) - path: /identity-profiles method: GET xCodeSample: @@ -5795,23 +5401,22 @@ filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb' # 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) sorters = 'name,-priority' # 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: **id, name, priority, created, modified, owner.id, owner.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: **id, name, priority, created, modified, owner.id, owner.name** (optional) try: - # List Identity Profiles - - api_response = api_instance.list_identity_profiles() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_identity_profiles(limit, offset, count, filters, sorters) - print("The response of IdentityProfilesApi->list_identity_profiles:\n") - pprint(api_response) + # List Identity Profiles + + results = IdentityProfilesApi(api_client).list_identity_profiles() + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->list_identity_profiles:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) + print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) - path: /identity-profiles/identity-preview method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-profiles#show-generate-identity-preview source: | - identity_preview_request = { + identity_preview_request = '''{ "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "identityAttributeConfig" : { "attributeTransforms" : [ { @@ -5837,18 +5442,17 @@ } ], "enabled" : true } - } # IdentityPreviewRequest | Identity Preview request body. - try: - # Generate Identity Profile Preview - Result = identity_preview_request.from_json(identity_preview_request) - api_response = api_instance.show_generate_identity_preview(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.show_generate_identity_preview(Result) - print("The response of IdentityProfilesApi->show_generate_identity_preview:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IdentityProfilesApi->show_generate_identity_preview: %s\n" % e) + }''' # IdentityPreviewRequest | Identity Preview request body. + try: + # Generate Identity Profile Preview + new_identity_preview_request = IdentityPreviewRequest.from_json(identity_preview_request) + results = IdentityProfilesApi(api_client).show_generate_identity_preview(identity_preview_request=new_identity_preview_request) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).show_generate_identity_preview(new_identity_preview_request) + print("The response of IdentityProfilesApi->show_generate_identity_preview:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->show_generate_identity_preview: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/process-identities method: POST xCodeSample: @@ -5857,16 +5461,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.sync_identity_profile(identity_profile_id) - print("The response of IdentityProfilesApi->sync_identity_profile:\n") - pprint(api_response) + # Process identities under profile + + results = IdentityProfilesApi(api_client).sync_identity_profile(identity_profile_id=identity_profile_id) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).sync_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->sync_identity_profile:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityProfilesApi->sync_identity_profile: %s\n" % e) + print("Exception when calling IdentityProfilesApi->sync_identity_profile: %s\n" % e) - path: /identity-profiles/{identity-profile-id} method: PATCH xCodeSample: @@ -5874,31 +5477,24 @@ label: SDK_tools/sdk/python/beta/methods/identity-profiles#update-identity-profile source: | identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. - [{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}] # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - try: - # Update Identity Profile - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_identity_profile(identity_profile_id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_identity_profile(identity_profile_id, Result) - print("The response of IdentityProfilesApi->update_identity_profile:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e) + json_patch_operation = '''[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}]''' # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + try: + # Update Identity Profile + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id=identity_profile_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id, new_json_patch_operation) + print("The response of IdentityProfilesApi->update_identity_profile:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e) - path: /launchers method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/launchers#create-launcher source: | - launcher_request = { + launcher_request = '''{ "reference" : { "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", "type" : "WORKFLOW" @@ -5908,18 +5504,17 @@ "disabled" : false, "type" : "INTERACTIVE_PROCESS", "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" - } # LauncherRequest | Payload to create a Launcher - try: - # Create launcher - Result = launcher_request.from_json(launcher_request) - api_response = api_instance.create_launcher(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_launcher(Result) - print("The response of LaunchersApi->create_launcher:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling LaunchersApi->create_launcher: %s\n" % e) + }''' # LauncherRequest | Payload to create a Launcher + try: + # Create launcher + new_launcher_request = LauncherRequest.from_json(launcher_request) + results = LaunchersApi(api_client).create_launcher(launcher_request=new_launcher_request) + # Below is a request that includes all optional parameters + # results = LaunchersApi(api_client).create_launcher(new_launcher_request) + print("The response of LaunchersApi->create_launcher:\n") + pprint(results) + except Exception as e: + print("Exception when calling LaunchersApi->create_launcher: %s\n" % e) - path: /launchers/{launcherID} method: DELETE xCodeSample: @@ -5928,14 +5523,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_launcher(launcher_id) + # Delete Launcher + + LaunchersApi(api_client).delete_launcher(launcher_id=launcher_id) + # Below is a request that includes all optional parameters + # LaunchersApi(api_client).delete_launcher(launcher_id) except Exception as e: - print("Exception when calling LaunchersApi->delete_launcher: %s\n" % e) + print("Exception when calling LaunchersApi->delete_launcher: %s\n" % e) - path: /launchers/{launcherID} method: GET xCodeSample: @@ -5944,16 +5538,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_launcher(launcher_id) - print("The response of LaunchersApi->get_launcher:\n") - pprint(api_response) + # Get Launcher by ID + + results = LaunchersApi(api_client).get_launcher(launcher_id=launcher_id) + # Below is a request that includes all optional parameters + # results = LaunchersApi(api_client).get_launcher(launcher_id) + print("The response of LaunchersApi->get_launcher:\n") + pprint(results) except Exception as e: - print("Exception when calling LaunchersApi->get_launcher: %s\n" % e) + print("Exception when calling LaunchersApi->get_launcher: %s\n" % e) - path: /launchers method: GET xCodeSample: @@ -5964,16 +5557,15 @@ 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) try: - # List all Launchers for tenant - - api_response = api_instance.get_launchers() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_launchers(filters, next, limit) - print("The response of LaunchersApi->get_launchers:\n") - pprint(api_response) + # List all Launchers for tenant + + results = LaunchersApi(api_client).get_launchers() + # Below is a request that includes all optional parameters + # results = LaunchersApi(api_client).get_launchers(filters, next, limit) + print("The response of LaunchersApi->get_launchers:\n") + pprint(results) except Exception as e: - print("Exception when calling LaunchersApi->get_launchers: %s\n" % e) + print("Exception when calling LaunchersApi->get_launchers: %s\n" % e) - path: /launchers/{launcherID} method: PUT xCodeSample: @@ -5981,7 +5573,7 @@ label: SDK_tools/sdk/python/beta/methods/launchers#put-launcher source: | 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 = { + launcher_request = '''{ "reference" : { "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", "type" : "WORKFLOW" @@ -5991,18 +5583,17 @@ "disabled" : false, "type" : "INTERACTIVE_PROCESS", "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" - } # LauncherRequest | Payload to replace Launcher - try: - # Replace Launcher - Result = launcher_request.from_json(launcher_request) - api_response = api_instance.put_launcher(launcher_id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_launcher(launcher_id, Result) - print("The response of LaunchersApi->put_launcher:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling LaunchersApi->put_launcher: %s\n" % e) + }''' # LauncherRequest | Payload to replace Launcher + try: + # Replace Launcher + new_launcher_request = LauncherRequest.from_json(launcher_request) + results = LaunchersApi(api_client).put_launcher(launcher_id=launcher_id, launcher_request=new_launcher_request) + # Below is a request that includes all optional parameters + # results = LaunchersApi(api_client).put_launcher(launcher_id, new_launcher_request) + print("The response of LaunchersApi->put_launcher:\n") + pprint(results) + except Exception as e: + print("Exception when calling LaunchersApi->put_launcher: %s\n" % e) - path: /beta/launchers/{launcherID}/launch method: POST xCodeSample: @@ -6011,16 +5602,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_launcher(launcher_id) - print("The response of LaunchersApi->start_launcher:\n") - pprint(api_response) + # Launch a Launcher + + results = LaunchersApi(api_client).start_launcher(launcher_id=launcher_id) + # Below is a request that includes all optional parameters + # results = LaunchersApi(api_client).start_launcher(launcher_id) + print("The response of LaunchersApi->start_launcher:\n") + pprint(results) except Exception as e: - print("Exception when calling LaunchersApi->start_launcher: %s\n" % e) + print("Exception when calling LaunchersApi->start_launcher: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} method: GET xCodeSample: @@ -6030,16 +5620,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_lifecycle_states(identity_profile_id, lifecycle_state_id) - print("The response of LifecycleStatesApi->get_lifecycle_states:\n") - pprint(api_response) + # Get Lifecycle State + + results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id) + # Below is a request that includes all optional parameters + # results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->get_lifecycle_states:\n") + pprint(results) except Exception as e: - print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) + print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} method: PATCH xCodeSample: @@ -6048,24 +5637,17 @@ source: | 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 - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # 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 - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result) - print("The response of LifecycleStatesApi->update_lifecycle_states:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) + json_patch_operation = '''[{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 + try: + # Update Lifecycle State + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = LifecycleStatesApi(api_client).update_lifecycle_states(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) - path: /managed-clients/{id}/status method: GET xCodeSample: @@ -6075,16 +5657,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_managed_client_status(id, type) - print("The response of ManagedClientsApi->get_managed_client_status:\n") - pprint(api_response) + # Specified Managed Client Status. + + results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + pprint(results) except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) - path: /managed-clients/{id}/status method: POST xCodeSample: @@ -6092,7 +5673,7 @@ label: SDK_tools/sdk/python/beta/methods/managed-clients#update-managed-client-status source: | id = 'aClientId' # str | ID of the Managed Client Status to update # str | ID of the Managed Client Status to update - managed_client_status = { + managed_client_status = '''{ "body" : { "alertKey" : "", "id" : "5678", @@ -6117,18 +5698,17 @@ "type" : "CCG", "status" : "NORMAL", "timestamp" : "2020-01-01T00:00:00Z" - } # ManagedClientStatus | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_managed_client_status(id, Result) - print("The response of ManagedClientsApi->update_managed_client_status:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ManagedClientsApi->update_managed_client_status: %s\n" % e) + }''' # ManagedClientStatus | + try: + # Handle status request from client + new_managed_client_status = ManagedClientStatus.from_json(managed_client_status) + results = ManagedClientsApi(api_client).update_managed_client_status(id=id, managed_client_status=new_managed_client_status) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).update_managed_client_status(id, new_managed_client_status) + print("The response of ManagedClientsApi->update_managed_client_status:\n") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client_status: %s\n" % e) - path: /managed-clusters/{id}/log-config method: GET xCodeSample: @@ -6137,16 +5717,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_client_log_configuration(id) - print("The response of ManagedClustersApi->get_client_log_configuration:\n") - pprint(api_response) + # Get managed cluster's log configuration + + results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + pprint(results) except Exception as e: - print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) - path: /managed-clusters/{id} method: GET xCodeSample: @@ -6155,16 +5734,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_managed_cluster(id) - print("The response of ManagedClustersApi->get_managed_cluster:\n") - pprint(api_response) + # Get a specified ManagedCluster. + + results = ManagedClustersApi(api_client).get_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + pprint(results) except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) - path: /managed-clusters method: GET xCodeSample: @@ -6176,16 +5754,15 @@ 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) filters = 'operational eq operation' # 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: **operational**: *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: **operational**: *eq* (optional) try: - # Retrieve all Managed Clusters. - - api_response = api_instance.get_managed_clusters() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_managed_clusters(offset, limit, count, filters) - print("The response of ManagedClustersApi->get_managed_clusters:\n") - pprint(api_response) + # Retrieve all Managed Clusters. + + results = ManagedClustersApi(api_client).get_managed_clusters() + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + pprint(results) except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) - path: /managed-clusters/{id}/log-config method: PUT xCodeSample: @@ -6193,24 +5770,23 @@ label: SDK_tools/sdk/python/beta/methods/managed-clusters#put-client-log-configuration source: | id = 'aClusterId' # str | ID of ManagedCluster to update log configuration for # str | ID of ManagedCluster to update log configuration for - client_log_configuration = { + client_log_configuration = '''{ "durationMinutes" : 120, "rootLevel" : "INFO", "clientId" : "aClientId", "expiration" : "2020-12-15T19:13:36.079Z", "logLevels" : "INFO" - } # ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster - try: - # Update managed cluster's log configuration - - api_response = api_instance.put_client_log_configuration(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_client_log_configuration(id, Result) - print("The response of ManagedClustersApi->put_client_log_configuration:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) + }''' # ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster + try: + # Update managed cluster's log configuration + + results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, client_log_configuration=new_client_log_configuration) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_client_log_configuration) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -6219,16 +5795,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_mfa_config(method) - print("The response of MFAConfigurationApi->delete_mfa_config:\n") - pprint(api_response) + # Delete MFA method configuration + + results = MFAConfigurationApi(api_client).delete_mfa_config(method=method) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).delete_mfa_config(method) + print("The response of MFAConfigurationApi->delete_mfa_config:\n") + pprint(results) except Exception as e: - print("Exception when calling MFAConfigurationApi->delete_mfa_config: %s\n" % e) + print("Exception when calling MFAConfigurationApi->delete_mfa_config: %s\n" % e) - path: /mfa/duo-web/config method: GET xCodeSample: @@ -6236,16 +5811,15 @@ label: SDK_tools/sdk/python/beta/methods/mfa-configuration#get-mfa-duo-config source: | try: - # Configuration of Duo MFA method - - api_response = api_instance.get_mfa_duo_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_mfa_duo_config() - print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") - pprint(api_response) + # Configuration of Duo MFA method + + results = MFAConfigurationApi(api_client).get_mfa_duo_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + pprint(results) except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) - path: /mfa/kba/config method: GET xCodeSample: @@ -6254,16 +5828,15 @@ source: | 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_mfa_kba_config(all_languages) - print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - pprint(api_response) + # Configuration of KBA MFA method + + results = MFAConfigurationApi(api_client).get_mfa_kba_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + pprint(results) except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) + print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) - path: /mfa/okta-verify/config method: GET xCodeSample: @@ -6271,23 +5844,22 @@ label: SDK_tools/sdk/python/beta/methods/mfa-configuration#get-mfa-okta-config source: | try: - # Configuration of Okta MFA method - - api_response = api_instance.get_mfa_okta_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_mfa_okta_config() - print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") - pprint(api_response) + # Configuration of Okta MFA method + + results = MFAConfigurationApi(api_client).get_mfa_okta_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + pprint(results) except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) - path: /mfa/duo-web/config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-configuration#set-mfa-duo-config source: | - mfa_duo_config = { + mfa_duo_config = '''{ "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", "host" : "example.com", "configProperties" : { @@ -6297,65 +5869,57 @@ "mfaMethod" : "duo-web", "enabled" : true, "identityAttribute" : "email" - } # MfaDuoConfig | - try: - # Set Duo MFA configuration - Result = mfa_duo_config.from_json(mfa_duo_config) - api_response = api_instance.set_mfa_duo_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_mfa_duo_config(Result) - print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) + }''' # MfaDuoConfig | + try: + # Set Duo MFA configuration + new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) + results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) - path: /mfa/okta-verify/config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-configuration#set-mfa-okta-config source: | - mfa_okta_config = { + mfa_okta_config = '''{ "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", "host" : "example.com", "mfaMethod" : "okta-verify", "enabled" : true, "identityAttribute" : "email" - } # MfaOktaConfig | - try: - # Set Okta MFA configuration - Result = mfa_okta_config.from_json(mfa_okta_config) - api_response = api_instance.set_mfa_okta_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_mfa_okta_config(Result) - print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) + }''' # MfaOktaConfig | + try: + # Set Okta MFA configuration + new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) + results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) - path: /mfa/kba/config/answers method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-configuration#set-mfakba-config source: | - [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | - kba_answer_request_item = { - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - } # List[KbaAnswerRequestItem] | - - try: - # Set MFA KBA configuration - Result = kba_answer_request_item.from_json(kba_answer_request_item) - api_response = api_instance.set_mfakba_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_mfakba_config(Result) - print("The response of MFAConfigurationApi->set_mfakba_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) + kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | + try: + # Set MFA KBA configuration + new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) + results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) - path: /mfa/{method}/test method: GET xCodeSample: @@ -6364,37 +5928,35 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.test_mfa_config(method) - print("The response of MFAConfigurationApi->test_mfa_config:\n") - pprint(api_response) + # MFA method's test configuration + + results = MFAConfigurationApi(api_client).test_mfa_config(method=method) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + pprint(results) except Exception as e: - print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /mfa/token/send method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-controller#create-send-token source: | - send_token_request = { + send_token_request = '''{ "userAlias" : "will.albin", "deliveryType" : "EMAIL_WORK" - } # SendTokenRequest | - try: - # Create and send user token - Result = send_token_request.from_json(send_token_request) - api_response = api_instance.create_send_token(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_send_token(Result) - print("The response of MFAControllerApi->create_send_token:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MFAControllerApi->create_send_token: %s\n" % e) + }''' # SendTokenRequest | + try: + # Create and send user token + new_send_token_request = SendTokenRequest.from_json(send_token_request) + results = MFAControllerApi(api_client).create_send_token(send_token_request=new_send_token_request) + # Below is a request that includes all optional parameters + # results = MFAControllerApi(api_client).create_send_token(new_send_token_request) + print("The response of MFAControllerApi->create_send_token:\n") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->create_send_token: %s\n" % e) - path: /mfa/{method}/poll method: POST xCodeSample: @@ -6402,113 +5964,103 @@ label: SDK_tools/sdk/python/beta/methods/mfa-controller#ping-verification-status source: | 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 = { + verification_poll_request = '''{ "requestId" : "089899f13a8f4da7824996191587bab9" - } # VerificationPollRequest | - try: - # Polling MFA method by VerificationPollRequest - Result = verification_poll_request.from_json(verification_poll_request) - api_response = api_instance.ping_verification_status(method, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.ping_verification_status(method, Result) - print("The response of MFAControllerApi->ping_verification_status:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MFAControllerApi->ping_verification_status: %s\n" % e) + }''' # VerificationPollRequest | + try: + # Polling MFA method by VerificationPollRequest + new_verification_poll_request = VerificationPollRequest.from_json(verification_poll_request) + results = MFAControllerApi(api_client).ping_verification_status(method=method, verification_poll_request=new_verification_poll_request) + # Below is a request that includes all optional parameters + # results = MFAControllerApi(api_client).ping_verification_status(method, new_verification_poll_request) + print("The response of MFAControllerApi->ping_verification_status:\n") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->ping_verification_status: %s\n" % e) - path: /mfa/duo-web/verify method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-controller#send-duo-verify-request source: | - duo_verification_request = { + duo_verification_request = '''{ "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", "userId" : "2c9180947f0ef465017f215cbcfd004b" - } # DuoVerificationRequest | - try: - # Verifying authentication via Duo method - Result = duo_verification_request.from_json(duo_verification_request) - api_response = api_instance.send_duo_verify_request(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.send_duo_verify_request(Result) - print("The response of MFAControllerApi->send_duo_verify_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MFAControllerApi->send_duo_verify_request: %s\n" % e) + }''' # DuoVerificationRequest | + try: + # Verifying authentication via Duo method + new_duo_verification_request = DuoVerificationRequest.from_json(duo_verification_request) + results = MFAControllerApi(api_client).send_duo_verify_request(duo_verification_request=new_duo_verification_request) + # Below is a request that includes all optional parameters + # results = MFAControllerApi(api_client).send_duo_verify_request(new_duo_verification_request) + print("The response of MFAControllerApi->send_duo_verify_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->send_duo_verify_request: %s\n" % e) - path: /mfa/kba/authenticate method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-controller#send-kba-answers source: | - [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | - kba_answer_request_item = { - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - } # List[KbaAnswerRequestItem] | - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.send_kba_answers(Result) - print("The response of MFAControllerApi->send_kba_answers:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MFAControllerApi->send_kba_answers: %s\n" % e) + kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | + try: + # Authenticate KBA provided MFA method + new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) + results = MFAControllerApi(api_client).send_kba_answers(kba_answer_request_item=new_kba_answer_request_item) + # Below is a request that includes all optional parameters + # results = MFAControllerApi(api_client).send_kba_answers(new_kba_answer_request_item) + print("The response of MFAControllerApi->send_kba_answers:\n") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->send_kba_answers: %s\n" % e) - path: /mfa/okta-verify/verify method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-controller#send-okta-verify-request source: | - okta_verification_request = { + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.send_okta_verify_request(Result) - print("The response of MFAControllerApi->send_okta_verify_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MFAControllerApi->send_okta_verify_request: %s\n" % e) + }''' # OktaVerificationRequest | + try: + # Verifying authentication via Okta method + new_okta_verification_request = OktaVerificationRequest.from_json(okta_verification_request) + results = MFAControllerApi(api_client).send_okta_verify_request(okta_verification_request=new_okta_verification_request) + # Below is a request that includes all optional parameters + # results = MFAControllerApi(api_client).send_okta_verify_request(new_okta_verification_request) + print("The response of MFAControllerApi->send_okta_verify_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->send_okta_verify_request: %s\n" % e) - path: /mfa/token/authenticate method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-controller#send-token-auth-request source: | - token_auth_request = { + token_auth_request = '''{ "userAlias" : "will.albin", "deliveryType" : "EMAIL_WORK", "token" : "12345" - } # TokenAuthRequest | - try: - # Authenticate Token provided MFA method - Result = token_auth_request.from_json(token_auth_request) - api_response = api_instance.send_token_auth_request(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.send_token_auth_request(Result) - print("The response of MFAControllerApi->send_token_auth_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) + }''' # TokenAuthRequest | + try: + # Authenticate Token provided MFA method + new_token_auth_request = TokenAuthRequest.from_json(token_auth_request) + results = MFAControllerApi(api_client).send_token_auth_request(token_auth_request=new_token_auth_request) + # Below is a request that includes all optional parameters + # results = MFAControllerApi(api_client).send_token_auth_request(new_token_auth_request) + print("The response of MFAControllerApi->send_token_auth_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) - path: /multihosts method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#create-multi-host-integration source: | - multi_host_integrations_create = { + multi_host_integrations_create = '''{ "owner" : { "name" : "MyName", "id" : "2c91808568c529c60168cca6f90c1313", @@ -6533,18 +6085,17 @@ "name" : "My Multi-Host Integration", "description" : "This is the Multi-Host Integration.", "modified" : "2024-01-23T18:08:50.897Z" - } # MultiHostIntegrationsCreate | The specifics of the Multi-Host Integration to create - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_multi_host_integration(Result) - print("The response of MultiHostIntegrationApi->create_multi_host_integration:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->create_multi_host_integration: %s\n" % e) + }''' # MultiHostIntegrationsCreate | The specifics of the Multi-Host Integration to create + try: + # Create Multi-Host Integration + new_multi_host_integrations_create = MultiHostIntegrationsCreate.from_json(multi_host_integrations_create) + results = MultiHostIntegrationApi(api_client).create_multi_host_integration(multi_host_integrations_create=new_multi_host_integrations_create) + # Below is a request that includes all optional parameters + # results = MultiHostIntegrationApi(api_client).create_multi_host_integration(new_multi_host_integrations_create) + print("The response of MultiHostIntegrationApi->create_multi_host_integration:\n") + pprint(results) + except Exception as e: + print("Exception when calling MultiHostIntegrationApi->create_multi_host_integration: %s\n" % e) - path: /multihosts/{multihostId} method: POST xCodeSample: @@ -6552,29 +6103,15 @@ label: SDK_tools/sdk/python/beta/methods/multi-host-integration#create-sources-within-multi-host source: | 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 = { - "connectorAttributes" : { - "authType" : "SQLAuthentication", - "url" : "jdbc:sqlserver://178.18.41.118:1433", - "user" : "username", - "driverClass" : "com.microsoft.sqlserver.jdbc.SQLServerDriver", - "maxSourcesPerAggGroup" : 10, - "maxAllowedSources" : 300 - }, - "name" : "My Source", - "description" : "This is the corporate directory." - } # List[MultiHostIntegrationsCreateSources] | The specifics of the sources to create within Multi-Host Integration. - - 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) - - # Below is a request that includes all optional parameters - # api_instance.create_sources_within_multi_host(multihost_id, Result) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->create_sources_within_multi_host: %s\n" % e) + multi_host_integrations_create_sources = '''[sailpoint.beta.MultiHostIntegrationsCreateSources()]''' # List[MultiHostIntegrationsCreateSources] | The specifics of the sources to create within Multi-Host Integration. + try: + # Create Sources Within Multi-Host Integration + new_multi_host_integrations_create_sources = MultiHostIntegrationsCreateSources.from_json(multi_host_integrations_create_sources) + MultiHostIntegrationApi(api_client).create_sources_within_multi_host(multihost_id=multihost_id, multi_host_integrations_create_sources=new_multi_host_integrations_create_sources) + # Below is a request that includes all optional parameters + # 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) - path: /multihosts/{multihostId} method: DELETE xCodeSample: @@ -6583,14 +6120,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_multi_host(multihost_id) + # Delete Multi-Host Integration + + MultiHostIntegrationApi(api_client).delete_multi_host(multihost_id=multihost_id) + # Below is a request that includes all optional parameters + # MultiHostIntegrationApi(api_client).delete_multi_host(multihost_id) except Exception as e: - print("Exception when calling MultiHostIntegrationApi->delete_multi_host: %s\n" % e) + print("Exception when calling MultiHostIntegrationApi->delete_multi_host: %s\n" % e) - path: /multihosts/{multihostId}/acctAggregationGroups method: GET xCodeSample: @@ -6599,16 +6135,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_acct_aggregation_groups(multihost_id) - print("The response of MultiHostIntegrationApi->get_acct_aggregation_groups:\n") - pprint(api_response) + # Get Account Aggregation Groups Within Multi-Host Integration ID + + results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id=multihost_id) + # Below is a request that includes all optional parameters + # results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id) + print("The response of MultiHostIntegrationApi->get_acct_aggregation_groups:\n") + pprint(results) except Exception as e: - print("Exception when calling MultiHostIntegrationApi->get_acct_aggregation_groups: %s\n" % e) + print("Exception when calling MultiHostIntegrationApi->get_acct_aggregation_groups: %s\n" % e) - path: /multihosts/{multiHostId}/entitlementAggregationGroups method: GET xCodeSample: @@ -6617,16 +6152,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_entitlement_aggregation_groups(multi_host_id) - print("The response of MultiHostIntegrationApi->get_entitlement_aggregation_groups:\n") - pprint(api_response) + # Get Entitlement Aggregation Groups Within Multi-Host Integration ID + + results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id=multi_host_id) + # Below is a request that includes all optional parameters + # results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id) + print("The response of MultiHostIntegrationApi->get_entitlement_aggregation_groups:\n") + pprint(results) except Exception as e: - print("Exception when calling MultiHostIntegrationApi->get_entitlement_aggregation_groups: %s\n" % e) + print("Exception when calling MultiHostIntegrationApi->get_entitlement_aggregation_groups: %s\n" % e) - path: /multihosts/{multihostId} method: GET xCodeSample: @@ -6635,16 +6169,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_multi_host_integrations(multihost_id) - print("The response of MultiHostIntegrationApi->get_multi_host_integrations:\n") - pprint(api_response) + # Get Multi-Host Integration By ID + + results = MultiHostIntegrationApi(api_client).get_multi_host_integrations(multihost_id=multihost_id) + # Below is a request that includes all optional parameters + # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations(multihost_id) + print("The response of MultiHostIntegrationApi->get_multi_host_integrations:\n") + pprint(results) except Exception as e: - print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations: %s\n" % e) + print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations: %s\n" % e) - path: /multihosts method: GET xCodeSample: @@ -6658,16 +6191,15 @@ 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) for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity 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 Identity 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) try: - # List All Existing Multi-Host Integrations - - api_response = api_instance.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) - print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n") - pprint(api_response) + # List All Existing Multi-Host Integrations + + results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e) + print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e) - path: /multihosts/{multiHostId}/sources/errors method: GET xCodeSample: @@ -6676,16 +6208,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_multi_host_source_creation_errors(multi_host_id) - print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n") - pprint(api_response) + # List Multi-Host Source Creation Errors + + results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id=multi_host_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e) + print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e) - path: /multihosts/types method: GET xCodeSample: @@ -6693,16 +6224,15 @@ label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-multihost-integration-types source: | try: - # List Multi-Host Integration Types - - api_response = api_instance.get_multihost_integration_types() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_multihost_integration_types() - print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n") - pprint(api_response) + # List Multi-Host Integration Types + + results = MultiHostIntegrationApi(api_client).get_multihost_integration_types() + # Below is a request that includes all optional parameters + # results = MultiHostIntegrationApi(api_client).get_multihost_integration_types() + print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n") + pprint(results) except Exception as e: - print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e) + print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e) - path: /multihosts/{multihostId}/sources method: GET xCodeSample: @@ -6716,16 +6246,15 @@ filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # 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**: *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: **id**: *in* (optional) 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) try: - # List Sources Within Multi-Host Integration - - api_response = api_instance.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) - print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n") - pprint(api_response) + # List Sources Within Multi-Host Integration + + results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id=multihost_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e) + print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e) - path: /multihosts/{multihostId}/sources/testConnection method: POST xCodeSample: @@ -6734,14 +6263,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.test_connection_multi_host_sources(multihost_id) + # Test Configuration For Multi-Host Integration + + MultiHostIntegrationApi(api_client).test_connection_multi_host_sources(multihost_id=multihost_id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling MultiHostIntegrationApi->test_connection_multi_host_sources: %s\n" % e) - path: /multihosts/{multihostId}/sources/{sourceId}/testConnection method: GET xCodeSample: @@ -6751,16 +6279,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.test_source_connection_multihost(multihost_id, source_id) - print("The response of MultiHostIntegrationApi->test_source_connection_multihost:\n") - pprint(api_response) + # Test Configuration For Multi-Host Integration's Single Source + + results = MultiHostIntegrationApi(api_client).test_source_connection_multihost(multihost_id=multihost_id, source_id=source_id) + # Below is a request that includes all optional parameters + # results = MultiHostIntegrationApi(api_client).test_source_connection_multihost(multihost_id, source_id) + print("The response of MultiHostIntegrationApi->test_source_connection_multihost:\n") + pprint(results) except Exception as e: - print("Exception when calling MultiHostIntegrationApi->test_source_connection_multihost: %s\n" % e) + print("Exception when calling MultiHostIntegrationApi->test_source_connection_multihost: %s\n" % e) - path: /multihosts/{multihostId} method: PATCH xCodeSample: @@ -6768,18 +6295,15 @@ label: SDK_tools/sdk/python/beta/methods/multi-host-integration#update-multi-host-sources source: | 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. - - 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) - - # Below is a request that includes all optional parameters - # api_instance.update_multi_host_sources(multihost_id, Result) - except Exception as e: - print("Exception when calling MultiHostIntegrationApi->update_multi_host_sources: %s\n" % e) + 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. + try: + # Update Multi-Host Integration + new_update_multi_host_sources_request_inner = UpdateMultiHostSourcesRequestInner.from_json(update_multi_host_sources_request_inner) + MultiHostIntegrationApi(api_client).update_multi_host_sources(multihost_id=multihost_id, update_multi_host_sources_request_inner=new_update_multi_host_sources_request_inner) + # Below is a request that includes all optional parameters + # 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) - path: /non-employee-approvals/{id}/approve method: POST xCodeSample: @@ -6787,27 +6311,26 @@ label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#approve-non-employee-request source: | id = 'id_example' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) - non_employee_approval_decision = { + non_employee_approval_decision = '''{ "comment" : "comment" - } # NonEmployeeApprovalDecision | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.approve_non_employee_request(id, Result) - print("The response of NonEmployeeLifecycleManagementApi->approve_non_employee_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->approve_non_employee_request: %s\n" % e) + }''' # NonEmployeeApprovalDecision | + try: + # Approve a Non-Employee Request + new_non_employee_approval_decision = NonEmployeeApprovalDecision.from_json(non_employee_approval_decision) + results = NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id=id, non_employee_approval_decision=new_non_employee_approval_decision) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->approve_non_employee_request: %s\n" % e) - path: /non-employee-records method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#create-non-employee-record source: | - non_employee_request_body = { + non_employee_request_body = '''{ "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", "lastName" : "Smith", @@ -6820,25 +6343,24 @@ "endDate" : "2021-03-25T00:00:00-05:00", "email" : "william.smith@example.com", "startDate" : "2020-03-24T00:00:00-05:00" - } # NonEmployeeRequestBody | Non-Employee record creation request body. - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_record(Result) - print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_record:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_record: %s\n" % e) + }''' # NonEmployeeRequestBody | Non-Employee record creation request body. + try: + # Create Non-Employee Record + new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body) + results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(non_employee_request_body=new_non_employee_request_body) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(new_non_employee_request_body) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_record:\n") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_record: %s\n" % e) - path: /non-employee-requests method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#create-non-employee-request source: | - non_employee_request_body = { + non_employee_request_body = '''{ "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", "lastName" : "Smith", @@ -6851,25 +6373,24 @@ "endDate" : "2021-03-25T00:00:00-05:00", "email" : "william.smith@example.com", "startDate" : "2020-03-24T00:00:00-05:00" - } # NonEmployeeRequestBody | Non-Employee creation request body - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_request(Result) - print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_request: %s\n" % e) + }''' # NonEmployeeRequestBody | Non-Employee creation request body + try: + # Create Non-Employee Request + new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body) + results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(non_employee_request_body=new_non_employee_request_body) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(new_non_employee_request_body) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_request: %s\n" % e) - path: /non-employee-sources method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#create-non-employee-source source: | - non_employee_source_request_body = { + non_employee_source_request_body = '''{ "owner" : { "id" : "2c91808570313110017040b06f344ec9" }, @@ -6894,18 +6415,17 @@ }, { "id" : "2c91808570313110017040b06f344ec9" } ] - } # NonEmployeeSourceRequestBody | Non-Employee source creation request body. - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_source(Result) - print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source: %s\n" % e) + }''' # NonEmployeeSourceRequestBody | Non-Employee source creation request body. + try: + # Create Non-Employee Source + new_non_employee_source_request_body = NonEmployeeSourceRequestBody.from_json(non_employee_source_request_body) + results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(non_employee_source_request_body=new_non_employee_source_request_body) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes method: POST xCodeSample: @@ -6913,25 +6433,24 @@ label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes source: | source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id - non_employee_schema_attribute_body = { + non_employee_schema_attribute_body = '''{ "helpText" : "The unique identifier for the account", "label" : "Account Name", "placeholder" : "Enter a unique user name for this account.", "type" : "TEXT", "technicalName" : "account.name", "required" : true - } # NonEmployeeSchemaAttributeBody | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) - print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes: %s\n" % e) + }''' # NonEmployeeSchemaAttributeBody | + try: + # Create Non-Employee Source Schema Attribute + new_non_employee_schema_attribute_body = NonEmployeeSchemaAttributeBody.from_json(non_employee_schema_attribute_body) + results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id=source_id, non_employee_schema_attribute_body=new_non_employee_schema_attribute_body) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes: %s\n" % e) - path: /non-employee-records/{id} method: DELETE xCodeSample: @@ -6940,30 +6459,28 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_record(id) + # Delete Non-Employee Record + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id=id) + # Below is a request that includes all optional parameters + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record: %s\n" % e) - path: /non-employee-records/bulk-delete method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-record-in-bulk source: | - delete_non_employee_record_in_bulk_request = sailpoint.beta.DeleteNonEmployeeRecordInBulkRequest() # DeleteNonEmployeeRecordInBulkRequest | Non-Employee bulk delete request body. + 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_record_in_bulk(Result) + # Delete Multiple Non-Employee Records + new_delete_non_employee_record_in_bulk_request = DeleteNonEmployeeRecordInBulkRequest.from_json(delete_non_employee_record_in_bulk_request) + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record_in_bulk(delete_non_employee_record_in_bulk_request=new_delete_non_employee_record_in_bulk_request) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record_in_bulk: %s\n" % e) - path: /non-employee-requests/{id} method: DELETE xCodeSample: @@ -6972,14 +6489,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_request(id) + # Delete Non-Employee Request + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id=id) + # Below is a request that includes all optional parameters + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_request: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_request: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} method: DELETE xCodeSample: @@ -6989,14 +6505,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_schema_attribute(attribute_id, source_id) + # Delete Non-Employee Source's Schema Attribute + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_schema_attribute: %s\n" % e) - path: /non-employee-sources/{sourceId} method: DELETE xCodeSample: @@ -7005,14 +6520,13 @@ source: | source_id = '2c91808b6ef1d43e016efba0ce470904' # str | Source Id # str | Source Id try: - # Delete Non-Employee Source - - api_instance.delete_non_employee_source(source_id) - - # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_source(source_id) + # Delete Non-Employee Source + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source(source_id=source_id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes method: DELETE xCodeSample: @@ -7021,14 +6535,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_source_schema_attributes(source_id) + # Delete all custom schema attributes + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source_schema_attributes(source_id=source_id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source_schema_attributes: %s\n" % e) - path: /non-employee-sources/{id}/non-employees/download method: GET xCodeSample: @@ -7037,14 +6550,13 @@ source: | id = '2c918085842e69ae018432d22ccb212f' # str | Source Id (UUID) # str | Source Id (UUID) try: - # Exports Non-Employee Records to CSV - - api_instance.export_non_employee_records(id) - - # Below is a request that includes all optional parameters - # api_instance.export_non_employee_records(id) + # Exports Non-Employee Records to CSV + + NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id=id) + # Below is a request that includes all optional parameters + # NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_records: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_records: %s\n" % e) - path: /non-employee-sources/{id}/schema-attributes-template/download method: GET xCodeSample: @@ -7053,14 +6565,13 @@ source: | id = '2c918085842e69ae018432d22ccb212f' # str | Source Id (UUID) # str | Source Id (UUID) try: - # Exports Source Schema Template - - api_instance.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) + # Exports Source Schema Template + + NonEmployeeLifecycleManagementApi(api_client).export_non_employee_source_schema_template(id=id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_source_schema_template: %s\n" % e) - path: /non-employee-approvals/{id} method: GET xCodeSample: @@ -7070,16 +6581,15 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_approval(id, include_detail) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n") - pprint(api_response) + # Get a non-employee approval item detail + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval(id=id) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval(id, include_detail) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval: %s\n" % e) - path: /non-employee-approvals/summary/{requested-for} method: GET xCodeSample: @@ -7088,16 +6598,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_approval_summary(requested_for) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n") - pprint(api_response) + # Get Summary of Non-Employee Approval Requests + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for=requested_for) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary: %s\n" % e) - path: /non-employee-sources/{id}/non-employee-bulk-upload/status method: GET xCodeSample: @@ -7106,16 +6615,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_bulk_upload_status(id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n") - pprint(api_response) + # Bulk upload status on source + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_bulk_upload_status(id=id) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_bulk_upload_status(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) - path: /non-employee-records/{id} method: GET xCodeSample: @@ -7124,16 +6632,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_record(id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n") - pprint(api_response) + # Get a Non-Employee Record + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id=id) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) - path: /non-employee-requests/{id} method: GET xCodeSample: @@ -7142,16 +6649,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_request(id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n") - pprint(api_response) + # Get a Non-Employee Request + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id=id) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) - path: /non-employee-requests/summary/{requested-for} method: GET xCodeSample: @@ -7160,16 +6666,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_request_summary(requested_for) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n") - pprint(api_response) + # Get Summary of Non-Employee Requests + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for=requested_for) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request_summary: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request_summary: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} method: GET xCodeSample: @@ -7179,16 +6684,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute:\n") - pprint(api_response) + # Get Schema Attribute Non-Employee Source + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) - path: /non-employee-sources/{sourceId} method: GET xCodeSample: @@ -7197,16 +6701,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_source(source_id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source:\n") - pprint(api_response) + # Get a Non-Employee Source + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id=source_id) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes method: GET xCodeSample: @@ -7215,16 +6718,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_source_schema_attributes(source_id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - pprint(api_response) + # List Schema Attributes Non-Employee Source + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id=source_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) - path: /non-employee-sources/{id}/non-employee-bulk-upload method: POST xCodeSample: @@ -7234,16 +6736,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.import_non_employee_records_in_bulk(id, data) - print("The response of NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk:\n") - pprint(api_response) + # Imports, or Updates, Non-Employee Records + + results = NonEmployeeLifecycleManagementApi(api_client).import_non_employee_records_in_bulk(id=id, data=data) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk: %s\n" % e) - path: /non-employee-approvals method: GET xCodeSample: @@ -7257,16 +6758,15 @@ filters = 'approvalStatus 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: **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: **approvalStatus**: *eq* (optional) sorters = 'created' # 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: **created, 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-results) Sorting is supported for the following fields: **created, modified** (optional) try: - # Get List of Non-Employee Approval Requests - - api_response = api_instance.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) - print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approval:\n") - pprint(api_response) + # Get List of Non-Employee Approval Requests + + results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approval() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approval: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approval: %s\n" % e) - path: /non-employee-records method: GET xCodeSample: @@ -7279,16 +6779,15 @@ sorters = 'accountName,sourceId' # 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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, 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-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) filters = 'sourceId eq \"2c91808568c529c60168cca6f90c1313\"' # 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: **sourceId**: *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: **sourceId**: *eq* (optional) try: - # List Non-Employee Records - - api_response = api_instance.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) - print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - pprint(api_response) + # List Non-Employee Records + + results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records() + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) - path: /non-employee-requests method: GET xCodeSample: @@ -7302,16 +6801,15 @@ sorters = 'approvalStatus,firstName' # 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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) filters = 'sourceId eq \"2c91808568c529c60168cca6f90c1313\"' # 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: **sourceId**: *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: **sourceId**: *eq* (optional) try: - # List Non-Employee Requests - - api_response = api_instance.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) - print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - pprint(api_response) + # List Non-Employee Requests + + results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for=requested_for) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) - path: /non-employee-sources method: GET xCodeSample: @@ -7325,16 +6823,15 @@ non_employee_count = False # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to False) # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to False) sorters = 'name,created' # 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, created, sourceId** (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, created, sourceId** (optional) try: - # List Non-Employee Sources - - api_response = api_instance.list_non_employee_sources() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) - print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - pprint(api_response) + # List Non-Employee Sources + + results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources() + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) - path: /non-employee-records/{id} method: PATCH xCodeSample: @@ -7342,24 +6839,17 @@ label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#patch-non-employee-record source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # 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. - - try: - # Patch Non-Employee Record - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_non_employee_record(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_non_employee_record(id, Result) - print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_record: %s\n" % e) + json_patch_operation = '''[{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. + try: + # Patch Non-Employee Record + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id, new_json_patch_operation) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_record: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} method: PATCH xCodeSample: @@ -7368,24 +6858,17 @@ source: | 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'. - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # 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'. - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) - print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute: %s\n" % e) + json_patch_operation = '''[{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'. + try: + # Patch Non-Employee Source's Schema Attribute + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute: %s\n" % e) - path: /non-employee-sources/{sourceId} method: PATCH xCodeSample: @@ -7393,24 +6876,17 @@ label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#patch-non-employee-source source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_non_employee_source(source_id, Result) - print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_source:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_source: %s\n" % e) + json_patch_operation = '''[{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. + try: + # Patch a Non-Employee Source + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id=source_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_source: %s\n" % e) - path: /non-employee-approvals/{id}/reject method: POST xCodeSample: @@ -7418,20 +6894,19 @@ label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#reject-non-employee-request source: | id = 'id_example' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) - non_employee_reject_approval_decision = { + non_employee_reject_approval_decision = '''{ "comment" : "comment" - } # NonEmployeeRejectApprovalDecision | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.reject_non_employee_request(id, Result) - print("The response of NonEmployeeLifecycleManagementApi->reject_non_employee_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->reject_non_employee_request: %s\n" % e) + }''' # NonEmployeeRejectApprovalDecision | + try: + # Reject a Non-Employee Request + new_non_employee_reject_approval_decision = NonEmployeeRejectApprovalDecision.from_json(non_employee_reject_approval_decision) + results = NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id=id, non_employee_reject_approval_decision=new_non_employee_reject_approval_decision) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->reject_non_employee_request: %s\n" % e) - path: /non-employee-records/{id} method: PUT xCodeSample: @@ -7439,7 +6914,7 @@ label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#update-non-employee-record source: | id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) - non_employee_request_body = { + non_employee_request_body = '''{ "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", "lastName" : "Smith", @@ -7452,45 +6927,43 @@ "endDate" : "2021-03-25T00:00:00-05:00", "email" : "william.smith@example.com", "startDate" : "2020-03-24T00:00:00-05:00" - } # NonEmployeeRequestBody | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_non_employee_record(id, Result) - print("The response of NonEmployeeLifecycleManagementApi->update_non_employee_record:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->update_non_employee_record: %s\n" % e) + }''' # NonEmployeeRequestBody | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + try: + # Update Non-Employee Record + new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body) + results = NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id=id, non_employee_request_body=new_non_employee_request_body) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->update_non_employee_record: %s\n" % e) - path: /verified-domains method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#create-domain-dkim source: | - domain_address = { + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_domain_dkim(Result) - print("The response of NotificationsApi->create_domain_dkim:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NotificationsApi->create_domain_dkim: %s\n" % e) + }''' # DomainAddress | + try: + # Verify domain address via DKIM + new_domain_address = DomainAddress.from_json(domain_address) + results = NotificationsApi(api_client).create_domain_dkim(domain_address=new_domain_address) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).create_domain_dkim(new_domain_address) + print("The response of NotificationsApi->create_domain_dkim:\n") + pprint(results) + except Exception as e: + print("Exception when calling NotificationsApi->create_domain_dkim: %s\n" % e) - path: /notification-templates method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#create-notification-template source: | - template_dto = { + template_dto = '''{ "slackTemplate" : "slackTemplate", "footer" : "footer", "teamsTemplate" : "teamsTemplate", @@ -7507,63 +6980,54 @@ "from" : "$__global.emailFromAddress", "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", "key" : "cloud_manual_work_item_summary" - } # TemplateDto | - try: - # Create Notification Template - Result = template_dto.from_json(template_dto) - api_response = api_instance.create_notification_template(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_notification_template(Result) - print("The response of NotificationsApi->create_notification_template:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NotificationsApi->create_notification_template: %s\n" % e) + }''' # TemplateDto | + try: + # Create Notification Template + new_template_dto = TemplateDto.from_json(template_dto) + results = NotificationsApi(api_client).create_notification_template(template_dto=new_template_dto) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).create_notification_template(new_template_dto) + print("The response of NotificationsApi->create_notification_template:\n") + pprint(results) + except Exception as e: + print("Exception when calling NotificationsApi->create_notification_template: %s\n" % e) - path: /verified-from-addresses method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#create-verified-from-address source: | - email_status_dto = { + email_status_dto = '''{ "isVerifiedByDomain" : false, "verificationStatus" : "PENDING", "id" : "id", "email" : "sender@example.com" - } # EmailStatusDto | - try: - # Create Verified From Address - Result = email_status_dto.from_json(email_status_dto) - api_response = api_instance.create_verified_from_address(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_verified_from_address(Result) - print("The response of NotificationsApi->create_verified_from_address:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NotificationsApi->create_verified_from_address: %s\n" % e) + }''' # EmailStatusDto | + try: + # Create Verified From Address + new_email_status_dto = EmailStatusDto.from_json(email_status_dto) + results = NotificationsApi(api_client).create_verified_from_address(email_status_dto=new_email_status_dto) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).create_verified_from_address(new_email_status_dto) + print("The response of NotificationsApi->create_verified_from_address:\n") + pprint(results) + except Exception as e: + print("Exception when calling NotificationsApi->create_verified_from_address: %s\n" % e) - path: /notification-templates/bulk-delete method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#delete-notification-templates-in-bulk source: | - [sailpoint.beta.TemplateBulkDeleteDto()] # List[TemplateBulkDeleteDto] | - template_bulk_delete_dto = { - "medium" : "EMAIL", - "locale" : "en", - "key" : "cloud_manual_work_item_summary" - } # List[TemplateBulkDeleteDto] | - + template_bulk_delete_dto = '''[sailpoint.beta.TemplateBulkDeleteDto()]''' # List[TemplateBulkDeleteDto] | try: - # Bulk Delete Notification Templates - Result = template_bulk_delete_dto.from_json(template_bulk_delete_dto) - api_instance.delete_notification_templates_in_bulk(Result) - - # Below is a request that includes all optional parameters - # api_instance.delete_notification_templates_in_bulk(Result) + # Bulk Delete Notification Templates + new_template_bulk_delete_dto = TemplateBulkDeleteDto.from_json(template_bulk_delete_dto) + NotificationsApi(api_client).delete_notification_templates_in_bulk(template_bulk_delete_dto=new_template_bulk_delete_dto) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling NotificationsApi->delete_notification_templates_in_bulk: %s\n" % e) - path: /verified-from-addresses/{id} method: DELETE xCodeSample: @@ -7572,14 +7036,13 @@ source: | id = 'id_example' # str | # str | try: - # Delete Verified From Address - - api_instance.delete_verified_from_address(id) - - # Below is a request that includes all optional parameters - # api_instance.delete_verified_from_address(id) + # Delete Verified From Address + + NotificationsApi(api_client).delete_verified_from_address(id=id) + # Below is a request that includes all optional parameters + # NotificationsApi(api_client).delete_verified_from_address(id) except Exception as e: - print("Exception when calling NotificationsApi->delete_verified_from_address: %s\n" % e) + print("Exception when calling NotificationsApi->delete_verified_from_address: %s\n" % e) - path: /verified-domains method: GET xCodeSample: @@ -7587,16 +7050,15 @@ label: SDK_tools/sdk/python/beta/methods/notifications#get-dkim-attributes source: | try: - # Get DKIM Attributes - - api_response = api_instance.get_dkim_attributes() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_dkim_attributes() - print("The response of NotificationsApi->get_dkim_attributes:\n") - pprint(api_response) + # Get DKIM Attributes + + results = NotificationsApi(api_client).get_dkim_attributes() + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).get_dkim_attributes() + print("The response of NotificationsApi->get_dkim_attributes:\n") + pprint(results) except Exception as e: - print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) + print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) - path: /mail-from-attributes/{identityId} method: GET xCodeSample: @@ -7605,16 +7067,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_mail_from_attributes(identity_id) - print("The response of NotificationsApi->get_mail_from_attributes:\n") - pprint(api_response) + # Get MAIL FROM Attributes + + results = NotificationsApi(api_client).get_mail_from_attributes(identity_id=identity_id) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).get_mail_from_attributes(identity_id) + print("The response of NotificationsApi->get_mail_from_attributes:\n") + pprint(results) except Exception as e: - print("Exception when calling NotificationsApi->get_mail_from_attributes: %s\n" % e) + print("Exception when calling NotificationsApi->get_mail_from_attributes: %s\n" % e) - path: /notification-templates/{id} method: GET xCodeSample: @@ -7623,16 +7084,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_notification_template(id) - print("The response of NotificationsApi->get_notification_template:\n") - pprint(api_response) + # Get Notification Template By Id + + results = NotificationsApi(api_client).get_notification_template(id=id) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).get_notification_template(id) + print("The response of NotificationsApi->get_notification_template:\n") + pprint(results) except Exception as e: - print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e) + print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e) - path: /notification-template-context method: GET xCodeSample: @@ -7640,16 +7100,15 @@ label: SDK_tools/sdk/python/beta/methods/notifications#get-notifications-template-context source: | try: - # Get Notification Template Context - - api_response = api_instance.get_notifications_template_context() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_notifications_template_context() - print("The response of NotificationsApi->get_notifications_template_context:\n") - pprint(api_response) + # Get Notification Template Context + + results = NotificationsApi(api_client).get_notifications_template_context() + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).get_notifications_template_context() + print("The response of NotificationsApi->get_notifications_template_context:\n") + pprint(results) except Exception as e: - print("Exception when calling NotificationsApi->get_notifications_template_context: %s\n" % e) + print("Exception when calling NotificationsApi->get_notifications_template_context: %s\n" % e) - path: /verified-from-addresses method: GET xCodeSample: @@ -7662,16 +7121,15 @@ filters = 'email eq \"john.doe@company.com\"' # 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: **email**: *eq, ge, le, 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: **email**: *eq, ge, le, sw* (optional) sorters = 'email' # 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: **email** (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: **email** (optional) try: - # List From Addresses - - api_response = api_instance.list_from_addresses() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_from_addresses(limit, offset, count, filters, sorters) - print("The response of NotificationsApi->list_from_addresses:\n") - pprint(api_response) + # List From Addresses + + results = NotificationsApi(api_client).list_from_addresses() + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).list_from_addresses(limit, offset, count, filters, sorters) + print("The response of NotificationsApi->list_from_addresses:\n") + pprint(results) except Exception as e: - print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) + print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) - path: /notification-preferences/{key} method: GET xCodeSample: @@ -7680,16 +7138,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_notification_preferences(key) - print("The response of NotificationsApi->list_notification_preferences:\n") - pprint(api_response) + # List Notification Preferences for tenant. + + results = NotificationsApi(api_client).list_notification_preferences(key=key) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).list_notification_preferences(key) + print("The response of NotificationsApi->list_notification_preferences:\n") + pprint(results) except Exception as e: - print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e) + print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e) - path: /notification-template-defaults method: GET xCodeSample: @@ -7700,16 +7157,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) 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) try: - # List Notification Template Defaults - - api_response = api_instance.list_notification_template_defaults() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_notification_template_defaults(limit, offset, filters) - print("The response of NotificationsApi->list_notification_template_defaults:\n") - pprint(api_response) + # List Notification Template Defaults + + results = NotificationsApi(api_client).list_notification_template_defaults() + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).list_notification_template_defaults(limit, offset, filters) + print("The response of NotificationsApi->list_notification_template_defaults:\n") + pprint(results) except Exception as e: - print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) + print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) - path: /notification-templates method: GET xCodeSample: @@ -7720,64 +7176,61 @@ 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) try: - # List Notification Templates - - api_response = api_instance.list_notification_templates() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_notification_templates(limit, offset, filters) - print("The response of NotificationsApi->list_notification_templates:\n") - pprint(api_response) + # List Notification Templates + + results = NotificationsApi(api_client).list_notification_templates() + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).list_notification_templates(limit, offset, filters) + print("The response of NotificationsApi->list_notification_templates:\n") + pprint(results) except Exception as e: - print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) + print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) - path: /mail-from-attributes method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#put-mail-from-attributes source: | - mail_from_attributes_dto = { + mail_from_attributes_dto = '''{ "identity" : "BobSmith@sailpoint.com", "mailFromDomain" : "example.sailpoint.com" - } # MailFromAttributesDto | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_mail_from_attributes(Result) - print("The response of NotificationsApi->put_mail_from_attributes:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NotificationsApi->put_mail_from_attributes: %s\n" % e) + }''' # MailFromAttributesDto | + try: + # Change MAIL FROM domain + new_mail_from_attributes_dto = MailFromAttributesDto.from_json(mail_from_attributes_dto) + results = NotificationsApi(api_client).put_mail_from_attributes(mail_from_attributes_dto=new_mail_from_attributes_dto) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).put_mail_from_attributes(new_mail_from_attributes_dto) + print("The response of NotificationsApi->put_mail_from_attributes:\n") + pprint(results) + except Exception as e: + print("Exception when calling NotificationsApi->put_mail_from_attributes: %s\n" % e) - path: /send-test-notification method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#send-test-notification source: | - send_test_notification_request_dto = { + send_test_notification_request_dto = '''{ "context" : "{}", "medium" : "EMAIL", "key" : "cloud_manual_work_item_summary" - } # SendTestNotificationRequestDto | + }''' # SendTestNotificationRequestDto | try: - # Send Test Notification - Result = send_test_notification_request_dto.from_json(send_test_notification_request_dto) - api_instance.send_test_notification(Result) - - # Below is a request that includes all optional parameters - # api_instance.send_test_notification(Result) + # Send Test Notification + new_send_test_notification_request_dto = SendTestNotificationRequestDto.from_json(send_test_notification_request_dto) + NotificationsApi(api_client).send_test_notification(send_test_notification_request_dto=new_send_test_notification_request_dto) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling NotificationsApi->send_test_notification: %s\n" % e) - path: /oauth-clients method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/o-auth-clients#create-oauth-client source: | - create_o_auth_client_request = { + create_o_auth_client_request = '''{ "internal" : false, "businessName" : "Acme-Solar", "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", @@ -7793,18 +7246,17 @@ "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], "name" : "Demo API Client", "claimsSupported" : false - } # CreateOAuthClientRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_oauth_client(Result) - print("The response of OAuthClientsApi->create_oauth_client:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling OAuthClientsApi->create_oauth_client: %s\n" % e) + }''' # CreateOAuthClientRequest | + try: + # Create OAuth Client + new_create_o_auth_client_request = CreateOAuthClientRequest.from_json(create_o_auth_client_request) + results = OAuthClientsApi(api_client).create_oauth_client(create_o_auth_client_request=new_create_o_auth_client_request) + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).create_oauth_client(new_create_o_auth_client_request) + print("The response of OAuthClientsApi->create_oauth_client:\n") + pprint(results) + except Exception as e: + print("Exception when calling OAuthClientsApi->create_oauth_client: %s\n" % e) - path: /oauth-clients/{id} method: DELETE xCodeSample: @@ -7813,14 +7265,13 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id try: - # Delete OAuth Client - - api_instance.delete_oauth_client(id) - - # Below is a request that includes all optional parameters - # api_instance.delete_oauth_client(id) + # Delete OAuth Client + + OAuthClientsApi(api_client).delete_oauth_client(id=id) + # Below is a request that includes all optional parameters + # OAuthClientsApi(api_client).delete_oauth_client(id) except Exception as e: - print("Exception when calling OAuthClientsApi->delete_oauth_client: %s\n" % e) + print("Exception when calling OAuthClientsApi->delete_oauth_client: %s\n" % e) - path: /oauth-clients/{id} method: GET xCodeSample: @@ -7829,16 +7280,15 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id try: - # Get OAuth Client - - api_response = api_instance.get_oauth_client(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_oauth_client(id) - print("The response of OAuthClientsApi->get_oauth_client:\n") - pprint(api_response) + # Get OAuth Client + + results = OAuthClientsApi(api_client).get_oauth_client(id=id) + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).get_oauth_client(id) + print("The response of OAuthClientsApi->get_oauth_client:\n") + pprint(results) except Exception as e: - print("Exception when calling OAuthClientsApi->get_oauth_client: %s\n" % e) + print("Exception when calling OAuthClientsApi->get_oauth_client: %s\n" % e) - path: /oauth-clients method: GET xCodeSample: @@ -7847,16 +7297,15 @@ source: | 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_oauth_clients(filters) - print("The response of OAuthClientsApi->list_oauth_clients:\n") - pprint(api_response) + # List OAuth Clients + + results = OAuthClientsApi(api_client).list_oauth_clients() + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).list_oauth_clients(filters) + print("The response of OAuthClientsApi->list_oauth_clients:\n") + pprint(results) except Exception as e: - print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) + print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) - path: /oauth-clients/{id} method: PATCH xCodeSample: @@ -7864,24 +7313,17 @@ label: SDK_tools/sdk/python/beta/methods/o-auth-clients#patch-oauth-client source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # 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 - - try: - # Patch OAuth Client - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_oauth_client(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_oauth_client(id, Result) - print("The response of OAuthClientsApi->patch_oauth_client:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e) + json_patch_operation = '''[{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 + try: + # Patch OAuth Client + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = OAuthClientsApi(api_client).patch_oauth_client(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).patch_oauth_client(id, new_json_patch_operation) + print("The response of OAuthClientsApi->patch_oauth_client:\n") + pprint(results) + except Exception as e: + print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e) - path: /org-config method: GET xCodeSample: @@ -7889,16 +7331,15 @@ label: SDK_tools/sdk/python/beta/methods/org-config#get-org-config source: | try: - # Get Org configuration settings - - api_response = api_instance.get_org_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_org_config() - print("The response of OrgConfigApi->get_org_config:\n") - pprint(api_response) + # Get Org configuration settings + + results = OrgConfigApi(api_client).get_org_config() + # Below is a request that includes all optional parameters + # results = OrgConfigApi(api_client).get_org_config() + print("The response of OrgConfigApi->get_org_config:\n") + pprint(results) except Exception as e: - print("Exception when calling OrgConfigApi->get_org_config: %s\n" % e) + print("Exception when calling OrgConfigApi->get_org_config: %s\n" % e) - path: /org-config/valid-time-zones method: GET xCodeSample: @@ -7906,63 +7347,54 @@ label: SDK_tools/sdk/python/beta/methods/org-config#get-valid-time-zones source: | try: - # Get list of time zones - - api_response = api_instance.get_valid_time_zones() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_valid_time_zones() - print("The response of OrgConfigApi->get_valid_time_zones:\n") - pprint(api_response) + # Get list of time zones + + results = OrgConfigApi(api_client).get_valid_time_zones() + # Below is a request that includes all optional parameters + # results = OrgConfigApi(api_client).get_valid_time_zones() + print("The response of OrgConfigApi->get_valid_time_zones:\n") + pprint(results) except Exception as e: - print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) + print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) - path: /org-config method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/org-config#patch-org-config source: | - [{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", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - try: - # Patch an Org configuration property - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_org_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_org_config(Result) - print("The response of OrgConfigApi->patch_org_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling OrgConfigApi->patch_org_config: %s\n" % e) + json_patch_operation = '''[{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. + try: + # Patch an Org configuration property + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = OrgConfigApi(api_client).patch_org_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = OrgConfigApi(api_client).patch_org_config(new_json_patch_operation) + print("The response of OrgConfigApi->patch_org_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling OrgConfigApi->patch_org_config: %s\n" % e) - path: /password-org-config method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/password-configuration#create-password-org-config source: | - password_org_config = { + password_org_config = '''{ "digitTokenLength" : 9, "digitTokenEnabled" : true, "digitTokenDurationMinutes" : 10, "customInstructionsEnabled" : true - } # PasswordOrgConfig | - try: - # Create Password Org Config - Result = password_org_config.from_json(password_org_config) - api_response = api_instance.create_password_org_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_password_org_config(Result) - print("The response of PasswordConfigurationApi->create_password_org_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordConfigurationApi->create_password_org_config: %s\n" % e) + }''' # PasswordOrgConfig | + try: + # Create Password Org Config + new_password_org_config = PasswordOrgConfig.from_json(password_org_config) + results = PasswordConfigurationApi(api_client).create_password_org_config(password_org_config=new_password_org_config) + # Below is a request that includes all optional parameters + # results = PasswordConfigurationApi(api_client).create_password_org_config(new_password_org_config) + print("The response of PasswordConfigurationApi->create_password_org_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->create_password_org_config: %s\n" % e) - path: /password-org-config method: GET xCodeSample: @@ -7970,39 +7402,37 @@ label: SDK_tools/sdk/python/beta/methods/password-configuration#get-password-org-config source: | try: - # Get Password Org Config - - api_response = api_instance.get_password_org_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_password_org_config() - print("The response of PasswordConfigurationApi->get_password_org_config:\n") - pprint(api_response) + # Get Password Org Config + + results = PasswordConfigurationApi(api_client).get_password_org_config() + # Below is a request that includes all optional parameters + # results = PasswordConfigurationApi(api_client).get_password_org_config() + print("The response of PasswordConfigurationApi->get_password_org_config:\n") + pprint(results) except Exception as e: - print("Exception when calling PasswordConfigurationApi->get_password_org_config: %s\n" % e) + print("Exception when calling PasswordConfigurationApi->get_password_org_config: %s\n" % e) - path: /password-org-config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/password-configuration#put-password-org-config source: | - password_org_config = { + password_org_config = '''{ "digitTokenLength" : 9, "digitTokenEnabled" : true, "digitTokenDurationMinutes" : 10, "customInstructionsEnabled" : true - } # PasswordOrgConfig | - try: - # Update Password Org Config - Result = password_org_config.from_json(password_org_config) - api_response = api_instance.put_password_org_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_password_org_config(Result) - print("The response of PasswordConfigurationApi->put_password_org_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordConfigurationApi->put_password_org_config: %s\n" % e) + }''' # PasswordOrgConfig | + try: + # Update Password Org Config + new_password_org_config = PasswordOrgConfig.from_json(password_org_config) + results = PasswordConfigurationApi(api_client).put_password_org_config(password_org_config=new_password_org_config) + # Below is a request that includes all optional parameters + # results = PasswordConfigurationApi(api_client).put_password_org_config(new_password_org_config) + print("The response of PasswordConfigurationApi->put_password_org_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->put_password_org_config: %s\n" % e) - path: /password-dictionary method: GET xCodeSample: @@ -8010,16 +7440,15 @@ label: SDK_tools/sdk/python/beta/methods/password-dictionary#get-password-dictionary source: | try: - # Get Password Dictionary - - api_response = api_instance.get_password_dictionary() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_password_dictionary() - print("The response of PasswordDictionaryApi->get_password_dictionary:\n") - pprint(api_response) + # Get Password Dictionary + + results = PasswordDictionaryApi(api_client).get_password_dictionary() + # Below is a request that includes all optional parameters + # results = PasswordDictionaryApi(api_client).get_password_dictionary() + print("The response of PasswordDictionaryApi->get_password_dictionary:\n") + pprint(results) except Exception as e: - print("Exception when calling PasswordDictionaryApi->get_password_dictionary: %s\n" % e) + print("Exception when calling PasswordDictionaryApi->get_password_dictionary: %s\n" % e) - path: /password-dictionary method: PUT xCodeSample: @@ -8028,36 +7457,34 @@ source: | file = None # bytearray | (optional) # bytearray | (optional) try: - # Update Password Dictionary - - api_instance.put_password_dictionary() - - # Below is a request that includes all optional parameters - # api_instance.put_password_dictionary(file) + # Update Password Dictionary + + PasswordDictionaryApi(api_client).put_password_dictionary() + # Below is a request that includes all optional parameters + # PasswordDictionaryApi(api_client).put_password_dictionary(file) except Exception as e: - print("Exception when calling PasswordDictionaryApi->put_password_dictionary: %s\n" % e) + print("Exception when calling PasswordDictionaryApi->put_password_dictionary: %s\n" % e) - path: /generate-password-reset-token/digit method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/password-management#create-digit-token source: | - password_digit_token_reset = { + password_digit_token_reset = '''{ "durationMinutes" : 5, "length" : 8, "userId" : "Abby.Smith" - } # PasswordDigitTokenReset | - try: - # Generate a digit token - Result = password_digit_token_reset.from_json(password_digit_token_reset) - api_response = api_instance.create_digit_token(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_digit_token(Result) - print("The response of PasswordManagementApi->create_digit_token:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordManagementApi->create_digit_token: %s\n" % e) + }''' # PasswordDigitTokenReset | + try: + # Generate a digit token + new_password_digit_token_reset = PasswordDigitTokenReset.from_json(password_digit_token_reset) + results = PasswordManagementApi(api_client).create_digit_token(password_digit_token_reset=new_password_digit_token_reset) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).create_digit_token(new_password_digit_token_reset) + print("The response of PasswordManagementApi->create_digit_token:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordManagementApi->create_digit_token: %s\n" % e) - path: /password-change-status/{id} method: GET xCodeSample: @@ -8066,68 +7493,65 @@ source: | id = 'id_example' # str | # str | try: - # Get Password Change Request Status - - api_response = api_instance.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) - print("The response of PasswordManagementApi->get_identity_password_change_status:\n") - pprint(api_response) + # Get Password Change Request Status + + results = PasswordManagementApi(api_client).get_identity_password_change_status(id=id) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).get_identity_password_change_status(id) + print("The response of PasswordManagementApi->get_identity_password_change_status:\n") + pprint(results) except Exception as e: - print("Exception when calling PasswordManagementApi->get_identity_password_change_status: %s\n" % e) + print("Exception when calling PasswordManagementApi->get_identity_password_change_status: %s\n" % e) - path: /query-password-info method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/password-management#query-password-info source: | - password_info_query_dto = { + password_info_query_dto = '''{ "sourceName" : "My-AD", "userName" : "Abby.Smith" - } # PasswordInfoQueryDTO | - try: - # Query Password Info - Result = password_info_query_dto.from_json(password_info_query_dto) - api_response = api_instance.query_password_info(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.query_password_info(Result) - print("The response of PasswordManagementApi->query_password_info:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordManagementApi->query_password_info: %s\n" % e) + }''' # PasswordInfoQueryDTO | + try: + # Query Password Info + new_password_info_query_dto = PasswordInfoQueryDto.from_json(password_info_query_dto) + results = PasswordManagementApi(api_client).query_password_info(password_info_query_dto=new_password_info_query_dto) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).query_password_info(new_password_info_query_dto) + print("The response of PasswordManagementApi->query_password_info:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordManagementApi->query_password_info: %s\n" % e) - path: /set-password method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/password-management#set-identity-password source: | - password_change_request = { + password_change_request = '''{ "sourceId" : "8a807d4c73c545510173c545d4b60246", "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", "identityId" : "8a807d4c73c545510173c545f0a002ff", "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" - } # PasswordChangeRequest | - try: - # Set Identity's Password - Result = password_change_request.from_json(password_change_request) - api_response = api_instance.set_identity_password(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_identity_password(Result) - print("The response of PasswordManagementApi->set_identity_password:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordManagementApi->set_identity_password: %s\n" % e) + }''' # PasswordChangeRequest | + try: + # Set Identity's Password + new_password_change_request = PasswordChangeRequest.from_json(password_change_request) + results = PasswordManagementApi(api_client).set_identity_password(password_change_request=new_password_change_request) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).set_identity_password(new_password_change_request) + print("The response of PasswordManagementApi->set_identity_password:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordManagementApi->set_identity_password: %s\n" % e) - path: /password-policies method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/password-policies#create-password-policy source: | - password_policy_v3_dto = { + password_policy_v3_dto = '''{ "validateAgainstAccountName" : true, "minLength" : 8, "description" : "Information about the Password Policy", @@ -8159,18 +7583,17 @@ "requireStrongAuthOffNetwork" : true, "name" : "PasswordPolicy Example", "maxLength" : 25 - } # PasswordPolicyV3Dto | - try: - # Create Password Policy - Result = password_policy_v3_dto.from_json(password_policy_v3_dto) - api_response = api_instance.create_password_policy(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_password_policy(Result) - print("The response of PasswordPoliciesApi->create_password_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordPoliciesApi->create_password_policy: %s\n" % e) + }''' # PasswordPolicyV3Dto | + try: + # Create Password Policy + new_password_policy_v3_dto = PasswordPolicyV3Dto.from_json(password_policy_v3_dto) + results = PasswordPoliciesApi(api_client).create_password_policy(password_policy_v3_dto=new_password_policy_v3_dto) + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).create_password_policy(new_password_policy_v3_dto) + print("The response of PasswordPoliciesApi->create_password_policy:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->create_password_policy: %s\n" % e) - path: /password-policies/{id} method: DELETE xCodeSample: @@ -8179,14 +7602,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_password_policy(id) + # Delete Password Policy by ID + + PasswordPoliciesApi(api_client).delete_password_policy(id=id) + # Below is a request that includes all optional parameters + # PasswordPoliciesApi(api_client).delete_password_policy(id) except Exception as e: - print("Exception when calling PasswordPoliciesApi->delete_password_policy: %s\n" % e) + print("Exception when calling PasswordPoliciesApi->delete_password_policy: %s\n" % e) - path: /password-policies/{id} method: GET xCodeSample: @@ -8195,16 +7617,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_password_policy_by_id(id) - print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n") - pprint(api_response) + # Get Password Policy by ID + + results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id=id) + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id) + print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n") + pprint(results) except Exception as e: - print("Exception when calling PasswordPoliciesApi->get_password_policy_by_id: %s\n" % e) + print("Exception when calling PasswordPoliciesApi->get_password_policy_by_id: %s\n" % e) - path: /password-policies method: GET xCodeSample: @@ -8215,16 +7636,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) 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) try: - # List Password Policies - - api_response = api_instance.list_password_policies() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_password_policies(limit, offset, count) - print("The response of PasswordPoliciesApi->list_password_policies:\n") - pprint(api_response) + # List Password Policies + + results = PasswordPoliciesApi(api_client).list_password_policies() + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) + print("The response of PasswordPoliciesApi->list_password_policies:\n") + pprint(results) except Exception as e: - print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) + print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) - path: /password-policies/{id} method: PUT xCodeSample: @@ -8232,7 +7652,7 @@ label: SDK_tools/sdk/python/beta/methods/password-policies#set-password-policy source: | id = 'ff808081838d9e9d01838da6a03e0007' # str | The ID of password policy to update. # str | The ID of password policy to update. - password_policy_v3_dto = { + password_policy_v3_dto = '''{ "validateAgainstAccountName" : true, "minLength" : 8, "description" : "Information about the Password Policy", @@ -8264,43 +7684,41 @@ "requireStrongAuthOffNetwork" : true, "name" : "PasswordPolicy Example", "maxLength" : 25 - } # PasswordPolicyV3Dto | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_password_policy(id, Result) - print("The response of PasswordPoliciesApi->set_password_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordPoliciesApi->set_password_policy: %s\n" % e) + }''' # PasswordPolicyV3Dto | + try: + # Update Password Policy by ID + new_password_policy_v3_dto = PasswordPolicyV3Dto.from_json(password_policy_v3_dto) + results = PasswordPoliciesApi(api_client).set_password_policy(id=id, password_policy_v3_dto=new_password_policy_v3_dto) + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).set_password_policy(id, new_password_policy_v3_dto) + print("The response of PasswordPoliciesApi->set_password_policy:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->set_password_policy: %s\n" % e) - path: /password-sync-groups method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/password-sync-groups#create-password-sync-group source: | - password_sync_group = { + password_sync_group = '''{ "created" : "2023-03-16T04:00:00Z", "name" : "Password Sync Group 1", "modified" : "2023-03-16T04:00:00Z", "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } # PasswordSyncGroup | - try: - # Create Password Sync Group - Result = password_sync_group.from_json(password_sync_group) - api_response = api_instance.create_password_sync_group(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_password_sync_group(Result) - print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->create_password_sync_group: %s\n" % e) + }''' # PasswordSyncGroup | + try: + # Create Password Sync Group + new_password_sync_group = PasswordSyncGroup.from_json(password_sync_group) + results = PasswordSyncGroupsApi(api_client).create_password_sync_group(password_sync_group=new_password_sync_group) + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).create_password_sync_group(new_password_sync_group) + print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->create_password_sync_group: %s\n" % e) - path: /password-sync-groups/{id} method: DELETE xCodeSample: @@ -8309,14 +7727,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_password_sync_group(id) + # Delete Password Sync Group by ID + + PasswordSyncGroupsApi(api_client).delete_password_sync_group(id=id) + # Below is a request that includes all optional parameters + # PasswordSyncGroupsApi(api_client).delete_password_sync_group(id) except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->delete_password_sync_group: %s\n" % e) + print("Exception when calling PasswordSyncGroupsApi->delete_password_sync_group: %s\n" % e) - path: /password-sync-groups/{id} method: GET xCodeSample: @@ -8325,16 +7742,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_password_sync_group(id) - print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n") - pprint(api_response) + # Get Password Sync Group by ID + + results = PasswordSyncGroupsApi(api_client).get_password_sync_group(id=id) + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).get_password_sync_group(id) + print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n") + pprint(results) except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->get_password_sync_group: %s\n" % e) + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_group: %s\n" % e) - path: /password-sync-groups method: GET xCodeSample: @@ -8345,16 +7761,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) 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) try: - # Get Password Sync Group List - - api_response = api_instance.get_password_sync_groups() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_password_sync_groups(limit, offset, count) - print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") - pprint(api_response) + # Get Password Sync Group List + + results = PasswordSyncGroupsApi(api_client).get_password_sync_groups() + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) + print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") + pprint(results) except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) - path: /password-sync-groups/{id} method: PUT xCodeSample: @@ -8362,47 +7777,45 @@ label: SDK_tools/sdk/python/beta/methods/password-sync-groups#update-password-sync-group source: | 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 = { + password_sync_group = '''{ "created" : "2023-03-16T04:00:00Z", "name" : "Password Sync Group 1", "modified" : "2023-03-16T04:00:00Z", "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } # PasswordSyncGroup | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_password_sync_group(id, Result) - print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->update_password_sync_group: %s\n" % e) + }''' # PasswordSyncGroup | + try: + # Update Password Sync Group by ID + new_password_sync_group = PasswordSyncGroup.from_json(password_sync_group) + results = PasswordSyncGroupsApi(api_client).update_password_sync_group(id=id, password_sync_group=new_password_sync_group) + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).update_password_sync_group(id, new_password_sync_group) + print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->update_password_sync_group: %s\n" % e) - path: /personal-access-tokens method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/personal-access-tokens#create-personal-access-token source: | - create_personal_access_token_request = { + create_personal_access_token_request = '''{ "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], "accessTokenValiditySeconds" : 36900, "name" : "NodeJS Integration" - } # CreatePersonalAccessTokenRequest | Name and scope of personal access token. - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_personal_access_token(Result) - print("The response of PersonalAccessTokensApi->create_personal_access_token:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PersonalAccessTokensApi->create_personal_access_token: %s\n" % e) + }''' # CreatePersonalAccessTokenRequest | Name and scope of personal access token. + try: + # Create Personal Access Token + new_create_personal_access_token_request = CreatePersonalAccessTokenRequest.from_json(create_personal_access_token_request) + results = PersonalAccessTokensApi(api_client).create_personal_access_token(create_personal_access_token_request=new_create_personal_access_token_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->create_personal_access_token: %s\n" % e) - path: /personal-access-tokens/{id} method: DELETE xCodeSample: @@ -8411,14 +7824,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_personal_access_token(id) + # Delete Personal Access Token + + PersonalAccessTokensApi(api_client).delete_personal_access_token(id=id) + # Below is a request that includes all optional parameters + # PersonalAccessTokensApi(api_client).delete_personal_access_token(id) except Exception as e: - print("Exception when calling PersonalAccessTokensApi->delete_personal_access_token: %s\n" % e) + print("Exception when calling PersonalAccessTokensApi->delete_personal_access_token: %s\n" % e) - path: /personal-access-tokens method: GET xCodeSample: @@ -8428,16 +7840,15 @@ 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_personal_access_tokens(owner_id, filters) - print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") - pprint(api_response) + # List Personal Access Tokens + + results = PersonalAccessTokensApi(api_client).list_personal_access_tokens() + # Below is a request that includes all optional parameters + # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) + print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") + pprint(results) except Exception as e: - print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) + print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) - path: /personal-access-tokens/{id} method: PATCH xCodeSample: @@ -8445,24 +7856,17 @@ label: SDK_tools/sdk/python/beta/methods/personal-access-tokens#patch-personal-access-token source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # 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 - - try: - # Patch Personal Access Token - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_personal_access_token(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_personal_access_token(id, Result) - print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PersonalAccessTokensApi->patch_personal_access_token: %s\n" % e) + json_patch_operation = '''[{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 + try: + # Patch Personal Access Token + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = PersonalAccessTokensApi(api_client).patch_personal_access_token(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = PersonalAccessTokensApi(api_client).patch_personal_access_token(id, new_json_patch_operation) + print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n") + pprint(results) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->patch_personal_access_token: %s\n" % e) - path: /public-identities-config method: GET xCodeSample: @@ -8470,23 +7874,22 @@ label: SDK_tools/sdk/python/beta/methods/public-identities-config#get-public-identity-config source: | try: - # Get Public Identity Config - - api_response = api_instance.get_public_identity_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_public_identity_config() - print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n") - pprint(api_response) + # Get Public Identity Config + + results = PublicIdentitiesConfigApi(api_client).get_public_identity_config() + # Below is a request that includes all optional parameters + # results = PublicIdentitiesConfigApi(api_client).get_public_identity_config() + print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n") + pprint(results) except Exception as e: - print("Exception when calling PublicIdentitiesConfigApi->get_public_identity_config: %s\n" % e) + print("Exception when calling PublicIdentitiesConfigApi->get_public_identity_config: %s\n" % e) - path: /public-identities-config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/public-identities-config#update-public-identity-config source: | - public_identity_config = { + public_identity_config = '''{ "modified" : "2018-06-25T20:22:28.104Z", "attributes" : [ { "name" : "Country", @@ -8500,18 +7903,17 @@ "id" : "2c9180a46faadee4016fb4e018c20639", "type" : "IDENTITY" } - } # PublicIdentityConfig | - try: - # Update Public Identity Config - Result = public_identity_config.from_json(public_identity_config) - api_response = api_instance.update_public_identity_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_public_identity_config(Result) - print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PublicIdentitiesConfigApi->update_public_identity_config: %s\n" % e) + }''' # PublicIdentityConfig | + try: + # Update Public Identity Config + new_public_identity_config = PublicIdentityConfig.from_json(public_identity_config) + results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(public_identity_config=new_public_identity_config) + # Below is a request that includes all optional parameters + # results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(new_public_identity_config) + print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->update_public_identity_config: %s\n" % e) - path: /requestable-objects method: GET xCodeSample: @@ -8519,29 +7921,24 @@ label: SDK_tools/sdk/python/beta/methods/requestable-objects#list-requestable-objects source: | 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) - - 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) + 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) term = 'Finance Role' # str | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) # str | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) - statuses = [sailpoint.beta.RequestableObjectRequestStatus()] # List[RequestableObjectRequestStatus] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) - - statuses = [sailpoint.beta.RequestableObjectRequestStatus()] # List[RequestableObjectRequestStatus] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) + statuses = '''[sailpoint.beta.RequestableObjectRequestStatus()]''' # List[RequestableObjectRequestStatus] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (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) 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) filters = 'name sw \"bob\"' # 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, in, 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: **id**: *eq, in* **name**: *eq, in, sw* (optional) 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) try: - # Requestable Objects List - - api_response = api_instance.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) - print("The response of RequestableObjectsApi->list_requestable_objects:\n") - pprint(api_response) + # Requestable Objects List + + results = RequestableObjectsApi(api_client).list_requestable_objects() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) + print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) - path: /role-insights/requests method: POST xCodeSample: @@ -8549,16 +7946,15 @@ label: SDK_tools/sdk/python/beta/methods/role-insights#create-role-insight-requests source: | try: - # Generate insights for roles - - api_response = api_instance.create_role_insight_requests() - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_role_insight_requests() - print("The response of RoleInsightsApi->create_role_insight_requests:\n") - pprint(api_response) + # Generate insights for roles + + results = RoleInsightsApi(api_client).create_role_insight_requests() + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).create_role_insight_requests() + print("The response of RoleInsightsApi->create_role_insight_requests:\n") + pprint(results) except Exception as e: - print("Exception when calling RoleInsightsApi->create_role_insight_requests: %s\n" % e) + print("Exception when calling RoleInsightsApi->create_role_insight_requests: %s\n" % e) - path: /role-insights/{insightId}/entitlement-changes/download method: GET xCodeSample: @@ -8569,16 +7965,15 @@ 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) try: - # Download entitlement insights for a role - - api_response = api_instance.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) - print("The response of RoleInsightsApi->download_role_insights_entitlements_changes:\n") - pprint(api_response) + # Download entitlement insights for a role + + results = RoleInsightsApi(api_client).download_role_insights_entitlements_changes(insight_id=insight_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling RoleInsightsApi->download_role_insights_entitlements_changes: %s\n" % e) + print("Exception when calling RoleInsightsApi->download_role_insights_entitlements_changes: %s\n" % e) - path: /role-insights/{insightId}/entitlement-changes/{entitlementId}/identities method: GET xCodeSample: @@ -8594,16 +7989,15 @@ 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) filters = 'name sw \"Jan\"' # 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* (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* (optional) try: - # Get identities for a suggested entitlement (for a role) - - api_response = api_instance.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) - print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") - pprint(api_response) + # Get identities for a suggested entitlement (for a role) + + results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id=insight_id, entitlement_id=entitlement_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) + print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) - path: /role-insights/{insightId} method: GET xCodeSample: @@ -8612,16 +8006,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_insight(insight_id) - print("The response of RoleInsightsApi->get_role_insight:\n") - pprint(api_response) + # Get a single role insight + + results = RoleInsightsApi(api_client).get_role_insight(insight_id=insight_id) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insight(insight_id) + print("The response of RoleInsightsApi->get_role_insight:\n") + pprint(results) except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insight: %s\n" % e) + print("Exception when calling RoleInsightsApi->get_role_insight: %s\n" % e) - path: /role-insights method: GET xCodeSample: @@ -8634,16 +8027,15 @@ sorters = 'numberOfUpdates' # 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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) filters = 'name sw \"John\"' # 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* **ownerName**: *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* **ownerName**: *sw* **description**: *sw* (optional) try: - # Get role insights - - api_response = api_instance.get_role_insights() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_insights(offset, limit, count, sorters, filters) - print("The response of RoleInsightsApi->get_role_insights:\n") - pprint(api_response) + # Get role insights + + results = RoleInsightsApi(api_client).get_role_insights() + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insights(offset, limit, count, sorters, filters) + print("The response of RoleInsightsApi->get_role_insights:\n") + pprint(results) except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) + print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) - path: /role-insights/{insightId}/current-entitlements method: GET xCodeSample: @@ -8653,16 +8045,15 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_insights_current_entitlements(insight_id, filters) - print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") - pprint(api_response) + # Get current entitlement for a role + + results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id=insight_id) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, filters) + print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") + pprint(results) except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) + print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) - path: /role-insights/{insightId}/entitlement-changes method: GET xCodeSample: @@ -8673,16 +8064,15 @@ 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) try: - # Get entitlement insights for a role - - api_response = api_instance.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) - print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") - pprint(api_response) + # Get entitlement insights for a role + + results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id=insight_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) + print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) - path: /role-insights/requests/{id} method: GET xCodeSample: @@ -8691,16 +8081,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_insights_requests(id) - print("The response of RoleInsightsApi->get_role_insights_requests:\n") - pprint(api_response) + # Returns metadata from prior request. + + results = RoleInsightsApi(api_client).get_role_insights_requests(id=id) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insights_requests(id) + print("The response of RoleInsightsApi->get_role_insights_requests:\n") + pprint(results) except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insights_requests: %s\n" % e) + print("Exception when calling RoleInsightsApi->get_role_insights_requests: %s\n" % e) - path: /role-insights/summary method: GET xCodeSample: @@ -8708,23 +8097,22 @@ label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights-summary source: | try: - # Get role insights summary information - - api_response = api_instance.get_role_insights_summary() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_insights_summary() - print("The response of RoleInsightsApi->get_role_insights_summary:\n") - pprint(api_response) + # Get role insights summary information + + results = RoleInsightsApi(api_client).get_role_insights_summary() + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insights_summary() + print("The response of RoleInsightsApi->get_role_insights_summary:\n") + pprint(results) except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insights_summary: %s\n" % e) + print("Exception when calling RoleInsightsApi->get_role_insights_summary: %s\n" % e) - path: /roles method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/roles#create-role source: | - role = { + role = '''{ "owner" : { "name" : "support", "id" : "2c9180a46faadee4016fb4e018c20639", @@ -8881,38 +8269,36 @@ }, "id" : "2c918086749d78830174a1a40e121518", "requestable" : true - } # Role | - try: - # Create a Role - Result = role.from_json(role) - api_response = api_instance.create_role(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_role(Result) - print("The response of RolesApi->create_role:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling RolesApi->create_role: %s\n" % e) + }''' # Role | + try: + # Create a Role + new_role = Role.from_json(role) + results = RolesApi(api_client).create_role(role=new_role) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).create_role(new_role) + print("The response of RolesApi->create_role:\n") + pprint(results) + except Exception as e: + print("Exception when calling RolesApi->create_role: %s\n" % e) - path: /roles/bulk-delete method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/roles#delete-bulk-roles source: | - role_bulk_delete_request = { + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_bulk_roles(Result) - print("The response of RolesApi->delete_bulk_roles:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling RolesApi->delete_bulk_roles: %s\n" % e) + }''' # RoleBulkDeleteRequest | + try: + # Delete Role(s) + new_role_bulk_delete_request = RoleBulkDeleteRequest.from_json(role_bulk_delete_request) + results = RolesApi(api_client).delete_bulk_roles(role_bulk_delete_request=new_role_bulk_delete_request) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).delete_bulk_roles(new_role_bulk_delete_request) + print("The response of RolesApi->delete_bulk_roles:\n") + pprint(results) + except Exception as e: + print("Exception when calling RolesApi->delete_bulk_roles: %s\n" % e) - path: /roles/{id} method: DELETE xCodeSample: @@ -8921,14 +8307,13 @@ source: | id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role try: - # Delete a Role - - api_instance.delete_role(id) - - # Below is a request that includes all optional parameters - # api_instance.delete_role(id) + # Delete a Role + + RolesApi(api_client).delete_role(id=id) + # Below is a request that includes all optional parameters + # RolesApi(api_client).delete_role(id) except Exception as e: - print("Exception when calling RolesApi->delete_role: %s\n" % e) + print("Exception when calling RolesApi->delete_role: %s\n" % e) - path: /roles/{id} method: GET xCodeSample: @@ -8937,16 +8322,15 @@ source: | id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role try: - # Get a Role - - api_response = api_instance.get_role(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_role(id) - print("The response of RolesApi->get_role:\n") - pprint(api_response) + # Get a Role + + results = RolesApi(api_client).get_role(id=id) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).get_role(id) + print("The response of RolesApi->get_role:\n") + pprint(results) except Exception as e: - print("Exception when calling RolesApi->get_role: %s\n" % e) + print("Exception when calling RolesApi->get_role: %s\n" % e) - path: /roles/{id}/assigned-identities method: GET xCodeSample: @@ -8960,16 +8344,15 @@ filters = 'name sw Joe' # 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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, 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: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) sorters = 'aliasName,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: **id, name, aliasName, email** (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: **id, name, aliasName, email** (optional) try: - # Identities assigned a Role - - api_response = api_instance.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) - print("The response of RolesApi->get_role_assigned_identities:\n") - pprint(api_response) + # Identities assigned a Role + + results = RolesApi(api_client).get_role_assigned_identities(id=id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) + print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) - path: /roles/{id}/entitlements method: GET xCodeSample: @@ -8983,16 +8366,15 @@ filters = 'attribute eq \"memberOf\"' # 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.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: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) sorters = 'name,-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-results) Sorting is supported for the following fields: **name, attribute, value, created, 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-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) try: - # List role's Entitlements - - api_response = api_instance.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) - print("The response of RolesApi->get_role_entitlements:\n") - pprint(api_response) + # List role's Entitlements + + results = RolesApi(api_client).get_role_entitlements(id=id) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).get_role_entitlements(id, limit, offset, count, filters, sorters) + print("The response of RolesApi->get_role_entitlements:\n") + pprint(results) except Exception as e: - print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) + print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) - path: /roles method: GET xCodeSample: @@ -9008,16 +8390,15 @@ for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) try: - # List Roles - - api_response = api_instance.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) - print("The response of RolesApi->list_roles:\n") - pprint(api_response) + # List Roles + + results = RolesApi(api_client).list_roles() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling RolesApi->list_roles: %s\n" % e) + print("Exception when calling RolesApi->list_roles: %s\n" % e) - path: /roles/{id} method: PATCH xCodeSample: @@ -9025,49 +8406,41 @@ label: SDK_tools/sdk/python/beta/methods/roles#patch-role source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | - - try: - # Patch a specified Role - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_role(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_role(id, Result) - print("The response of RolesApi->patch_role:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling RolesApi->patch_role: %s\n" % e) + json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]''' # List[JsonPatchOperation] | + try: + # Patch a specified Role + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = RolesApi(api_client).patch_role(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).patch_role(id, new_json_patch_operation) + print("The response of RolesApi->patch_role:\n") + pprint(results) + except Exception as e: + print("Exception when calling RolesApi->patch_role: %s\n" % e) - path: /accounts/search-attribute-config method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#create-search-attribute-config source: | - search_attribute_config = { + search_attribute_config = '''{ "displayName" : "New Mail Attribute", "name" : "newMailAttribute", "applicationAttributes" : { "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" } - } # SearchAttributeConfig | - try: - # Create Extended Search Attributes - Result = search_attribute_config.from_json(search_attribute_config) - api_response = api_instance.create_search_attribute_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_search_attribute_config(Result) - print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) + }''' # SearchAttributeConfig | + try: + # Create Extended Search Attributes + new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config) + results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(search_attribute_config=new_search_attribute_config) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config) + print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} method: DELETE xCodeSample: @@ -9076,14 +8449,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_search_attribute_config(name) + # Delete Extended Search Attribute + + SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name) + # Below is a request that includes all optional parameters + # SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name) except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) + print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config method: GET xCodeSample: @@ -9091,16 +8463,15 @@ label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-search-attribute-config source: | try: - # List Extended Search Attributes - - api_response = api_instance.get_search_attribute_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_search_attribute_config() - print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - pprint(api_response) + # List Extended Search Attributes + + results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config() + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config() + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + pprint(results) except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) + print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} method: GET xCodeSample: @@ -9109,16 +8480,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_single_search_attribute_config(name) - print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") - pprint(api_response) + # Get Extended Search Attribute + + results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) + print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") + pprint(results) except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) + print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} method: PATCH xCodeSample: @@ -9126,31 +8496,24 @@ label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#patch-search-attribute-config source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | - - try: - # Update Extended Search Attribute - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_search_attribute_config(name, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_search_attribute_config(name, Result) - print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) + json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | + try: + # Update Extended Search Attribute + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation) + print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) - path: /segments method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/segments#create-segment source: | - segment = { + segment = '''{ "owner" : { "name" : "support", "id" : "2c9180a46faadee4016fb4e018c20639", @@ -9173,18 +8536,17 @@ "description" : "This segment represents xyz", "active" : true, "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - } # Segment | - try: - # Create Segment - Result = segment.from_json(segment) - api_response = api_instance.create_segment(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_segment(Result) - print("The response of SegmentsApi->create_segment:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SegmentsApi->create_segment: %s\n" % e) + }''' # Segment | + try: + # Create Segment + new_segment = Segment.from_json(segment) + results = SegmentsApi(api_client).create_segment(segment=new_segment) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).create_segment(new_segment) + print("The response of SegmentsApi->create_segment:\n") + pprint(results) + except Exception as e: + print("Exception when calling SegmentsApi->create_segment: %s\n" % e) - path: /segments/{id} method: DELETE xCodeSample: @@ -9193,14 +8555,13 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. try: - # Delete Segment by ID - - api_instance.delete_segment(id) - - # Below is a request that includes all optional parameters - # api_instance.delete_segment(id) + # Delete Segment by ID + + SegmentsApi(api_client).delete_segment(id=id) + # Below is a request that includes all optional parameters + # SegmentsApi(api_client).delete_segment(id) except Exception as e: - print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) + print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) - path: /segments/{id} method: GET xCodeSample: @@ -9209,16 +8570,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_segment(id) - print("The response of SegmentsApi->get_segment:\n") - pprint(api_response) + # Get Segment by ID + + results = SegmentsApi(api_client).get_segment(id=id) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + pprint(results) except Exception as e: - print("Exception when calling SegmentsApi->get_segment: %s\n" % e) + print("Exception when calling SegmentsApi->get_segment: %s\n" % e) - path: /segments method: GET xCodeSample: @@ -9229,16 +8589,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) 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) try: - # List Segments - - api_response = api_instance.list_segments() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_segments(limit, offset, count) - print("The response of SegmentsApi->list_segments:\n") - pprint(api_response) + # List Segments + + results = SegmentsApi(api_client).list_segments() + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).list_segments(limit, offset, count) + print("The response of SegmentsApi->list_segments:\n") + pprint(results) except Exception as e: - print("Exception when calling SegmentsApi->list_segments: %s\n" % e) + print("Exception when calling SegmentsApi->list_segments: %s\n" % e) - path: /segments/{id} method: PATCH xCodeSample: @@ -9246,27 +8605,24 @@ label: SDK_tools/sdk/python/beta/methods/segments#patch-segment source: | 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 - - try: - # Update Segment - Result = request_body.from_json(request_body) - api_response = api_instance.patch_segment(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_segment(id, Result) - print("The response of SegmentsApi->patch_segment:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) + 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 + try: + # Update Segment + new_request_body = RequestBody.from_json(request_body) + results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).patch_segment(id, new_request_body) + print("The response of SegmentsApi->patch_segment:\n") + pprint(results) + except Exception as e: + print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) - path: /service-desk-integrations method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/service-desk-integration#create-service-desk-integration source: | - service_desk_integration_dto = { + service_desk_integration_dto = '''{ "ownerRef" : "", "cluster" : "xyzzy999", "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], @@ -9296,18 +8652,17 @@ "clusterRef" : "", "type" : "ServiceNowSDIM", "beforeProvisioningRule" : "" - } # ServiceDeskIntegrationDto | The specifics of a new integration to create - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_service_desk_integration(Result) - print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) + }''' # ServiceDeskIntegrationDto | The specifics of a new integration to create + try: + # Create new Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) + results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(service_desk_integration_dto=new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) + print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) - path: /service-desk-integrations/{id} method: DELETE xCodeSample: @@ -9316,14 +8671,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_service_desk_integration(id) + # Delete a Service Desk integration + + ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id=id) + # Below is a request that includes all optional parameters + # ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) + print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) - path: /service-desk-integrations/{id} method: GET xCodeSample: @@ -9332,16 +8686,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_service_desk_integration(id) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") - pprint(api_response) + # Get a Service Desk integration + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id=id) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") + pprint(results) except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) - path: /service-desk-integrations method: GET xCodeSample: @@ -9354,16 +8707,15 @@ filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # 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* **type**: *eq, in* **cluster**: *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: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) 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) try: - # List existing Service Desk integrations - - api_response = api_instance.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) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") - pprint(api_response) + # List existing Service Desk integrations + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) - path: /service-desk-integrations/templates/{scriptName} method: GET xCodeSample: @@ -9372,16 +8724,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_service_desk_integration_template(script_name) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") - pprint(api_response) + # Service Desk integration template by scriptName + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name=script_name) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") + pprint(results) except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) - path: /service-desk-integrations/types method: GET xCodeSample: @@ -9389,16 +8740,15 @@ label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-types source: | try: - # List Service Desk integration types - - api_response = api_instance.get_service_desk_integration_types() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_service_desk_integration_types() - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - pprint(api_response) + # List Service Desk integration types + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") + pprint(results) except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) - path: /service-desk-integrations/status-check-configuration method: GET xCodeSample: @@ -9406,16 +8756,15 @@ label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-status-check-details source: | try: - # Get the time check configuration - - api_response = api_instance.get_status_check_details() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_status_check_details() - print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") - pprint(api_response) + # Get the time check configuration + + results = ServiceDeskIntegrationApi(api_client).get_status_check_details() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_status_check_details() + print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") + pprint(results) except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) + print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) - path: /service-desk-integrations/{id} method: PATCH xCodeSample: @@ -9423,18 +8772,17 @@ label: SDK_tools/sdk/python/beta/methods/service-desk-integration#patch-service-desk-integration source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_service_desk_integration(id, Result) - print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) + 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 + new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) - path: /service-desk-integrations/{id} method: PUT xCodeSample: @@ -9442,7 +8790,7 @@ label: SDK_tools/sdk/python/beta/methods/service-desk-integration#put-service-desk-integration source: | id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - service_desk_integration_dto = { + service_desk_integration_dto = '''{ "ownerRef" : "", "cluster" : "xyzzy999", "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], @@ -9472,46 +8820,44 @@ "clusterRef" : "", "type" : "ServiceNowSDIM", "beforeProvisioningRule" : "" - } # ServiceDeskIntegrationDto | The specifics of the integration to update - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_service_desk_integration(id, Result) - print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) + }''' # ServiceDeskIntegrationDto | The specifics of the integration to update + try: + # Update a Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) + results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id=id, service_desk_integration_dto=new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) - path: /service-desk-integrations/status-check-configuration method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/service-desk-integration#update-status-check-details source: | - queued_check_config_details = { + queued_check_config_details = '''{ "provisioningStatusCheckIntervalMinutes" : "30", "provisioningMaxStatusCheckDays" : "2" - } # QueuedCheckConfigDetails | The modified time check configuration - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_status_check_details(Result) - print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) + }''' # QueuedCheckConfigDetails | The modified time check configuration + try: + # Update the time check configuration + new_queued_check_config_details = QueuedCheckConfigDetails.from_json(queued_check_config_details) + results = ServiceDeskIntegrationApi(api_client).update_status_check_details(queued_check_config_details=new_queued_check_config_details) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) + print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) - path: /sim-integrations method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/sim-integrations#create-sim-integration source: | - sim_integration_details = { + sim_integration_details = '''{ "cluster" : "xyzzy999", "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", @@ -9528,18 +8874,17 @@ "id" : "2c918085708c274401708c2a8a760001", "type" : "IDENTITY" } - } # SimIntegrationDetails | DTO containing the details of the SIM integration - try: - # Create new SIM integration - Result = sim_integration_details.from_json(sim_integration_details) - api_response = api_instance.create_sim_integration(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_sim_integration(Result) - print("The response of SIMIntegrationsApi->create_sim_integration:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) + }''' # SimIntegrationDetails | DTO containing the details of the SIM integration + try: + # Create new SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).create_sim_integration(sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).create_sim_integration(new_sim_integration_details) + print("The response of SIMIntegrationsApi->create_sim_integration:\n") + pprint(results) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) - path: /sim-integrations/{id} method: DELETE xCodeSample: @@ -9548,14 +8893,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_sim_integration(id) + # Delete a SIM integration + + SIMIntegrationsApi(api_client).delete_sim_integration(id=id) + # Below is a request that includes all optional parameters + # SIMIntegrationsApi(api_client).delete_sim_integration(id) except Exception as e: - print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) + print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) - path: /sim-integrations/{id} method: GET xCodeSample: @@ -9564,16 +8908,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sim_integration(id) - print("The response of SIMIntegrationsApi->get_sim_integration:\n") - pprint(api_response) + # Get a SIM integration details. + + results = SIMIntegrationsApi(api_client).get_sim_integration(id=id) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integration(id) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + pprint(results) except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) - path: /sim-integrations method: GET xCodeSample: @@ -9581,16 +8924,15 @@ label: SDK_tools/sdk/python/beta/methods/sim-integrations#get-sim-integrations source: | try: - # List the existing SIM integrations. - - api_response = api_instance.get_sim_integrations() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sim_integrations() - print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - pprint(api_response) + # List the existing SIM integrations. + + results = SIMIntegrationsApi(api_client).get_sim_integrations() + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integrations() + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") + pprint(results) except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) - path: /sim-integrations/{id}/beforeProvisioningRule method: PATCH xCodeSample: @@ -9598,18 +8940,17 @@ label: SDK_tools/sdk/python/beta/methods/sim-integrations#patch-before-provisioning-rule source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_before_provisioning_rule(id, Result) - print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) + 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. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, new_json_patch) + print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") + pprint(results) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) - path: /sim-integrations/{id} method: PATCH xCodeSample: @@ -9617,18 +8958,17 @@ label: SDK_tools/sdk/python/beta/methods/sim-integrations#patch-sim-attributes source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_sim_attributes(id, Result) - print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) + 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. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, new_json_patch) + print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") + pprint(results) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) - path: /sim-integrations/{id} method: PUT xCodeSample: @@ -9636,7 +8976,7 @@ label: SDK_tools/sdk/python/beta/methods/sim-integrations#put-sim-integration source: | id = '12345' # str | The id of the integration. # str | The id of the integration. - sim_integration_details = { + sim_integration_details = '''{ "cluster" : "xyzzy999", "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", @@ -9653,25 +8993,24 @@ "id" : "2c918085708c274401708c2a8a760001", "type" : "IDENTITY" } - } # SimIntegrationDetails | The full DTO of the integration containing the updated model - try: - # Update an existing SIM integration - Result = sim_integration_details.from_json(sim_integration_details) - api_response = api_instance.put_sim_integration(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_sim_integration(id, Result) - print("The response of SIMIntegrationsApi->put_sim_integration:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) + }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model + try: + # Update an existing SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).put_sim_integration(id, new_sim_integration_details) + print("The response of SIMIntegrationsApi->put_sim_integration:\n") + pprint(results) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) - path: /sod-policies method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#create-sod-policy source: | - sod_policy = { + sod_policy = '''{ "conflictingAccessCriteria" : { "leftCriteria" : { "name" : "money-in", @@ -9726,18 +9065,17 @@ "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", "state" : "ENFORCED", "externalPolicyReference" : "XYZ policy" - } # SodPolicy | - try: - # Create SOD policy - Result = sod_policy.from_json(sod_policy) - api_response = api_instance.create_sod_policy(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_sod_policy(Result) - print("The response of SODPoliciesApi->create_sod_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) + }''' # SodPolicy | + try: + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") + pprint(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) - path: /sod-policies/{id} method: DELETE xCodeSample: @@ -9747,14 +9085,13 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_instance.delete_sod_policy(id, logical) + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) - path: /sod-policies/{id}/schedule method: DELETE xCodeSample: @@ -9763,14 +9100,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_sod_policy_schedule(id) + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) - path: /sod-violation-report/{reportResultId}/download/{fileName} method: GET xCodeSample: @@ -9780,16 +9116,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") - pprint(api_response) + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) - path: /sod-violation-report/{reportResultId}/download method: GET xCodeSample: @@ -9798,16 +9133,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - pprint(api_response) + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) - path: /sod-violation-report method: GET xCodeSample: @@ -9815,16 +9149,15 @@ label: SDK_tools/sdk/python/beta/methods/sod-policies#get-sod-all-report-run-status source: | try: - # Get multi-report run task status - - api_response = api_instance.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() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - pprint(api_response) + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) - path: /sod-policies/{id} method: GET xCodeSample: @@ -9833,16 +9166,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - pprint(api_response) + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) - path: /sod-policies/{id}/schedule method: GET xCodeSample: @@ -9851,16 +9183,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - pprint(api_response) + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) - path: /sod-policies/sod-violation-report-status/{reportResultId} method: GET xCodeSample: @@ -9869,16 +9200,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - pprint(api_response) + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) - path: /sod-policies/{id}/violation-report method: GET xCodeSample: @@ -9887,16 +9217,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - pprint(api_response) + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) - path: /sod-policies method: GET xCodeSample: @@ -9909,16 +9238,15 @@ filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # 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, in* **state**: *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: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) sorters = 'id,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: **id, name, created, modified, description** (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: **id, name, created, modified, description** (optional) try: - # List SOD policies - - api_response = api_instance.list_sod_policies() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") - pprint(api_response) + # List SOD policies + + results = SODPoliciesApi(api_client).list_sod_policies() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) - path: /sod-policies/{id} method: PATCH xCodeSample: @@ -9926,20 +9254,17 @@ label: SDK_tools/sdk/python/beta/methods/sod-policies#patch-sod-policy source: | 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 - - try: - # Patch a SOD policy - Result = request_body.from_json(request_body) - api_response = api_instance.patch_sod_policy(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_sod_policy(id, Result) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) + 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 + try: + # Patch a SOD policy + new_request_body = RequestBody.from_json(request_body) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_request_body) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + pprint(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) - path: /sod-policies/{id}/schedule method: PUT xCodeSample: @@ -9947,7 +9272,7 @@ label: SDK_tools/sdk/python/beta/methods/sod-policies#put-policy-schedule source: | 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 = { + sod_policy_schedule = '''{ "schedule" : { "hours" : { "accountMatchConfig" : { @@ -10032,18 +9357,17 @@ "modified" : "2020-01-01T00:00:00Z", "description" : "Schedule for policy xyz", "emailEmptyResults" : false - } # SodPolicySchedule | - try: - # Update SOD Policy schedule - Result = sod_policy_schedule.from_json(sod_policy_schedule) - api_response = api_instance.put_policy_schedule(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_policy_schedule(id, Result) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + pprint(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) - path: /sod-policies/{id} method: PUT xCodeSample: @@ -10051,7 +9375,7 @@ label: SDK_tools/sdk/python/beta/methods/sod-policies#put-sod-policy source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = { + sod_policy = '''{ "conflictingAccessCriteria" : { "leftCriteria" : { "name" : "money-in", @@ -10106,38 +9430,36 @@ "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", "state" : "ENFORCED", "externalPolicyReference" : "XYZ policy" - } # SodPolicy | - try: - # Update SOD policy by ID - Result = sod_policy.from_json(sod_policy) - api_response = api_instance.put_sod_policy(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_sod_policy(id, Result) - print("The response of SODPoliciesApi->put_sod_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + pprint(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) - path: /sod-violation-report/run method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#start-sod-all-policies-for-org source: | - multi_policy_request = { + multi_policy_request = '''{ "filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ] - } # MultiPolicyRequest | (optional) - try: - # Runs all policies for org - - api_response = api_instance.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) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) - path: /sod-policies/{id}/violation-report/run method: POST xCodeSample: @@ -10146,23 +9468,22 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - pprint(api_response) + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) - path: /sod-violations/predict method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-violations#start-predict-sod-violations source: | - identity_with_new_access = { + identity_with_new_access = '''{ "identityId" : "2c91808568c529c60168cca6f90c1313", "accessRefs" : [ { "type" : "ENTITLEMENT", @@ -10173,18 +9494,17 @@ "id" : "2c918087682f9a86016839c0509c1ab2", "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" } ] - } # IdentityWithNewAccess | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_predict_sod_violations(Result) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + pprint(results) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -10192,7 +9512,7 @@ label: SDK_tools/sdk/python/beta/methods/sources#create-provisioning-policy source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id - provisioning_policy_dto = { + provisioning_policy_dto = '''{ "name" : "example provisioning policy for inactive identities", "description" : "this provisioning policy creates access based on an identity going inactive", "fields" : [ { @@ -10231,25 +9551,24 @@ "type" : "string" } ], "usageType" : "CREATE" - } # ProvisioningPolicyDto | - try: - # Create Provisioning Policy - Result = provisioning_policy_dto.from_json(provisioning_policy_dto) - api_response = api_instance.create_provisioning_policy(source_id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_provisioning_policy(source_id, Result) - print("The response of SourcesApi->create_provisioning_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) + }''' # ProvisioningPolicyDto | + try: + # Create Provisioning Policy + new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto) + results = SourcesApi(api_client).create_provisioning_policy(source_id=source_id, provisioning_policy_dto=new_provisioning_policy_dto) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).create_provisioning_policy(source_id, new_provisioning_policy_dto) + print("The response of SourcesApi->create_provisioning_policy:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) - path: /sources method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#create-source source: | - source = { + source = '''{ "cluster" : { "name" : "Corporate Cluster", "id" : "2c9180866166b5b0016167c32ef31a66", @@ -10331,19 +9650,18 @@ }, "status" : "SOURCE_STATE_HEALTHY", "since" : "2021-09-28T15:48:29.3801666300Z" - } # Source | + }''' # Source | provision_as_csv = false # bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) # bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) try: - # Creates a source in IdentityNow. - Result = source.from_json(source) - api_response = api_instance.create_source(Result, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_source(Result, provision_as_csv) - print("The response of SourcesApi->create_source:\n") - pprint(api_response) + # Creates a source in IdentityNow. + new_source = Source.from_json(source) + results = SourcesApi(api_client).create_source(source=new_source) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).create_source(new_source, provision_as_csv) + print("The response of SourcesApi->create_source:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->create_source: %s\n" % e) + print("Exception when calling SourcesApi->create_source: %s\n" % e) - path: /sources/{sourceId}/schemas method: POST xCodeSample: @@ -10351,18 +9669,17 @@ label: SDK_tools/sdk/python/beta/methods/sources#create-source-schema source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_source_schema(source_id, Result) - print("The response of SourcesApi->create_source_schema:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) + model_schema = '''sailpoint.beta.ModelSchema()''' # ModelSchema | + try: + # Create Schema on Source + new_model_schema = ModelSchema.from_json(model_schema) + results = SourcesApi(api_client).create_source_schema(source_id=source_id, model_schema=new_model_schema) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).create_source_schema(source_id, new_model_schema) + print("The response of SourcesApi->create_source_schema:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) - path: /sources/{id} method: DELETE xCodeSample: @@ -10371,16 +9688,15 @@ source: | id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. try: - # Delete Source by ID - - api_response = api_instance.delete(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete(id) - print("The response of SourcesApi->delete:\n") - pprint(api_response) + # Delete Source by ID + + results = SourcesApi(api_client).delete(id=id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).delete(id) + print("The response of SourcesApi->delete:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->delete: %s\n" % e) + print("Exception when calling SourcesApi->delete: %s\n" % e) - path: /sources/{sourceId}/remove-accounts method: POST xCodeSample: @@ -10389,16 +9705,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_accounts_async(source_id) - print("The response of SourcesApi->delete_accounts_async:\n") - pprint(api_response) + # Remove All Accounts in a Source + + results = SourcesApi(api_client).delete_accounts_async(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).delete_accounts_async(source_id) + print("The response of SourcesApi->delete_accounts_async:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->delete_accounts_async: %s\n" % e) + print("Exception when calling SourcesApi->delete_accounts_async: %s\n" % e) - path: /sources/{sourceId}/native-change-detection-config method: DELETE xCodeSample: @@ -10407,14 +9722,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_native_change_detection_config(source_id) + # Delete Native Change Detection Configuration + + SourcesApi(api_client).delete_native_change_detection_config(source_id=source_id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling SourcesApi->delete_native_change_detection_config: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} method: DELETE xCodeSample: @@ -10424,14 +9738,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_provisioning_policy(source_id, usage_type) + # Delete Provisioning Policy by UsageType + + SourcesApi(api_client).delete_provisioning_policy(source_id=source_id, usage_type=usage_type) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling SourcesApi->delete_provisioning_policy: %s\n" % e) - path: /sources/{sourceId}/schemas/{schemaId} method: DELETE xCodeSample: @@ -10441,14 +9754,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_source_schema(source_id, schema_id) + # Delete Source Schema by ID + + SourcesApi(api_client).delete_source_schema(source_id=source_id, schema_id=schema_id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling SourcesApi->delete_source_schema: %s\n" % e) - path: /sources/{sourceId}/correlation-config method: GET xCodeSample: @@ -10457,16 +9769,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_correlation_config(source_id) - print("The response of SourcesApi->get_correlation_config:\n") - pprint(api_response) + # Get Source Correlation Configuration + + results = SourcesApi(api_client).get_correlation_config(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_correlation_config(source_id) + print("The response of SourcesApi->get_correlation_config:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_correlation_config: %s\n" % e) + print("Exception when calling SourcesApi->get_correlation_config: %s\n" % e) - path: /sources/{sourceId}/native-change-detection-config method: GET xCodeSample: @@ -10475,16 +9786,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_native_change_detection_config(source_id) - print("The response of SourcesApi->get_native_change_detection_config:\n") - pprint(api_response) + # Native Change Detection Configuration + + results = SourcesApi(api_client).get_native_change_detection_config(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_native_change_detection_config(source_id) + print("The response of SourcesApi->get_native_change_detection_config:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_native_change_detection_config: %s\n" % e) + print("Exception when calling SourcesApi->get_native_change_detection_config: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} method: GET xCodeSample: @@ -10494,16 +9804,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_provisioning_policy(source_id, usage_type) - print("The response of SourcesApi->get_provisioning_policy:\n") - pprint(api_response) + # Get Provisioning Policy by UsageType + + results = SourcesApi(api_client).get_provisioning_policy(source_id=source_id, usage_type=usage_type) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_provisioning_policy(source_id, usage_type) + print("The response of SourcesApi->get_provisioning_policy:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) + print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) - path: /sources/{id} method: GET xCodeSample: @@ -10512,16 +9821,15 @@ source: | id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. try: - # Get Source by ID - - api_response = api_instance.get_source(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_source(id) - print("The response of SourcesApi->get_source:\n") - pprint(api_response) + # Get Source by ID + + results = SourcesApi(api_client).get_source(id=id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source(id) + print("The response of SourcesApi->get_source:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_source: %s\n" % e) + print("Exception when calling SourcesApi->get_source: %s\n" % e) - path: /sources/{sourceId}/schemas/accounts method: GET xCodeSample: @@ -10530,14 +9838,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.get_source_accounts_schema(source_id) + # Downloads source accounts schema template + + SourcesApi(api_client).get_source_accounts_schema(source_id=source_id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling SourcesApi->get_source_accounts_schema: %s\n" % e) - path: /sources/{id}/attribute-sync-config method: GET xCodeSample: @@ -10546,16 +9853,15 @@ source: | id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id try: - # Attribute Sync Config - - api_response = api_instance.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) - print("The response of SourcesApi->get_source_attr_sync_config:\n") - pprint(api_response) + # Attribute Sync Config + + results = SourcesApi(api_client).get_source_attr_sync_config(id=id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_attr_sync_config(id) + print("The response of SourcesApi->get_source_attr_sync_config:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_source_attr_sync_config: %s\n" % e) + print("Exception when calling SourcesApi->get_source_attr_sync_config: %s\n" % e) - path: /sources/{id}/connectors/source-config method: GET xCodeSample: @@ -10565,16 +9871,15 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_config(id, locale) - print("The response of SourcesApi->get_source_config:\n") - pprint(api_response) + # Gets source config with language translations + + results = SourcesApi(api_client).get_source_config(id=id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_config(id, locale) + print("The response of SourcesApi->get_source_config:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_source_config: %s\n" % e) + print("Exception when calling SourcesApi->get_source_config: %s\n" % e) - path: /sources/{sourceId}/entitlement-request-config method: GET xCodeSample: @@ -10583,16 +9888,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_entitlement_request_config(source_id) - print("The response of SourcesApi->get_source_entitlement_request_config:\n") - pprint(api_response) + # Get Source Entitlement Request Configuration + + results = SourcesApi(api_client).get_source_entitlement_request_config(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_entitlement_request_config(source_id) + print("The response of SourcesApi->get_source_entitlement_request_config:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_source_entitlement_request_config: %s\n" % e) + print("Exception when calling SourcesApi->get_source_entitlement_request_config: %s\n" % e) - path: /sources/{sourceId}/schemas/entitlements method: GET xCodeSample: @@ -10602,14 +9906,13 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_instance.get_source_entitlements_schema(source_id, schema_name) + # Downloads source entitlements schema template + + SourcesApi(api_client).get_source_entitlements_schema(source_id=source_id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling SourcesApi->get_source_entitlements_schema: %s\n" % e) - path: /sources/{sourceId}/schemas/{schemaId} method: GET xCodeSample: @@ -10619,16 +9922,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_schema(source_id, schema_id) - print("The response of SourcesApi->get_source_schema:\n") - pprint(api_response) + # Get Source Schema by ID + + results = SourcesApi(api_client).get_source_schema(source_id=source_id, schema_id=schema_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_schema(source_id, schema_id) + print("The response of SourcesApi->get_source_schema:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) + print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) - path: /sources/{sourceId}/schemas method: GET xCodeSample: @@ -10639,16 +9941,15 @@ 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) try: - # List Schemas on Source - - api_response = api_instance.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) - print("The response of SourcesApi->get_source_schemas:\n") - pprint(api_response) + # List Schemas on Source + + results = SourcesApi(api_client).get_source_schemas(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) + print("The response of SourcesApi->get_source_schemas:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) + print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) - path: /sources/{sourceId}/load-accounts method: POST xCodeSample: @@ -10659,16 +9960,15 @@ 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) try: - # Account Aggregation - - api_response = api_instance.import_accounts(source_id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.import_accounts(source_id, file, disable_optimization) - print("The response of SourcesApi->import_accounts:\n") - pprint(api_response) + # Account Aggregation + + results = SourcesApi(api_client).import_accounts(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_accounts(source_id, file, disable_optimization) + print("The response of SourcesApi->import_accounts:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->import_accounts: %s\n" % e) + print("Exception when calling SourcesApi->import_accounts: %s\n" % e) - path: /sources/{sourceId}/load-entitlements method: POST xCodeSample: @@ -10678,16 +9978,15 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.import_entitlements(source_id, file) - print("The response of SourcesApi->import_entitlements:\n") - pprint(api_response) + # Entitlement Aggregation + + results = SourcesApi(api_client).import_entitlements(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_entitlements(source_id, file) + print("The response of SourcesApi->import_entitlements:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->import_entitlements: %s\n" % e) + print("Exception when calling SourcesApi->import_entitlements: %s\n" % e) - path: /sources/{sourceId}/schemas/accounts method: POST xCodeSample: @@ -10697,16 +9996,15 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.import_source_accounts_schema(source_id, file) - print("The response of SourcesApi->import_source_accounts_schema:\n") - pprint(api_response) + # Uploads source accounts schema template + + results = SourcesApi(api_client).import_source_accounts_schema(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_source_accounts_schema(source_id, file) + print("The response of SourcesApi->import_source_accounts_schema:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->import_source_accounts_schema: %s\n" % e) + print("Exception when calling SourcesApi->import_source_accounts_schema: %s\n" % e) - path: /sources/{sourceId}/upload-connector-file method: POST xCodeSample: @@ -10716,16 +10014,15 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.import_source_connector_file(source_id, file) - print("The response of SourcesApi->import_source_connector_file:\n") - pprint(api_response) + # Upload connector file to source + + results = SourcesApi(api_client).import_source_connector_file(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_source_connector_file(source_id, file) + print("The response of SourcesApi->import_source_connector_file:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->import_source_connector_file: %s\n" % e) + print("Exception when calling SourcesApi->import_source_connector_file: %s\n" % e) - path: /sources/{sourceId}/schemas/entitlements method: POST xCodeSample: @@ -10736,16 +10033,15 @@ schema_name = '?schemaName=group' # str | Name of entitlement schema (optional) # str | Name of entitlement schema (optional) file = None # bytearray | (optional) # bytearray | (optional) try: - # Uploads source entitlements schema template - - api_response = api_instance.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) - print("The response of SourcesApi->import_source_entitlements_schema:\n") - pprint(api_response) + # Uploads source entitlements schema template + + results = SourcesApi(api_client).import_source_entitlements_schema(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_source_entitlements_schema(source_id, schema_name, file) + print("The response of SourcesApi->import_source_entitlements_schema:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->import_source_entitlements_schema: %s\n" % e) + print("Exception when calling SourcesApi->import_source_entitlements_schema: %s\n" % e) - path: /sources/{sourceId}/load-uncorrelated-accounts method: POST xCodeSample: @@ -10755,16 +10051,15 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.import_uncorrelated_accounts(source_id, file) - print("The response of SourcesApi->import_uncorrelated_accounts:\n") - pprint(api_response) + # Process Uncorrelated Accounts + + results = SourcesApi(api_client).import_uncorrelated_accounts(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_uncorrelated_accounts(source_id, file) + print("The response of SourcesApi->import_uncorrelated_accounts:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->import_uncorrelated_accounts: %s\n" % e) + print("Exception when calling SourcesApi->import_uncorrelated_accounts: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: GET xCodeSample: @@ -10773,16 +10068,15 @@ source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id try: - # Lists ProvisioningPolicies - - api_response = api_instance.list_provisioning_policies(source_id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_provisioning_policies(source_id) - print("The response of SourcesApi->list_provisioning_policies:\n") - pprint(api_response) + # Lists ProvisioningPolicies + + results = SourcesApi(api_client).list_provisioning_policies(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).list_provisioning_policies(source_id) + print("The response of SourcesApi->list_provisioning_policies:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) + print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) - path: /sources method: GET xCodeSample: @@ -10797,16 +10091,15 @@ for_subadmin = 'name' # str | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) # str | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) include_idn_source = False # bool | Include the IdentityNow source in the response. (optional) (default to False) # bool | Include the IdentityNow source in the response. (optional) (default to False) try: - # Lists all sources in IdentityNow. - - api_response = api_instance.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) - print("The response of SourcesApi->list_sources:\n") - pprint(api_response) + # Lists all sources in IdentityNow. + + results = SourcesApi(api_client).list_sources() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling SourcesApi->list_sources: %s\n" % e) + print("Exception when calling SourcesApi->list_sources: %s\n" % e) - path: /sources/{sourceId}/connector/peek-resource-objects method: POST xCodeSample: @@ -10814,21 +10107,20 @@ label: SDK_tools/sdk/python/beta/methods/sources#peek-resource-objects source: | source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source - resource_objects_request = { + resource_objects_request = '''{ "maxCount" : 100, "objectType" : "group" - } # ResourceObjectsRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.peek_resource_objects(source_id, Result) - print("The response of SourcesApi->peek_resource_objects:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->peek_resource_objects: %s\n" % e) + }''' # ResourceObjectsRequest | + try: + # Peek source connector's resource objects + new_resource_objects_request = ResourceObjectsRequest.from_json(resource_objects_request) + results = SourcesApi(api_client).peek_resource_objects(source_id=source_id, resource_objects_request=new_resource_objects_request) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).peek_resource_objects(source_id, new_resource_objects_request) + print("The response of SourcesApi->peek_resource_objects:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->peek_resource_objects: %s\n" % e) - path: /sources/{sourceId}/connector/ping-cluster method: POST xCodeSample: @@ -10837,16 +10129,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.ping_cluster(source_id) - print("The response of SourcesApi->ping_cluster:\n") - pprint(api_response) + # Ping cluster for source connector + + results = SourcesApi(api_client).ping_cluster(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).ping_cluster(source_id) + print("The response of SourcesApi->ping_cluster:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->ping_cluster: %s\n" % e) + print("Exception when calling SourcesApi->ping_cluster: %s\n" % e) - path: /sources/{sourceId}/correlation-config method: PUT xCodeSample: @@ -10854,7 +10145,7 @@ label: SDK_tools/sdk/python/beta/methods/sources#put-correlation-config source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id - correlation_config = { + correlation_config = '''{ "attributeAssignments" : [ { "filterString" : "first_name == \"John\"", "ignoreCase" : false, @@ -10874,18 +10165,17 @@ } ], "name" : "Source [source] Account Correlation", "id" : "2c9180835d191a86015d28455b4a2329" - } # CorrelationConfig | - try: - # Update Source Correlation Configuration - Result = correlation_config.from_json(correlation_config) - api_response = api_instance.put_correlation_config(source_id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_correlation_config(source_id, Result) - print("The response of SourcesApi->put_correlation_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->put_correlation_config: %s\n" % e) + }''' # CorrelationConfig | + try: + # Update Source Correlation Configuration + new_correlation_config = CorrelationConfig.from_json(correlation_config) + results = SourcesApi(api_client).put_correlation_config(source_id=source_id, correlation_config=new_correlation_config) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).put_correlation_config(source_id, new_correlation_config) + print("The response of SourcesApi->put_correlation_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_correlation_config: %s\n" % e) - path: /sources/{sourceId}/native-change-detection-config method: PUT xCodeSample: @@ -10893,25 +10183,24 @@ label: SDK_tools/sdk/python/beta/methods/sources#put-native-change-detection-config source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id - native_change_detection_config = { + native_change_detection_config = '''{ "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], "allNonEntitlementAttributes" : false, "allEntitlements" : false, "enabled" : true - } # NativeChangeDetectionConfig | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_native_change_detection_config(source_id, Result) - print("The response of SourcesApi->put_native_change_detection_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->put_native_change_detection_config: %s\n" % e) + }''' # NativeChangeDetectionConfig | + try: + # Update Native Change Detection Configuration + new_native_change_detection_config = NativeChangeDetectionConfig.from_json(native_change_detection_config) + results = SourcesApi(api_client).put_native_change_detection_config(source_id=source_id, native_change_detection_config=new_native_change_detection_config) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SourcesApi->put_native_change_detection_config: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} method: PUT xCodeSample: @@ -10920,7 +10209,7 @@ source: | 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 = { + provisioning_policy_dto = '''{ "name" : "example provisioning policy for inactive identities", "description" : "this provisioning policy creates access based on an identity going inactive", "fields" : [ { @@ -10959,18 +10248,17 @@ "type" : "string" } ], "usageType" : "CREATE" - } # ProvisioningPolicyDto | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) - print("The response of SourcesApi->put_provisioning_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) + }''' # ProvisioningPolicyDto | + try: + # Update Provisioning Policy by UsageType + new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto) + results = SourcesApi(api_client).put_provisioning_policy(source_id=source_id, usage_type=usage_type, provisioning_policy_dto=new_provisioning_policy_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) - path: /sources/{id} method: PUT xCodeSample: @@ -10978,7 +10266,7 @@ label: SDK_tools/sdk/python/beta/methods/sources#put-source source: | id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. - source = { + source = '''{ "cluster" : { "name" : "Corporate Cluster", "id" : "2c9180866166b5b0016167c32ef31a66", @@ -11060,18 +10348,17 @@ }, "status" : "SOURCE_STATE_HEALTHY", "since" : "2021-09-28T15:48:29.3801666300Z" - } # Source | - try: - # Update Source (Full) - Result = source.from_json(source) - api_response = api_instance.put_source(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_source(id, Result) - print("The response of SourcesApi->put_source:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->put_source: %s\n" % e) + }''' # Source | + try: + # Update Source (Full) + new_source = Source.from_json(source) + results = SourcesApi(api_client).put_source(id=id, source=new_source) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).put_source(id, new_source) + print("The response of SourcesApi->put_source:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_source: %s\n" % e) - path: /sources/{id}/attribute-sync-config method: PUT xCodeSample: @@ -11079,7 +10366,7 @@ label: SDK_tools/sdk/python/beta/methods/sources#put-source-attr-sync-config source: | id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id - attr_sync_source_config = { + attr_sync_source_config = '''{ "attributes" : [ { "name" : "email", "displayName" : "Email", @@ -11096,18 +10383,17 @@ "id" : "2c9180835d191a86015d28455b4b232a", "type" : "SOURCE" } - } # AttrSyncSourceConfig | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_source_attr_sync_config(id, Result) - print("The response of SourcesApi->put_source_attr_sync_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->put_source_attr_sync_config: %s\n" % e) + }''' # AttrSyncSourceConfig | + try: + # Update Attribute Sync Config + new_attr_sync_source_config = AttrSyncSourceConfig.from_json(attr_sync_source_config) + results = SourcesApi(api_client).put_source_attr_sync_config(id=id, attr_sync_source_config=new_attr_sync_source_config) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SourcesApi->put_source_attr_sync_config: %s\n" % e) - path: /sources/{sourceId}/schemas/{schemaId} method: PUT xCodeSample: @@ -11116,18 +10402,17 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_source_schema(source_id, schema_id, Result) - print("The response of SourcesApi->put_source_schema:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) + model_schema = '''sailpoint.beta.ModelSchema()''' # ModelSchema | + try: + # Update Source Schema (Full) + new_model_schema = ModelSchema.from_json(model_schema) + results = SourcesApi(api_client).put_source_schema(source_id=source_id, schema_id=schema_id, model_schema=new_model_schema) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).put_source_schema(source_id, schema_id, new_model_schema) + print("The response of SourcesApi->put_source_schema:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) - path: /sources/{sourceId}/synchronize-attributes method: POST xCodeSample: @@ -11136,16 +10421,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.sync_attributes_for_source(source_id) - print("The response of SourcesApi->sync_attributes_for_source:\n") - pprint(api_response) + # Synchronize single source attributes. + + results = SourcesApi(api_client).sync_attributes_for_source(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).sync_attributes_for_source(source_id) + print("The response of SourcesApi->sync_attributes_for_source:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->sync_attributes_for_source: %s\n" % e) + print("Exception when calling SourcesApi->sync_attributes_for_source: %s\n" % e) - path: /sources/{sourceId}/connector/test-configuration method: POST xCodeSample: @@ -11154,16 +10438,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.test_source_configuration(source_id) - print("The response of SourcesApi->test_source_configuration:\n") - pprint(api_response) + # Test configuration for source connector + + results = SourcesApi(api_client).test_source_configuration(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).test_source_configuration(source_id) + print("The response of SourcesApi->test_source_configuration:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->test_source_configuration: %s\n" % e) + print("Exception when calling SourcesApi->test_source_configuration: %s\n" % e) - path: /sources/{sourceId}/connector/check-connection method: POST xCodeSample: @@ -11172,16 +10455,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.test_source_connection(source_id) - print("The response of SourcesApi->test_source_connection:\n") - pprint(api_response) + # Check connection for source connector. + + results = SourcesApi(api_client).test_source_connection(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).test_source_connection(source_id) + print("The response of SourcesApi->test_source_connection:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->test_source_connection: %s\n" % e) + print("Exception when calling SourcesApi->test_source_connection: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/bulk-update method: POST xCodeSample: @@ -11189,59 +10471,17 @@ label: SDK_tools/sdk/python/beta/methods/sources#update-provisioning-policies-in-bulk source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - [sailpoint.beta.ProvisioningPolicyDto()] # List[ProvisioningPolicyDto] | - provisioning_policy_dto = { - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - } # List[ProvisioningPolicyDto] | - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) - print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) + provisioning_policy_dto = '''[sailpoint.beta.ProvisioningPolicyDto()]''' # List[ProvisioningPolicyDto] | + try: + # Bulk Update Provisioning Policies + new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto) + results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id=source_id, provisioning_policy_dto=new_provisioning_policy_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} method: PATCH xCodeSample: @@ -11250,24 +10490,17 @@ source: | 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. - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) - print("The response of SourcesApi->update_provisioning_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) + json_patch_operation = '''[{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. + try: + # Partial update of Provisioning Policy + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SourcesApi(api_client).update_provisioning_policy(source_id=source_id, usage_type=usage_type, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) - path: /sources/{id} method: PATCH xCodeSample: @@ -11275,24 +10508,17 @@ label: SDK_tools/sdk/python/beta/methods/sources#update-source source: | 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 = { - "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). - - try: - # Update Source (Partial) - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_source(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_source(id, Result) - print("The response of SourcesApi->update_source:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->update_source: %s\n" % e) + json_patch_operation = '''[{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). + try: + # Update Source (Partial) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SourcesApi(api_client).update_source(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).update_source(id, new_json_patch_operation) + print("The response of SourcesApi->update_source:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->update_source: %s\n" % e) - path: /sources/{sourceId}/entitlement-request-config method: PUT xCodeSample: @@ -11300,7 +10526,7 @@ label: SDK_tools/sdk/python/beta/methods/sources#update-source-entitlement-request-config source: | source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id - source_entitlement_request_config = { + source_entitlement_request_config = '''{ "accessRequestConfig" : { "denialCommentRequired" : false, "approvalSchemes" : [ { @@ -11312,18 +10538,17 @@ } ], "requestCommentRequired" : true } - } # SourceEntitlementRequestConfig | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_source_entitlement_request_config(source_id, Result) - print("The response of SourcesApi->update_source_entitlement_request_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->update_source_entitlement_request_config: %s\n" % e) + }''' # SourceEntitlementRequestConfig | + try: + # Update Source Entitlement Request Configuration + new_source_entitlement_request_config = SourceEntitlementRequestConfig.from_json(source_entitlement_request_config) + results = SourcesApi(api_client).update_source_entitlement_request_config(source_id=source_id, source_entitlement_request_config=new_source_entitlement_request_config) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SourcesApi->update_source_entitlement_request_config: %s\n" % e) - path: /sources/{sourceId}/schemas/{schemaId} method: PATCH xCodeSample: @@ -11332,24 +10557,17 @@ source: | 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. - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_source_schema(source_id, schema_id, Result) - print("The response of SourcesApi->update_source_schema:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) + json_patch_operation = '''[{op=replace, path=/displayAttribute, value={new-display-attribute=null}}]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + try: + # Update Source Schema (Partial) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SourcesApi(api_client).update_source_schema(source_id=source_id, schema_id=schema_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) - path: /source-usages/{sourceId}/status method: GET xCodeSample: @@ -11358,16 +10576,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") - pprint(api_response) + # Finds status of source usage + + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + pprint(results) except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) - path: /source-usages/{sourceId}/summaries method: GET xCodeSample: @@ -11380,36 +10597,34 @@ 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) sorters = '-date' # 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: **date** (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: **date** (optional) try: - # Returns source usage insights - - api_response = api_instance.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) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - pprint(api_response) + # Returns source usage insights + + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sp-config/export method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/sp-config#export-sp-config source: | - export_payload = { + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.export_sp_config(Result) - print("The response of SPConfigApi->export_sp_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) + }''' # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + new_export_payload = ExportPayload.from_json(export_payload) + results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).export_sp_config(new_export_payload) + print("The response of SPConfigApi->export_sp_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) - path: /sp-config/export/{id}/download method: GET xCodeSample: @@ -11418,16 +10633,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sp_config_export(id) - print("The response of SPConfigApi->get_sp_config_export:\n") - pprint(api_response) + # Download export job result. + + results = SPConfigApi(api_client).get_sp_config_export(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + pprint(results) except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) - path: /sp-config/export/{id} method: GET xCodeSample: @@ -11436,16 +10650,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sp_config_export_status(id) - print("The response of SPConfigApi->get_sp_config_export_status:\n") - pprint(api_response) + # Get export job status + + results = SPConfigApi(api_client).get_sp_config_export_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + pprint(results) except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) - path: /sp-config/import/{id}/download method: GET xCodeSample: @@ -11454,16 +10667,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sp_config_import(id) - print("The response of SPConfigApi->get_sp_config_import:\n") - pprint(api_response) + # Download import job result + + results = SPConfigApi(api_client).get_sp_config_import(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + pprint(results) except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) - path: /sp-config/import/{id} method: GET xCodeSample: @@ -11472,16 +10684,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sp_config_import_status(id) - print("The response of SPConfigApi->get_sp_config_import_status:\n") - pprint(api_response) + # Get import job status + + results = SPConfigApi(api_client).get_sp_config_import_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + pprint(results) except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) - path: /sp-config/import method: POST xCodeSample: @@ -11490,18 +10701,17 @@ source: | 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) - try: - # Initiates configuration objects import job - - api_response = api_instance.import_sp_config(data, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.import_sp_config(data, preview, options) - print("The response of SPConfigApi->import_sp_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) + options = '''sailpoint.beta.ImportOptions()''' # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + results = SPConfigApi(api_client).import_sp_config(data=data) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) - path: /sp-config/config-objects method: GET xCodeSample: @@ -11509,16 +10719,15 @@ label: SDK_tools/sdk/python/beta/methods/sp-config#list-sp-config-objects source: | try: - # Get config object details - - api_response = api_instance.list_sp_config_objects() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_sp_config_objects() - print("The response of SPConfigApi->list_sp_config_objects:\n") - pprint(api_response) + # Get config object details + + results = SPConfigApi(api_client).list_sp_config_objects() + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + pprint(results) except Exception as e: - print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -11527,16 +10736,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sed_batch_stats(batch_id) - print("The response of SuggestedEntitlementDescriptionApi->get_sed_batch_stats:\n") - pprint(api_response) + # Submit Sed Batch Stats Request + + results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id=batch_id) + # Below is a request that includes all optional parameters + # results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id) + print("The response of SuggestedEntitlementDescriptionApi->get_sed_batch_stats:\n") + pprint(results) except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batch_stats: %s\n" % e) + print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batch_stats: %s\n" % e) - path: /suggested-entitlement-description-batches method: GET xCodeSample: @@ -11544,16 +10752,15 @@ label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#get-sed-batches source: | try: - # List Sed Batch Request - - api_response = api_instance.get_sed_batches() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sed_batches() - print("The response of SuggestedEntitlementDescriptionApi->get_sed_batches:\n") - pprint(api_response) + # List Sed Batch Request + + results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches() + # Below is a request that includes all optional parameters + # results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches() + print("The response of SuggestedEntitlementDescriptionApi->get_sed_batches:\n") + pprint(results) except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batches: %s\n" % e) + print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batches: %s\n" % e) - path: /suggested-entitlement-descriptions method: GET xCodeSample: @@ -11568,16 +10775,15 @@ requested_by_anyone = requested-by-anyone=true # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) show_pending_status_only = show-pending-status-only=true # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) try: - # List Suggested Entitlement Descriptions - - api_response = api_instance.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) - print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") - pprint(api_response) + # List Suggested Entitlement Descriptions + + results = SuggestedEntitlementDescriptionApi(api_client).list_seds() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) + print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) - path: /suggested-entitlement-descriptions method: PATCH xCodeSample: @@ -11585,91 +10791,77 @@ label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#patch-sed source: | 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 = { - "op" : "replace", - "path" : "status", - "value" : "approved" - } # List[SedPatch] | Sed Patch Request - - try: - # Patch Suggested Entitlement Description - Result = sed_patch.from_json(sed_patch) - api_response = api_instance.patch_sed(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_sed(id, Result) - print("The response of SuggestedEntitlementDescriptionApi->patch_sed:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->patch_sed: %s\n" % e) + sed_patch = '''[sailpoint.beta.SedPatch()]''' # List[SedPatch] | Sed Patch Request + try: + # Patch Suggested Entitlement Description + new_sed_patch = SedPatch.from_json(sed_patch) + results = SuggestedEntitlementDescriptionApi(api_client).patch_sed(id=id, sed_patch=new_sed_patch) + # Below is a request that includes all optional parameters + # results = SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, new_sed_patch) + print("The response of SuggestedEntitlementDescriptionApi->patch_sed:\n") + pprint(results) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->patch_sed: %s\n" % e) - path: /suggested-entitlement-description-approvals method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#submit-sed-approval source: | - [sailpoint.beta.SedApproval()] # List[SedApproval] | Sed Approval - sed_approval = { - "items" : "016629d1-1d25-463f-97f3-c6686846650" - } # List[SedApproval] | Sed Approval - - try: - # Submit Bulk Approval Request - Result = sed_approval.from_json(sed_approval) - api_response = api_instance.submit_sed_approval(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.submit_sed_approval(Result) - print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) + sed_approval = '''[sailpoint.beta.SedApproval()]''' # List[SedApproval] | Sed Approval + try: + # Submit Bulk Approval Request + new_sed_approval = SedApproval.from_json(sed_approval) + results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(sed_approval=new_sed_approval) + # Below is a request that includes all optional parameters + # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") + pprint(results) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) - path: /suggested-entitlement-description-assignments method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#submit-sed-assignment source: | - sed_assignment = { + sed_assignment = '''{ "assignee" : { "type" : "SOURCE_OWNER", "value" : "016629d1-1d25-463f-97f3-c6686846650" }, "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] - } # SedAssignment | Sed Assignment Request - try: - # Submit Sed Assignment Request - Result = sed_assignment.from_json(sed_assignment) - api_response = api_instance.submit_sed_assignment(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.submit_sed_assignment(Result) - print("The response of SuggestedEntitlementDescriptionApi->submit_sed_assignment:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_assignment: %s\n" % e) + }''' # SedAssignment | Sed Assignment Request + try: + # Submit Sed Assignment Request + new_sed_assignment = SedAssignment.from_json(sed_assignment) + results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(sed_assignment=new_sed_assignment) + # Below is a request that includes all optional parameters + # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(new_sed_assignment) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_assignment:\n") + pprint(results) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_assignment: %s\n" % e) - path: /suggested-entitlement-description-batches method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#submit-sed-batch-request source: | - sed_batch_request = { + 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" ] - } # SedBatchRequest | Sed Batch Request (optional) - try: - # Submit Sed Batch Request - - api_response = api_instance.submit_sed_batch_request() - - # Below is a request that includes all optional parameters - # api_response = api_instance.submit_sed_batch_request(Result) - print("The response of SuggestedEntitlementDescriptionApi->submit_sed_batch_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_batch_request: %s\n" % e) + }''' # SedBatchRequest | Sed Batch Request (optional) + try: + # Submit Sed Batch Request + + results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request() + # Below is a request that includes all optional parameters + # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request(new_sed_batch_request) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_batch_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_batch_request: %s\n" % e) - path: /tagged-objects/{type}/{id} method: DELETE xCodeSample: @@ -11679,21 +10871,20 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_tagged_object(type, id) + # Delete Object Tags + + TaggedObjectsApi(api_client).delete_tagged_object(type=type, id=id) + # Below is a request that includes all optional parameters + # TaggedObjectsApi(api_client).delete_tagged_object(type, id) except Exception as e: - print("Exception when calling TaggedObjectsApi->delete_tagged_object: %s\n" % e) + print("Exception when calling TaggedObjectsApi->delete_tagged_object: %s\n" % e) - path: /tagged-objects/bulk-remove method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/tagged-objects#delete-tags-to-many-object source: | - bulk_tagged_object = { + bulk_tagged_object = '''{ "objectRefs" : [ { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", @@ -11705,16 +10896,15 @@ } ], "operation" : "MERGE", "tags" : [ "BU_FINANCE", "PCI" ] - } # BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + }''' # BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. try: - # Remove Tags from Multiple Objects - Result = bulk_tagged_object.from_json(bulk_tagged_object) - api_instance.delete_tags_to_many_object(Result) - - # Below is a request that includes all optional parameters - # api_instance.delete_tags_to_many_object(Result) + # Remove Tags from Multiple Objects + new_bulk_tagged_object = BulkTaggedObject.from_json(bulk_tagged_object) + TaggedObjectsApi(api_client).delete_tags_to_many_object(bulk_tagged_object=new_bulk_tagged_object) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling TaggedObjectsApi->delete_tags_to_many_object: %s\n" % e) - path: /tagged-objects/{type}/{id} method: GET xCodeSample: @@ -11724,16 +10914,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_tagged_object(type, id) - print("The response of TaggedObjectsApi->get_tagged_object:\n") - pprint(api_response) + # Get Tagged Object + + results = TaggedObjectsApi(api_client).get_tagged_object(type=type, id=id) + # Below is a request that includes all optional parameters + # results = TaggedObjectsApi(api_client).get_tagged_object(type, id) + print("The response of TaggedObjectsApi->get_tagged_object:\n") + pprint(results) except Exception as e: - print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e) + print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e) - path: /tagged-objects method: GET xCodeSample: @@ -11745,16 +10934,15 @@ 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) filters = 'tagName eq \"BU_FINANCE\"' # 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) try: - # List Tagged Objects - - api_response = api_instance.list_tagged_objects() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_tagged_objects(limit, offset, count, filters) - print("The response of TaggedObjectsApi->list_tagged_objects:\n") - pprint(api_response) + # List Tagged Objects + + results = TaggedObjectsApi(api_client).list_tagged_objects() + # Below is a request that includes all optional parameters + # results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects:\n") + pprint(results) except Exception as e: - print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) + print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) - path: /tagged-objects/{type} method: GET xCodeSample: @@ -11767,16 +10955,15 @@ 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) filters = 'objectRef.id eq \"2c91808568c529c60168cca6f90c1313\"' # 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: **objectRef.id**: *eq* **objectRef.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: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) try: - # List Tagged Objects by Type - - api_response = api_instance.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) - print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") - pprint(api_response) + # List Tagged Objects by Type + + results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type=type) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) + print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) - path: /tagged-objects/{type}/{id} method: PUT xCodeSample: @@ -11785,55 +10972,53 @@ source: | 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 = { + tagged_object = '''{ "objectRef" : { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, "tags" : [ "BU_FINANCE", "PCI" ] - } # TaggedObject | - try: - # Update Tagged Object - Result = tagged_object.from_json(tagged_object) - api_response = api_instance.put_tagged_object(type, id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_tagged_object(type, id, Result) - print("The response of TaggedObjectsApi->put_tagged_object:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e) + }''' # TaggedObject | + try: + # Update Tagged Object + new_tagged_object = TaggedObject.from_json(tagged_object) + results = TaggedObjectsApi(api_client).put_tagged_object(type=type, id=id, tagged_object=new_tagged_object) + # Below is a request that includes all optional parameters + # results = TaggedObjectsApi(api_client).put_tagged_object(type, id, new_tagged_object) + print("The response of TaggedObjectsApi->put_tagged_object:\n") + pprint(results) + except Exception as e: + print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e) - path: /tagged-objects method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/tagged-objects#set-tag-to-object source: | - tagged_object = { + tagged_object = '''{ "objectRef" : { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, "tags" : [ "BU_FINANCE", "PCI" ] - } # TaggedObject | + }''' # TaggedObject | try: - # Add Tag to Object - Result = tagged_object.from_json(tagged_object) - api_instance.set_tag_to_object(Result) - - # Below is a request that includes all optional parameters - # api_instance.set_tag_to_object(Result) + # Add Tag to Object + new_tagged_object = TaggedObject.from_json(tagged_object) + TaggedObjectsApi(api_client).set_tag_to_object(tagged_object=new_tagged_object) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling TaggedObjectsApi->set_tag_to_object: %s\n" % e) - path: /tagged-objects/bulk-add method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/tagged-objects#set-tags-to-many-objects source: | - bulk_tagged_object = { + bulk_tagged_object = '''{ "objectRefs" : [ { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", @@ -11845,25 +11030,24 @@ } ], "operation" : "MERGE", "tags" : [ "BU_FINANCE", "PCI" ] - } # BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - try: - # Tag Multiple Objects - Result = bulk_tagged_object.from_json(bulk_tagged_object) - api_response = api_instance.set_tags_to_many_objects(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_tags_to_many_objects(Result) - print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) + }''' # BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + try: + # Tag Multiple Objects + new_bulk_tagged_object = BulkTaggedObject.from_json(bulk_tagged_object) + results = TaggedObjectsApi(api_client).set_tags_to_many_objects(bulk_tagged_object=new_bulk_tagged_object) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) - path: /tags method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/tags#create-tag source: | - tag = { + tag = '''{ "created" : "2022-05-04T14:48:49Z", "tagCategoryRefs" : [ { "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", @@ -11877,18 +11061,17 @@ "name" : "PCI", "modified" : "2022-07-14T16:31:11Z", "id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f" - } # Tag | - try: - # Create Tag - Result = tag.from_json(tag) - api_response = api_instance.create_tag(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_tag(Result) - print("The response of TagsApi->create_tag:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TagsApi->create_tag: %s\n" % e) + }''' # Tag | + try: + # Create Tag + new_tag = Tag.from_json(tag) + results = TagsApi(api_client).create_tag(tag=new_tag) + # Below is a request that includes all optional parameters + # results = TagsApi(api_client).create_tag(new_tag) + print("The response of TagsApi->create_tag:\n") + pprint(results) + except Exception as e: + print("Exception when calling TagsApi->create_tag: %s\n" % e) - path: /tags/{id} method: DELETE xCodeSample: @@ -11897,14 +11080,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_tag_by_id(id) + # Delete Tag + + TagsApi(api_client).delete_tag_by_id(id=id) + # Below is a request that includes all optional parameters + # TagsApi(api_client).delete_tag_by_id(id) except Exception as e: - print("Exception when calling TagsApi->delete_tag_by_id: %s\n" % e) + print("Exception when calling TagsApi->delete_tag_by_id: %s\n" % e) - path: /tags/{id} method: GET xCodeSample: @@ -11913,16 +11095,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_tag_by_id(id) - print("The response of TagsApi->get_tag_by_id:\n") - pprint(api_response) + # Get Tag By Id + + results = TagsApi(api_client).get_tag_by_id(id=id) + # Below is a request that includes all optional parameters + # results = TagsApi(api_client).get_tag_by_id(id) + print("The response of TagsApi->get_tag_by_id:\n") + pprint(results) except Exception as e: - print("Exception when calling TagsApi->get_tag_by_id: %s\n" % e) + print("Exception when calling TagsApi->get_tag_by_id: %s\n" % e) - path: /tags method: GET xCodeSample: @@ -11935,16 +11116,15 @@ filters = 'id eq \"27462f54-61c7-4140-b5da-d5dbe27fc6db\"' # 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, in, 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: **id**: *eq, in* **name**: *eq, in, sw* (optional) sorters = 'name,-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-results) Sorting is supported for the following fields: **id, name, created, 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-results) Sorting is supported for the following fields: **id, name, created, modified** (optional) try: - # List Tags - - api_response = api_instance.list_tags() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_tags(limit, offset, count, filters, sorters) - print("The response of TagsApi->list_tags:\n") - pprint(api_response) + # List Tags + + results = TagsApi(api_client).list_tags() + # Below is a request that includes all optional parameters + # results = TagsApi(api_client).list_tags(limit, offset, count, filters, sorters) + print("The response of TagsApi->list_tags:\n") + pprint(results) except Exception as e: - print("Exception when calling TagsApi->list_tags: %s\n" % e) + print("Exception when calling TagsApi->list_tags: %s\n" % e) - path: /task-status/pending-tasks method: HEAD xCodeSample: @@ -11955,14 +11135,13 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) try: - # Retrieve Pending Task List Headers - - api_instance.get_pending_task_headers() - - # Below is a request that includes all optional parameters - # api_instance.get_pending_task_headers(offset, limit, count) + # Retrieve Pending Task List Headers + + TaskManagementApi(api_client).get_pending_task_headers() + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling TaskManagementApi->get_pending_task_headers: %s\n" % e) - path: /task-status/pending-tasks method: GET xCodeSample: @@ -11973,16 +11152,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) try: - # Retrieve Pending Task Status List - - api_response = api_instance.get_pending_tasks() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_pending_tasks(offset, limit, count) - print("The response of TaskManagementApi->get_pending_tasks:\n") - pprint(api_response) + # Retrieve Pending Task Status List + + results = TaskManagementApi(api_client).get_pending_tasks() + # Below is a request that includes all optional parameters + # results = TaskManagementApi(api_client).get_pending_tasks(offset, limit, count) + print("The response of TaskManagementApi->get_pending_tasks:\n") + pprint(results) except Exception as e: - print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) + print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) - path: /task-status/{id} method: GET xCodeSample: @@ -11991,16 +11169,15 @@ source: | id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. try: - # Get Task Status by ID - - api_response = api_instance.get_task_status(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_task_status(id) - print("The response of TaskManagementApi->get_task_status:\n") - pprint(api_response) + # Get Task Status by ID + + results = TaskManagementApi(api_client).get_task_status(id=id) + # Below is a request that includes all optional parameters + # results = TaskManagementApi(api_client).get_task_status(id) + print("The response of TaskManagementApi->get_task_status:\n") + pprint(results) except Exception as e: - print("Exception when calling TaskManagementApi->get_task_status: %s\n" % e) + print("Exception when calling TaskManagementApi->get_task_status: %s\n" % e) - path: /task-status method: GET xCodeSample: @@ -12013,16 +11190,15 @@ filters = 'completionStatus eq \"Success\"' # 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* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *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: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) sorters = '-created' # 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: **created** (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: **created** (optional) try: - # Retrieve Task Status List - - api_response = api_instance.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) - print("The response of TaskManagementApi->get_task_status_list:\n") - pprint(api_response) + # Retrieve Task Status List + + results = TaskManagementApi(api_client).get_task_status_list() + # Below is a request that includes all optional parameters + # results = TaskManagementApi(api_client).get_task_status_list(limit, offset, count, filters, sorters) + print("The response of TaskManagementApi->get_task_status_list:\n") + pprint(results) except Exception as e: - print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) + print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) - path: /task-status/{id} method: PATCH xCodeSample: @@ -12030,24 +11206,17 @@ label: SDK_tools/sdk/python/beta/methods/task-management#update-task-status source: | id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. - [sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] | The JSONPatch payload used to update the object. - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | The JSONPatch payload used to update the object. - - try: - # Update Task Status by ID - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_task_status(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_task_status(id, Result) - print("The response of TaskManagementApi->update_task_status:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TaskManagementApi->update_task_status: %s\n" % e) + json_patch_operation = '''[sailpoint.beta.JsonPatchOperation()]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the object. + try: + # Update Task Status by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = TaskManagementApi(api_client).update_task_status(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = TaskManagementApi(api_client).update_task_status(id, new_json_patch_operation) + print("The response of TaskManagementApi->update_task_status:\n") + pprint(results) + except Exception as e: + print("Exception when calling TaskManagementApi->update_task_status: %s\n" % e) - path: /tenant method: GET xCodeSample: @@ -12055,38 +11224,36 @@ label: SDK_tools/sdk/python/beta/methods/tenant#get-tenant source: | try: - # Get Tenant Information. - - api_response = api_instance.get_tenant() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_tenant() - print("The response of TenantApi->get_tenant:\n") - pprint(api_response) + # Get Tenant Information. + + results = TenantApi(api_client).get_tenant() + # Below is a request that includes all optional parameters + # results = TenantApi(api_client).get_tenant() + print("The response of TenantApi->get_tenant:\n") + pprint(results) except Exception as e: - print("Exception when calling TenantApi->get_tenant: %s\n" % e) + print("Exception when calling TenantApi->get_tenant: %s\n" % e) - path: /transforms method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/transforms#create-transform source: | - transform = { + transform = '''{ "name" : "Timestamp To Date", "attributes" : "{}", "type" : "dateFormat" - } # Transform | The transform to be created. - try: - # Create transform - Result = transform.from_json(transform) - api_response = api_instance.create_transform(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_transform(Result) - print("The response of TransformsApi->create_transform:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TransformsApi->create_transform: %s\n" % e) + }''' # Transform | The transform to be created. + try: + # Create transform + new_transform = Transform.from_json(transform) + results = TransformsApi(api_client).create_transform(transform=new_transform) + # Below is a request that includes all optional parameters + # results = TransformsApi(api_client).create_transform(new_transform) + print("The response of TransformsApi->create_transform:\n") + pprint(results) + except Exception as e: + print("Exception when calling TransformsApi->create_transform: %s\n" % e) - path: /transforms/{id} method: DELETE xCodeSample: @@ -12095,14 +11262,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_transform(id) + # Delete a transform + + TransformsApi(api_client).delete_transform(id=id) + # Below is a request that includes all optional parameters + # TransformsApi(api_client).delete_transform(id) except Exception as e: - print("Exception when calling TransformsApi->delete_transform: %s\n" % e) + print("Exception when calling TransformsApi->delete_transform: %s\n" % e) - path: /transforms/{id} method: GET xCodeSample: @@ -12111,16 +11277,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_transform(id) - print("The response of TransformsApi->get_transform:\n") - pprint(api_response) + # Transform by ID + + results = TransformsApi(api_client).get_transform(id=id) + # Below is a request that includes all optional parameters + # results = TransformsApi(api_client).get_transform(id) + print("The response of TransformsApi->get_transform:\n") + pprint(results) except Exception as e: - print("Exception when calling TransformsApi->get_transform: %s\n" % e) + print("Exception when calling TransformsApi->get_transform: %s\n" % e) - path: /transforms method: GET xCodeSample: @@ -12133,16 +11298,15 @@ name = 'ExampleTransformName123' # str | Name of the transform to retrieve from the list. (optional) # str | Name of the transform to retrieve from the list. (optional) filters = 'name eq \"Uppercase\"' # 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: **internal**: *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: **internal**: *eq* **name**: *eq, sw* (optional) try: - # List transforms - - api_response = api_instance.list_transforms() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_transforms(offset, limit, count, name, filters) - print("The response of TransformsApi->list_transforms:\n") - pprint(api_response) + # List transforms + + results = TransformsApi(api_client).list_transforms() + # Below is a request that includes all optional parameters + # results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters) + print("The response of TransformsApi->list_transforms:\n") + pprint(results) except Exception as e: - print("Exception when calling TransformsApi->list_transforms: %s\n" % e) + print("Exception when calling TransformsApi->list_transforms: %s\n" % e) - path: /transforms/{id} method: PUT xCodeSample: @@ -12150,22 +11314,21 @@ label: SDK_tools/sdk/python/beta/methods/transforms#update-transform source: | id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to update # str | ID of the transform to update - transform = { + transform = '''{ "name" : "Timestamp To Date", "attributes" : "{}", "type" : "dateFormat" - } # Transform | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional) - try: - # Update a transform - - api_response = api_instance.update_transform(id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_transform(id, Result) - print("The response of TransformsApi->update_transform:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TransformsApi->update_transform: %s\n" % e) + }''' # Transform | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional) + try: + # Update a transform + + results = TransformsApi(api_client).update_transform(id=id) + # Below is a request that includes all optional parameters + # results = TransformsApi(api_client).update_transform(id, new_transform) + print("The response of TransformsApi->update_transform:\n") + pprint(results) + except Exception as e: + print("Exception when calling TransformsApi->update_transform: %s\n" % e) - path: /trigger-invocations/{id}/complete method: POST xCodeSample: @@ -12173,29 +11336,28 @@ label: SDK_tools/sdk/python/beta/methods/triggers#complete-trigger-invocation source: | id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the invocation to complete. # str | The ID of the invocation to complete. - complete_invocation = { + complete_invocation = '''{ "output" : { "approved" : false }, "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", "error" : "Access request is denied." - } # CompleteInvocation | + }''' # CompleteInvocation | try: - # Complete Trigger Invocation - Result = complete_invocation.from_json(complete_invocation) - api_instance.complete_trigger_invocation(id, Result) - - # Below is a request that includes all optional parameters - # api_instance.complete_trigger_invocation(id, Result) + # Complete Trigger Invocation + new_complete_invocation = CompleteInvocation.from_json(complete_invocation) + TriggersApi(api_client).complete_trigger_invocation(id=id, complete_invocation=new_complete_invocation) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling TriggersApi->complete_trigger_invocation: %s\n" % e) - path: /trigger-subscriptions method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#create-subscription source: | - subscription_post_request = { + subscription_post_request = '''{ "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", "httpConfig" : { "bearerTokenAuthConfig" : { @@ -12219,18 +11381,17 @@ "responseDeadline" : "PT1H", "type" : "HTTP", "enabled" : true - } # SubscriptionPostRequest | - try: - # Create a Subscription - Result = subscription_post_request.from_json(subscription_post_request) - api_response = api_instance.create_subscription(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_subscription(Result) - print("The response of TriggersApi->create_subscription:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TriggersApi->create_subscription: %s\n" % e) + }''' # SubscriptionPostRequest | + try: + # Create a Subscription + new_subscription_post_request = SubscriptionPostRequest.from_json(subscription_post_request) + results = TriggersApi(api_client).create_subscription(subscription_post_request=new_subscription_post_request) + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).create_subscription(new_subscription_post_request) + print("The response of TriggersApi->create_subscription:\n") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->create_subscription: %s\n" % e) - path: /trigger-subscriptions/{id} method: DELETE xCodeSample: @@ -12239,14 +11400,13 @@ source: | id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID try: - # Delete a Subscription - - api_instance.delete_subscription(id) - - # Below is a request that includes all optional parameters - # api_instance.delete_subscription(id) + # Delete a Subscription + + TriggersApi(api_client).delete_subscription(id=id) + # Below is a request that includes all optional parameters + # TriggersApi(api_client).delete_subscription(id) except Exception as e: - print("Exception when calling TriggersApi->delete_subscription: %s\n" % e) + print("Exception when calling TriggersApi->delete_subscription: %s\n" % e) - path: /trigger-subscriptions method: GET xCodeSample: @@ -12259,16 +11419,15 @@ filters = 'id eq \"12cff757-c0c0-413b-8ad7-2a47956d1e89\"' # 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* **triggerId**: *eq* **type**: *eq, le* (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* **triggerId**: *eq* **type**: *eq, le* (optional) sorters = 'triggerName' # 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: **triggerId, triggerName** (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: **triggerId, triggerName** (optional) try: - # List Subscriptions - - api_response = api_instance.list_subscriptions() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_subscriptions(limit, offset, count, filters, sorters) - print("The response of TriggersApi->list_subscriptions:\n") - pprint(api_response) + # List Subscriptions + + results = TriggersApi(api_client).list_subscriptions() + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).list_subscriptions(limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_subscriptions:\n") + pprint(results) except Exception as e: - print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) + print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) - path: /trigger-invocations/status method: GET xCodeSample: @@ -12281,16 +11440,15 @@ filters = 'triggerId eq \"idn:access-request-dynamic-approver\"' # 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: **triggerId**: *eq* **subscriptionId**: *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: **triggerId**: *eq* **subscriptionId**: *eq* (optional) sorters = 'created' # 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: **triggerId, subscriptionName, created, completed** (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: **triggerId, subscriptionName, created, completed** (optional) try: - # List Latest Invocation Statuses - - api_response = api_instance.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) - print("The response of TriggersApi->list_trigger_invocation_status:\n") - pprint(api_response) + # List Latest Invocation Statuses + + results = TriggersApi(api_client).list_trigger_invocation_status() + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).list_trigger_invocation_status(limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_trigger_invocation_status:\n") + pprint(results) except Exception as e: - print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) + print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) - path: /triggers method: GET xCodeSample: @@ -12303,16 +11461,15 @@ filters = 'id eq \"idn:access-request-post-approval\"' # 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, ge, le* (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, ge, le* (optional) 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: **id, 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: **id, name** (optional) try: - # List Triggers - - api_response = api_instance.list_triggers() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_triggers(limit, offset, count, filters, sorters) - print("The response of TriggersApi->list_triggers:\n") - pprint(api_response) + # List Triggers + + results = TriggersApi(api_client).list_triggers() + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).list_triggers(limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_triggers:\n") + pprint(results) except Exception as e: - print("Exception when calling TriggersApi->list_triggers: %s\n" % e) + print("Exception when calling TriggersApi->list_triggers: %s\n" % e) - path: /trigger-subscriptions/{id} method: PATCH xCodeSample: @@ -12320,27 +11477,24 @@ label: SDK_tools/sdk/python/beta/methods/triggers#patch-subscription source: | 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] | - - try: - # Patch a Subscription - Result = subscription_patch_request_inner.from_json(subscription_patch_request_inner) - api_response = api_instance.patch_subscription(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_subscription(id, Result) - print("The response of TriggersApi->patch_subscription:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TriggersApi->patch_subscription: %s\n" % e) + subscription_patch_request_inner = '''[sailpoint.beta.SubscriptionPatchRequestInner()]''' # List[SubscriptionPatchRequestInner] | + try: + # Patch a Subscription + new_subscription_patch_request_inner = SubscriptionPatchRequestInner.from_json(subscription_patch_request_inner) + results = TriggersApi(api_client).patch_subscription(id=id, subscription_patch_request_inner=new_subscription_patch_request_inner) + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).patch_subscription(id, new_subscription_patch_request_inner) + print("The response of TriggersApi->patch_subscription:\n") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->patch_subscription: %s\n" % e) - path: /trigger-invocations/test method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#start-test-trigger-invocation source: | - test_invocation = { + test_invocation = '''{ "input" : { "identityId" : "201327fda1c44704ac01181e963d463c" }, @@ -12349,41 +11503,39 @@ "contentJson" : { "workflowId" : 1234 } - } # TestInvocation | - try: - # Start a Test Invocation - Result = test_invocation.from_json(test_invocation) - api_response = api_instance.start_test_trigger_invocation(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_test_trigger_invocation(Result) - print("The response of TriggersApi->start_test_trigger_invocation:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) + }''' # TestInvocation | + try: + # Start a Test Invocation + new_test_invocation = TestInvocation.from_json(test_invocation) + results = TriggersApi(api_client).start_test_trigger_invocation(test_invocation=new_test_invocation) + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).start_test_trigger_invocation(new_test_invocation) + print("The response of TriggersApi->start_test_trigger_invocation:\n") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) - path: /trigger-subscriptions/validate-filter method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#test-subscription-filter source: | - validate_filter_input_dto = { + validate_filter_input_dto = '''{ "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", "input" : { "identityId" : "201327fda1c44704ac01181e963d463c" } - } # ValidateFilterInputDto | - try: - # Validate a Subscription Filter - Result = validate_filter_input_dto.from_json(validate_filter_input_dto) - api_response = api_instance.test_subscription_filter(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.test_subscription_filter(Result) - print("The response of TriggersApi->test_subscription_filter:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TriggersApi->test_subscription_filter: %s\n" % e) + }''' # ValidateFilterInputDto | + try: + # Validate a Subscription Filter + new_validate_filter_input_dto = ValidateFilterInputDto.from_json(validate_filter_input_dto) + results = TriggersApi(api_client).test_subscription_filter(validate_filter_input_dto=new_validate_filter_input_dto) + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).test_subscription_filter(new_validate_filter_input_dto) + print("The response of TriggersApi->test_subscription_filter:\n") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->test_subscription_filter: %s\n" % e) - path: /trigger-subscriptions/{id} method: PUT xCodeSample: @@ -12391,7 +11543,7 @@ label: SDK_tools/sdk/python/beta/methods/triggers#update-subscription source: | id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID - subscription_put_request = { + subscription_put_request = '''{ "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", "httpConfig" : { "bearerTokenAuthConfig" : { @@ -12414,18 +11566,17 @@ "responseDeadline" : "PT1H", "type" : "HTTP", "enabled" : true - } # SubscriptionPutRequest | - try: - # Update a Subscription - Result = subscription_put_request.from_json(subscription_put_request) - api_response = api_instance.update_subscription(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_subscription(id, Result) - print("The response of TriggersApi->update_subscription:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TriggersApi->update_subscription: %s\n" % e) + }''' # SubscriptionPutRequest | + try: + # Update a Subscription + new_subscription_put_request = SubscriptionPutRequest.from_json(subscription_put_request) + results = TriggersApi(api_client).update_subscription(id=id, subscription_put_request=new_subscription_put_request) + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).update_subscription(id, new_subscription_put_request) + print("The response of TriggersApi->update_subscription:\n") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->update_subscription: %s\n" % e) - path: /ui-metadata/tenant method: GET xCodeSample: @@ -12433,45 +11584,43 @@ label: SDK_tools/sdk/python/beta/methods/ui-metadata#get-tenant-ui-metadata source: | try: - # Get a tenant UI metadata - - api_response = api_instance.get_tenant_ui_metadata() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_tenant_ui_metadata() - print("The response of UIMetadataApi->get_tenant_ui_metadata:\n") - pprint(api_response) + # Get a tenant UI metadata + + results = UIMetadataApi(api_client).get_tenant_ui_metadata() + # Below is a request that includes all optional parameters + # results = UIMetadataApi(api_client).get_tenant_ui_metadata() + print("The response of UIMetadataApi->get_tenant_ui_metadata:\n") + pprint(results) except Exception as e: - print("Exception when calling UIMetadataApi->get_tenant_ui_metadata: %s\n" % e) + print("Exception when calling UIMetadataApi->get_tenant_ui_metadata: %s\n" % e) - path: /ui-metadata/tenant method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/ui-metadata#set-tenant-ui-metadata source: | - tenant_ui_metadata_item_update_request = { + tenant_ui_metadata_item_update_request = '''{ "usernameEmptyText" : "Please provide your work email address...", "usernameLabel" : "Email", "iframeWhiteList" : "http://example.com http://example2.com" - } # TenantUiMetadataItemUpdateRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_tenant_ui_metadata(Result) - print("The response of UIMetadataApi->set_tenant_ui_metadata:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UIMetadataApi->set_tenant_ui_metadata: %s\n" % e) + }''' # TenantUiMetadataItemUpdateRequest | + try: + # Update tenant UI metadata + new_tenant_ui_metadata_item_update_request = TenantUiMetadataItemUpdateRequest.from_json(tenant_ui_metadata_item_update_request) + results = UIMetadataApi(api_client).set_tenant_ui_metadata(tenant_ui_metadata_item_update_request=new_tenant_ui_metadata_item_update_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling UIMetadataApi->set_tenant_ui_metadata: %s\n" % e) - path: /vendor-connector-mappings method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/vendor-connector-mappings#create-vendor-connector-mapping source: | - vendor_connector_mapping = { + vendor_connector_mapping = '''{ "createdAt" : "2024-03-13T12:56:19.391294Z", "deletedAt" : { "Valid" : false, @@ -12493,25 +11642,24 @@ "Valid" : true, "Time" : "2024-03-14T12:56:19.391294Z" } - } # VendorConnectorMapping | - try: - # Create Vendor Connector Mapping - Result = vendor_connector_mapping.from_json(vendor_connector_mapping) - api_response = api_instance.create_vendor_connector_mapping(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_vendor_connector_mapping(Result) - print("The response of VendorConnectorMappingsApi->create_vendor_connector_mapping:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e) + }''' # VendorConnectorMapping | + try: + # Create Vendor Connector Mapping + new_vendor_connector_mapping = VendorConnectorMapping.from_json(vendor_connector_mapping) + results = VendorConnectorMappingsApi(api_client).create_vendor_connector_mapping(vendor_connector_mapping=new_vendor_connector_mapping) + # Below is a request that includes all optional parameters + # results = VendorConnectorMappingsApi(api_client).create_vendor_connector_mapping(new_vendor_connector_mapping) + print("The response of VendorConnectorMappingsApi->create_vendor_connector_mapping:\n") + pprint(results) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e) - path: /vendor-connector-mappings method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/vendor-connector-mappings#delete-vendor-connector-mapping source: | - vendor_connector_mapping = { + vendor_connector_mapping = '''{ "createdAt" : "2024-03-13T12:56:19.391294Z", "deletedAt" : { "Valid" : false, @@ -12533,18 +11681,17 @@ "Valid" : true, "Time" : "2024-03-14T12:56:19.391294Z" } - } # VendorConnectorMapping | - try: - # Delete Vendor Connector Mapping - Result = vendor_connector_mapping.from_json(vendor_connector_mapping) - api_response = api_instance.delete_vendor_connector_mapping(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_vendor_connector_mapping(Result) - print("The response of VendorConnectorMappingsApi->delete_vendor_connector_mapping:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e) + }''' # VendorConnectorMapping | + try: + # Delete Vendor Connector Mapping + new_vendor_connector_mapping = VendorConnectorMapping.from_json(vendor_connector_mapping) + results = VendorConnectorMappingsApi(api_client).delete_vendor_connector_mapping(vendor_connector_mapping=new_vendor_connector_mapping) + # Below is a request that includes all optional parameters + # results = VendorConnectorMappingsApi(api_client).delete_vendor_connector_mapping(new_vendor_connector_mapping) + print("The response of VendorConnectorMappingsApi->delete_vendor_connector_mapping:\n") + pprint(results) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e) - path: /vendor-connector-mappings method: GET xCodeSample: @@ -12552,16 +11699,15 @@ label: SDK_tools/sdk/python/beta/methods/vendor-connector-mappings#get-vendor-connector-mappings source: | try: - # List Vendor Connector Mappings - - api_response = api_instance.get_vendor_connector_mappings() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_vendor_connector_mappings() - print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") - pprint(api_response) + # List Vendor Connector Mappings + + results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() + # Below is a request that includes all optional parameters + # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() + print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") + pprint(results) except Exception as e: - print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) + print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) - path: /workflow-executions/{id}/cancel method: POST xCodeSample: @@ -12570,32 +11716,30 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.cancel_workflow_execution(id) + # Cancel Workflow Execution by ID + + WorkflowsApi(api_client).cancel_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).cancel_workflow_execution(id) except Exception as e: - print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) - path: /workflows method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#create-workflow source: | - 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 | + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_workflow(Result) - print("The response of WorkflowsApi->create_workflow:\n") - pprint(api_response) + # Create Workflow + new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) + results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) + print("The response of WorkflowsApi->create_workflow:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) - path: /workflows/{id} method: DELETE xCodeSample: @@ -12604,14 +11748,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_workflow(id) + # Delete Workflow By Id + + WorkflowsApi(api_client).delete_workflow(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).delete_workflow(id) except Exception as e: - print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) - path: /workflows/{id} method: GET xCodeSample: @@ -12620,16 +11763,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_workflow(id) - print("The response of WorkflowsApi->get_workflow:\n") - pprint(api_response) + # Get Workflow By Id + + results = WorkflowsApi(api_client).get_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) - path: /workflow-executions/{id} method: GET xCodeSample: @@ -12638,16 +11780,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_workflow_execution(id) - print("The response of WorkflowsApi->get_workflow_execution:\n") - pprint(api_response) + # Get Workflow Execution + + results = WorkflowsApi(api_client).get_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) - path: /workflow-executions/{id}/history method: GET xCodeSample: @@ -12656,16 +11797,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_workflow_execution_history(id) - print("The response of WorkflowsApi->get_workflow_execution_history:\n") - pprint(api_response) + # Get Workflow Execution History + + results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) - path: /workflows/{id}/executions method: GET xCodeSample: @@ -12678,16 +11818,15 @@ 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) filters = 'status eq \"Failed\"' # 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: **startTime**: *eq, lt, le, gt, ge* **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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) try: - # List Workflow Executions - - api_response = api_instance.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) - print("The response of WorkflowsApi->get_workflow_executions:\n") - pprint(api_response) + # List Workflow Executions + + results = WorkflowsApi(api_client).get_workflow_executions(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) - path: /workflow-library method: GET xCodeSample: @@ -12697,16 +11836,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_complete_workflow_library(limit, offset) - print("The response of WorkflowsApi->list_complete_workflow_library:\n") - pprint(api_response) + # List Complete Workflow Library + + results = WorkflowsApi(api_client).list_complete_workflow_library() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) - path: /workflow-library/actions method: GET xCodeSample: @@ -12717,16 +11855,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) 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) try: - # List Workflow Library Actions - - api_response = api_instance.list_workflow_library_actions() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_workflow_library_actions(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_actions:\n") - pprint(api_response) + # List Workflow Library Actions + + results = WorkflowsApi(api_client).list_workflow_library_actions() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) - path: /workflow-library/operators method: GET xCodeSample: @@ -12734,16 +11871,15 @@ label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-operators source: | try: - # List Workflow Library Operators - - api_response = api_instance.list_workflow_library_operators() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_workflow_library_operators() - print("The response of WorkflowsApi->list_workflow_library_operators:\n") - pprint(api_response) + # List Workflow Library Operators + + results = WorkflowsApi(api_client).list_workflow_library_operators() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) - path: /workflow-library/triggers method: GET xCodeSample: @@ -12754,16 +11890,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) 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) try: - # List Workflow Library Triggers - - api_response = api_instance.list_workflow_library_triggers() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_workflow_library_triggers(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - pprint(api_response) + # List Workflow Library Triggers + + results = WorkflowsApi(api_client).list_workflow_library_triggers() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) - path: /workflows method: GET xCodeSample: @@ -12771,16 +11906,15 @@ label: SDK_tools/sdk/python/beta/methods/workflows#list-workflows source: | try: - # List Workflows - - api_response = api_instance.list_workflows() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_workflows() - print("The response of WorkflowsApi->list_workflows:\n") - pprint(api_response) + # List Workflows + + results = WorkflowsApi(api_client).list_workflows() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) - path: /workflows/{id} method: PATCH xCodeSample: @@ -12788,24 +11922,17 @@ label: SDK_tools/sdk/python/beta/methods/workflows#patch-workflow source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | - - try: - # Patch Workflow - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_workflow(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_workflow(id, Result) - print("The response of WorkflowsApi->patch_workflow:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) + json_patch_operation = '''[{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] | + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) + print("The response of WorkflowsApi->patch_workflow:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) - path: /workflows/execute/external/{id} method: POST xCodeSample: @@ -12813,18 +11940,17 @@ label: SDK_tools/sdk/python/beta/methods/workflows#post-external-execute-workflow source: | 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.post_external_execute_workflow(id, Result) - print("The response of WorkflowsApi->post_external_execute_workflow:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling WorkflowsApi->post_external_execute_workflow: %s\n" % e) + post_external_execute_workflow_request = '''sailpoint.beta.PostExternalExecuteWorkflowRequest()''' # PostExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + results = WorkflowsApi(api_client).post_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling WorkflowsApi->post_external_execute_workflow: %s\n" % e) - path: /workflows/{id}/external/oauth-clients method: POST xCodeSample: @@ -12833,16 +11959,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.post_workflow_external_trigger(id) - print("The response of WorkflowsApi->post_workflow_external_trigger:\n") - pprint(api_response) + # Generate External Trigger OAuth Client + + results = WorkflowsApi(api_client).post_workflow_external_trigger(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).post_workflow_external_trigger(id) + print("The response of WorkflowsApi->post_workflow_external_trigger:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->post_workflow_external_trigger: %s\n" % e) + print("Exception when calling WorkflowsApi->post_workflow_external_trigger: %s\n" % e) - path: /workflows/execute/external/{id}/test method: POST xCodeSample: @@ -12850,18 +11975,17 @@ label: SDK_tools/sdk/python/beta/methods/workflows#test-external-execute-workflow source: | 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.test_external_execute_workflow(id, Result) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) + test_external_execute_workflow_request = '''sailpoint.beta.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) - path: /workflows/{id}/test method: POST xCodeSample: @@ -12869,18 +11993,17 @@ label: SDK_tools/sdk/python/beta/methods/workflows#test-workflow source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.test_workflow(id, Result) - print("The response of WorkflowsApi->test_workflow:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) + 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 + new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) + results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) + print("The response of WorkflowsApi->test_workflow:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) - path: /workflows/{id} method: PUT xCodeSample: @@ -12888,7 +12011,7 @@ label: SDK_tools/sdk/python/beta/methods/workflows#update-workflow source: | id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = { + workflow_body = '''{ "owner" : { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", @@ -12925,18 +12048,17 @@ "type" : "EVENT" }, "enabled" : false - } # WorkflowBody | - try: - # Update Workflow - Result = workflow_body.from_json(workflow_body) - api_response = api_instance.update_workflow(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_workflow(id, Result) - print("The response of WorkflowsApi->update_workflow:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling WorkflowsApi->update_workflow: %s\n" % e) + }''' # WorkflowBody | + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).update_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).update_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->update_workflow:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->update_workflow: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -12946,16 +12068,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.approve_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->approve_approval_item:\n") - pprint(api_response) + # Approve an Approval Item + + results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->approve_approval_item:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) - path: /work-items/bulk-approve/{id} method: POST xCodeSample: @@ -12964,16 +12085,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.approve_approval_items_in_bulk(id) - print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") - pprint(api_response) + # Bulk approve Approval Items + + results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id) + print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) + print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) - path: /work-items/{id} method: POST xCodeSample: @@ -12983,16 +12103,15 @@ id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) try: - # Complete a Work Item - - api_response = api_instance.complete_work_item(id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.complete_work_item(id, Result) - print("The response of WorkItemsApi->complete_work_item:\n") - pprint(api_response) + # Complete a Work Item + + results = WorkItemsApi(api_client).complete_work_item(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).complete_work_item(id, new_body) + print("The response of WorkItemsApi->complete_work_item:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) - path: /work-items/{id}/forward method: POST xCodeSample: @@ -13000,20 +12119,19 @@ label: SDK_tools/sdk/python/beta/methods/work-items#forward-work-item source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - work_item_forward = { + work_item_forward = '''{ "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", "comment" : "I'm going on vacation.", "sendNotifications" : true - } # WorkItemForward | + }''' # WorkItemForward | try: - # Forward a Work Item - Result = work_item_forward.from_json(work_item_forward) - api_instance.forward_work_item(id, Result) - - # Below is a request that includes all optional parameters - # api_instance.forward_work_item(id, Result) + # Forward a Work Item + new_work_item_forward = WorkItemForward.from_json(work_item_forward) + WorkItemsApi(api_client).forward_work_item(id=id, work_item_forward=new_work_item_forward) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e) - path: /work-items/completed method: GET xCodeSample: @@ -13025,16 +12143,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) 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) try: - # Completed Work Items - - api_response = api_instance.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) - print("The response of WorkItemsApi->get_completed_work_items:\n") - pprint(api_response) + # Completed Work Items + + results = WorkItemsApi(api_client).get_completed_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) + print("The response of WorkItemsApi->get_completed_work_items:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) - path: /work-items/completed/count method: GET xCodeSample: @@ -13043,16 +12160,15 @@ source: | 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_count_completed_work_items(owner_id) - print("The response of WorkItemsApi->get_count_completed_work_items:\n") - pprint(api_response) + # Count Completed Work Items + + results = WorkItemsApi(api_client).get_count_completed_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id) + print("The response of WorkItemsApi->get_count_completed_work_items:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) - path: /work-items/count method: GET xCodeSample: @@ -13061,16 +12177,15 @@ source: | 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_count_work_items(owner_id) - print("The response of WorkItemsApi->get_count_work_items:\n") - pprint(api_response) + # Count Work Items + + results = WorkItemsApi(api_client).get_count_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_work_items(owner_id) + print("The response of WorkItemsApi->get_count_work_items:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) - path: /work-items/{id} method: GET xCodeSample: @@ -13080,16 +12195,15 @@ id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. owner_id = '2c9180835d191a86015d28455b4a2329' # 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_work_item(id, owner_id) - print("The response of WorkItemsApi->get_work_item:\n") - pprint(api_response) + # Get a Work Item + + results = WorkItemsApi(api_client).get_work_item(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_item(id, owner_id) + print("The response of WorkItemsApi->get_work_item:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) - path: /work-items/summary method: GET xCodeSample: @@ -13098,16 +12212,15 @@ source: | 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_work_items_summary(owner_id) - print("The response of WorkItemsApi->get_work_items_summary:\n") - pprint(api_response) + # Work Items Summary + + results = WorkItemsApi(api_client).get_work_items_summary() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_items_summary(owner_id) + print("The response of WorkItemsApi->get_work_items_summary:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) - path: /work-items method: GET xCodeSample: @@ -13119,16 +12232,15 @@ 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) owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) try: - # List Work Items - - api_response = api_instance.list_work_items() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_work_items(limit, offset, count, owner_id) - print("The response of WorkItemsApi->list_work_items:\n") - pprint(api_response) + # List Work Items + + results = WorkItemsApi(api_client).list_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) + print("The response of WorkItemsApi->list_work_items:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) - path: /work-items/{id}/reject/{approvalItemId} method: POST xCodeSample: @@ -13138,16 +12250,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.reject_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->reject_approval_item:\n") - pprint(api_response) + # Reject an Approval Item + + results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->reject_approval_item:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) - path: /work-items/bulk-reject/{id} method: POST xCodeSample: @@ -13156,16 +12267,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.reject_approval_items_in_bulk(id) - print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") - pprint(api_response) + # Bulk reject Approval Items + + results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id) + print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) + print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) - path: /work-items/{id}/submit-account-selection method: POST xCodeSample: @@ -13175,40 +12285,38 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.submit_account_selection(id, Result) - print("The response of WorkItemsApi->submit_account_selection:\n") - pprint(api_response) + # Submit Account Selections + new_request_body = RequestBody.from_json(request_body) + results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body) + print("The response of WorkItemsApi->submit_account_selection:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) - path: /reassignment-configurations method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/work-reassignment#create-reassignment-configuration source: | - configuration_item_request = { + configuration_item_request = '''{ "endDate" : "2022-07-30T17:00:00Z", "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", "configType" : "ACCESS_REQUESTS", "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", "startDate" : "2022-07-21T11:13:12.345Z" - } # ConfigurationItemRequest | - try: - # Create a Reassignment Configuration - Result = configuration_item_request.from_json(configuration_item_request) - api_response = api_instance.create_reassignment_configuration(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_reassignment_configuration(Result) - print("The response of WorkReassignmentApi->create_reassignment_configuration:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling WorkReassignmentApi->create_reassignment_configuration: %s\n" % e) + }''' # ConfigurationItemRequest | + try: + # Create a Reassignment Configuration + new_configuration_item_request = ConfigurationItemRequest.from_json(configuration_item_request) + results = WorkReassignmentApi(api_client).create_reassignment_configuration(configuration_item_request=new_configuration_item_request) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).create_reassignment_configuration(new_configuration_item_request) + print("The response of WorkReassignmentApi->create_reassignment_configuration:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->create_reassignment_configuration: %s\n" % e) - path: /reassignment-configurations/{identityId}/{configType} method: DELETE xCodeSample: @@ -13218,14 +12326,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_reassignment_configuration(identity_id, config_type) + # Delete Reassignment Configuration + + WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id=identity_id, config_type=config_type) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling WorkReassignmentApi->delete_reassignment_configuration: %s\n" % e) - path: /reassignment-configurations/{identityId}/evaluate/{configType} method: GET xCodeSample: @@ -13234,20 +12341,17 @@ source: | 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) - - 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) - try: - # Evaluate Reassignment Configuration - - api_response = api_instance.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) - print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) + 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) + try: + # Evaluate Reassignment Configuration + + results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id=identity_id, config_type=config_type) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) - path: /reassignment-configurations/types method: GET xCodeSample: @@ -13255,16 +12359,15 @@ label: SDK_tools/sdk/python/beta/methods/work-reassignment#get-reassignment-config-types source: | try: - # List Reassignment Config Types - - api_response = api_instance.get_reassignment_config_types() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_reassignment_config_types() - print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") - pprint(api_response) + # List Reassignment Config Types + + results = WorkReassignmentApi(api_client).get_reassignment_config_types() + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).get_reassignment_config_types() + print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) + print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) - path: /reassignment-configurations/{identityId} method: GET xCodeSample: @@ -13273,16 +12376,15 @@ source: | identity_id = '2c91808781a71ddb0181b9090b5c504f' # str | unique identity id # str | unique identity id try: - # Get Reassignment Configuration - - api_response = api_instance.get_reassignment_configuration(identity_id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_reassignment_configuration(identity_id) - print("The response of WorkReassignmentApi->get_reassignment_configuration:\n") - pprint(api_response) + # Get Reassignment Configuration + + results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id=identity_id) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id) + print("The response of WorkReassignmentApi->get_reassignment_configuration:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkReassignmentApi->get_reassignment_configuration: %s\n" % e) + print("Exception when calling WorkReassignmentApi->get_reassignment_configuration: %s\n" % e) - path: /reassignment-configurations/tenant-config method: GET xCodeSample: @@ -13290,16 +12392,15 @@ label: SDK_tools/sdk/python/beta/methods/work-reassignment#get-tenant-config-configuration source: | try: - # Get Tenant-wide Reassignment Configuration settings - - api_response = api_instance.get_tenant_config_configuration() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_tenant_config_configuration() - print("The response of WorkReassignmentApi->get_tenant_config_configuration:\n") - pprint(api_response) + # Get Tenant-wide Reassignment Configuration settings + + results = WorkReassignmentApi(api_client).get_tenant_config_configuration() + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).get_tenant_config_configuration() + print("The response of WorkReassignmentApi->get_tenant_config_configuration:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkReassignmentApi->get_tenant_config_configuration: %s\n" % e) + print("Exception when calling WorkReassignmentApi->get_tenant_config_configuration: %s\n" % e) - path: /reassignment-configurations method: GET xCodeSample: @@ -13309,16 +12410,15 @@ limit = 20 # int | Max number of results to return. (optional) (default to 20) # int | Max number of results to return. (optional) (default to 20) 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) try: - # List Reassignment Configurations - - api_response = api_instance.list_reassignment_configurations() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_reassignment_configurations(limit, offset) - print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") - pprint(api_response) + # List Reassignment Configurations + + results = WorkReassignmentApi(api_client).list_reassignment_configurations() + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).list_reassignment_configurations(limit, offset) + print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) + print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) - path: /reassignment-configurations/{identityId} method: PUT xCodeSample: @@ -13326,43 +12426,41 @@ label: SDK_tools/sdk/python/beta/methods/work-reassignment#put-reassignment-config source: | identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id - configuration_item_request = { + configuration_item_request = '''{ "endDate" : "2022-07-30T17:00:00Z", "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", "configType" : "ACCESS_REQUESTS", "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", "startDate" : "2022-07-21T11:13:12.345Z" - } # ConfigurationItemRequest | - try: - # Update Reassignment Configuration - Result = configuration_item_request.from_json(configuration_item_request) - api_response = api_instance.put_reassignment_config(identity_id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_reassignment_config(identity_id, Result) - print("The response of WorkReassignmentApi->put_reassignment_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling WorkReassignmentApi->put_reassignment_config: %s\n" % e) + }''' # ConfigurationItemRequest | + try: + # Update Reassignment Configuration + new_configuration_item_request = ConfigurationItemRequest.from_json(configuration_item_request) + results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id=identity_id, configuration_item_request=new_configuration_item_request) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id, new_configuration_item_request) + print("The response of WorkReassignmentApi->put_reassignment_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_reassignment_config: %s\n" % e) - path: /reassignment-configurations/tenant-config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/beta/methods/work-reassignment#put-tenant-configuration source: | - tenant_configuration_request = { + tenant_configuration_request = '''{ "configDetails" : { "disabled" : true } - } # TenantConfigurationRequest | - try: - # Update Tenant-wide Reassignment Configuration settings - Result = tenant_configuration_request.from_json(tenant_configuration_request) - api_response = api_instance.put_tenant_configuration(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_tenant_configuration(Result) - print("The response of WorkReassignmentApi->put_tenant_configuration:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) + }''' # TenantConfigurationRequest | + try: + # Update Tenant-wide Reassignment Configuration settings + new_tenant_configuration_request = TenantConfigurationRequest.from_json(tenant_configuration_request) + results = WorkReassignmentApi(api_client).put_tenant_configuration(tenant_configuration_request=new_tenant_configuration_request) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).put_tenant_configuration(new_tenant_configuration_request) + print("The response of WorkReassignmentApi->put_tenant_configuration:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) diff --git a/sailpoint/v2024/docs/Examples/python_code_examples_overlay.yaml b/sailpoint/v2024/docs/Examples/python_code_examples_overlay.yaml index e26f867e3..0048892bb 100644 --- a/sailpoint/v2024/docs/Examples/python_code_examples_overlay.yaml +++ b/sailpoint/v2024/docs/Examples/python_code_examples_overlay.yaml @@ -7,16 +7,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.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: - print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute: %s\n" % e) + # Get Access Model Metadata Attribute + + results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key=key, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute: %s\n" % e) - path: /access-model-metadata/attributes/{key}/values/{value} method: GET xCodeSample: @@ -27,16 +26,15 @@ 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') try: - # Get Access Model Metadata Value - - api_response = api_instance.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) - print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute_value:\n") - pprint(api_response) + # Get Access Model Metadata Value + + results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key=key, value=value, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute_value: %s\n" % e) + print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute_value: %s\n" % e) - path: /access-model-metadata/attributes method: GET xCodeSample: @@ -46,16 +44,15 @@ x_sail_point_experimental = 'true' # 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_access_model_metadata_attribute(x_sail_point_experimental, filters) - print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") - pprint(api_response) + # List Access Model Metadata Attributes + + results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) + print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) - path: /access-model-metadata/attributes/{key}/values method: GET xCodeSample: @@ -65,23 +62,22 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.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) + # List Access Model Metadata Values + + results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key=key, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) + print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) - path: /access-profiles method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-profiles#create-access-profile source: | - access_profile = { + access_profile = '''{ "owner" : { "name" : "support", "id" : "2c9180a46faadee4016fb4e018c20639", @@ -165,18 +161,17 @@ "modified" : "2021-03-02T20:22:28.104Z", "id" : "2c91808a7190d06e01719938fcd20792", "requestable" : true - } # AccessProfile | - try: - # Create Access Profile - Result = access_profile.from_json(access_profile) - api_response = api_instance.create_access_profile(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_access_profile(Result) - print("The response of AccessProfilesApi->create_access_profile:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessProfilesApi->create_access_profile: %s\n" % e) + }''' # AccessProfile | + try: + # Create Access Profile + new_access_profile = AccessProfile.from_json(access_profile) + results = AccessProfilesApi(api_client).create_access_profile(access_profile=new_access_profile) + # Below is a request that includes all optional parameters + # results = AccessProfilesApi(api_client).create_access_profile(new_access_profile) + print("The response of AccessProfilesApi->create_access_profile:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->create_access_profile: %s\n" % e) - path: /access-profiles/{id} method: DELETE xCodeSample: @@ -185,35 +180,33 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_access_profile(id) + # Delete the specified Access Profile + + AccessProfilesApi(api_client).delete_access_profile(id=id) + # Below is a request that includes all optional parameters + # AccessProfilesApi(api_client).delete_access_profile(id) except Exception as e: - print("Exception when calling AccessProfilesApi->delete_access_profile: %s\n" % e) + print("Exception when calling AccessProfilesApi->delete_access_profile: %s\n" % e) - path: /access-profiles/bulk-delete method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-profiles#delete-access-profiles-in-bulk source: | - access_profile_bulk_delete_request = { + access_profile_bulk_delete_request = '''{ "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], "bestEffortOnly" : true - } # AccessProfileBulkDeleteRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_access_profiles_in_bulk(Result) - print("The response of AccessProfilesApi->delete_access_profiles_in_bulk:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessProfilesApi->delete_access_profiles_in_bulk: %s\n" % e) + }''' # AccessProfileBulkDeleteRequest | + try: + # Delete Access Profile(s) + new_access_profile_bulk_delete_request = AccessProfileBulkDeleteRequest.from_json(access_profile_bulk_delete_request) + results = AccessProfilesApi(api_client).delete_access_profiles_in_bulk(access_profile_bulk_delete_request=new_access_profile_bulk_delete_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->delete_access_profiles_in_bulk: %s\n" % e) - path: /access-profiles/{id} method: GET xCodeSample: @@ -222,16 +215,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_access_profile(id) - print("The response of AccessProfilesApi->get_access_profile:\n") - pprint(api_response) + # Get an Access Profile + + results = AccessProfilesApi(api_client).get_access_profile(id=id) + # Below is a request that includes all optional parameters + # results = AccessProfilesApi(api_client).get_access_profile(id) + print("The response of AccessProfilesApi->get_access_profile:\n") + pprint(results) except Exception as e: - print("Exception when calling AccessProfilesApi->get_access_profile: %s\n" % e) + print("Exception when calling AccessProfilesApi->get_access_profile: %s\n" % e) - path: /access-profiles/{id}/entitlements method: GET xCodeSample: @@ -245,16 +237,15 @@ filters = 'attribute eq \"memberOf\"' # 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) sorters = 'name,-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-results) Sorting is supported for the following fields: **name, attribute, value, created, 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-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) try: - # List Access Profile's Entitlements - - api_response = api_instance.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) - print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") - pprint(api_response) + # List Access Profile's Entitlements + + results = AccessProfilesApi(api_client).get_access_profile_entitlements(id=id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) + print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) - path: /access-profiles method: GET xCodeSample: @@ -270,16 +261,15 @@ for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) try: - # List Access Profiles - - api_response = api_instance.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) - print("The response of AccessProfilesApi->list_access_profiles:\n") - pprint(api_response) + # List Access Profiles + + results = AccessProfilesApi(api_client).list_access_profiles() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) + print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) - path: /access-profiles/{id} method: PATCH xCodeSample: @@ -287,24 +277,17 @@ label: SDK_tools/sdk/python/v2024/methods/access-profiles#patch-access-profile source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | - - try: - # Patch a specified Access Profile - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_access_profile(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_access_profile(id, Result) - print("The response of AccessProfilesApi->patch_access_profile:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e) + json_patch_operation = '''[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}]''' # List[JsonPatchOperation] | + try: + # Patch a specified Access Profile + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = AccessProfilesApi(api_client).patch_access_profile(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = AccessProfilesApi(api_client).patch_access_profile(id, new_json_patch_operation) + print("The response of AccessProfilesApi->patch_access_profile:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e) - path: /access-profiles/bulk-update-requestable method: POST xCodeSample: @@ -312,20 +295,17 @@ label: SDK_tools/sdk/python/v2024/methods/access-profiles#update-access-profiles-in-bulk 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') - [{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] | - + 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(x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_access_profiles_in_bulk(x_sail_point_experimental, Result) - print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") - pprint(api_response) + # Update Access Profile(s) requestable field. + new_access_profile_bulk_update_request_inner = AccessProfileBulkUpdateRequestInner.from_json(access_profile_bulk_update_request_inner) + results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(x_sail_point_experimental=x_sail_point_experimental, access_profile_bulk_update_request_inner=new_access_profile_bulk_update_request_inner) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) + print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) - path: /access-request-approvals/{approvalId}/approve method: POST xCodeSample: @@ -333,7 +313,7 @@ label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#approve-access-request source: | approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. - comment_dto = { + comment_dto = '''{ "created" : "2017-07-11T18:45:37.098Z", "author" : { "name" : "john.doe", @@ -341,18 +321,17 @@ "type" : "IDENTITY" }, "comment" : "This is a comment." - } # CommentDto | Reviewer's comment. (optional) - try: - # Approve Access Request Approval - - api_response = api_instance.approve_access_request(approval_id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.approve_access_request(approval_id, Result) - print("The response of AccessRequestApprovalsApi->approve_access_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->approve_access_request: %s\n" % e) + }''' # CommentDto | Reviewer's comment. (optional) + try: + # Approve Access Request Approval + + results = AccessRequestApprovalsApi(api_client).approve_access_request(approval_id=approval_id) + # Below is a request that includes all optional parameters + # results = AccessRequestApprovalsApi(api_client).approve_access_request(approval_id, new_comment_dto) + print("The response of AccessRequestApprovalsApi->approve_access_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->approve_access_request: %s\n" % e) - path: /access-request-approvals/{approvalId}/forward method: POST xCodeSample: @@ -360,21 +339,20 @@ label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#forward-access-request source: | approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. - forward_approval_dto = { + forward_approval_dto = '''{ "newOwnerId" : "2c91808568c529c60168cca6f90c1314", "comment" : "2c91808568c529c60168cca6f90c1313" - } # ForwardApprovalDto | Information about the forwarded approval. - try: - # Forward Access Request Approval - Result = forward_approval_dto.from_json(forward_approval_dto) - api_response = api_instance.forward_access_request(approval_id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.forward_access_request(approval_id, Result) - print("The response of AccessRequestApprovalsApi->forward_access_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->forward_access_request: %s\n" % e) + }''' # ForwardApprovalDto | Information about the forwarded approval. + try: + # Forward Access Request Approval + new_forward_approval_dto = ForwardApprovalDto.from_json(forward_approval_dto) + results = AccessRequestApprovalsApi(api_client).forward_access_request(approval_id=approval_id, forward_approval_dto=new_forward_approval_dto) + # Below is a request that includes all optional parameters + # results = AccessRequestApprovalsApi(api_client).forward_access_request(approval_id, new_forward_approval_dto) + print("The response of AccessRequestApprovalsApi->forward_access_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->forward_access_request: %s\n" % e) - path: /access-request-approvals/approval-summary method: GET xCodeSample: @@ -384,16 +362,15 @@ 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_access_request_approval_summary(owner_id, from_date) - print("The response of AccessRequestApprovalsApi->get_access_request_approval_summary:\n") - pprint(api_response) + # Get Access Requests Approvals Number + + results = AccessRequestApprovalsApi(api_client).get_access_request_approval_summary() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->get_access_request_approval_summary: %s\n" % e) + print("Exception when calling AccessRequestApprovalsApi->get_access_request_approval_summary: %s\n" % e) - path: /access-request-approvals/{accessRequestId}/approvers method: GET xCodeSample: @@ -405,16 +382,15 @@ 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) count = False # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to False) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to False) try: - # Access Request Approvers - - api_response = api_instance.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) - print("The response of AccessRequestApprovalsApi->list_access_request_approvers:\n") - pprint(api_response) + # Access Request Approvers + + results = AccessRequestApprovalsApi(api_client).list_access_request_approvers(access_request_id=access_request_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->list_access_request_approvers: %s\n" % e) + print("Exception when calling AccessRequestApprovalsApi->list_access_request_approvers: %s\n" % e) - path: /access-request-approvals/completed method: GET xCodeSample: @@ -428,16 +404,15 @@ filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # 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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, 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: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) 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-results) Sorting is supported for the following fields: **created, 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-results) Sorting is supported for the following fields: **created, modified** (optional) try: - # Completed Access Request Approvals List - - api_response = api_instance.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) - print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") - pprint(api_response) + # Completed Access Request Approvals List + + results = AccessRequestApprovalsApi(api_client).list_completed_approvals() + # Below is a request that includes all optional parameters + # results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") + pprint(results) except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) + print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) - path: /access-request-approvals/pending method: GET xCodeSample: @@ -451,16 +426,15 @@ filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *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: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) 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-results) Sorting is supported for the following fields: **created, 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-results) Sorting is supported for the following fields: **created, modified** (optional) try: - # Pending Access Request Approvals List - - api_response = api_instance.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) - print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") - pprint(api_response) + # Pending Access Request Approvals List + + results = AccessRequestApprovalsApi(api_client).list_pending_approvals() + # Below is a request that includes all optional parameters + # results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") + pprint(results) except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) + print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) - path: /access-request-approvals/{approvalId}/reject method: POST xCodeSample: @@ -468,7 +442,7 @@ label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#reject-access-request source: | approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. - comment_dto = { + comment_dto = '''{ "created" : "2017-07-11T18:45:37.098Z", "author" : { "name" : "john.doe", @@ -476,18 +450,17 @@ "type" : "IDENTITY" }, "comment" : "This is a comment." - } # CommentDto | Reviewer's comment. - try: - # Reject Access Request Approval - Result = comment_dto.from_json(comment_dto) - api_response = api_instance.reject_access_request(approval_id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.reject_access_request(approval_id, Result) - print("The response of AccessRequestApprovalsApi->reject_access_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e) + }''' # CommentDto | Reviewer's comment. + try: + # Reject Access Request Approval + new_comment_dto = CommentDto.from_json(comment_dto) + results = AccessRequestApprovalsApi(api_client).reject_access_request(approval_id=approval_id, comment_dto=new_comment_dto) + # Below is a request that includes all optional parameters + # results = AccessRequestApprovalsApi(api_client).reject_access_request(approval_id, new_comment_dto) + print("The response of AccessRequestApprovalsApi->reject_access_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e) - path: /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type} method: GET xCodeSample: @@ -498,79 +471,75 @@ 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. try: - # Return access request identity metrics - - api_response = api_instance.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) - print("The response of AccessRequestIdentityMetricsApi->get_access_request_identity_metrics:\n") - pprint(api_response) + # Return access request identity metrics + + results = AccessRequestIdentityMetricsApi(api_client).get_access_request_identity_metrics(identity_id=identity_id, requested_object_id=requested_object_id, type=type) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccessRequestIdentityMetricsApi->get_access_request_identity_metrics: %s\n" % e) + print("Exception when calling AccessRequestIdentityMetricsApi->get_access_request_identity_metrics: %s\n" % e) - path: /access-request-approvals/bulk-approve method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-requests#approve-bulk-access-request source: | - bulk_approve_access_request = { + bulk_approve_access_request = '''{ "comment" : "I approve these request items", "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] - } # BulkApproveAccessRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.approve_bulk_access_request(Result) - print("The response of AccessRequestsApi->approve_bulk_access_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessRequestsApi->approve_bulk_access_request: %s\n" % e) + }''' # BulkApproveAccessRequest | + try: + # Bulk Approve Access Request + new_bulk_approve_access_request = BulkApproveAccessRequest.from_json(bulk_approve_access_request) + results = AccessRequestsApi(api_client).approve_bulk_access_request(bulk_approve_access_request=new_bulk_approve_access_request) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).approve_bulk_access_request(new_bulk_approve_access_request) + print("The response of AccessRequestsApi->approve_bulk_access_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->approve_bulk_access_request: %s\n" % e) - path: /access-requests/cancel method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-requests#cancel-access-request source: | - cancel_access_request = { + cancel_access_request = '''{ "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", "comment" : "I requested this role by mistake." - } # CancelAccessRequest | - try: - # Cancel Access Request - Result = cancel_access_request.from_json(cancel_access_request) - api_response = api_instance.cancel_access_request(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.cancel_access_request(Result) - print("The response of AccessRequestsApi->cancel_access_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e) + }''' # CancelAccessRequest | + try: + # Cancel Access Request + new_cancel_access_request = CancelAccessRequest.from_json(cancel_access_request) + results = AccessRequestsApi(api_client).cancel_access_request(cancel_access_request=new_cancel_access_request) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).cancel_access_request(new_cancel_access_request) + print("The response of AccessRequestsApi->cancel_access_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e) - path: /access-requests/bulk-cancel method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-requests#cancel-access-request-in-bulk source: | - bulk_cancel_access_request = { + bulk_cancel_access_request = '''{ "accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ], "comment" : "I requested this role by mistake." - } # BulkCancelAccessRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.cancel_access_request_in_bulk(Result) - print("The response of AccessRequestsApi->cancel_access_request_in_bulk:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessRequestsApi->cancel_access_request_in_bulk: %s\n" % e) + }''' # BulkCancelAccessRequest | + try: + # Bulk Cancel Access Request + new_bulk_cancel_access_request = BulkCancelAccessRequest.from_json(bulk_cancel_access_request) + results = AccessRequestsApi(api_client).cancel_access_request_in_bulk(bulk_cancel_access_request=new_bulk_cancel_access_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->cancel_access_request_in_bulk: %s\n" % e) - path: /access-requests/close method: POST xCodeSample: @@ -578,30 +547,29 @@ label: SDK_tools/sdk/python/v2024/methods/access-requests#close-access-request 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') - close_access_request = { + close_access_request = '''{ "executionStatus" : "Terminated", "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], "completionStatus" : "Failure", "message" : "The IdentityNow Administrator manually closed this request." - } # CloseAccessRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.close_access_request(x_sail_point_experimental, Result) - print("The response of AccessRequestsApi->close_access_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessRequestsApi->close_access_request: %s\n" % e) + }''' # CloseAccessRequest | + try: + # Close Access Request + new_close_access_request = CloseAccessRequest.from_json(close_access_request) + results = AccessRequestsApi(api_client).close_access_request(x_sail_point_experimental=x_sail_point_experimental, close_access_request=new_close_access_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->close_access_request: %s\n" % e) - path: /access-requests method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-requests#create-access-request source: | - access_request = { + access_request = '''{ "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", @@ -654,18 +622,17 @@ "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" } ] - } # AccessRequest | - try: - # Submit Access Request - Result = access_request.from_json(access_request) - api_response = api_instance.create_access_request(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_access_request(Result) - print("The response of AccessRequestsApi->create_access_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessRequestsApi->create_access_request: %s\n" % e) + }''' # AccessRequest | + try: + # Submit Access Request + new_access_request = AccessRequest.from_json(access_request) + results = AccessRequestsApi(api_client).create_access_request(access_request=new_access_request) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).create_access_request(new_access_request) + print("The response of AccessRequestsApi->create_access_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->create_access_request: %s\n" % e) - path: /access-request-config method: GET xCodeSample: @@ -673,16 +640,15 @@ label: SDK_tools/sdk/python/v2024/methods/access-requests#get-access-request-config source: | try: - # Get Access Request Configuration - - api_response = api_instance.get_access_request_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_access_request_config() - print("The response of AccessRequestsApi->get_access_request_config:\n") - pprint(api_response) + # Get Access Request Configuration + + results = AccessRequestsApi(api_client).get_access_request_config() + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).get_access_request_config() + print("The response of AccessRequestsApi->get_access_request_config:\n") + pprint(results) except Exception as e: - print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e) + print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e) - path: /access-request-status method: GET xCodeSample: @@ -700,16 +666,15 @@ sorters = 'created' # 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: **created, modified, accountActivityItemId, 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: **created, modified, accountActivityItemId, name** (optional) request_state = 'request-state=EXECUTING' # str | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) # str | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) try: - # Access Request Status - - api_response = api_instance.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) - print("The response of AccessRequestsApi->list_access_request_status:\n") - pprint(api_response) + # Access Request Status + + results = AccessRequestsApi(api_client).list_access_request_status() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) + print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) - path: /access-request-administration method: GET xCodeSample: @@ -727,23 +692,22 @@ sorters = 'created' # 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: **created, modified, accountActivityItemId, name, accessRequestId** (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: **created, modified, accountActivityItemId, name, accessRequestId** (optional) request_state = 'request-state=EXECUTING' # str | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) # str | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) try: - # Access Request Status for Administrators - - api_response = api_instance.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) - print("The response of AccessRequestsApi->list_administrators_access_request_status:\n") - pprint(api_response) + # Access Request Status for Administrators + + results = AccessRequestsApi(api_client).list_administrators_access_request_status() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccessRequestsApi->list_administrators_access_request_status: %s\n" % e) + print("Exception when calling AccessRequestsApi->list_administrators_access_request_status: %s\n" % e) - path: /access-request-config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-requests#set-access-request-config source: | - access_request_config = { + access_request_config = '''{ "requestOnBehalfOfConfig" : { "allowRequestOnBehalfOfEmployeeByManager" : true, "allowRequestOnBehalfOfAnyoneByAnyone" : true @@ -768,18 +732,17 @@ }, "reauthorizationEnabled" : true, "approvalsMustBeExternal" : true - } # AccessRequestConfig | - try: - # Update Access Request Configuration - Result = access_request_config.from_json(access_request_config) - api_response = api_instance.set_access_request_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_access_request_config(Result) - print("The response of AccessRequestsApi->set_access_request_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessRequestsApi->set_access_request_config: %s\n" % e) + }''' # AccessRequestConfig | + try: + # Update Access Request Configuration + new_access_request_config = AccessRequestConfig.from_json(access_request_config) + results = AccessRequestsApi(api_client).set_access_request_config(access_request_config=new_access_request_config) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).set_access_request_config(new_access_request_config) + print("The response of AccessRequestsApi->set_access_request_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->set_access_request_config: %s\n" % e) - path: /account-activities/{id} method: GET xCodeSample: @@ -788,16 +751,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_account_activity(id) - print("The response of AccountActivitiesApi->get_account_activity:\n") - pprint(api_response) + # Get an Account Activity + + results = AccountActivitiesApi(api_client).get_account_activity(id=id) + # Below is a request that includes all optional parameters + # results = AccountActivitiesApi(api_client).get_account_activity(id) + print("The response of AccountActivitiesApi->get_account_activity:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountActivitiesApi->get_account_activity: %s\n" % e) + print("Exception when calling AccountActivitiesApi->get_account_activity: %s\n" % e) - path: /account-activities method: GET xCodeSample: @@ -813,16 +775,15 @@ filters = 'type eq \"Identity Refresh\"' # 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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, 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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) sorters = 'created' # 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: **type, created, 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-results) Sorting is supported for the following fields: **type, created, modified** (optional) try: - # List Account Activities - - api_response = api_instance.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) - print("The response of AccountActivitiesApi->list_account_activities:\n") - pprint(api_response) + # List Account Activities + + results = AccountActivitiesApi(api_client).list_account_activities() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) + print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) - path: /account-aggregations/{id}/status method: GET xCodeSample: @@ -832,23 +793,22 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_account_aggregation_status(id, x_sail_point_experimental) - print("The response of AccountAggregationsApi->get_account_aggregation_status:\n") - pprint(api_response) + # In-progress Account Aggregation status + + results = AccountAggregationsApi(api_client).get_account_aggregation_status(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AccountAggregationsApi(api_client).get_account_aggregation_status(id, x_sail_point_experimental) + print("The response of AccountAggregationsApi->get_account_aggregation_status:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) + print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) - path: /accounts method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#create-account source: | - account_attributes_create = { + account_attributes_create = '''{ "attributes" : { "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", "city" : "Austin", @@ -857,18 +817,17 @@ "sAMAccountName" : "jDoe", "mail" : "john.doe@sailpoint.com" } - } # AccountAttributesCreate | - try: - # Create Account - Result = account_attributes_create.from_json(account_attributes_create) - api_response = api_instance.create_account(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_account(Result) - print("The response of AccountsApi->create_account:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccountsApi->create_account: %s\n" % e) + }''' # AccountAttributesCreate | + try: + # Create Account + new_account_attributes_create = AccountAttributesCreate.from_json(account_attributes_create) + results = AccountsApi(api_client).create_account(account_attributes_create=new_account_attributes_create) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).create_account(new_account_attributes_create) + print("The response of AccountsApi->create_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->create_account: %s\n" % e) - path: /accounts/{id} method: DELETE xCodeSample: @@ -877,16 +836,15 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. try: - # Delete Account - - api_response = api_instance.delete_account(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_account(id) - print("The response of AccountsApi->delete_account:\n") - pprint(api_response) + # Delete Account + + results = AccountsApi(api_client).delete_account(id=id) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).delete_account(id) + print("The response of AccountsApi->delete_account:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountsApi->delete_account: %s\n" % e) + print("Exception when calling AccountsApi->delete_account: %s\n" % e) - path: /accounts/{id}/remove method: POST xCodeSample: @@ -896,16 +854,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_account_async(id, x_sail_point_experimental) - print("The response of AccountsApi->delete_account_async:\n") - pprint(api_response) + # Remove Account + + results = AccountsApi(api_client).delete_account_async(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).delete_account_async(id, x_sail_point_experimental) + print("The response of AccountsApi->delete_account_async:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountsApi->delete_account_async: %s\n" % e) + print("Exception when calling AccountsApi->delete_account_async: %s\n" % e) - path: /accounts/{id}/disable method: POST xCodeSample: @@ -913,21 +870,20 @@ label: SDK_tools/sdk/python/v2024/methods/accounts#disable-account source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id - account_toggle_request = { + account_toggle_request = '''{ "forceProvisioning" : false, "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" - } # AccountToggleRequest | - try: - # Disable Account - Result = account_toggle_request.from_json(account_toggle_request) - api_response = api_instance.disable_account(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.disable_account(id, Result) - print("The response of AccountsApi->disable_account:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccountsApi->disable_account: %s\n" % e) + }''' # AccountToggleRequest | + try: + # Disable Account + new_account_toggle_request = AccountToggleRequest.from_json(account_toggle_request) + results = AccountsApi(api_client).disable_account(id=id, account_toggle_request=new_account_toggle_request) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).disable_account(id, new_account_toggle_request) + print("The response of AccountsApi->disable_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->disable_account: %s\n" % e) - path: /identities-accounts/{id}/disable method: POST xCodeSample: @@ -937,16 +893,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.disable_account_for_identity(id, x_sail_point_experimental) - print("The response of AccountsApi->disable_account_for_identity:\n") - pprint(api_response) + # Disable IDN Account for Identity + + results = AccountsApi(api_client).disable_account_for_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).disable_account_for_identity(id, x_sail_point_experimental) + print("The response of AccountsApi->disable_account_for_identity:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountsApi->disable_account_for_identity: %s\n" % e) + print("Exception when calling AccountsApi->disable_account_for_identity: %s\n" % e) - path: /identities-accounts/disable method: POST xCodeSample: @@ -954,20 +909,19 @@ label: SDK_tools/sdk/python/v2024/methods/accounts#disable-accounts-for-identities 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') - identities_accounts_bulk_request = { + 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(x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.disable_accounts_for_identities(x_sail_point_experimental, Result) - print("The response of AccountsApi->disable_accounts_for_identities:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) + }''' # IdentitiesAccountsBulkRequest | + try: + # Disable IDN Accounts for Identities + new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest.from_json(identities_accounts_bulk_request) + results = AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental=x_sail_point_experimental, identities_accounts_bulk_request=new_identities_accounts_bulk_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) - path: /accounts/{id}/enable method: POST xCodeSample: @@ -975,21 +929,20 @@ label: SDK_tools/sdk/python/v2024/methods/accounts#enable-account source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id - account_toggle_request = { + account_toggle_request = '''{ "forceProvisioning" : false, "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" - } # AccountToggleRequest | - try: - # Enable Account - Result = account_toggle_request.from_json(account_toggle_request) - api_response = api_instance.enable_account(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.enable_account(id, Result) - print("The response of AccountsApi->enable_account:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccountsApi->enable_account: %s\n" % e) + }''' # AccountToggleRequest | + try: + # Enable Account + new_account_toggle_request = AccountToggleRequest.from_json(account_toggle_request) + results = AccountsApi(api_client).enable_account(id=id, account_toggle_request=new_account_toggle_request) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).enable_account(id, new_account_toggle_request) + print("The response of AccountsApi->enable_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->enable_account: %s\n" % e) - path: /identities-accounts/{id}/enable method: POST xCodeSample: @@ -999,16 +952,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.enable_account_for_identity(id, x_sail_point_experimental) - print("The response of AccountsApi->enable_account_for_identity:\n") - pprint(api_response) + # Enable IDN Account for Identity + + results = AccountsApi(api_client).enable_account_for_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).enable_account_for_identity(id, x_sail_point_experimental) + print("The response of AccountsApi->enable_account_for_identity:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountsApi->enable_account_for_identity: %s\n" % e) + print("Exception when calling AccountsApi->enable_account_for_identity: %s\n" % e) - path: /identities-accounts/enable method: POST xCodeSample: @@ -1016,20 +968,19 @@ label: SDK_tools/sdk/python/v2024/methods/accounts#enable-accounts-for-identities 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') - identities_accounts_bulk_request = { + 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(x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.enable_accounts_for_identities(x_sail_point_experimental, Result) - print("The response of AccountsApi->enable_accounts_for_identities:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) + }''' # IdentitiesAccountsBulkRequest | + try: + # Enable IDN Accounts for Identities + new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest.from_json(identities_accounts_bulk_request) + results = AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental=x_sail_point_experimental, identities_accounts_bulk_request=new_identities_accounts_bulk_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) - path: /accounts/{id} method: GET xCodeSample: @@ -1038,16 +989,15 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. try: - # Account Details - - api_response = api_instance.get_account(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_account(id) - print("The response of AccountsApi->get_account:\n") - pprint(api_response) + # Account Details + + results = AccountsApi(api_client).get_account(id=id) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).get_account(id) + print("The response of AccountsApi->get_account:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountsApi->get_account: %s\n" % e) + print("Exception when calling AccountsApi->get_account: %s\n" % e) - path: /accounts/{id}/entitlements method: GET xCodeSample: @@ -1059,16 +1009,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) 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) try: - # Account Entitlements - - api_response = api_instance.get_account_entitlements(id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_account_entitlements(id, limit, offset, count) - print("The response of AccountsApi->get_account_entitlements:\n") - pprint(api_response) + # Account Entitlements + + results = AccountsApi(api_client).get_account_entitlements(id=id) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).get_account_entitlements(id, limit, offset, count) + print("The response of AccountsApi->get_account_entitlements:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) + print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) - path: /accounts method: GET xCodeSample: @@ -1082,16 +1031,15 @@ filters = 'identityId eq \"2c9180858082150f0180893dbaf44201\"' # 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) sorters = 'id,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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) try: - # Accounts List - - api_response = api_instance.list_accounts() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_accounts(limit, offset, count, detail_level, filters, sorters) - print("The response of AccountsApi->list_accounts:\n") - pprint(api_response) + # Accounts List + + results = AccountsApi(api_client).list_accounts() + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).list_accounts(limit, offset, count, detail_level, filters, sorters) + print("The response of AccountsApi->list_accounts:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountsApi->list_accounts: %s\n" % e) + print("Exception when calling AccountsApi->list_accounts: %s\n" % e) - path: /accounts/{id} method: PUT xCodeSample: @@ -1099,7 +1047,7 @@ label: SDK_tools/sdk/python/v2024/methods/accounts#put-account source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. - account_attributes = { + account_attributes = '''{ "attributes" : { "city" : "Austin", "displayName" : "John Doe", @@ -1107,18 +1055,17 @@ "sAMAccountName" : "jDoe", "mail" : "john.doe@sailpoint.com" } - } # AccountAttributes | - try: - # Update Account - Result = account_attributes.from_json(account_attributes) - api_response = api_instance.put_account(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_account(id, Result) - print("The response of AccountsApi->put_account:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccountsApi->put_account: %s\n" % e) + }''' # AccountAttributes | + try: + # Update Account + new_account_attributes = AccountAttributes.from_json(account_attributes) + results = AccountsApi(api_client).put_account(id=id, account_attributes=new_account_attributes) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).put_account(id, new_account_attributes) + print("The response of AccountsApi->put_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->put_account: %s\n" % e) - path: /accounts/{id}/reload method: POST xCodeSample: @@ -1127,16 +1074,15 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id try: - # Reload Account - - api_response = api_instance.submit_reload_account(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.submit_reload_account(id) - print("The response of AccountsApi->submit_reload_account:\n") - pprint(api_response) + # Reload Account + + results = AccountsApi(api_client).submit_reload_account(id=id) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).submit_reload_account(id) + print("The response of AccountsApi->submit_reload_account:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountsApi->submit_reload_account: %s\n" % e) + print("Exception when calling AccountsApi->submit_reload_account: %s\n" % e) - path: /accounts/{id}/unlock method: POST xCodeSample: @@ -1144,22 +1090,21 @@ label: SDK_tools/sdk/python/v2024/methods/accounts#unlock-account source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. # str | The account ID. - account_unlock_request = { + account_unlock_request = '''{ "forceProvisioning" : false, "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", "unlockIDNAccount" : false - } # AccountUnlockRequest | - try: - # Unlock Account - Result = account_unlock_request.from_json(account_unlock_request) - api_response = api_instance.unlock_account(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.unlock_account(id, Result) - print("The response of AccountsApi->unlock_account:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccountsApi->unlock_account: %s\n" % e) + }''' # AccountUnlockRequest | + try: + # Unlock Account + new_account_unlock_request = AccountUnlockRequest.from_json(account_unlock_request) + results = AccountsApi(api_client).unlock_account(id=id, account_unlock_request=new_account_unlock_request) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).unlock_account(id, new_account_unlock_request) + print("The response of AccountsApi->unlock_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->unlock_account: %s\n" % e) - path: /accounts/{id} method: PATCH xCodeSample: @@ -1167,20 +1112,17 @@ label: SDK_tools/sdk/python/v2024/methods/accounts#update-account source: | 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. - - try: - # Update Account - Result = request_body.from_json(request_body) - api_response = api_instance.update_account(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_account(id, Result) - print("The response of AccountsApi->update_account:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccountsApi->update_account: %s\n" % e) + 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. + try: + # Update Account + new_request_body = RequestBody.from_json(request_body) + results = AccountsApi(api_client).update_account(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).update_account(id, new_request_body) + print("The response of AccountsApi->update_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->update_account: %s\n" % e) - path: /account-usages/{accountId}/summaries method: GET xCodeSample: @@ -1193,16 +1135,15 @@ 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) sorters = '-date' # 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: **date** (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: **date** (optional) try: - # Returns account usage insights - - api_response = api_instance.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) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - pprint(api_response) + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: @@ -1215,16 +1156,15 @@ filter = 'name eq \"Okta\" and description co \"Okta\" and discoverySource in (\"csv\", \"Okta Saas\")' # 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, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) 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, description, discoveredAt, discoverySource** (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, description, discoveredAt, discoverySource** (optional) try: - # Get Discovered Applications for Tenant - - api_response = api_instance.get_discovered_applications() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_discovered_applications(limit, offset, detail, filter, sorters) - print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") - pprint(api_response) + # Get Discovered Applications for Tenant + + results = ApplicationDiscoveryApi(api_client).get_discovered_applications() + # Below is a request that includes all optional parameters + # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) + print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") + pprint(results) except Exception as e: - print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) + print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) - path: /manual-discover-applications-template method: GET xCodeSample: @@ -1232,16 +1172,15 @@ label: SDK_tools/sdk/python/v2024/methods/application-discovery#get-manual-discover-applications-csv-template source: | try: - # Download CSV Template for Discovery - - api_response = api_instance.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() - print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n") - pprint(api_response) + # Download CSV Template for Discovery + + results = ApplicationDiscoveryApi(api_client).get_manual_discover_applications_csv_template() + # Below is a request that includes all optional parameters + # results = ApplicationDiscoveryApi(api_client).get_manual_discover_applications_csv_template() + print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n") + pprint(results) except Exception as e: - print("Exception when calling ApplicationDiscoveryApi->get_manual_discover_applications_csv_template: %s\n" % e) + print("Exception when calling ApplicationDiscoveryApi->get_manual_discover_applications_csv_template: %s\n" % e) - path: /manual-discover-applications method: POST xCodeSample: @@ -1250,14 +1189,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.send_manual_discover_applications_csv_template(file) + # Upload CSV to Discover Applications + + ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file=file) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling ApplicationDiscoveryApi->send_manual_discover_applications_csv_template: %s\n" % e) - path: /generic-approvals/{id} method: GET xCodeSample: @@ -1267,16 +1205,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_approval(id, x_sail_point_experimental) - print("The response of ApprovalsApi->get_approval:\n") - pprint(api_response) + # Get an approval + + results = ApprovalsApi(api_client).get_approval(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = ApprovalsApi(api_client).get_approval(id, x_sail_point_experimental) + print("The response of ApprovalsApi->get_approval:\n") + pprint(results) except Exception as e: - print("Exception when calling ApprovalsApi->get_approval: %s\n" % e) + print("Exception when calling ApprovalsApi->get_approval: %s\n" % e) - path: /generic-approvals method: GET xCodeSample: @@ -1288,16 +1225,15 @@ 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) try: - # Get Approvals - - api_response = api_instance.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) - print("The response of ApprovalsApi->get_approvals:\n") - pprint(api_response) + # Get Approvals + + results = ApprovalsApi(api_client).get_approvals(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = ApprovalsApi(api_client).get_approvals(x_sail_point_experimental, mine, requester_id, filters) + print("The response of ApprovalsApi->get_approvals:\n") + pprint(results) except Exception as e: - print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) + print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) - path: /source-apps method: POST xCodeSample: @@ -1305,7 +1241,7 @@ label: SDK_tools/sdk/python/v2024/methods/apps#create-source-app 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') - source_app_create_dto = { + source_app_create_dto = '''{ "name" : "my app", "description" : "the source app for engineers", "accountSource" : { @@ -1314,18 +1250,17 @@ "type" : "SOURCE" }, "matchAllAccounts" : true - } # SourceAppCreateDto | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_source_app(x_sail_point_experimental, Result) - print("The response of AppsApi->create_source_app:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AppsApi->create_source_app: %s\n" % e) + }''' # SourceAppCreateDto | + try: + # Create source app + new_source_app_create_dto = SourceAppCreateDto.from_json(source_app_create_dto) + results = AppsApi(api_client).create_source_app(x_sail_point_experimental=x_sail_point_experimental, source_app_create_dto=new_source_app_create_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling AppsApi->create_source_app: %s\n" % e) - path: /source-apps/{id}/access-profiles/bulk-remove method: POST xCodeSample: @@ -1334,21 +1269,18 @@ source: | 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] | - request_body = [c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9] # List[str] | - + request_body = '''[c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9]''' # List[str] | limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) 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, ) - - # 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) - print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") - pprint(api_response) + # Bulk remove access profiles from the specified source app + new_request_body = RequestBody.from_json(request_body) + results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id=id, x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) + print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) - path: /source-apps/{id} method: DELETE xCodeSample: @@ -1358,16 +1290,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_source_app(id, x_sail_point_experimental) - print("The response of AppsApi->delete_source_app:\n") - pprint(api_response) + # Delete source app by ID + + results = AppsApi(api_client).delete_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).delete_source_app(id, x_sail_point_experimental) + print("The response of AppsApi->delete_source_app:\n") + pprint(results) except Exception as e: - print("Exception when calling AppsApi->delete_source_app: %s\n" % e) + print("Exception when calling AppsApi->delete_source_app: %s\n" % e) - path: /source-apps/{id} method: GET xCodeSample: @@ -1377,16 +1308,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_app(id, x_sail_point_experimental) - print("The response of AppsApi->get_source_app:\n") - pprint(api_response) + # Get source app by ID + + results = AppsApi(api_client).get_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).get_source_app(id, x_sail_point_experimental) + print("The response of AppsApi->get_source_app:\n") + pprint(results) except Exception as e: - print("Exception when calling AppsApi->get_source_app: %s\n" % e) + print("Exception when calling AppsApi->get_source_app: %s\n" % e) - path: /source-apps/{id}/access-profiles method: GET xCodeSample: @@ -1399,16 +1329,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) filters = 'name eq \"developer access profile\"' # 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, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) try: - # List access profiles for the specified source app - - api_response = api_instance.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) - print("The response of AppsApi->list_access_profiles_for_source_app:\n") - pprint(api_response) + # List access profiles for the specified source app + + results = AppsApi(api_client).list_access_profiles_for_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) + print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) - path: /source-apps/all method: GET xCodeSample: @@ -1422,16 +1351,15 @@ sorters = 'name,-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-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (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: **id, name, created, modified, owner.id, accountSource.id** (optional) filters = 'enabled 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *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, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) try: - # List all source apps - - api_response = api_instance.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) - print("The response of AppsApi->list_all_source_app:\n") - pprint(api_response) + # List all source apps + + results = AppsApi(api_client).list_all_source_app(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) + print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) - path: /user-apps/all method: GET xCodeSample: @@ -1444,16 +1372,15 @@ 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) try: - # List all user apps - - api_response = api_instance.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) - print("The response of AppsApi->list_all_user_apps:\n") - pprint(api_response) + # List all user apps + + results = AppsApi(api_client).list_all_user_apps(filters=filters, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) + print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) - path: /source-apps/assigned method: GET xCodeSample: @@ -1467,16 +1394,15 @@ sorters = 'name,-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-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (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: **id, name, created, modified, accountSource.id** (optional) filters = 'name eq \"source 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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) try: - # List assigned source apps - - api_response = api_instance.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) - print("The response of AppsApi->list_assigned_source_app:\n") - pprint(api_response) + # List assigned source apps + + results = AppsApi(api_client).list_assigned_source_app(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) + print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) - path: /user-apps/{id}/available-accounts method: GET xCodeSample: @@ -1488,16 +1414,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) try: - # List available accounts for user app - - api_response = api_instance.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) - print("The response of AppsApi->list_available_accounts_for_user_app:\n") - pprint(api_response) + # List available accounts for user app + + results = AppsApi(api_client).list_available_accounts_for_user_app(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) + print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) - path: /source-apps method: GET xCodeSample: @@ -1511,16 +1436,15 @@ sorters = 'name,-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-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (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: **id, name, created, modified, owner.id, accountSource.id** (optional) filters = 'name eq \"source 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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) try: - # List available source apps - - api_response = api_instance.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) - print("The response of AppsApi->list_available_source_apps:\n") - pprint(api_response) + # List available source apps + + results = AppsApi(api_client).list_available_source_apps(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) + print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) - path: /user-apps method: GET xCodeSample: @@ -1533,16 +1457,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) 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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) try: - # List owned user apps - - api_response = api_instance.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) - print("The response of AppsApi->list_owned_user_apps:\n") - pprint(api_response) + # List owned user apps + + results = AppsApi(api_client).list_owned_user_apps(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) + print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) - path: /source-apps/{id} method: PATCH xCodeSample: @@ -1551,24 +1474,17 @@ source: | 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) - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | (optional) - - try: - # Patch source app by ID - - api_response = api_instance.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) - print("The response of AppsApi->patch_source_app:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AppsApi->patch_source_app: %s\n" % e) + json_patch_operation = '''[{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}]''' # List[JsonPatchOperation] | (optional) + try: + # Patch source app by ID + + results = AppsApi(api_client).patch_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling AppsApi->patch_source_app: %s\n" % e) - path: /user-apps/{id} method: PATCH xCodeSample: @@ -1577,24 +1493,17 @@ source: | 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) - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | (optional) - - try: - # Patch user app by ID - - api_response = api_instance.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) - print("The response of AppsApi->patch_user_app:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AppsApi->patch_user_app: %s\n" % e) + json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | (optional) + try: + # Patch user app by ID + + results = AppsApi(api_client).patch_user_app(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling AppsApi->patch_user_app: %s\n" % e) - path: /source-apps/bulk-update method: POST xCodeSample: @@ -1602,7 +1511,7 @@ label: SDK_tools/sdk/python/v2024/methods/apps#update-source-apps-in-bulk 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') - source_app_bulk_update_request = { + source_app_bulk_update_request = '''{ "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], "jsonPatch" : [ { "op" : "replace", @@ -1613,16 +1522,15 @@ "path" : "/matchAllAccounts", "value" : false } ] - } # SourceAppBulkUpdateRequest | (optional) + }''' # SourceAppBulkUpdateRequest | (optional) try: - # Bulk update source apps - - api_instance.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) + # Bulk update source apps + + AppsApi(api_client).update_source_apps_in_bulk(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling AppsApi->update_source_apps_in_bulk: %s\n" % e) - path: /auth-profiles/{id} method: GET xCodeSample: @@ -1632,16 +1540,15 @@ x_sail_point_experimental = 'true' # 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_profile_config(x_sail_point_experimental, id) - print("The response of AuthProfileApi->get_profile_config:\n") - pprint(api_response) + # Get Auth Profile + + results = AuthProfileApi(api_client).get_profile_config(x_sail_point_experimental=x_sail_point_experimental, id=id) + # Below is a request that includes all optional parameters + # results = AuthProfileApi(api_client).get_profile_config(x_sail_point_experimental, id) + print("The response of AuthProfileApi->get_profile_config:\n") + pprint(results) except Exception as e: - print("Exception when calling AuthProfileApi->get_profile_config: %s\n" % e) + print("Exception when calling AuthProfileApi->get_profile_config: %s\n" % e) - path: /auth-profiles method: GET xCodeSample: @@ -1650,16 +1557,15 @@ 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: - # Get list of Auth Profiles - - api_response = api_instance.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) - print("The response of AuthProfileApi->get_profile_config_list:\n") - pprint(api_response) + # Get list of Auth Profiles + + results = AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental) + print("The response of AuthProfileApi->get_profile_config_list:\n") + pprint(results) except Exception as e: - print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) + print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) - path: /auth-profiles/{id} method: PATCH xCodeSample: @@ -1668,24 +1574,17 @@ source: | 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] | - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_profile_config(id, x_sail_point_experimental, Result) - print("The response of AuthProfileApi->patch_profile_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AuthProfileApi->patch_profile_config: %s\n" % e) + json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | + try: + # Patch a specified Auth Profile + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = AuthProfileApi(api_client).patch_profile_config(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling AuthProfileApi->patch_profile_config: %s\n" % e) - path: /auth-users/{id} method: GET xCodeSample: @@ -1694,16 +1593,15 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID try: - # Auth User Details - - api_response = api_instance.get_auth_user(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_auth_user(id) - print("The response of AuthUsersApi->get_auth_user:\n") - pprint(api_response) + # Auth User Details + + results = AuthUsersApi(api_client).get_auth_user(id=id) + # Below is a request that includes all optional parameters + # results = AuthUsersApi(api_client).get_auth_user(id) + print("The response of AuthUsersApi->get_auth_user:\n") + pprint(results) except Exception as e: - print("Exception when calling AuthUsersApi->get_auth_user: %s\n" % e) + print("Exception when calling AuthUsersApi->get_auth_user: %s\n" % e) - path: /auth-users/{id} method: PATCH xCodeSample: @@ -1711,24 +1609,17 @@ label: SDK_tools/sdk/python/v2024/methods/auth-users#patch-auth-user source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - try: - # Auth User Update - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_auth_user(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_auth_user(id, Result) - print("The response of AuthUsersApi->patch_auth_user:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AuthUsersApi->patch_auth_user: %s\n" % e) + json_patch_operation = '''[{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. + try: + # Auth User Update + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = AuthUsersApi(api_client).patch_auth_user(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = AuthUsersApi(api_client).patch_auth_user(id, new_json_patch_operation) + print("The response of AuthUsersApi->patch_auth_user:\n") + pprint(results) + except Exception as e: + print("Exception when calling AuthUsersApi->patch_auth_user: %s\n" % e) - path: /brandings method: POST xCodeSample: @@ -1744,16 +1635,15 @@ login_informational_message = 'login_informational_message_example' # str | login information message (optional) # str | login information message (optional) file_standard = None # bytearray | png file with logo (optional) # bytearray | png file with logo (optional) try: - # Create a branding item - - api_response = api_instance.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) - print("The response of BrandingApi->create_branding_item:\n") - pprint(api_response) + # Create a branding item + + results = BrandingApi(api_client).create_branding_item(name=name, product_name=product_name) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling BrandingApi->create_branding_item: %s\n" % e) + print("Exception when calling BrandingApi->create_branding_item: %s\n" % e) - path: /brandings/{name} method: DELETE xCodeSample: @@ -1762,14 +1652,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_branding(name) + # Delete a branding item + + BrandingApi(api_client).delete_branding(name=name) + # Below is a request that includes all optional parameters + # BrandingApi(api_client).delete_branding(name) except Exception as e: - print("Exception when calling BrandingApi->delete_branding: %s\n" % e) + print("Exception when calling BrandingApi->delete_branding: %s\n" % e) - path: /brandings/{name} method: GET xCodeSample: @@ -1778,16 +1667,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_branding(name) - print("The response of BrandingApi->get_branding:\n") - pprint(api_response) + # Get a branding item + + results = BrandingApi(api_client).get_branding(name=name) + # Below is a request that includes all optional parameters + # results = BrandingApi(api_client).get_branding(name) + print("The response of BrandingApi->get_branding:\n") + pprint(results) except Exception as e: - print("Exception when calling BrandingApi->get_branding: %s\n" % e) + print("Exception when calling BrandingApi->get_branding: %s\n" % e) - path: /brandings method: GET xCodeSample: @@ -1795,16 +1683,15 @@ label: SDK_tools/sdk/python/v2024/methods/branding#get-branding-list source: | try: - # List of branding items - - api_response = api_instance.get_branding_list() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_branding_list() - print("The response of BrandingApi->get_branding_list:\n") - pprint(api_response) + # List of branding items + + results = BrandingApi(api_client).get_branding_list() + # Below is a request that includes all optional parameters + # results = BrandingApi(api_client).get_branding_list() + print("The response of BrandingApi->get_branding_list:\n") + pprint(results) except Exception as e: - print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) + print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) - path: /brandings/{name} method: PUT xCodeSample: @@ -1821,23 +1708,22 @@ login_informational_message = 'login_informational_message_example' # str | login information message (optional) # str | login information message (optional) file_standard = None # bytearray | png file with logo (optional) # bytearray | png file with logo (optional) try: - # Update a branding item - - api_response = api_instance.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) - print("The response of BrandingApi->set_branding_item:\n") - pprint(api_response) + # Update a branding item + + results = BrandingApi(api_client).set_branding_item(name=name, name2=name2, product_name=product_name) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling BrandingApi->set_branding_item: %s\n" % e) + print("Exception when calling BrandingApi->set_branding_item: %s\n" % e) - path: /campaign-filters method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaign-filters#create-campaign-filter source: | - campaign_filter_details = { + campaign_filter_details = '''{ "owner" : "SailPoint Support", "mode" : "INCLUSION", "isSystemFilter" : false, @@ -1854,36 +1740,32 @@ "recordChildMatches" : false, "suppressMatchedItems" : false } ] - } # CampaignFilterDetails | - try: - # Create Campaign Filter - Result = campaign_filter_details.from_json(campaign_filter_details) - api_response = api_instance.create_campaign_filter(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_campaign_filter(Result) - print("The response of CertificationCampaignFiltersApi->create_campaign_filter:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignFiltersApi->create_campaign_filter: %s\n" % e) + }''' # CampaignFilterDetails | + try: + # Create Campaign Filter + new_campaign_filter_details = CampaignFilterDetails.from_json(campaign_filter_details) + results = CertificationCampaignFiltersApi(api_client).create_campaign_filter(campaign_filter_details=new_campaign_filter_details) + # Below is a request that includes all optional parameters + # results = CertificationCampaignFiltersApi(api_client).create_campaign_filter(new_campaign_filter_details) + print("The response of CertificationCampaignFiltersApi->create_campaign_filter:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->create_campaign_filter: %s\n" % e) - path: /campaign-filters/delete method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaign-filters#delete-campaign-filters source: | - 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. - + 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_campaign_filters(Result) + # Deletes Campaign Filters + new_request_body = RequestBody.from_json(request_body) + CertificationCampaignFiltersApi(api_client).delete_campaign_filters(request_body=new_request_body) + # Below is a request that includes all optional parameters + # CertificationCampaignFiltersApi(api_client).delete_campaign_filters(new_request_body) except Exception as e: - print("Exception when calling CertificationCampaignFiltersApi->delete_campaign_filters: %s\n" % e) + print("Exception when calling CertificationCampaignFiltersApi->delete_campaign_filters: %s\n" % e) - path: /campaign-filters/{id} method: GET xCodeSample: @@ -1892,16 +1774,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_campaign_filter_by_id(id) - print("The response of CertificationCampaignFiltersApi->get_campaign_filter_by_id:\n") - pprint(api_response) + # Get Campaign Filter by ID + + results = CertificationCampaignFiltersApi(api_client).get_campaign_filter_by_id(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignFiltersApi(api_client).get_campaign_filter_by_id(id) + print("The response of CertificationCampaignFiltersApi->get_campaign_filter_by_id:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignFiltersApi->get_campaign_filter_by_id: %s\n" % e) + print("Exception when calling CertificationCampaignFiltersApi->get_campaign_filter_by_id: %s\n" % e) - path: /campaign-filters method: GET xCodeSample: @@ -1912,16 +1793,15 @@ 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) try: - # List Campaign Filters - - api_response = api_instance.list_campaign_filters() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_campaign_filters(limit, start, include_system_filters) - print("The response of CertificationCampaignFiltersApi->list_campaign_filters:\n") - pprint(api_response) + # List Campaign Filters + + results = CertificationCampaignFiltersApi(api_client).list_campaign_filters() + # Below is a request that includes all optional parameters + # results = CertificationCampaignFiltersApi(api_client).list_campaign_filters(limit, start, include_system_filters) + print("The response of CertificationCampaignFiltersApi->list_campaign_filters:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignFiltersApi->list_campaign_filters: %s\n" % e) + print("Exception when calling CertificationCampaignFiltersApi->list_campaign_filters: %s\n" % e) - path: /campaign-filters/{id} method: POST xCodeSample: @@ -1929,7 +1809,7 @@ label: SDK_tools/sdk/python/v2024/methods/certification-campaign-filters#update-campaign-filter source: | filter_id = 'e9f9a1397b842fd5a65842087040d3ac' # str | The ID of the campaign filter being modified. # str | The ID of the campaign filter being modified. - campaign_filter_details = { + campaign_filter_details = '''{ "owner" : "SailPoint Support", "mode" : "INCLUSION", "isSystemFilter" : false, @@ -1946,18 +1826,17 @@ "recordChildMatches" : false, "suppressMatchedItems" : false } ] - } # CampaignFilterDetails | A campaign filter details with updated field values. - try: - # Updates a Campaign Filter - Result = campaign_filter_details.from_json(campaign_filter_details) - api_response = api_instance.update_campaign_filter(filter_id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_campaign_filter(filter_id, Result) - print("The response of CertificationCampaignFiltersApi->update_campaign_filter:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignFiltersApi->update_campaign_filter: %s\n" % e) + }''' # CampaignFilterDetails | A campaign filter details with updated field values. + try: + # Updates a Campaign Filter + new_campaign_filter_details = CampaignFilterDetails.from_json(campaign_filter_details) + results = CertificationCampaignFiltersApi(api_client).update_campaign_filter(filter_id=filter_id, campaign_filter_details=new_campaign_filter_details) + # Below is a request that includes all optional parameters + # results = CertificationCampaignFiltersApi(api_client).update_campaign_filter(filter_id, new_campaign_filter_details) + print("The response of CertificationCampaignFiltersApi->update_campaign_filter:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->update_campaign_filter: %s\n" % e) - path: /campaigns/{id}/complete method: POST xCodeSample: @@ -1965,27 +1844,26 @@ label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#complete-campaign source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID. - campaign_complete_options = { + campaign_complete_options = '''{ "autoCompleteAction" : "REVOKE" - } # CampaignCompleteOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) - try: - # Complete a Campaign - - api_response = api_instance.complete_campaign(id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.complete_campaign(id, Result) - print("The response of CertificationCampaignsApi->complete_campaign:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e) + }''' # CampaignCompleteOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) + try: + # Complete a Campaign + + results = CertificationCampaignsApi(api_client).complete_campaign(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).complete_campaign(id, new_campaign_complete_options) + print("The response of CertificationCampaignsApi->complete_campaign:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e) - path: /campaigns method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#create-campaign source: | - campaign = { + campaign = '''{ "totalCertifications" : 100, "sourcesWithOrphanEntitlements" : [ { "name" : "Source with orphan entitlements", @@ -2094,25 +1972,24 @@ "deadline" : "2020-03-15T10:00:01.456Z", "status" : "ACTIVE", "correlatedStatus" : "CORRELATED" - } # Campaign | - try: - # Create a campaign - Result = campaign.from_json(campaign) - api_response = api_instance.create_campaign(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_campaign(Result) - print("The response of CertificationCampaignsApi->create_campaign:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->create_campaign: %s\n" % e) + }''' # Campaign | + try: + # Create a campaign + new_campaign = Campaign.from_json(campaign) + results = CertificationCampaignsApi(api_client).create_campaign(campaign=new_campaign) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).create_campaign(new_campaign) + print("The response of CertificationCampaignsApi->create_campaign:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign: %s\n" % e) - path: /campaign-templates method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#create-campaign-template source: | - campaign_template = { + campaign_template = '''{ "ownerRef" : { "name" : "Mister Manager", "id" : "2c918086676d3e0601677611dbde220f", @@ -2236,18 +2113,17 @@ "correlatedStatus" : "CORRELATED" }, "id" : "2c9079b270a266a60170a277bb960008" - } # CampaignTemplate | - try: - # Create a Campaign Template - Result = campaign_template.from_json(campaign_template) - api_response = api_instance.create_campaign_template(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_campaign_template(Result) - print("The response of CertificationCampaignsApi->create_campaign_template:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->create_campaign_template: %s\n" % e) + }''' # CampaignTemplate | + try: + # Create a Campaign Template + new_campaign_template = CampaignTemplate.from_json(campaign_template) + results = CertificationCampaignsApi(api_client).create_campaign_template(campaign_template=new_campaign_template) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).create_campaign_template(new_campaign_template) + print("The response of CertificationCampaignsApi->create_campaign_template:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign_template: %s\n" % e) - path: /campaign-templates/{id} method: DELETE xCodeSample: @@ -2256,14 +2132,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_campaign_template(id) + # Delete a Campaign Template + + CertificationCampaignsApi(api_client).delete_campaign_template(id=id) + # Below is a request that includes all optional parameters + # CertificationCampaignsApi(api_client).delete_campaign_template(id) except Exception as e: - print("Exception when calling CertificationCampaignsApi->delete_campaign_template: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->delete_campaign_template: %s\n" % e) - path: /campaign-templates/{id}/schedule method: DELETE xCodeSample: @@ -2272,34 +2147,32 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_campaign_template_schedule(id) + # Delete Campaign Template Schedule + + CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id=id) + # Below is a request that includes all optional parameters + # CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id) except Exception as e: - print("Exception when calling CertificationCampaignsApi->delete_campaign_template_schedule: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->delete_campaign_template_schedule: %s\n" % e) - path: /campaigns/delete method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#delete-campaigns source: | - campaigns_delete_request = { + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_campaigns(Result) - print("The response of CertificationCampaignsApi->delete_campaigns:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e) + }''' # CampaignsDeleteRequest | IDs of the campaigns to delete. + try: + # Delete Campaigns + new_campaigns_delete_request = CampaignsDeleteRequest.from_json(campaigns_delete_request) + results = CertificationCampaignsApi(api_client).delete_campaigns(campaigns_delete_request=new_campaigns_delete_request) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).delete_campaigns(new_campaigns_delete_request) + print("The response of CertificationCampaignsApi->delete_campaigns:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e) - path: /campaigns method: GET xCodeSample: @@ -2313,16 +2186,15 @@ filters = 'name eq \"Manager 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, in* **name**: *eq, sw* **status**: *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: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) 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, created** (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, created** (optional) try: - # List Campaigns - - api_response = api_instance.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) - print("The response of CertificationCampaignsApi->get_active_campaigns:\n") - pprint(api_response) + # List Campaigns + + results = CertificationCampaignsApi(api_client).get_active_campaigns() + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters) + print("The response of CertificationCampaignsApi->get_active_campaigns:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) - path: /campaigns/{id} method: GET xCodeSample: @@ -2332,16 +2204,15 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_campaign(id, detail) - print("The response of CertificationCampaignsApi->get_campaign:\n") - pprint(api_response) + # Get Campaign + + results = CertificationCampaignsApi(api_client).get_campaign(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign(id, detail) + print("The response of CertificationCampaignsApi->get_campaign:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e) - path: /campaigns/{id}/reports method: GET xCodeSample: @@ -2350,16 +2221,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_campaign_reports(id) - print("The response of CertificationCampaignsApi->get_campaign_reports:\n") - pprint(api_response) + # Get Campaign Reports + + results = CertificationCampaignsApi(api_client).get_campaign_reports(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign_reports(id) + print("The response of CertificationCampaignsApi->get_campaign_reports:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) - path: /campaigns/reports-configuration method: GET xCodeSample: @@ -2367,16 +2237,15 @@ label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign-reports-config source: | try: - # Get Campaign Reports Configuration - - api_response = api_instance.get_campaign_reports_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_campaign_reports_config() - print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n") - pprint(api_response) + # Get Campaign Reports Configuration + + results = CertificationCampaignsApi(api_client).get_campaign_reports_config() + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign_reports_config() + print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e) - path: /campaign-templates/{id} method: GET xCodeSample: @@ -2385,16 +2254,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_campaign_template(id) - print("The response of CertificationCampaignsApi->get_campaign_template:\n") - pprint(api_response) + # Get a Campaign Template + + results = CertificationCampaignsApi(api_client).get_campaign_template(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign_template(id) + print("The response of CertificationCampaignsApi->get_campaign_template:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e) - path: /campaign-templates/{id}/schedule method: GET xCodeSample: @@ -2403,16 +2271,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_campaign_template_schedule(id) - print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n") - pprint(api_response) + # Get Campaign Template Schedule + + results = CertificationCampaignsApi(api_client).get_campaign_template_schedule(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign_template_schedule(id) + print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e) - path: /campaign-templates method: GET xCodeSample: @@ -2425,16 +2292,15 @@ 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, created, 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-results) Sorting is supported for the following fields: **name, created, modified** (optional) filters = 'name eq \"manager template\"' # 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, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, 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**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) try: - # List Campaign Templates - - api_response = api_instance.get_campaign_templates() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_campaign_templates(limit, offset, count, sorters, filters) - print("The response of CertificationCampaignsApi->get_campaign_templates:\n") - pprint(api_response) + # List Campaign Templates + + results = CertificationCampaignsApi(api_client).get_campaign_templates() + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters) + print("The response of CertificationCampaignsApi->get_campaign_templates:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) - path: /campaigns/{id}/reassign method: POST xCodeSample: @@ -2442,25 +2308,24 @@ label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#move source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification campaign ID # str | The certification campaign ID - admin_review_reassign = { + admin_review_reassign = '''{ "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], "reason" : "reassigned for some reason", "reassignTo" : { "id" : "ef38f94347e94562b5bb8424a56397d8", "type" : "IDENTITY" } - } # AdminReviewReassign | - try: - # Reassign Certifications - Result = admin_review_reassign.from_json(admin_review_reassign) - api_response = api_instance.move(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.move(id, Result) - print("The response of CertificationCampaignsApi->move:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->move: %s\n" % e) + }''' # AdminReviewReassign | + try: + # Reassign Certifications + new_admin_review_reassign = AdminReviewReassign.from_json(admin_review_reassign) + results = CertificationCampaignsApi(api_client).move(id=id, admin_review_reassign=new_admin_review_reassign) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).move(id, new_admin_review_reassign) + print("The response of CertificationCampaignsApi->move:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->move: %s\n" % e) - path: /campaign-templates/{id} method: PATCH xCodeSample: @@ -2468,44 +2333,36 @@ label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#patch-campaign-template source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # 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) - - try: - # Update a Campaign Template - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_campaign_template(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_campaign_template(id, Result) - print("The response of CertificationCampaignsApi->patch_campaign_template:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e) + json_patch_operation = '''[{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) + try: + # Update a Campaign Template + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = CertificationCampaignsApi(api_client).patch_campaign_template(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).patch_campaign_template(id, new_json_patch_operation) + print("The response of CertificationCampaignsApi->patch_campaign_template:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e) - path: /campaigns/reports-configuration method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#set-campaign-reports-config source: | - campaign_reports_config = { + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_campaign_reports_config(Result) - print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->set_campaign_reports_config: %s\n" % e) + }''' # CampaignReportsConfig | Campaign report configuration. + try: + # Set Campaign Reports Configuration + new_campaign_reports_config = CampaignReportsConfig.from_json(campaign_reports_config) + results = CertificationCampaignsApi(api_client).set_campaign_reports_config(campaign_reports_config=new_campaign_reports_config) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).set_campaign_reports_config(new_campaign_reports_config) + print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->set_campaign_reports_config: %s\n" % e) - path: /campaign-templates/{id}/schedule method: PUT xCodeSample: @@ -2513,7 +2370,7 @@ label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#set-campaign-template-schedule source: | id = '04bedce387bd47b2ae1f86eb0bb36dee' # str | ID of the campaign template being scheduled. # str | ID of the campaign template being scheduled. - schedule = { + schedule = '''{ "hours" : { "values" : [ "1" ], "interval" : 2, @@ -2532,16 +2389,15 @@ }, "expiration" : "2000-01-23T04:56:07.000+00:00", "type" : "WEEKLY" - } # Schedule | (optional) + }''' # Schedule | (optional) try: - # Set Campaign Template Schedule - - api_instance.set_campaign_template_schedule(id, ) - - # Below is a request that includes all optional parameters - # api_instance.set_campaign_template_schedule(id, Result) + # Set Campaign Template Schedule + + CertificationCampaignsApi(api_client).set_campaign_template_schedule(id=id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling CertificationCampaignsApi->set_campaign_template_schedule: %s\n" % e) - path: /campaigns/{id}/activate method: POST xCodeSample: @@ -2549,20 +2405,19 @@ label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#start-campaign source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID. - activate_campaign_options = { + activate_campaign_options = '''{ "timeZone" : "-05:00" - } # ActivateCampaignOptions | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional) - try: - # Activate a Campaign - - api_response = api_instance.start_campaign(id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_campaign(id, Result) - print("The response of CertificationCampaignsApi->start_campaign:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->start_campaign: %s\n" % e) + }''' # ActivateCampaignOptions | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional) + try: + # Activate a Campaign + + results = CertificationCampaignsApi(api_client).start_campaign(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).start_campaign(id, new_activate_campaign_options) + print("The response of CertificationCampaignsApi->start_campaign:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign: %s\n" % e) - path: /campaigns/{id}/run-remediation-scan method: POST xCodeSample: @@ -2571,16 +2426,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_campaign_remediation_scan(id) - print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n") - pprint(api_response) + # Run Campaign Remediation Scan + + results = CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id) + print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->start_campaign_remediation_scan: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->start_campaign_remediation_scan: %s\n" % e) - path: /campaigns/{id}/run-report/{type} method: POST xCodeSample: @@ -2590,16 +2444,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_campaign_report(id, type) - print("The response of CertificationCampaignsApi->start_campaign_report:\n") - pprint(api_response) + # Run Campaign Report + + results = CertificationCampaignsApi(api_client).start_campaign_report(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).start_campaign_report(id, type) + print("The response of CertificationCampaignsApi->start_campaign_report:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e) - path: /campaign-templates/{id}/generate method: POST xCodeSample: @@ -2608,16 +2461,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_generate_campaign_template(id) - print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n") - pprint(api_response) + # Generate a Campaign from Template + + results = CertificationCampaignsApi(api_client).start_generate_campaign_template(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).start_generate_campaign_template(id) + print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e) - path: /campaigns/{id} method: PATCH xCodeSample: @@ -2625,24 +2477,17 @@ label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#update-campaign source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New 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 - - try: - # Update a Campaign - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_campaign(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_campaign(id, Result) - print("The response of CertificationCampaignsApi->update_campaign:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) + json_patch_operation = '''[{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 + try: + # Update a Campaign + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = CertificationCampaignsApi(api_client).update_campaign(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).update_campaign(id, new_json_patch_operation) + print("The response of CertificationCampaignsApi->update_campaign:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) - path: /certification-tasks/{id} method: GET xCodeSample: @@ -2651,16 +2496,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_certification_task(id) - print("The response of CertificationsApi->get_certification_task:\n") - pprint(api_response) + # Certification Task by ID + + results = CertificationsApi(api_client).get_certification_task(id=id) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).get_certification_task(id) + print("The response of CertificationsApi->get_certification_task:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationsApi->get_certification_task: %s\n" % e) + print("Exception when calling CertificationsApi->get_certification_task: %s\n" % e) - path: /certifications/{id} method: GET xCodeSample: @@ -2669,16 +2513,15 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification id # str | The certification id try: - # Identity Certification by ID - - api_response = api_instance.get_identity_certification(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_certification(id) - print("The response of CertificationsApi->get_identity_certification:\n") - pprint(api_response) + # Identity Certification by ID + + results = CertificationsApi(api_client).get_identity_certification(id=id) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).get_identity_certification(id) + print("The response of CertificationsApi->get_identity_certification:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationsApi->get_identity_certification: %s\n" % e) + print("Exception when calling CertificationsApi->get_identity_certification: %s\n" % e) - path: /certifications/{certificationId}/access-review-items/{itemId}/permissions method: GET xCodeSample: @@ -2692,16 +2535,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) 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) try: - # Permissions for Entitlement Certification Item - - api_response = api_instance.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) - print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") - pprint(api_response) + # Permissions for Entitlement Certification Item + + results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id=certification_id, item_id=item_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) + print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) - path: /certification-tasks method: GET xCodeSample: @@ -2714,16 +2556,15 @@ 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) filters = 'type eq \"ADMIN_REASSIGN\"' # 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* **targetId**: *eq, in* **type**: *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: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) try: - # List of Pending Certification Tasks - - api_response = api_instance.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) - print("The response of CertificationsApi->get_pending_certification_tasks:\n") - pprint(api_response) + # List of Pending Certification Tasks + + results = CertificationsApi(api_client).get_pending_certification_tasks() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) + print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) - path: /certifications/{id}/reviewers method: GET xCodeSample: @@ -2737,16 +2578,15 @@ filters = 'name eq \"Bob\"' # 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* **email**: *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: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) 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, email** (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, email** (optional) try: - # List of Reviewers for certification - - api_response = api_instance.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) - print("The response of CertificationsApi->list_certification_reviewers:\n") - pprint(api_response) + # List of Reviewers for certification + + results = CertificationsApi(api_client).list_certification_reviewers(id=id) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_certification_reviewers:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) + print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) - path: /certifications/{id}/access-review-items method: GET xCodeSample: @@ -2763,16 +2603,15 @@ access_profiles = 'accessProfile1' # str | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) # str | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) roles = 'userRole' # str | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) # str | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) try: - # List of Access Review Items - - api_response = api_instance.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) - print("The response of CertificationsApi->list_identity_access_review_items:\n") - pprint(api_response) + # List of Access Review Items + + results = CertificationsApi(api_client).list_identity_access_review_items(id=id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) + print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) - path: /certifications method: GET xCodeSample: @@ -2786,16 +2625,15 @@ filters = '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: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *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* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) sorters = 'name,due' # 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, due, signed** (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, due, signed** (optional) try: - # List Identity Campaign Certifications - - api_response = api_instance.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) - print("The response of CertificationsApi->list_identity_certifications:\n") - pprint(api_response) + # List Identity Campaign Certifications + + results = CertificationsApi(api_client).list_identity_certifications() + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_identity_certifications:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) + print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) - path: /certifications/{id}/decide method: POST xCodeSample: @@ -2803,31 +2641,17 @@ label: SDK_tools/sdk/python/v2024/methods/certifications#make-identity-decision source: | 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 = { - "comments" : "This user no longer needs access to this source", - "decision" : "APPROVE", - "proposedEndDate" : "2017-07-11T18:45:37.098Z", - "recommendation" : { - "reasons" : [ "Reason 1", "Reason 2" ], - "recommendation" : "recommendation", - "timestamp" : "2020-06-01T13:49:37.385Z" - }, - "id" : "ef38f94347e94562b5bb8424a56397d8", - "bulk" : true - } # List[ReviewDecision] | A non-empty array of decisions to be made. - - try: - # Decide on a Certification Item - Result = review_decision.from_json(review_decision) - api_response = api_instance.make_identity_decision(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.make_identity_decision(id, Result) - print("The response of CertificationsApi->make_identity_decision:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationsApi->make_identity_decision: %s\n" % e) + review_decision = '''[{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. + try: + # Decide on a Certification Item + new_review_decision = ReviewDecision.from_json(review_decision) + results = CertificationsApi(api_client).make_identity_decision(id=id, review_decision=new_review_decision) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).make_identity_decision(id, new_review_decision) + print("The response of CertificationsApi->make_identity_decision:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->make_identity_decision: %s\n" % e) - path: /certifications/{id}/reassign method: POST xCodeSample: @@ -2835,7 +2659,7 @@ label: SDK_tools/sdk/python/v2024/methods/certifications#reassign-identity-certifications source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - review_reassign = { + review_reassign = '''{ "reason" : "reassigned for some reason", "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", "reassign" : [ { @@ -2845,18 +2669,17 @@ "id" : "ef38f94347e94562b5bb8424a56397d8", "type" : "ITEM" } ] - } # ReviewReassign | - try: - # Reassign Identities or Items - Result = review_reassign.from_json(review_reassign) - api_response = api_instance.reassign_identity_certifications(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.reassign_identity_certifications(id, Result) - print("The response of CertificationsApi->reassign_identity_certifications:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationsApi->reassign_identity_certifications: %s\n" % e) + }''' # ReviewReassign | + try: + # Reassign Identities or Items + new_review_reassign = ReviewReassign.from_json(review_reassign) + results = CertificationsApi(api_client).reassign_identity_certifications(id=id, review_reassign=new_review_reassign) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).reassign_identity_certifications(id, new_review_reassign) + print("The response of CertificationsApi->reassign_identity_certifications:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->reassign_identity_certifications: %s\n" % e) - path: /certifications/{id}/sign-off method: POST xCodeSample: @@ -2865,16 +2688,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.sign_off_identity_certification(id) - print("The response of CertificationsApi->sign_off_identity_certification:\n") - pprint(api_response) + # Finalize Identity Certification Decisions + + results = CertificationsApi(api_client).sign_off_identity_certification(id=id) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).sign_off_identity_certification(id) + print("The response of CertificationsApi->sign_off_identity_certification:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationsApi->sign_off_identity_certification: %s\n" % e) + print("Exception when calling CertificationsApi->sign_off_identity_certification: %s\n" % e) - path: /certifications/{id}/reassign-async method: POST xCodeSample: @@ -2882,7 +2704,7 @@ label: SDK_tools/sdk/python/v2024/methods/certifications#submit-reassign-certs-async source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - review_reassign = { + review_reassign = '''{ "reason" : "reassigned for some reason", "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", "reassign" : [ { @@ -2892,18 +2714,17 @@ "id" : "ef38f94347e94562b5bb8424a56397d8", "type" : "ITEM" } ] - } # ReviewReassign | - try: - # Reassign Certifications Asynchronously - Result = review_reassign.from_json(review_reassign) - api_response = api_instance.submit_reassign_certs_async(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.submit_reassign_certs_async(id, Result) - print("The response of CertificationsApi->submit_reassign_certs_async:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) + }''' # ReviewReassign | + try: + # Reassign Certifications Asynchronously + new_review_reassign = ReviewReassign.from_json(review_reassign) + results = CertificationsApi(api_client).submit_reassign_certs_async(id=id, review_reassign=new_review_reassign) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).submit_reassign_certs_async(id, new_review_reassign) + print("The response of CertificationsApi->submit_reassign_certs_async:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) - path: /certifications/{id}/access-summaries/{type} method: GET xCodeSample: @@ -2918,16 +2739,15 @@ filters = 'access.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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) sorters = 'access.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: **access.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: **access.name** (optional) try: - # Access Summaries - - api_response = api_instance.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) - print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - pprint(api_response) + # Access Summaries + + results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) - path: /certifications/{id}/decision-summary method: GET xCodeSample: @@ -2937,16 +2757,15 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_decision_summary(id, filters) - print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") - pprint(api_response) + # Summary of Certification Decisions + + results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) - path: /certifications/{id}/identity-summaries method: GET xCodeSample: @@ -2960,16 +2779,15 @@ filters = '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: **id**: *eq, in* **completed**: *eq, ne* **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: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) 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) try: - # Identity Summaries for Campaign Certification - - api_response = api_instance.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) - print("The response of CertificationSummariesApi->get_identity_summaries:\n") - pprint(api_response) + # Identity Summaries for Campaign Certification + + results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) - path: /certifications/{id}/identity-summaries/{identitySummaryId} method: GET xCodeSample: @@ -2979,36 +2797,34 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_summary(id, identity_summary_id) - print("The response of CertificationSummariesApi->get_identity_summary:\n") - pprint(api_response) + # Summary for Identity + + results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /configuration-hub/deploys method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#create-deploy source: | - deploy_request = { + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_deploy(Result) - print("The response of ConfigurationHubApi->create_deploy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ConfigurationHubApi->create_deploy: %s\n" % e) + }''' # DeployRequest | The deploy request body. + try: + # Create a Deploy + new_deploy_request = DeployRequest.from_json(deploy_request) + results = ConfigurationHubApi(api_client).create_deploy(deploy_request=new_deploy_request) + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).create_deploy(new_deploy_request) + print("The response of ConfigurationHubApi->create_deploy:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_deploy: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg} method: POST xCodeSample: @@ -3016,24 +2832,23 @@ label: SDK_tools/sdk/python/v2024/methods/configuration-hub#create-object-mapping source: | source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. - object_mapping_request = { + object_mapping_request = '''{ "targetValue" : "My New Governance Group Name", "jsonPath" : "$.name", "sourceValue" : "My Governance Group Name", "enabled" : false, "objectType" : "IDENTITY" - } # ObjectMappingRequest | The object mapping request body. - try: - # Creates an object mapping - Result = object_mapping_request.from_json(object_mapping_request) - api_response = api_instance.create_object_mapping(source_org, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_object_mapping(source_org, Result) - print("The response of ConfigurationHubApi->create_object_mapping:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ConfigurationHubApi->create_object_mapping: %s\n" % e) + }''' # ObjectMappingRequest | The object mapping request body. + try: + # Creates an object mapping + new_object_mapping_request = ObjectMappingRequest.from_json(object_mapping_request) + results = ConfigurationHubApi(api_client).create_object_mapping(source_org=source_org, object_mapping_request=new_object_mapping_request) + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).create_object_mapping(source_org, new_object_mapping_request) + print("The response of ConfigurationHubApi->create_object_mapping:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_object_mapping: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg}/bulk-create method: POST xCodeSample: @@ -3041,7 +2856,7 @@ label: SDK_tools/sdk/python/v2024/methods/configuration-hub#create-object-mappings source: | source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. - object_mapping_bulk_create_request = { + object_mapping_bulk_create_request = '''{ "newObjectsMappings" : [ { "targetValue" : "My New Governance Group Name", "jsonPath" : "$.name", @@ -3055,18 +2870,17 @@ "enabled" : false, "objectType" : "IDENTITY" } ] - } # ObjectMappingBulkCreateRequest | The bulk create object mapping request body. - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_object_mappings(source_org, Result) - print("The response of ConfigurationHubApi->create_object_mappings:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ConfigurationHubApi->create_object_mappings: %s\n" % e) + }''' # ObjectMappingBulkCreateRequest | The bulk create object mapping request body. + try: + # Bulk creates object mappings + new_object_mapping_bulk_create_request = ObjectMappingBulkCreateRequest.from_json(object_mapping_bulk_create_request) + results = ConfigurationHubApi(api_client).create_object_mappings(source_org=source_org, object_mapping_bulk_create_request=new_object_mapping_bulk_create_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_object_mappings: %s\n" % e) - path: /configuration-hub/backups/uploads method: POST xCodeSample: @@ -3076,16 +2890,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_uploaded_configuration(data, name) - print("The response of ConfigurationHubApi->create_uploaded_configuration:\n") - pprint(api_response) + # Upload a Configuration + + results = ConfigurationHubApi(api_client).create_uploaded_configuration(data=data, name=name) + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).create_uploaded_configuration(data, name) + print("The response of ConfigurationHubApi->create_uploaded_configuration:\n") + pprint(results) except Exception as e: - print("Exception when calling ConfigurationHubApi->create_uploaded_configuration: %s\n" % e) + print("Exception when calling ConfigurationHubApi->create_uploaded_configuration: %s\n" % e) - path: /configuration-hub/backups/{id} method: DELETE xCodeSample: @@ -3094,14 +2907,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_backup(id) + # Delete a Backup + + ConfigurationHubApi(api_client).delete_backup(id=id) + # Below is a request that includes all optional parameters + # ConfigurationHubApi(api_client).delete_backup(id) except Exception as e: - print("Exception when calling ConfigurationHubApi->delete_backup: %s\n" % e) + print("Exception when calling ConfigurationHubApi->delete_backup: %s\n" % e) - path: /configuration-hub/drafts/{id} method: DELETE xCodeSample: @@ -3110,14 +2922,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_draft(id) + # Delete a draft + + ConfigurationHubApi(api_client).delete_draft(id=id) + # Below is a request that includes all optional parameters + # ConfigurationHubApi(api_client).delete_draft(id) except Exception as e: - print("Exception when calling ConfigurationHubApi->delete_draft: %s\n" % e) + print("Exception when calling ConfigurationHubApi->delete_draft: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId} method: DELETE xCodeSample: @@ -3127,14 +2938,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_object_mapping(source_org, object_mapping_id) + # Deletes an object mapping + + ConfigurationHubApi(api_client).delete_object_mapping(source_org=source_org, object_mapping_id=object_mapping_id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling ConfigurationHubApi->delete_object_mapping: %s\n" % e) - path: /configuration-hub/backups/uploads/{id} method: DELETE xCodeSample: @@ -3143,14 +2953,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_uploaded_configuration(id) + # Delete an Uploaded Configuration + + ConfigurationHubApi(api_client).delete_uploaded_configuration(id=id) + # Below is a request that includes all optional parameters + # ConfigurationHubApi(api_client).delete_uploaded_configuration(id) except Exception as e: - print("Exception when calling ConfigurationHubApi->delete_uploaded_configuration: %s\n" % e) + print("Exception when calling ConfigurationHubApi->delete_uploaded_configuration: %s\n" % e) - path: /configuration-hub/deploys/{id} method: GET xCodeSample: @@ -3159,16 +2968,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_deploy(id) - print("The response of ConfigurationHubApi->get_deploy:\n") - pprint(api_response) + # Get a Deploy + + results = ConfigurationHubApi(api_client).get_deploy(id=id) + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).get_deploy(id) + print("The response of ConfigurationHubApi->get_deploy:\n") + pprint(results) except Exception as e: - print("Exception when calling ConfigurationHubApi->get_deploy: %s\n" % e) + print("Exception when calling ConfigurationHubApi->get_deploy: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg} method: GET xCodeSample: @@ -3177,16 +2985,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_object_mappings(source_org) - print("The response of ConfigurationHubApi->get_object_mappings:\n") - pprint(api_response) + # Gets list of object mappings + + results = ConfigurationHubApi(api_client).get_object_mappings(source_org=source_org) + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).get_object_mappings(source_org) + print("The response of ConfigurationHubApi->get_object_mappings:\n") + pprint(results) except Exception as e: - print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) + print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) - path: /configuration-hub/backups/uploads/{id} method: GET xCodeSample: @@ -3195,16 +3002,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_uploaded_configuration(id) - print("The response of ConfigurationHubApi->get_uploaded_configuration:\n") - pprint(api_response) + # Get an Uploaded Configuration + + results = ConfigurationHubApi(api_client).get_uploaded_configuration(id=id) + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).get_uploaded_configuration(id) + print("The response of ConfigurationHubApi->get_uploaded_configuration:\n") + pprint(results) except Exception as e: - print("Exception when calling ConfigurationHubApi->get_uploaded_configuration: %s\n" % e) + print("Exception when calling ConfigurationHubApi->get_uploaded_configuration: %s\n" % e) - path: /configuration-hub/backups method: GET xCodeSample: @@ -3213,16 +3019,15 @@ source: | 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_backups(filters) - print("The response of ConfigurationHubApi->list_backups:\n") - pprint(api_response) + # List Backups + + results = ConfigurationHubApi(api_client).list_backups() + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).list_backups(filters) + print("The response of ConfigurationHubApi->list_backups:\n") + pprint(results) except Exception as e: - print("Exception when calling ConfigurationHubApi->list_backups: %s\n" % e) + print("Exception when calling ConfigurationHubApi->list_backups: %s\n" % e) - path: /configuration-hub/deploys method: GET xCodeSample: @@ -3230,16 +3035,15 @@ label: SDK_tools/sdk/python/v2024/methods/configuration-hub#list-deploys source: | try: - # List Deploys - - api_response = api_instance.list_deploys() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_deploys() - print("The response of ConfigurationHubApi->list_deploys:\n") - pprint(api_response) + # List Deploys + + results = ConfigurationHubApi(api_client).list_deploys() + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).list_deploys() + print("The response of ConfigurationHubApi->list_deploys:\n") + pprint(results) except Exception as e: - print("Exception when calling ConfigurationHubApi->list_deploys: %s\n" % e) + print("Exception when calling ConfigurationHubApi->list_deploys: %s\n" % e) - path: /configuration-hub/drafts method: GET xCodeSample: @@ -3248,16 +3052,15 @@ source: | 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_drafts(filters) - print("The response of ConfigurationHubApi->list_drafts:\n") - pprint(api_response) + # List Drafts + + results = ConfigurationHubApi(api_client).list_drafts() + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).list_drafts(filters) + print("The response of ConfigurationHubApi->list_drafts:\n") + pprint(results) except Exception as e: - print("Exception when calling ConfigurationHubApi->list_drafts: %s\n" % e) + print("Exception when calling ConfigurationHubApi->list_drafts: %s\n" % e) - path: /configuration-hub/backups/uploads method: GET xCodeSample: @@ -3266,16 +3069,15 @@ source: | 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_uploaded_configurations(filters) - print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") - pprint(api_response) + # List Uploaded Configurations + + results = ConfigurationHubApi(api_client).list_uploaded_configurations() + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).list_uploaded_configurations(filters) + print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") + pprint(results) except Exception as e: - print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) + print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch method: POST xCodeSample: @@ -3283,7 +3085,7 @@ label: SDK_tools/sdk/python/v2024/methods/configuration-hub#update-object-mappings source: | source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. - object_mapping_bulk_patch_request = { + object_mapping_bulk_patch_request = '''{ "patches" : { "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { "op" : "replace", @@ -3296,18 +3098,17 @@ "value" : "New Target Value" } ] } - } # ObjectMappingBulkPatchRequest | The object mapping request body. - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_object_mappings(source_org, Result) - print("The response of ConfigurationHubApi->update_object_mappings:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ConfigurationHubApi->update_object_mappings: %s\n" % e) + }''' # ObjectMappingBulkPatchRequest | The object mapping request body. + try: + # Bulk updates object mappings + new_object_mapping_bulk_patch_request = ObjectMappingBulkPatchRequest.from_json(object_mapping_bulk_patch_request) + results = ConfigurationHubApi(api_client).update_object_mappings(source_org=source_org, object_mapping_bulk_patch_request=new_object_mapping_bulk_patch_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->update_object_mappings: %s\n" % e) - path: /connector-rules method: POST xCodeSample: @@ -3315,7 +3116,7 @@ label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#create-connector-rule 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') - connector_rule_create_request = { + connector_rule_create_request = '''{ "sourceCode" : { "version" : "1.0", "script" : "return \"Mr. \" + firstName;" @@ -3340,18 +3141,17 @@ "description" : "This rule does that", "attributes" : { }, "type" : "BuildMap" - } # ConnectorRuleCreateRequest | Connector rule to create. - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_connector_rule(x_sail_point_experimental, Result) - print("The response of ConnectorRuleManagementApi->create_connector_rule:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->create_connector_rule: %s\n" % e) + }''' # ConnectorRuleCreateRequest | Connector rule to create. + try: + # Create Connector Rule + new_connector_rule_create_request = ConnectorRuleCreateRequest.from_json(connector_rule_create_request) + results = ConnectorRuleManagementApi(api_client).create_connector_rule(x_sail_point_experimental=x_sail_point_experimental, connector_rule_create_request=new_connector_rule_create_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->create_connector_rule: %s\n" % e) - path: /connector-rules/{id} method: DELETE xCodeSample: @@ -3361,14 +3161,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_connector_rule(id, x_sail_point_experimental) + # Delete Connector Rule + + ConnectorRuleManagementApi(api_client).delete_connector_rule(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling ConnectorRuleManagementApi->delete_connector_rule: %s\n" % e) - path: /connector-rules/{id} method: GET xCodeSample: @@ -3378,16 +3177,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_connector_rule(id, x_sail_point_experimental) - print("The response of ConnectorRuleManagementApi->get_connector_rule:\n") - pprint(api_response) + # Get Connector Rule + + results = ConnectorRuleManagementApi(api_client).get_connector_rule(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = ConnectorRuleManagementApi(api_client).get_connector_rule(id, x_sail_point_experimental) + print("The response of ConnectorRuleManagementApi->get_connector_rule:\n") + pprint(results) except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->get_connector_rule: %s\n" % e) + print("Exception when calling ConnectorRuleManagementApi->get_connector_rule: %s\n" % e) - path: /connector-rules method: GET xCodeSample: @@ -3399,16 +3197,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) 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) try: - # List Connector Rules - - api_response = api_instance.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) - print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") - pprint(api_response) + # List Connector Rules + + results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) + print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) - path: /connector-rules/{id} method: PUT xCodeSample: @@ -3417,7 +3214,7 @@ source: | 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 = { + connector_rule_update_request = '''{ "sourceCode" : { "version" : "1.0", "script" : "return \"Mr. \" + firstName;" @@ -3443,18 +3240,17 @@ "attributes" : { }, "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", "type" : "BuildMap" - } # ConnectorRuleUpdateRequest | Connector rule with updated data. (optional) - try: - # Update Connector Rule - - api_response = api_instance.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) - print("The response of ConnectorRuleManagementApi->put_connector_rule:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->put_connector_rule: %s\n" % e) + }''' # ConnectorRuleUpdateRequest | Connector rule with updated data. (optional) + try: + # Update Connector Rule + + results = ConnectorRuleManagementApi(api_client).put_connector_rule(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->put_connector_rule: %s\n" % e) - path: /connector-rules/validate method: POST xCodeSample: @@ -3462,45 +3258,43 @@ label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#test-connector-rule 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') - source_code = { + source_code = '''{ "version" : "1.0", "script" : "return \"Mr. \" + firstName;" - } # SourceCode | Code to validate. - try: - # Validate Connector Rule - Result = source_code.from_json(source_code) - api_response = api_instance.test_connector_rule(x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.test_connector_rule(x_sail_point_experimental, Result) - print("The response of ConnectorRuleManagementApi->test_connector_rule:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ConnectorRuleManagementApi->test_connector_rule: %s\n" % e) + }''' # SourceCode | Code to validate. + try: + # Validate Connector Rule + new_source_code = SourceCode.from_json(source_code) + results = ConnectorRuleManagementApi(api_client).test_connector_rule(x_sail_point_experimental=x_sail_point_experimental, source_code=new_source_code) + # Below is a request that includes all optional parameters + # results = ConnectorRuleManagementApi(api_client).test_connector_rule(x_sail_point_experimental, new_source_code) + print("The response of ConnectorRuleManagementApi->test_connector_rule:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorRuleManagementApi->test_connector_rule: %s\n" % e) - path: /connectors method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#create-custom-connector source: | - v3_create_connector_dto = { + v3_create_connector_dto = '''{ "name" : "custom connector", "directConnect" : true, "className" : "sailpoint.connector.OpenConnectorAdapter", "type" : "custom connector type", "status" : "RELEASED" - } # V3CreateConnectorDto | - try: - # Create Custom Connector - Result = v3_create_connector_dto.from_json(v3_create_connector_dto) - api_response = api_instance.create_custom_connector(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_custom_connector(Result) - print("The response of ConnectorsApi->create_custom_connector:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ConnectorsApi->create_custom_connector: %s\n" % e) + }''' # V3CreateConnectorDto | + try: + # Create Custom Connector + new_v3_create_connector_dto = V3CreateConnectorDto.from_json(v3_create_connector_dto) + results = ConnectorsApi(api_client).create_custom_connector(v3_create_connector_dto=new_v3_create_connector_dto) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).create_custom_connector(new_v3_create_connector_dto) + print("The response of ConnectorsApi->create_custom_connector:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->create_custom_connector: %s\n" % e) - path: /connectors/{scriptName} method: DELETE xCodeSample: @@ -3509,14 +3303,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_custom_connector(script_name) + # Delete Connector by Script Name + + ConnectorsApi(api_client).delete_custom_connector(script_name=script_name) + # Below is a request that includes all optional parameters + # ConnectorsApi(api_client).delete_custom_connector(script_name) except Exception as e: - print("Exception when calling ConnectorsApi->delete_custom_connector: %s\n" % e) + print("Exception when calling ConnectorsApi->delete_custom_connector: %s\n" % e) - path: /connectors/{scriptName} method: GET xCodeSample: @@ -3526,16 +3319,15 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_connector(script_name, locale) - print("The response of ConnectorsApi->get_connector:\n") - pprint(api_response) + # Get Connector by Script Name + + results = ConnectorsApi(api_client).get_connector(script_name=script_name) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).get_connector(script_name, locale) + print("The response of ConnectorsApi->get_connector:\n") + pprint(results) except Exception as e: - print("Exception when calling ConnectorsApi->get_connector: %s\n" % e) + print("Exception when calling ConnectorsApi->get_connector: %s\n" % e) - path: /connectors/{scriptName}/correlation-config method: GET xCodeSample: @@ -3544,16 +3336,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_connector_correlation_config(script_name) - print("The response of ConnectorsApi->get_connector_correlation_config:\n") - pprint(api_response) + # Get Connector Correlation Configuration + + results = ConnectorsApi(api_client).get_connector_correlation_config(script_name=script_name) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).get_connector_correlation_config(script_name) + print("The response of ConnectorsApi->get_connector_correlation_config:\n") + pprint(results) except Exception as e: - print("Exception when calling ConnectorsApi->get_connector_correlation_config: %s\n" % e) + print("Exception when calling ConnectorsApi->get_connector_correlation_config: %s\n" % e) - path: /connectors method: GET xCodeSample: @@ -3566,16 +3357,15 @@ 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) 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 List - - api_response = api_instance.get_connector_list() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_connector_list(filters, limit, offset, count, locale) - print("The response of ConnectorsApi->get_connector_list:\n") - pprint(api_response) + # Get Connector List + + results = ConnectorsApi(api_client).get_connector_list() + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale) + print("The response of ConnectorsApi->get_connector_list:\n") + pprint(results) except Exception as e: - print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) + print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) - path: /connectors/{scriptName}/source-config method: GET xCodeSample: @@ -3584,16 +3374,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_connector_source_config(script_name) - print("The response of ConnectorsApi->get_connector_source_config:\n") - pprint(api_response) + # Get Connector Source Configuration + + results = ConnectorsApi(api_client).get_connector_source_config(script_name=script_name) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).get_connector_source_config(script_name) + print("The response of ConnectorsApi->get_connector_source_config:\n") + pprint(results) except Exception as e: - print("Exception when calling ConnectorsApi->get_connector_source_config: %s\n" % e) + print("Exception when calling ConnectorsApi->get_connector_source_config: %s\n" % e) - path: /connectors/{scriptName}/source-template method: GET xCodeSample: @@ -3602,16 +3391,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_connector_source_template(script_name) - print("The response of ConnectorsApi->get_connector_source_template:\n") - pprint(api_response) + # Get Connector Source Template + + results = ConnectorsApi(api_client).get_connector_source_template(script_name=script_name) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).get_connector_source_template(script_name) + print("The response of ConnectorsApi->get_connector_source_template:\n") + pprint(results) except Exception as e: - print("Exception when calling ConnectorsApi->get_connector_source_template: %s\n" % e) + print("Exception when calling ConnectorsApi->get_connector_source_template: %s\n" % e) - path: /connectors/{scriptName}/translations/{locale} method: GET xCodeSample: @@ -3621,16 +3409,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_connector_translations(script_name, locale) - print("The response of ConnectorsApi->get_connector_translations:\n") - pprint(api_response) + # Get Connector Translations + + results = ConnectorsApi(api_client).get_connector_translations(script_name=script_name, locale=locale) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).get_connector_translations(script_name, locale) + print("The response of ConnectorsApi->get_connector_translations:\n") + pprint(results) except Exception as e: - print("Exception when calling ConnectorsApi->get_connector_translations: %s\n" % e) + print("Exception when calling ConnectorsApi->get_connector_translations: %s\n" % e) - path: /connectors/{scriptName}/correlation-config method: PUT xCodeSample: @@ -3640,16 +3427,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_connector_correlation_config(script_name, file) - print("The response of ConnectorsApi->put_connector_correlation_config:\n") - pprint(api_response) + # Update Connector Correlation Configuration + + results = ConnectorsApi(api_client).put_connector_correlation_config(script_name=script_name, file=file) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).put_connector_correlation_config(script_name, file) + print("The response of ConnectorsApi->put_connector_correlation_config:\n") + pprint(results) except Exception as e: - print("Exception when calling ConnectorsApi->put_connector_correlation_config: %s\n" % e) + print("Exception when calling ConnectorsApi->put_connector_correlation_config: %s\n" % e) - path: /connectors/{scriptName}/source-config method: PUT xCodeSample: @@ -3659,16 +3445,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_connector_source_config(script_name, file) - print("The response of ConnectorsApi->put_connector_source_config:\n") - pprint(api_response) + # Update Connector Source Configuration + + results = ConnectorsApi(api_client).put_connector_source_config(script_name=script_name, file=file) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).put_connector_source_config(script_name, file) + print("The response of ConnectorsApi->put_connector_source_config:\n") + pprint(results) except Exception as e: - print("Exception when calling ConnectorsApi->put_connector_source_config: %s\n" % e) + print("Exception when calling ConnectorsApi->put_connector_source_config: %s\n" % e) - path: /connectors/{scriptName}/source-template method: PUT xCodeSample: @@ -3678,16 +3463,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_connector_source_template(script_name, file) - print("The response of ConnectorsApi->put_connector_source_template:\n") - pprint(api_response) + # Update Connector Source Template + + results = ConnectorsApi(api_client).put_connector_source_template(script_name=script_name, file=file) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).put_connector_source_template(script_name, file) + print("The response of ConnectorsApi->put_connector_source_template:\n") + pprint(results) except Exception as e: - print("Exception when calling ConnectorsApi->put_connector_source_template: %s\n" % e) + print("Exception when calling ConnectorsApi->put_connector_source_template: %s\n" % e) - path: /connectors/{scriptName}/translations/{locale} method: PUT xCodeSample: @@ -3697,16 +3481,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_connector_translations(script_name, locale) - print("The response of ConnectorsApi->put_connector_translations:\n") - pprint(api_response) + # Update Connector Translations + + results = ConnectorsApi(api_client).put_connector_translations(script_name=script_name, locale=locale) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).put_connector_translations(script_name, locale) + print("The response of ConnectorsApi->put_connector_translations:\n") + pprint(results) except Exception as e: - print("Exception when calling ConnectorsApi->put_connector_translations: %s\n" % e) + print("Exception when calling ConnectorsApi->put_connector_translations: %s\n" % e) - path: /connectors/{scriptName} method: PATCH xCodeSample: @@ -3714,24 +3497,17 @@ label: SDK_tools/sdk/python/v2024/methods/connectors#update-connector source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | A list of connector detail update operations - - try: - # Update Connector by Script Name - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_connector(script_name, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_connector(script_name, Result) - print("The response of ConnectorsApi->update_connector:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ConnectorsApi->update_connector: %s\n" % e) + json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of connector detail update operations + try: + # Update Connector by Script Name + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ConnectorsApi(api_client).update_connector(script_name=script_name, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).update_connector(script_name, new_json_patch_operation) + print("The response of ConnectorsApi->update_connector:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->update_connector: %s\n" % e) - path: /form-definitions method: POST xCodeSample: @@ -3739,7 +3515,7 @@ label: SDK_tools/sdk/python/v2024/methods/custom-forms#create-form-definition 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') - body = { + body = '''{ "owner" : { "name" : "Grant Smith", "id" : "2c9180867624cbd7017642d8c8c81f67", @@ -3849,18 +3625,17 @@ }, "key" : "department" } ] - } # CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional) - try: - # Creates a form definition. - - api_response = api_instance.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) - print("The response of CustomFormsApi->create_form_definition:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CustomFormsApi->create_form_definition: %s\n" % e) + }''' # CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional) + try: + # Creates a form definition. + + results = CustomFormsApi(api_client).create_form_definition(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).create_form_definition(x_sail_point_experimental, new_body) + print("The response of CustomFormsApi->create_form_definition:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition: %s\n" % e) - path: /form-definitions/forms-action-dynamic-schema method: POST xCodeSample: @@ -3868,7 +3643,7 @@ label: SDK_tools/sdk/python/v2024/methods/custom-forms#create-form-definition-dynamic-schema 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') - body = { + body = '''{ "description" : "A description", "attributes" : { "formDefinitionId" : "00000000-0000-0000-0000-000000000000" @@ -3876,18 +3651,17 @@ "id" : "00000000-0000-0000-0000-000000000000", "type" : "action", "versionNumber" : 1 - } # FormDefinitionDynamicSchemaRequest | Body is the request payload to create a form definition dynamic schema (optional) - try: - # Generate JSON Schema dynamically. - - api_response = api_instance.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) - print("The response of CustomFormsApi->create_form_definition_dynamic_schema:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CustomFormsApi->create_form_definition_dynamic_schema: %s\n" % e) + }''' # FormDefinitionDynamicSchemaRequest | Body is the request payload to create a form definition dynamic schema (optional) + try: + # Generate JSON Schema dynamically. + + results = CustomFormsApi(api_client).create_form_definition_dynamic_schema(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_dynamic_schema: %s\n" % e) - path: /form-definitions/{formDefinitionID}/upload method: POST xCodeSample: @@ -3898,16 +3672,15 @@ x_sail_point_experimental = 'true' # 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 try: - # Upload new form definition file. - - api_response = api_instance.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) - print("The response of CustomFormsApi->create_form_definition_file_request:\n") - pprint(api_response) + # Upload new form definition file. + + results = CustomFormsApi(api_client).create_form_definition_file_request(form_definition_id=form_definition_id, x_sail_point_experimental=x_sail_point_experimental, file=file) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CustomFormsApi->create_form_definition_file_request: %s\n" % e) + print("Exception when calling CustomFormsApi->create_form_definition_file_request: %s\n" % e) - path: /form-instances method: POST xCodeSample: @@ -3915,7 +3688,7 @@ label: SDK_tools/sdk/python/v2024/methods/custom-forms#create-form-instance 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') - body = { + body = '''{ "formInput" : { "input1" : "Sales" }, @@ -3935,18 +3708,17 @@ "formDefinitionId" : "00000000-0000-0000-0000-000000000000", "state" : "ASSIGNED", "ttl" : 1571827560 - } # CreateFormInstanceRequest | Body is the request payload to create a form instance (optional) - try: - # Creates a form instance. - - api_response = api_instance.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) - print("The response of CustomFormsApi->create_form_instance:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CustomFormsApi->create_form_instance: %s\n" % e) + }''' # CreateFormInstanceRequest | Body is the request payload to create a form instance (optional) + try: + # Creates a form instance. + + results = CustomFormsApi(api_client).create_form_instance(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).create_form_instance(x_sail_point_experimental, new_body) + print("The response of CustomFormsApi->create_form_instance:\n") + pprint(results) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_instance: %s\n" % e) - path: /form-definitions/{formDefinitionID} method: DELETE xCodeSample: @@ -3956,16 +3728,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_form_definition(form_definition_id, x_sail_point_experimental) - print("The response of CustomFormsApi->delete_form_definition:\n") - pprint(api_response) + # Deletes a form definition. + + results = CustomFormsApi(api_client).delete_form_definition(form_definition_id=form_definition_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).delete_form_definition(form_definition_id, x_sail_point_experimental) + print("The response of CustomFormsApi->delete_form_definition:\n") + pprint(results) except Exception as e: - print("Exception when calling CustomFormsApi->delete_form_definition: %s\n" % e) + print("Exception when calling CustomFormsApi->delete_form_definition: %s\n" % e) - path: /form-definitions/export method: GET xCodeSample: @@ -3978,16 +3749,15 @@ 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) 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, description, created, modified** (optional) (default to '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, description, created, modified** (optional) (default to 'name') try: - # List form definitions by tenant. - - api_response = api_instance.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) - print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") - pprint(api_response) + # List form definitions by tenant. + + results = CustomFormsApi(api_client).export_form_definitions_by_tenant(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) + print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) - path: /form-definitions/{formDefinitionID}/file/{fileID} method: GET xCodeSample: @@ -3998,16 +3768,15 @@ 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') try: - # Download definition file by fileId. - - api_response = api_instance.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) - print("The response of CustomFormsApi->get_file_from_s3:\n") - pprint(api_response) + # Download definition file by fileId. + + results = CustomFormsApi(api_client).get_file_from_s3(form_definition_id=form_definition_id, file_id=file_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CustomFormsApi->get_file_from_s3: %s\n" % e) + print("Exception when calling CustomFormsApi->get_file_from_s3: %s\n" % e) - path: /form-definitions/{formDefinitionID} method: GET xCodeSample: @@ -4017,16 +3786,15 @@ 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) - - # 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) - print("The response of CustomFormsApi->get_form_definition_by_key:\n") - pprint(api_response) + # Return a form definition. + + results = CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id=form_definition_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CustomFormsApi->get_form_definition_by_key: %s\n" % e) + print("Exception when calling CustomFormsApi->get_form_definition_by_key: %s\n" % e) - path: /form-instances/{formInstanceID} method: GET xCodeSample: @@ -4036,16 +3804,15 @@ 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) - - # 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) - print("The response of CustomFormsApi->get_form_instance_by_key:\n") - pprint(api_response) + # Returns a form instance. + + results = CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id=form_instance_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CustomFormsApi->get_form_instance_by_key: %s\n" % e) + print("Exception when calling CustomFormsApi->get_form_instance_by_key: %s\n" % e) - path: /form-instances/{formInstanceID}/file/{fileID} method: GET xCodeSample: @@ -4056,16 +3823,15 @@ 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') try: - # Download instance file by fileId. - - api_response = api_instance.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) - print("The response of CustomFormsApi->get_form_instance_file:\n") - pprint(api_response) + # Download instance file by fileId. + + results = CustomFormsApi(api_client).get_form_instance_file(form_instance_id=form_instance_id, file_id=file_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CustomFormsApi->get_form_instance_file: %s\n" % e) + print("Exception when calling CustomFormsApi->get_form_instance_file: %s\n" % e) - path: /form-definitions/import method: POST xCodeSample: @@ -4073,20 +3839,17 @@ label: SDK_tools/sdk/python/v2024/methods/custom-forms#import-form-definitions 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') - [{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) - + 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) try: - # Import form definitions from export. - - api_response = api_instance.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) - print("The response of CustomFormsApi->import_form_definitions:\n") - pprint(api_response) + # Import form definitions from export. + + results = CustomFormsApi(api_client).import_form_definitions(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).import_form_definitions(x_sail_point_experimental, new_body) + print("The response of CustomFormsApi->import_form_definitions:\n") + pprint(results) except Exception as e: - print("Exception when calling CustomFormsApi->import_form_definitions: %s\n" % e) + print("Exception when calling CustomFormsApi->import_form_definitions: %s\n" % e) - path: /form-definitions/{formDefinitionID} method: PATCH xCodeSample: @@ -4095,20 +3858,17 @@ source: | 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) - 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) try: - # Patch a form definition. - - api_response = api_instance.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) - print("The response of CustomFormsApi->patch_form_definition:\n") - pprint(api_response) + # Patch a form definition. + + results = CustomFormsApi(api_client).patch_form_definition(form_definition_id=form_definition_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CustomFormsApi->patch_form_definition: %s\n" % e) + print("Exception when calling CustomFormsApi->patch_form_definition: %s\n" % e) - path: /form-instances/{formInstanceID} method: PATCH xCodeSample: @@ -4117,20 +3877,17 @@ source: | 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) - 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) try: - # Patch a form instance. - - api_response = api_instance.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) - print("The response of CustomFormsApi->patch_form_instance:\n") - pprint(api_response) + # Patch a form instance. + + results = CustomFormsApi(api_client).patch_form_instance(form_instance_id=form_instance_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CustomFormsApi->patch_form_instance: %s\n" % e) + print("Exception when calling CustomFormsApi->patch_form_instance: %s\n" % e) - path: /form-definitions method: GET xCodeSample: @@ -4143,16 +3900,15 @@ 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) 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, description, created, modified** (optional) (default to '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, description, created, modified** (optional) (default to 'name') try: - # Export form definitions by tenant. - - api_response = api_instance.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) - print("The response of CustomFormsApi->search_form_definitions_by_tenant:\n") - pprint(api_response) + # Export form definitions by tenant. + + results = CustomFormsApi(api_client).search_form_definitions_by_tenant(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CustomFormsApi->search_form_definitions_by_tenant: %s\n" % e) + print("Exception when calling CustomFormsApi->search_form_definitions_by_tenant: %s\n" % e) - path: /form-instances/{formInstanceID}/data-source/{formElementID} method: GET xCodeSample: @@ -4166,16 +3922,15 @@ 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) query = 'support' # str | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # str | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) 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, ) - - # 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) - print("The response of CustomFormsApi->search_form_element_data_by_element_id:\n") - pprint(api_response) + # Retrieves dynamic data by element. + + results = CustomFormsApi(api_client).search_form_element_data_by_element_id(form_instance_id=form_instance_id, form_element_id=form_element_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CustomFormsApi->search_form_element_data_by_element_id: %s\n" % e) + print("Exception when calling CustomFormsApi->search_form_element_data_by_element_id: %s\n" % e) - path: /form-instances method: GET xCodeSample: @@ -4184,16 +3939,15 @@ 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: - # List form instances by tenant. - - api_response = api_instance.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) - print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") - pprint(api_response) + # List form instances by tenant. + + results = CustomFormsApi(api_client).search_form_instances_by_tenant(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) + print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) - path: /form-definitions/predefined-select-options method: GET xCodeSample: @@ -4202,16 +3956,15 @@ 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: - # List predefined select options. - - api_response = api_instance.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) - print("The response of CustomFormsApi->search_pre_defined_select_options:\n") - pprint(api_response) + # List predefined select options. + + results = CustomFormsApi(api_client).search_pre_defined_select_options(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CustomFormsApi->search_pre_defined_select_options: %s\n" % e) + print("Exception when calling CustomFormsApi->search_pre_defined_select_options: %s\n" % e) - path: /form-definitions/{formDefinitionID}/data-source method: POST xCodeSample: @@ -4223,7 +3976,7 @@ 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) query = 'ac' # str | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # str | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) - form_element_preview_request = { + form_element_preview_request = '''{ "dataSource" : { "config" : { "indices" : [ "identities" ], @@ -4233,18 +3986,17 @@ }, "dataSourceType" : "STATIC" } - } # FormElementPreviewRequest | Body is the request payload to create a form definition dynamic schema (optional) - try: - # Preview form definition data source. - - api_response = api_instance.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) - print("The response of CustomFormsApi->show_preview_data_source:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CustomFormsApi->show_preview_data_source: %s\n" % e) + }''' # FormElementPreviewRequest | Body is the request payload to create a form definition dynamic schema (optional) + try: + # Preview form definition data source. + + results = CustomFormsApi(api_client).show_preview_data_source(form_definition_id=form_definition_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling CustomFormsApi->show_preview_data_source: %s\n" % e) - path: /custom-password-instructions method: POST xCodeSample: @@ -4252,22 +4004,21 @@ label: SDK_tools/sdk/python/v2024/methods/custom-password-instructions#create-custom-password-instructions 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') - custom_password_instruction = { + 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", "locale" : "en" - } # CustomPasswordInstruction | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_custom_password_instructions(x_sail_point_experimental, Result) - print("The response of CustomPasswordInstructionsApi->create_custom_password_instructions:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CustomPasswordInstructionsApi->create_custom_password_instructions: %s\n" % e) + }''' # CustomPasswordInstruction | + try: + # Create Custom Password Instructions + new_custom_password_instruction = CustomPasswordInstruction.from_json(custom_password_instruction) + results = CustomPasswordInstructionsApi(api_client).create_custom_password_instructions(x_sail_point_experimental=x_sail_point_experimental, custom_password_instruction=new_custom_password_instruction) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->create_custom_password_instructions: %s\n" % e) - path: /custom-password-instructions/{pageId} method: DELETE xCodeSample: @@ -4278,14 +4029,13 @@ x_sail_point_experimental = 'true' # 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) try: - # Delete Custom Password Instructions by page ID - - api_instance.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) + # Delete Custom Password Instructions by page ID + + CustomPasswordInstructionsApi(api_client).delete_custom_password_instructions(page_id=page_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling CustomPasswordInstructionsApi->delete_custom_password_instructions: %s\n" % e) - path: /custom-password-instructions/{pageId} method: GET xCodeSample: @@ -4296,34 +4046,32 @@ x_sail_point_experimental = 'true' # 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) try: - # Get Custom Password Instructions by Page ID - - api_response = api_instance.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) - print("The response of CustomPasswordInstructionsApi->get_custom_password_instructions:\n") - pprint(api_response) + # Get Custom Password Instructions by Page ID + + results = CustomPasswordInstructionsApi(api_client).get_custom_password_instructions(page_id=page_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CustomPasswordInstructionsApi->get_custom_password_instructions: %s\n" % e) + print("Exception when calling CustomPasswordInstructionsApi->get_custom_password_instructions: %s\n" % e) - path: /data-segments method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/data-segmentation#create-data-segment source: | - data_segment = sailpoint.v2024.DataSegment() # DataSegment | + data_segment = '''sailpoint.v2024.DataSegment()''' # DataSegment | try: - # Create Segment - Result = data_segment.from_json(data_segment) - api_response = api_instance.create_data_segment(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_data_segment(Result) - print("The response of DataSegmentationApi->create_data_segment:\n") - pprint(api_response) + # Create Segment + new_data_segment = DataSegment.from_json(data_segment) + results = DataSegmentationApi(api_client).create_data_segment(data_segment=new_data_segment) + # Below is a request that includes all optional parameters + # results = DataSegmentationApi(api_client).create_data_segment(new_data_segment) + print("The response of DataSegmentationApi->create_data_segment:\n") + pprint(results) except Exception as e: - print("Exception when calling DataSegmentationApi->create_data_segment: %s\n" % e) + print("Exception when calling DataSegmentationApi->create_data_segment: %s\n" % e) - path: /data-segments/{segmentId} method: DELETE xCodeSample: @@ -4334,14 +4082,13 @@ x_sail_point_experimental = 'true' # 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) try: - # Delete Segment by ID - - api_instance.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) + # Delete Segment by ID + + DataSegmentationApi(api_client).delete_data_segment(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling DataSegmentationApi->delete_data_segment: %s\n" % e) - path: /data-segments/{segmentId} method: GET xCodeSample: @@ -4351,16 +4098,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_data_segment(id, x_sail_point_experimental) - print("The response of DataSegmentationApi->get_data_segment:\n") - pprint(api_response) + # Get Segment by ID + + results = DataSegmentationApi(api_client).get_data_segment(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = DataSegmentationApi(api_client).get_data_segment(id, x_sail_point_experimental) + print("The response of DataSegmentationApi->get_data_segment:\n") + pprint(results) except Exception as e: - print("Exception when calling DataSegmentationApi->get_data_segment: %s\n" % e) + print("Exception when calling DataSegmentationApi->get_data_segment: %s\n" % e) - path: /data-segments/membership/{identityId} method: GET xCodeSample: @@ -4370,16 +4116,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.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) + # Get SegmentMembership by Identity ID + + results = DataSegmentationApi(api_client).get_data_segment_identity_membership(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling DataSegmentationApi->get_data_segment_identity_membership: %s\n" % e) + print("Exception when calling DataSegmentationApi->get_data_segment_identity_membership: %s\n" % e) - path: /data-segments/user-enabled/{identityId} method: GET xCodeSample: @@ -4389,16 +4134,15 @@ 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) - - # 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) - print("The response of DataSegmentationApi->get_data_segmentation_enabled_for_user:\n") - pprint(api_response) + # Is Segmentation enabled by Identity + + results = DataSegmentationApi(api_client).get_data_segmentation_enabled_for_user(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling DataSegmentationApi->get_data_segmentation_enabled_for_user: %s\n" % e) + print("Exception when calling DataSegmentationApi->get_data_segmentation_enabled_for_user: %s\n" % e) - path: /data-segments method: GET xCodeSample: @@ -4414,16 +4158,15 @@ 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) filters = 'name 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, in, sw* **name**: *eq, in, 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: **id**: *eq, in, sw* **name**: *eq, in, sw* (optional) try: - # Get Segments - - api_response = api_instance.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) - print("The response of DataSegmentationApi->list_data_segments:\n") - pprint(api_response) + # Get Segments + + results = DataSegmentationApi(api_client).list_data_segments(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling DataSegmentationApi->list_data_segments: %s\n" % e) + print("Exception when calling DataSegmentationApi->list_data_segments: %s\n" % e) - path: /data-segments/{segmentId} method: PATCH xCodeSample: @@ -4432,20 +4175,17 @@ source: | 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 - 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 - + 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 try: - # Update Segment - Result = request_body.from_json(request_body) - api_response = api_instance.patch_data_segment(id, x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_data_segment(id, x_sail_point_experimental, Result) - print("The response of DataSegmentationApi->patch_data_segment:\n") - pprint(api_response) + # Update Segment + new_request_body = RequestBody.from_json(request_body) + results = DataSegmentationApi(api_client).patch_data_segment(id=id, x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling DataSegmentationApi->patch_data_segment: %s\n" % e) + print("Exception when calling DataSegmentationApi->patch_data_segment: %s\n" % e) - path: /data-segments/{segmentId} method: POST xCodeSample: @@ -4453,19 +4193,16 @@ label: SDK_tools/sdk/python/v2024/methods/data-segmentation#publish-data-segment 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') - 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 - + request_body = '''['request_body_example']''' # List[str] | A list of segment ids that you wish to publish publish_all = True # bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to True) # bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to True) try: - # Publish segment by ID - Result = request_body.from_json(request_body) - api_instance.publish_data_segment(x_sail_point_experimental, Result, ) - - # Below is a request that includes all optional parameters - # api_instance.publish_data_segment(x_sail_point_experimental, Result, publish_all) + # Publish segment by ID + new_request_body = RequestBody.from_json(request_body) + DataSegmentationApi(api_client).publish_data_segment(x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling DataSegmentationApi->publish_data_segment: %s\n" % e) - path: /roles/{roleId}/dimensions method: POST xCodeSample: @@ -4473,7 +4210,7 @@ label: SDK_tools/sdk/python/v2024/methods/dimensions#create-dimension source: | role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension. - dimension = { + dimension = '''{ "owner" : { "name" : "support", "id" : "2c9180a46faadee4016fb4e018c20639", @@ -4559,18 +4296,17 @@ "type" : "STANDARD" }, "parentId" : "2c918086749d78830174a1a40e121518" - } # Dimension | - try: - # Create a Dimension - Result = dimension.from_json(dimension) - api_response = api_instance.create_dimension(role_id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_dimension(role_id, Result) - print("The response of DimensionsApi->create_dimension:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling DimensionsApi->create_dimension: %s\n" % e) + }''' # Dimension | + try: + # Create a Dimension + new_dimension = Dimension.from_json(dimension) + results = DimensionsApi(api_client).create_dimension(role_id=role_id, dimension=new_dimension) + # Below is a request that includes all optional parameters + # results = DimensionsApi(api_client).create_dimension(role_id, new_dimension) + print("The response of DimensionsApi->create_dimension:\n") + pprint(results) + except Exception as e: + print("Exception when calling DimensionsApi->create_dimension: %s\n" % e) - path: /roles/{roleId}/dimensions/bulk-delete method: POST xCodeSample: @@ -4578,20 +4314,19 @@ label: SDK_tools/sdk/python/v2024/methods/dimensions#delete-bulk-dimensions source: | role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimensions. # str | Parent Role Id of the dimensions. - dimension_bulk_delete_request = { + dimension_bulk_delete_request = '''{ "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] - } # DimensionBulkDeleteRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_bulk_dimensions(role_id, Result) - print("The response of DimensionsApi->delete_bulk_dimensions:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling DimensionsApi->delete_bulk_dimensions: %s\n" % e) + }''' # DimensionBulkDeleteRequest | + try: + # Delete Dimension(s) + new_dimension_bulk_delete_request = DimensionBulkDeleteRequest.from_json(dimension_bulk_delete_request) + results = DimensionsApi(api_client).delete_bulk_dimensions(role_id=role_id, dimension_bulk_delete_request=new_dimension_bulk_delete_request) + # Below is a request that includes all optional parameters + # results = DimensionsApi(api_client).delete_bulk_dimensions(role_id, new_dimension_bulk_delete_request) + print("The response of DimensionsApi->delete_bulk_dimensions:\n") + pprint(results) + except Exception as e: + print("Exception when calling DimensionsApi->delete_bulk_dimensions: %s\n" % e) - path: /roles/{roleId}/dimensions/{dimensionId} method: DELETE xCodeSample: @@ -4601,14 +4336,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_dimension(role_id, dimension_id) + # Delete a Dimension + + DimensionsApi(api_client).delete_dimension(role_id=role_id, dimension_id=dimension_id) + # Below is a request that includes all optional parameters + # DimensionsApi(api_client).delete_dimension(role_id, dimension_id) except Exception as e: - print("Exception when calling DimensionsApi->delete_dimension: %s\n" % e) + print("Exception when calling DimensionsApi->delete_dimension: %s\n" % e) - path: /roles/{roleId}/dimensions/{dimensionId} method: GET xCodeSample: @@ -4618,16 +4352,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_dimension(role_id, dimension_id) - print("The response of DimensionsApi->get_dimension:\n") - pprint(api_response) + # Get a Dimension under Role. + + results = DimensionsApi(api_client).get_dimension(role_id=role_id, dimension_id=dimension_id) + # Below is a request that includes all optional parameters + # results = DimensionsApi(api_client).get_dimension(role_id, dimension_id) + print("The response of DimensionsApi->get_dimension:\n") + pprint(results) except Exception as e: - print("Exception when calling DimensionsApi->get_dimension: %s\n" % e) + print("Exception when calling DimensionsApi->get_dimension: %s\n" % e) - path: /roles/{roleId}/dimensions/{dimensionId}/entitlements method: GET xCodeSample: @@ -4642,16 +4375,15 @@ filters = 'attribute eq \"memberOf\"' # 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.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: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) sorters = 'name,-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-results) Sorting is supported for the following fields: **name, attribute, value, created, 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-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) try: - # List Dimension's Entitlements - - api_response = api_instance.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) - print("The response of DimensionsApi->get_dimension_entitlements:\n") - pprint(api_response) + # List Dimension's Entitlements + + results = DimensionsApi(api_client).get_dimension_entitlements(role_id=role_id, dimension_id=dimension_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling DimensionsApi->get_dimension_entitlements: %s\n" % e) + print("Exception when calling DimensionsApi->get_dimension_entitlements: %s\n" % e) - path: /roles/{roleId}/dimensions/{dimensionId}/access-profiles method: GET xCodeSample: @@ -4666,16 +4398,15 @@ filters = 'source.id eq \"2c91808982f979270182f99e386d00fa\"' # 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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.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: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) sorters = 'name,-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-results) Sorting is supported for the following fields: **name, created, 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-results) Sorting is supported for the following fields: **name, created, modified** (optional) try: - # List Dimension's Access Profiles - - api_response = api_instance.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) - print("The response of DimensionsApi->list_dimension_access_profiles:\n") - pprint(api_response) + # List Dimension's Access Profiles + + results = DimensionsApi(api_client).list_dimension_access_profiles(role_id=role_id, dimension_id=dimension_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling DimensionsApi->list_dimension_access_profiles: %s\n" % e) + print("Exception when calling DimensionsApi->list_dimension_access_profiles: %s\n" % e) - path: /roles/{roleId}/dimensions method: GET xCodeSample: @@ -4690,16 +4421,15 @@ filters = 'id eq \'2c918086749d78830174a1a40e121518\'' # 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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.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: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) sorters = 'name,-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-results) Sorting is supported for the following fields: **name, created, 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-results) Sorting is supported for the following fields: **name, created, modified** (optional) try: - # List Dimensions - - api_response = api_instance.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) - print("The response of DimensionsApi->list_dimensions:\n") - pprint(api_response) + # List Dimensions + + results = DimensionsApi(api_client).list_dimensions(role_id=role_id) + # Below is a request that includes all optional parameters + # results = DimensionsApi(api_client).list_dimensions(role_id, for_subadmin, limit, offset, count, filters, sorters) + print("The response of DimensionsApi->list_dimensions:\n") + pprint(results) except Exception as e: - print("Exception when calling DimensionsApi->list_dimensions: %s\n" % e) + print("Exception when calling DimensionsApi->list_dimensions: %s\n" % e) - path: /roles/{roleId}/dimensions/{dimensionId} method: PATCH xCodeSample: @@ -4708,24 +4438,17 @@ source: | 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] | - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_dimension(role_id, dimension_id, Result) - print("The response of DimensionsApi->patch_dimension:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling DimensionsApi->patch_dimension: %s\n" % e) + json_patch_operation = '''[{op=replace, path=/description, value=Test Description}, {op=replace, path=/name, value=new name}]''' # List[JsonPatchOperation] | + try: + # Patch a specified Dimension + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = DimensionsApi(api_client).patch_dimension(role_id=role_id, dimension_id=dimension_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = DimensionsApi(api_client).patch_dimension(role_id, dimension_id, new_json_patch_operation) + print("The response of DimensionsApi->patch_dimension:\n") + pprint(results) + except Exception as e: + print("Exception when calling DimensionsApi->patch_dimension: %s\n" % e) - path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} method: POST xCodeSample: @@ -4737,16 +4460,15 @@ 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') 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) - - # 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) - print("The response of EntitlementsApi->create_access_model_metadata_for_entitlement:\n") - pprint(api_response) + # Add metadata to an entitlement. + + results = EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id=id, attribute_key=attribute_key, attribute_value=attribute_value, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling EntitlementsApi->create_access_model_metadata_for_entitlement: %s\n" % e) + print("Exception when calling EntitlementsApi->create_access_model_metadata_for_entitlement: %s\n" % e) - path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} method: DELETE xCodeSample: @@ -4758,14 +4480,13 @@ 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') try: - # Remove metadata from an entitlement. - - api_instance.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) + # Remove metadata from an entitlement. + + EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id=id, attribute_key=attribute_key, attribute_value=attribute_value, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling EntitlementsApi->delete_access_model_metadata_from_entitlement: %s\n" % e) - path: /entitlements/{id} method: GET xCodeSample: @@ -4775,16 +4496,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_entitlement(id, x_sail_point_experimental) - print("The response of EntitlementsApi->get_entitlement:\n") - pprint(api_response) + # Get an entitlement + + results = EntitlementsApi(api_client).get_entitlement(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).get_entitlement(id, x_sail_point_experimental) + print("The response of EntitlementsApi->get_entitlement:\n") + pprint(results) except Exception as e: - print("Exception when calling EntitlementsApi->get_entitlement: %s\n" % e) + print("Exception when calling EntitlementsApi->get_entitlement: %s\n" % e) - path: /entitlements/{id}/entitlement-request-config method: GET xCodeSample: @@ -4794,16 +4514,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_entitlement_request_config(id, x_sail_point_experimental) - print("The response of EntitlementsApi->get_entitlement_request_config:\n") - pprint(api_response) + # Get Entitlement Request Config + + results = EntitlementsApi(api_client).get_entitlement_request_config(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).get_entitlement_request_config(id, x_sail_point_experimental) + print("The response of EntitlementsApi->get_entitlement_request_config:\n") + pprint(results) except Exception as e: - print("Exception when calling EntitlementsApi->get_entitlement_request_config: %s\n" % e) + print("Exception when calling EntitlementsApi->get_entitlement_request_config: %s\n" % e) - path: /entitlements/aggregate/sources/{id} method: POST xCodeSample: @@ -4814,16 +4533,15 @@ x_sail_point_experimental = 'true' # 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) try: - # Aggregate Entitlements - - api_response = api_instance.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) - print("The response of EntitlementsApi->import_entitlements_by_source:\n") - pprint(api_response) + # Aggregate Entitlements + + results = EntitlementsApi(api_client).import_entitlements_by_source(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling EntitlementsApi->import_entitlements_by_source: %s\n" % e) + print("Exception when calling EntitlementsApi->import_entitlements_by_source: %s\n" % e) - path: /entitlements/{id}/children method: GET xCodeSample: @@ -4838,16 +4556,15 @@ sorters = 'name,-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-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (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: **id, name, created, modified, type, attribute, value, source.id** (optional) filters = 'attribute eq \"memberOf\"' # 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) try: - # List of entitlements children - - api_response = api_instance.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) - print("The response of EntitlementsApi->list_entitlement_children:\n") - pprint(api_response) + # List of entitlements children + + results = EntitlementsApi(api_client).list_entitlement_children(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) + print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) - path: /entitlements/{id}/parents method: GET xCodeSample: @@ -4862,16 +4579,15 @@ sorters = 'name,-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-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (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: **id, name, created, modified, type, attribute, value, source.id** (optional) filters = 'attribute eq \"memberOf\"' # 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) try: - # List of entitlements parents - - api_response = api_instance.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) - print("The response of EntitlementsApi->list_entitlement_parents:\n") - pprint(api_response) + # List of entitlements parents + + results = EntitlementsApi(api_client).list_entitlement_parents(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) + print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) - path: /entitlements method: GET xCodeSample: @@ -4889,16 +4605,15 @@ sorters = 'name,-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-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (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: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) filters = 'attribute eq \"memberOf\"' # 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, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) try: - # Gets a list of entitlements. - - api_response = api_instance.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) - print("The response of EntitlementsApi->list_entitlements:\n") - pprint(api_response) + # Gets a list of entitlements. + + results = EntitlementsApi(api_client).list_entitlements(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) + print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) - path: /entitlements/{id} method: PATCH xCodeSample: @@ -4907,24 +4622,17 @@ source: | 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) - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | (optional) - - try: - # Patch an entitlement - - api_response = api_instance.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) - print("The response of EntitlementsApi->patch_entitlement:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling EntitlementsApi->patch_entitlement: %s\n" % e) + json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}]''' # List[JsonPatchOperation] | (optional) + try: + # Patch an entitlement + + results = EntitlementsApi(api_client).patch_entitlement(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).patch_entitlement(id, x_sail_point_experimental, new_json_patch_operation) + print("The response of EntitlementsApi->patch_entitlement:\n") + pprint(results) + except Exception as e: + print("Exception when calling EntitlementsApi->patch_entitlement: %s\n" % e) - path: /entitlements/{id}/entitlement-request-config method: PUT xCodeSample: @@ -4933,23 +4641,22 @@ source: | 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 = { + entitlement_request_config = '''{ "requestCommentsRequired" : false, "deniedCommentsRequired" : false, "allowEntitlementRequest" : true, "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" - } # EntitlementRequestConfig | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_entitlement_request_config(id, x_sail_point_experimental, Result) - print("The response of EntitlementsApi->put_entitlement_request_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling EntitlementsApi->put_entitlement_request_config: %s\n" % e) + }''' # EntitlementRequestConfig | + try: + # Replace Entitlement Request Config + new_entitlement_request_config = EntitlementRequestConfig.from_json(entitlement_request_config) + results = EntitlementsApi(api_client).put_entitlement_request_config(id=id, x_sail_point_experimental=x_sail_point_experimental, entitlement_request_config=new_entitlement_request_config) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling EntitlementsApi->put_entitlement_request_config: %s\n" % e) - path: /entitlements/reset/sources/{id} method: POST xCodeSample: @@ -4959,16 +4666,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.reset_source_entitlements(id, x_sail_point_experimental) - print("The response of EntitlementsApi->reset_source_entitlements:\n") - pprint(api_response) + # Reset Source Entitlements + + results = EntitlementsApi(api_client).reset_source_entitlements(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).reset_source_entitlements(id, x_sail_point_experimental) + print("The response of EntitlementsApi->reset_source_entitlements:\n") + pprint(results) except Exception as e: - print("Exception when calling EntitlementsApi->reset_source_entitlements: %s\n" % e) + print("Exception when calling EntitlementsApi->reset_source_entitlements: %s\n" % e) - path: /entitlements/bulk-update method: POST xCodeSample: @@ -4976,7 +4682,7 @@ label: SDK_tools/sdk/python/v2024/methods/entitlements#update-entitlements-in-bulk 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') - entitlement_bulk_update_request = { + entitlement_bulk_update_request = '''{ "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], "jsonPatch" : [ { "op" : "replace", @@ -4987,38 +4693,36 @@ "path" : "/requestable", "value" : false } ] - } # EntitlementBulkUpdateRequest | + }''' # EntitlementBulkUpdateRequest | 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) - - # Below is a request that includes all optional parameters - # api_instance.update_entitlements_in_bulk(x_sail_point_experimental, Result) + # Bulk update an entitlement list + new_entitlement_bulk_update_request = EntitlementBulkUpdateRequest.from_json(entitlement_bulk_update_request) + EntitlementsApi(api_client).update_entitlements_in_bulk(x_sail_point_experimental=x_sail_point_experimental, entitlement_bulk_update_request=new_entitlement_bulk_update_request) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling EntitlementsApi->update_entitlements_in_bulk: %s\n" % e) - path: /auth-org/network-config method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#create-auth-org-network-config source: | - network_configuration = { + network_configuration = '''{ "range" : [ "1.3.7.2", "255.255.255.252/30" ], "whitelisted" : true, "geolocation" : [ "CA", "FR", "HT" ] - } # NetworkConfiguration | Network configuration creation request body. The following constraints ensure the request body 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. - try: - # Create security network configuration. - Result = network_configuration.from_json(network_configuration) - api_response = api_instance.create_auth_org_network_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_auth_org_network_config(Result) - print("The response of GlobalTenantSecuritySettingsApi->create_auth_org_network_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling GlobalTenantSecuritySettingsApi->create_auth_org_network_config: %s\n" % e) + }''' # NetworkConfiguration | Network configuration creation request body. The following constraints ensure the request body 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. + try: + # Create security network configuration. + new_network_configuration = NetworkConfiguration.from_json(network_configuration) + results = GlobalTenantSecuritySettingsApi(api_client).create_auth_org_network_config(network_configuration=new_network_configuration) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).create_auth_org_network_config(new_network_configuration) + print("The response of GlobalTenantSecuritySettingsApi->create_auth_org_network_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->create_auth_org_network_config: %s\n" % e) - path: /auth-org/network-config method: GET xCodeSample: @@ -5026,40 +4730,32 @@ label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#get-auth-org-network-config source: | try: - # Get security network configuration. - - api_response = api_instance.get_auth_org_network_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_auth_org_network_config() - print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_network_config:\n") - pprint(api_response) + # Get security network configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_network_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_network_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_network_config:\n") + pprint(results) except Exception as e: - print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_network_config: %s\n" % e) + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_network_config: %s\n" % e) - path: /auth-org/network-config method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#patch-auth-org-network-config source: | - [{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", - "path" : "/description", - "value" : "New description" - } # 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. - - try: - # Update security network configuration. - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_auth_org_network_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_auth_org_network_config(Result) - print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_network_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_network_config: %s\n" % e) + json_patch_operation = '''[{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. + try: + # Update security network configuration. + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_network_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_network_config: %s\n" % e) - path: /workgroups method: POST xCodeSample: @@ -5067,7 +4763,7 @@ label: SDK_tools/sdk/python/v2024/methods/governance-groups#create-workgroup 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') - workgroup_dto = { + workgroup_dto = '''{ "owner" : { "emailAddress" : "support@sailpoint.com", "displayName" : "Support", @@ -5082,18 +4778,17 @@ "description" : "Description of the Governance Group", "modified" : "2022-01-06T19:51:13Z", "id" : "2c91808568c529c60168cca6f90c1313" - } # WorkgroupDto | - try: - # Create a new Governance Group. - Result = workgroup_dto.from_json(workgroup_dto) - api_response = api_instance.create_workgroup(x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_workgroup(x_sail_point_experimental, Result) - print("The response of GovernanceGroupsApi->create_workgroup:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->create_workgroup: %s\n" % e) + }''' # WorkgroupDto | + try: + # Create a new Governance Group. + new_workgroup_dto = WorkgroupDto.from_json(workgroup_dto) + results = GovernanceGroupsApi(api_client).create_workgroup(x_sail_point_experimental=x_sail_point_experimental, workgroup_dto=new_workgroup_dto) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).create_workgroup(x_sail_point_experimental, new_workgroup_dto) + print("The response of GovernanceGroupsApi->create_workgroup:\n") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->create_workgroup: %s\n" % e) - path: /workgroups/{id} method: DELETE xCodeSample: @@ -5103,14 +4798,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_workgroup(id, x_sail_point_experimental) + # Delete a Governance Group + + GovernanceGroupsApi(api_client).delete_workgroup(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # GovernanceGroupsApi(api_client).delete_workgroup(id, x_sail_point_experimental) except Exception as e: - print("Exception when calling GovernanceGroupsApi->delete_workgroup: %s\n" % e) + print("Exception when calling GovernanceGroupsApi->delete_workgroup: %s\n" % e) - path: /workgroups/{workgroupId}/members/bulk-delete method: POST xCodeSample: @@ -5119,20 +4813,17 @@ source: | 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. - identity_preview_response_identity = [sailpoint.v2024.IdentityPreviewResponseIdentity()] # List[IdentityPreviewResponseIdentity] | List of identities to be removed from a Governance Group members list. - + identity_preview_response_identity = '''[sailpoint.v2024.IdentityPreviewResponseIdentity()]''' # List[IdentityPreviewResponseIdentity] | List of identities to be removed from a Governance Group members list. 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_workgroup_members(workgroup_id, x_sail_point_experimental, Result) - print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") - pprint(api_response) + # Remove members from Governance Group + new_identity_preview_response_identity = IdentityPreviewResponseIdentity.from_json(identity_preview_response_identity) + results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id=workgroup_id, x_sail_point_experimental=x_sail_point_experimental, identity_preview_response_identity=new_identity_preview_response_identity) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) + print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) - path: /workgroups/bulk-delete method: POST xCodeSample: @@ -5140,20 +4831,19 @@ label: SDK_tools/sdk/python/v2024/methods/governance-groups#delete-workgroups-in-bulk 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') - workgroup_bulk_delete_request = { + 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(x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_workgroups_in_bulk(x_sail_point_experimental, Result) - print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) + }''' # WorkgroupBulkDeleteRequest | + try: + # Delete Governance Group(s) + new_workgroup_bulk_delete_request = WorkgroupBulkDeleteRequest.from_json(workgroup_bulk_delete_request) + results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(x_sail_point_experimental=x_sail_point_experimental, workgroup_bulk_delete_request=new_workgroup_bulk_delete_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) - path: /workgroups/{id} method: GET xCodeSample: @@ -5163,16 +4853,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_workgroup(id, x_sail_point_experimental) - print("The response of GovernanceGroupsApi->get_workgroup:\n") - pprint(api_response) + # Get Governance Group by Id + + results = GovernanceGroupsApi(api_client).get_workgroup(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).get_workgroup(id, x_sail_point_experimental) + print("The response of GovernanceGroupsApi->get_workgroup:\n") + pprint(results) except Exception as e: - print("Exception when calling GovernanceGroupsApi->get_workgroup: %s\n" % e) + print("Exception when calling GovernanceGroupsApi->get_workgroup: %s\n" % e) - path: /workgroups/{workgroupId}/connections method: GET xCodeSample: @@ -5186,16 +4875,15 @@ 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) sorters = 'name,-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-results) Sorting is supported for the following fields: **name, created, 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-results) Sorting is supported for the following fields: **name, created, modified** (optional) try: - # List connections for Governance Group - - api_response = api_instance.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) - print("The response of GovernanceGroupsApi->list_connections:\n") - pprint(api_response) + # List connections for Governance Group + + results = GovernanceGroupsApi(api_client).list_connections(workgroup_id=workgroup_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) + print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) - path: /workgroups/{workgroupId}/members method: GET xCodeSample: @@ -5209,16 +4897,15 @@ 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) sorters = 'name,-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-results) Sorting is supported for the following fields: **name, created, 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-results) Sorting is supported for the following fields: **name, created, modified** (optional) try: - # List Governance Group Members - - api_response = api_instance.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) - print("The response of GovernanceGroupsApi->list_workgroup_members:\n") - pprint(api_response) + # List Governance Group Members + + results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id=workgroup_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) + print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) - path: /workgroups method: GET xCodeSample: @@ -5232,16 +4919,15 @@ filters = '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: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *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: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) sorters = 'name,-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-results) Sorting is supported for the following fields: **name, created, modified, id, description** (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, created, modified, id, description** (optional) try: - # List Governance Groups - - api_response = api_instance.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) - print("The response of GovernanceGroupsApi->list_workgroups:\n") - pprint(api_response) + # List Governance Groups + + results = GovernanceGroupsApi(api_client).list_workgroups(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).list_workgroups(x_sail_point_experimental, offset, limit, count, filters, sorters) + print("The response of GovernanceGroupsApi->list_workgroups:\n") + pprint(results) except Exception as e: - print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) + print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) - path: /workgroups/{id} method: PATCH xCodeSample: @@ -5250,24 +4936,17 @@ source: | 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) - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | (optional) - - try: - # Patch a Governance Group - - api_response = api_instance.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) - print("The response of GovernanceGroupsApi->patch_workgroup:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling GovernanceGroupsApi->patch_workgroup: %s\n" % e) + json_patch_operation = '''[{op=replace, path=/description, value=Governance Group new description.}]''' # List[JsonPatchOperation] | (optional) + try: + # Patch a Governance Group + + results = GovernanceGroupsApi(api_client).patch_workgroup(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).patch_workgroup(id, x_sail_point_experimental, new_json_patch_operation) + print("The response of GovernanceGroupsApi->patch_workgroup:\n") + pprint(results) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->patch_workgroup: %s\n" % e) - path: /workgroups/{workgroupId}/members/bulk-add method: POST xCodeSample: @@ -5276,20 +4955,17 @@ source: | 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. - identity_preview_response_identity = [sailpoint.v2024.IdentityPreviewResponseIdentity()] # List[IdentityPreviewResponseIdentity] | List of identities to be added to a Governance Group members list. - + identity_preview_response_identity = '''[sailpoint.v2024.IdentityPreviewResponseIdentity()]''' # List[IdentityPreviewResponseIdentity] | List of identities to be added to a Governance Group members list. 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_workgroup_members(workgroup_id, x_sail_point_experimental, Result) - print("The response of GovernanceGroupsApi->update_workgroup_members:\n") - pprint(api_response) + # Add members to Governance Group + new_identity_preview_response_identity = IdentityPreviewResponseIdentity.from_json(identity_preview_response_identity) + results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id=workgroup_id, x_sail_point_experimental=x_sail_point_experimental, identity_preview_response_identity=new_identity_preview_response_identity) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) + print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) - path: /ai-access-request-recommendations/ignored-items method: POST xCodeSample: @@ -5297,24 +4973,23 @@ label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item 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') - access_request_recommendation_action_item_dto = { + access_request_recommendation_action_item_dto = '''{ "access" : { "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" }, "identityId" : "2c91808570313110017040b06f344ec9" - } # AccessRequestRecommendationActionItemDto | The recommended access item to ignore for an identity. - try: - # Ignore Access Request Recommendation - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.add_access_request_recommendations_ignored_item(x_sail_point_experimental, Result) - print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item: %s\n" % e) + }''' # AccessRequestRecommendationActionItemDto | The recommended access item to ignore for an identity. + try: + # Ignore Access Request Recommendation + new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto) + results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_ignored_item(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item: %s\n" % e) - path: /ai-access-request-recommendations/requested-items method: POST xCodeSample: @@ -5322,24 +4997,23 @@ label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item 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') - access_request_recommendation_action_item_dto = { + access_request_recommendation_action_item_dto = '''{ "access" : { "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" }, "identityId" : "2c91808570313110017040b06f344ec9" - } # AccessRequestRecommendationActionItemDto | The recommended access item that was requested for an identity. - try: - # Accept Access Request Recommendation - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.add_access_request_recommendations_requested_item(x_sail_point_experimental, Result) - print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item: %s\n" % e) + }''' # AccessRequestRecommendationActionItemDto | The recommended access item that was requested for an identity. + try: + # Accept Access Request Recommendation + new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto) + results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_requested_item(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item: %s\n" % e) - path: /ai-access-request-recommendations/viewed-items method: POST xCodeSample: @@ -5347,24 +5021,23 @@ label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item 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') - access_request_recommendation_action_item_dto = { + access_request_recommendation_action_item_dto = '''{ "access" : { "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" }, "identityId" : "2c91808570313110017040b06f344ec9" - } # AccessRequestRecommendationActionItemDto | The recommended access that was viewed for an identity. - try: - # Mark 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.add_access_request_recommendations_viewed_item(x_sail_point_experimental, Result) - print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item: %s\n" % e) + }''' # AccessRequestRecommendationActionItemDto | The recommended access that was viewed for an identity. + try: + # Mark Viewed Access Request Recommendations + new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto) + results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_item(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item: %s\n" % e) - path: /ai-access-request-recommendations/viewed-items/bulk-create method: POST xCodeSample: @@ -5372,26 +5045,17 @@ label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items 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') - [sailpoint.v2024.AccessRequestRecommendationActionItemDto()] # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. - access_request_recommendation_action_item_dto = { - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" - } # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. - - try: - # Bulk Mark 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_items(x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.add_access_request_recommendations_viewed_items(x_sail_point_experimental, Result) - print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) + access_request_recommendation_action_item_dto = '''[sailpoint.v2024.AccessRequestRecommendationActionItemDto()]''' # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. + try: + # Bulk Mark Viewed Access Request Recommendations + new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto) + results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) - path: /ai-access-request-recommendations method: GET xCodeSample: @@ -5407,16 +5071,15 @@ filters = 'access.name co \"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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) sorters = 'access.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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) try: - # Identity Access Request Recommendations - - api_response = api_instance.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) - print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n") - pprint(api_response) + # Identity Access Request Recommendations + + results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) - path: /ai-access-request-recommendations/config method: GET xCodeSample: @@ -5425,16 +5088,15 @@ 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: - # Get Access Request Recommendations config - - api_response = api_instance.get_access_request_recommendations_config(x_sail_point_experimental) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_access_request_recommendations_config(x_sail_point_experimental) - print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_config:\n") - pprint(api_response) + # Get Access Request Recommendations config + + results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_config(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_config(x_sail_point_experimental) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_config:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_config: %s\n" % e) + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_config: %s\n" % e) - path: /ai-access-request-recommendations/ignored-items method: GET xCodeSample: @@ -5448,16 +5110,15 @@ filters = 'identityId eq \"2c9180846b0a0583016b299f210c1314\"' # 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) sorters = 'access.id' # 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) try: - # List Ignored Access Request Recommendations - - api_response = api_instance.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) - print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n") - pprint(api_response) + # List Ignored Access Request Recommendations + + results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) - path: /ai-access-request-recommendations/requested-items method: GET xCodeSample: @@ -5471,16 +5132,15 @@ filters = 'access.id eq \"2c9180846b0a0583016b299f210c1314\"' # 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) sorters = 'access.id' # 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) try: - # List Accepted Access Request Recommendations - - api_response = api_instance.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) - print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n") - pprint(api_response) + # List Accepted Access Request Recommendations + + results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) - path: /ai-access-request-recommendations/viewed-items method: GET xCodeSample: @@ -5494,16 +5154,15 @@ filters = 'access.id eq \"2c9180846b0a0583016b299f210c1314\"' # 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) sorters = 'access.id' # 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional) try: - # List Viewed Access Request Recommendations - - api_response = api_instance.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) - print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n") - pprint(api_response) + # List Viewed Access Request Recommendations + + results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) - path: /ai-access-request-recommendations/config method: PUT xCodeSample: @@ -5511,25 +5170,24 @@ label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#set-access-request-recommendations-config 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') - access_request_recommendation_config_dto = { + access_request_recommendation_config_dto = '''{ "scoreThreshold" : 0.5, "startDateAttribute" : "startDate", "restrictionAttribute" : "location", "moverAttribute" : "isMover", "joinerAttribute" : "isJoiner", "useRestrictionAttribute" : true - } # AccessRequestRecommendationConfigDto | The desired configurations for Access Request Recommender for the tenant. - try: - # Update Access Request Recommendations config - Result = access_request_recommendation_config_dto.from_json(access_request_recommendation_config_dto) - api_response = api_instance.set_access_request_recommendations_config(x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_access_request_recommendations_config(x_sail_point_experimental, Result) - print("The response of IAIAccessRequestRecommendationsApi->set_access_request_recommendations_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIAccessRequestRecommendationsApi->set_access_request_recommendations_config: %s\n" % e) + }''' # AccessRequestRecommendationConfigDto | The desired configurations for Access Request Recommender for the tenant. + try: + # Update Access Request Recommendations config + new_access_request_recommendation_config_dto = AccessRequestRecommendationConfigDto.from_json(access_request_recommendation_config_dto) + results = IAIAccessRequestRecommendationsApi(api_client).set_access_request_recommendations_config(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_config_dto=new_access_request_recommendation_config_dto) + # Below is a request that includes all optional parameters + # results = IAIAccessRequestRecommendationsApi(api_client).set_access_request_recommendations_config(x_sail_point_experimental, new_access_request_recommendation_config_dto) + print("The response of IAIAccessRequestRecommendationsApi->set_access_request_recommendations_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->set_access_request_recommendations_config: %s\n" % e) - path: /common-access method: POST xCodeSample: @@ -5537,7 +5195,7 @@ label: SDK_tools/sdk/python/v2024/methods/iai-common-access#create-common-access 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') - common_access_item_request = { + common_access_item_request = '''{ "access" : { "ownerName" : "ownerName", "name" : "name", @@ -5547,18 +5205,17 @@ "ownerId" : "ownerId" }, "status" : "CONFIRMED" - } # CommonAccessItemRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_common_access(x_sail_point_experimental, Result) - print("The response of IAICommonAccessApi->create_common_access:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAICommonAccessApi->create_common_access: %s\n" % e) + }''' # CommonAccessItemRequest | + try: + # Create common access items + new_common_access_item_request = CommonAccessItemRequest.from_json(common_access_item_request) + results = IAICommonAccessApi(api_client).create_common_access(x_sail_point_experimental=x_sail_point_experimental, common_access_item_request=new_common_access_item_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling IAICommonAccessApi->create_common_access: %s\n" % e) - path: /common-access method: GET xCodeSample: @@ -5572,16 +5229,15 @@ filters = 'access.type eq \"ROLE\"' # 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, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, 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, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) sorters = 'access.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: **access.name, status** By default the common access items are sorted by name, ascending. (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: **access.name, status** By default the common access items are sorted by name, ascending. (optional) try: - # Get a paginated list of common access - - api_response = api_instance.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) - print("The response of IAICommonAccessApi->get_common_access:\n") - pprint(api_response) + # Get a paginated list of common access + + results = IAICommonAccessApi(api_client).get_common_access(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) + print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) - path: /common-access/update-status method: POST xCodeSample: @@ -5589,23 +5245,17 @@ label: SDK_tools/sdk/python/v2024/methods/iai-common-access#update-common-access-status-in-bulk 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') - [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 = { - "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], - "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] - } # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access - + common_access_id_status = '''[sailpoint.v2024.CommonAccessIDStatus()]''' # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_common_access_status_in_bulk(x_sail_point_experimental, Result) - print("The response of IAICommonAccessApi->update_common_access_status_in_bulk:\n") - pprint(api_response) + # Bulk update common access status + new_common_access_id_status = CommonAccessIdStatus.from_json(common_access_id_status) + results = IAICommonAccessApi(api_client).update_common_access_status_in_bulk(x_sail_point_experimental=x_sail_point_experimental, common_access_id_status=new_common_access_id_status) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAICommonAccessApi->update_common_access_status_in_bulk: %s\n" % e) + print("Exception when calling IAICommonAccessApi->update_common_access_status_in_bulk: %s\n" % e) - path: /outliers/export method: GET xCodeSample: @@ -5615,16 +5265,15 @@ x_sail_point_experimental = 'true' # 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.export_outliers_zip(x_sail_point_experimental, type) - print("The response of IAIOutliersApi->export_outliers_zip:\n") - pprint(api_response) + # IAI Identity Outliers Export + + results = IAIOutliersApi(api_client).export_outliers_zip(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).export_outliers_zip(x_sail_point_experimental, type) + print("The response of IAIOutliersApi->export_outliers_zip:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIOutliersApi->export_outliers_zip: %s\n" % e) + print("Exception when calling IAIOutliersApi->export_outliers_zip: %s\n" % e) - path: /outlier-summaries method: GET xCodeSample: @@ -5638,16 +5287,15 @@ filters = 'snapshotDate ge \"2022-02-07T20:13:29.356648026Z\"' # 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: **snapshotDate**: *ge, le* (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: **snapshotDate**: *ge, le* (optional) sorters = 'snapshotDate' # 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: **snapshotDate** (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: **snapshotDate** (optional) try: - # IAI Identity Outliers Summary - - api_response = api_instance.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) - print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") - pprint(api_response) + # IAI Identity Outliers Summary + + results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(x_sail_point_experimental, limit, offset, type, filters, sorters) + print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) + print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) - path: /outliers method: GET xCodeSample: @@ -5662,16 +5310,15 @@ filters = 'attributes.displayName sw \"John\" and certStatus 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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) sorters = 'attributes.displayName,firstDetectionDate,-score' # 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: **firstDetectionDate, attributes, score** (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: **firstDetectionDate, attributes, score** (optional) try: - # IAI Get Identity Outliers - - api_response = api_instance.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) - print("The response of IAIOutliersApi->get_identity_outliers:\n") - pprint(api_response) + # IAI Get Identity Outliers + + results = IAIOutliersApi(api_client).get_identity_outliers(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).get_identity_outliers(x_sail_point_experimental, limit, offset, count, type, filters, sorters) + print("The response of IAIOutliersApi->get_identity_outliers:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) + print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) - path: /outlier-summaries/latest method: GET xCodeSample: @@ -5681,16 +5328,15 @@ x_sail_point_experimental = 'true' # 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_latest_identity_outlier_snapshots(x_sail_point_experimental, type) - print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") - pprint(api_response) + # IAI Identity Outliers Latest Summary + + results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(x_sail_point_experimental, type) + print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) + print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) - path: /outlier-feature-summaries/{outlierFeatureId} method: GET xCodeSample: @@ -5700,16 +5346,15 @@ 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) - - # 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) - print("The response of IAIOutliersApi->get_outlier_contributing_feature_summary:\n") - pprint(api_response) + # Get identity outlier contibuting feature summary + + results = IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id=outlier_feature_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id, x_sail_point_experimental) + print("The response of IAIOutliersApi->get_outlier_contributing_feature_summary:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIOutliersApi->get_outlier_contributing_feature_summary: %s\n" % e) + print("Exception when calling IAIOutliersApi->get_outlier_contributing_feature_summary: %s\n" % e) - path: /outliers/{outlierId}/contributing-features method: GET xCodeSample: @@ -5724,16 +5369,15 @@ include_translation_messages = 'include-translation-messages=' # str | Whether or not to include translation messages object in returned response (optional) # str | Whether or not to include translation messages object in returned response (optional) sorters = 'importance' # 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: **importance** (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: **importance** (optional) try: - # Get identity outlier's contibuting features - - api_response = api_instance.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) - print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") - pprint(api_response) + # Get identity outlier's contibuting features + + results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id=outlier_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, x_sail_point_experimental, limit, offset, count, include_translation_messages, sorters) + print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) + print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) - path: /outliers/ignore method: POST xCodeSample: @@ -5741,18 +5385,15 @@ label: SDK_tools/sdk/python/v2024/methods/iai-outliers#ignore-identity-outliers 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') - request_body = ['request_body_example'] # List[str] | - request_body = ['request_body_example'] # List[str] | - + request_body = '''['request_body_example']''' # List[str] | try: - # IAI Identity Outliers Ignore - Result = request_body.from_json(request_body) - api_instance.ignore_identity_outliers(x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_instance.ignore_identity_outliers(x_sail_point_experimental, Result) + # IAI Identity Outliers Ignore + new_request_body = RequestBody.from_json(request_body) + IAIOutliersApi(api_client).ignore_identity_outliers(x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) + # Below is a request that includes all optional parameters + # IAIOutliersApi(api_client).ignore_identity_outliers(x_sail_point_experimental, new_request_body) except Exception as e: - print("Exception when calling IAIOutliersApi->ignore_identity_outliers: %s\n" % e) + print("Exception when calling IAIOutliersApi->ignore_identity_outliers: %s\n" % e) - path: /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items method: GET xCodeSample: @@ -5768,16 +5409,15 @@ access_type = 'ENTITLEMENT' # str | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) # str | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) 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** (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** (optional) 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, ) - - # 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) - print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") - pprint(api_response) + # Gets a list of access items associated with each identity outlier contributing feature + + results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id=outlier_id, contributing_feature_name=contributing_feature_name, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, x_sail_point_experimental, limit, offset, count, access_type, sorters) + print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) + print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) - path: /outliers/unignore method: POST xCodeSample: @@ -5785,18 +5425,15 @@ label: SDK_tools/sdk/python/v2024/methods/iai-outliers#un-ignore-identity-outliers 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') - request_body = ['request_body_example'] # List[str] | - request_body = ['request_body_example'] # List[str] | - + request_body = '''['request_body_example']''' # List[str] | try: - # IAI Identity Outliers Unignore - Result = request_body.from_json(request_body) - api_instance.un_ignore_identity_outliers(x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_instance.un_ignore_identity_outliers(x_sail_point_experimental, Result) + # IAI Identity Outliers Unignore + new_request_body = RequestBody.from_json(request_body) + IAIOutliersApi(api_client).un_ignore_identity_outliers(x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) + # Below is a request that includes all optional parameters + # IAIOutliersApi(api_client).un_ignore_identity_outliers(x_sail_point_experimental, new_request_body) except Exception as e: - print("Exception when calling IAIOutliersApi->un_ignore_identity_outliers: %s\n" % e) + print("Exception when calling IAIOutliersApi->un_ignore_identity_outliers: %s\n" % e) - path: /peer-group-strategies/{strategy}/identity-outliers method: GET xCodeSample: @@ -5809,16 +5446,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) 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) try: - # Identity Outliers List - - api_response = api_instance.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) - print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") - pprint(api_response) + # Identity Outliers List + + results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy=strategy, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) + print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) - path: /recommendations/request method: POST xCodeSample: @@ -5826,7 +5462,7 @@ label: SDK_tools/sdk/python/v2024/methods/iai-recommendations#get-recommendations 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') - recommendation_request_dto = { + recommendation_request_dto = '''{ "prescribeMode" : false, "excludeInterpretations" : false, "requests" : [ { @@ -5844,18 +5480,17 @@ } ], "includeTranslationMessages" : false, "includeDebugInformation" : true - } # RecommendationRequestDto | - try: - # Returns Recommendation Based on Object - Result = recommendation_request_dto.from_json(recommendation_request_dto) - api_response = api_instance.get_recommendations(x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_recommendations(x_sail_point_experimental, Result) - print("The response of IAIRecommendationsApi->get_recommendations:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIRecommendationsApi->get_recommendations: %s\n" % e) + }''' # RecommendationRequestDto | + try: + # Returns Recommendation Based on Object + new_recommendation_request_dto = RecommendationRequestDto.from_json(recommendation_request_dto) + results = IAIRecommendationsApi(api_client).get_recommendations(x_sail_point_experimental=x_sail_point_experimental, recommendation_request_dto=new_recommendation_request_dto) + # Below is a request that includes all optional parameters + # results = IAIRecommendationsApi(api_client).get_recommendations(x_sail_point_experimental, new_recommendation_request_dto) + print("The response of IAIRecommendationsApi->get_recommendations:\n") + pprint(results) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->get_recommendations: %s\n" % e) - path: /recommendations/config method: GET xCodeSample: @@ -5864,16 +5499,15 @@ 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: - # Get certification recommendation config values - - api_response = api_instance.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) - print("The response of IAIRecommendationsApi->get_recommendations_config:\n") - pprint(api_response) + # Get certification recommendation config values + + results = IAIRecommendationsApi(api_client).get_recommendations_config(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRecommendationsApi(api_client).get_recommendations_config(x_sail_point_experimental) + print("The response of IAIRecommendationsApi->get_recommendations_config:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIRecommendationsApi->get_recommendations_config: %s\n" % e) + print("Exception when calling IAIRecommendationsApi->get_recommendations_config: %s\n" % e) - path: /recommendations/config method: PUT xCodeSample: @@ -5881,23 +5515,22 @@ label: SDK_tools/sdk/python/v2024/methods/iai-recommendations#update-recommendations-config 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') - recommendation_config_dto = { + recommendation_config_dto = '''{ "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], "peerGroupPercentageThreshold" : 0.5, "runAutoSelectOnce" : false, "onlyTuneThreshold" : false - } # RecommendationConfigDto | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_recommendations_config(x_sail_point_experimental, Result) - print("The response of IAIRecommendationsApi->update_recommendations_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIRecommendationsApi->update_recommendations_config: %s\n" % e) + }''' # RecommendationConfigDto | + try: + # Update certification recommendation config values + new_recommendation_config_dto = RecommendationConfigDto.from_json(recommendation_config_dto) + results = IAIRecommendationsApi(api_client).update_recommendations_config(x_sail_point_experimental=x_sail_point_experimental, recommendation_config_dto=new_recommendation_config_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->update_recommendations_config: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision method: POST xCodeSample: @@ -5909,24 +5542,23 @@ x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) include_common_access = True # bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to True) # bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to True) - role_mining_potential_role_provision_request = { + role_mining_potential_role_provision_request = '''{ "includeIdentities" : true, "roleName" : "Finance - Accounting", "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", "roleDescription" : "General access for accounting department", "directlyAssignedEntitlements" : false - } # RoleMiningPotentialRoleProvisionRequest | Required information to create a new role (optional) - 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, ) - - # 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) - print("The response of IAIRoleMiningApi->create_potential_role_provision_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->create_potential_role_provision_request: %s\n" % e) + }''' # RoleMiningPotentialRoleProvisionRequest | Required information to create a new role (optional) + try: + # Create request to provision a potential role into an actual role. + + results = IAIRoleMiningApi(api_client).create_potential_role_provision_request(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->create_potential_role_provision_request: %s\n" % e) - path: /role-mining-sessions method: POST xCodeSample: @@ -5934,7 +5566,7 @@ label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#create-role-mining-sessions 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') - role_mining_session_dto = { + role_mining_session_dto = '''{ "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", "prescribedPruneThreshold" : 10, "pruneThreshold" : 50, @@ -5965,18 +5597,17 @@ "minNumIdentitiesInPotentialRole" : 20, "identityCount" : 0, "type" : "SPECIALIZED" - } # RoleMiningSessionDto | Role mining session parameters - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_role_mining_sessions(x_sail_point_experimental, Result) - print("The response of IAIRoleMiningApi->create_role_mining_sessions:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->create_role_mining_sessions: %s\n" % e) + }''' # RoleMiningSessionDto | Role mining session parameters + try: + # Create a role mining session + new_role_mining_session_dto = RoleMiningSessionDto.from_json(role_mining_session_dto) + results = IAIRoleMiningApi(api_client).create_role_mining_sessions(x_sail_point_experimental=x_sail_point_experimental, role_mining_session_dto=new_role_mining_session_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->create_role_mining_sessions: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download method: GET xCodeSample: @@ -5988,16 +5619,15 @@ 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 x_sail_point_experimental = 'true' # 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: - # 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) - - # 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) - print("The response of IAIRoleMiningApi->download_role_mining_potential_role_zip:\n") - pprint(api_response) + # Export (download) details for a potential role in a role mining session + + results = IAIRoleMiningApi(api_client).download_role_mining_potential_role_zip(session_id=session_id, potential_role_id=potential_role_id, export_id=export_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).download_role_mining_potential_role_zip(session_id, potential_role_id, export_id, x_sail_point_experimental) + print("The response of IAIRoleMiningApi->download_role_mining_potential_role_zip:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->download_role_mining_potential_role_zip: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->download_role_mining_potential_role_zip: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export method: GET xCodeSample: @@ -6008,16 +5638,15 @@ 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') 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) - - # 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) - print("The response of IAIRoleMiningApi->export_role_mining_potential_role:\n") - pprint(api_response) + # Export (download) details for a potential role in a role mining session + + results = IAIRoleMiningApi(api_client).export_role_mining_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async method: POST xCodeSample: @@ -6027,21 +5656,20 @@ 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') - role_mining_potential_role_export_request = { + role_mining_potential_role_export_request = '''{ "minEntitlementPopularity" : 0, "includeCommonAccess" : true - } # RoleMiningPotentialRoleExportRequest | (optional) - 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, ) - - # 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) - print("The response of IAIRoleMiningApi->export_role_mining_potential_role_async:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_async: %s\n" % e) + }''' # RoleMiningPotentialRoleExportRequest | (optional) + try: + # Asynchronously export details for a potential role in a role mining session and upload to S3 + + results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_async(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_async: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} method: GET xCodeSample: @@ -6053,16 +5681,15 @@ 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 x_sail_point_experimental = 'true' # 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: - # 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) - - # 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) - print("The response of IAIRoleMiningApi->export_role_mining_potential_role_status:\n") - pprint(api_response) + # Retrieve status of a potential role export job + + results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_status(session_id=session_id, potential_role_id=potential_role_id, export_id=export_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_status(session_id, potential_role_id, export_id, x_sail_point_experimental) + print("The response of IAIRoleMiningApi->export_role_mining_potential_role_status:\n") + pprint(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_status: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_status: %s\n" % e) - path: /role-mining-potential-roles method: GET xCodeSample: @@ -6076,16 +5703,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) try: - # Retrieves all potential role summaries - - api_response = api_instance.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) - print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") - pprint(api_response) + # Retrieves all potential role summaries + + results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution method: GET xCodeSample: @@ -6097,16 +5723,15 @@ x_sail_point_experimental = 'true' # 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_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) 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, ) - - # 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) - print("The response of IAIRoleMiningApi->get_entitlement_distribution_potential_role:\n") - pprint(api_response) + # Retrieves entitlement popularity distribution for a potential role in a role mining session + + results = IAIRoleMiningApi(api_client).get_entitlement_distribution_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_entitlement_distribution_potential_role: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_entitlement_distribution_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities method: GET xCodeSample: @@ -6123,16 +5748,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) 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, ) - - # 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) - print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") - pprint(api_response) + # Retrieves entitlements for a potential role in a role mining session + + results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements method: GET xCodeSample: @@ -6148,16 +5772,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) 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, ) - - # 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) - print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") - pprint(api_response) + # Retrieves excluded entitlements for a potential role in a role mining session + + results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities method: GET xCodeSample: @@ -6173,16 +5796,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) 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, ) - - # 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) - print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") - pprint(api_response) + # Retrieves identities for a potential role in a role mining session + + results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} method: GET xCodeSample: @@ -6193,16 +5815,15 @@ 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') try: - # Retrieves a specific potential role - - api_response = api_instance.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) - print("The response of IAIRoleMiningApi->get_potential_role:\n") - pprint(api_response) + # Retrieves a specific potential role + + results = IAIRoleMiningApi(api_client).get_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_potential_role: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications method: GET xCodeSample: @@ -6217,16 +5838,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) 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, ) - - # 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) - print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") - pprint(api_response) + # Retrieves the applications of a potential role for a role mining session + + results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements method: GET xCodeSample: @@ -6241,16 +5861,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) 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, ) - - # 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) - print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") - pprint(api_response) + # Retrieves the entitlements of a potential role for a role mining session + + results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) - path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage method: GET xCodeSample: @@ -6265,16 +5884,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) 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, ) - - # 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) - print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") - pprint(api_response) + # Retrieves potential role source usage + + results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id=potential_role_id, source_id=source_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries method: GET xCodeSample: @@ -6289,16 +5907,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) try: - # Retrieves all potential role summaries - - api_response = api_instance.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) - print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") - pprint(api_response) + # Retrieves all potential role summaries + + results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id=session_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) - path: /role-mining-potential-roles/{potentialRoleId} method: GET xCodeSample: @@ -6308,16 +5925,15 @@ 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) - - # 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) - print("The response of IAIRoleMiningApi->get_role_mining_potential_role:\n") - pprint(api_response) + # Retrieves a specific potential role + + results = IAIRoleMiningApi(api_client).get_role_mining_potential_role(potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_role_mining_potential_role: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_role_mining_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId} method: GET xCodeSample: @@ -6327,16 +5943,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_mining_session(session_id, x_sail_point_experimental) - print("The response of IAIRoleMiningApi->get_role_mining_session:\n") - pprint(api_response) + # Get a role mining session + + results = IAIRoleMiningApi(api_client).get_role_mining_session(session_id=session_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_role_mining_session: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_role_mining_session: %s\n" % e) - path: /role-mining-sessions/{sessionId}/status method: GET xCodeSample: @@ -6346,16 +5961,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.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) + # Get role mining session status state + + results = IAIRoleMiningApi(api_client).get_role_mining_session_status(session_id=session_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_role_mining_session_status: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_role_mining_session_status: %s\n" % e) - path: /role-mining-sessions method: GET xCodeSample: @@ -6369,16 +5983,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) try: - # Retrieves all role mining sessions - - api_response = api_instance.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) - print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") - pprint(api_response) + # Retrieves all role mining sessions + + results = IAIRoleMiningApi(api_client).get_role_mining_sessions(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) - path: /role-mining-potential-roles/saved method: GET xCodeSample: @@ -6391,16 +6004,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) try: - # Retrieves all saved potential roles - - api_response = api_instance.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) - print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") - pprint(api_response) + # Retrieves all saved potential roles + + results = IAIRoleMiningApi(api_client).get_saved_potential_roles(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} method: PATCH xCodeSample: @@ -6410,20 +6022,17 @@ 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') - [{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] | - + 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] | 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) - - # 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) - print("The response of IAIRoleMiningApi->patch_potential_role:\n") - pprint(api_response) + # Update a potential role + new_patch_potential_role_request_inner = PatchPotentialRoleRequestInner.from_json(patch_potential_role_request_inner) + results = IAIRoleMiningApi(api_client).patch_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental, patch_potential_role_request_inner=new_patch_potential_role_request_inner) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->patch_potential_role: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->patch_potential_role: %s\n" % e) - path: /role-mining-potential-roles/{potentialRoleId} method: PATCH xCodeSample: @@ -6433,20 +6042,17 @@ 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') - [{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] | - + 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] | 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) - - # 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) - print("The response of IAIRoleMiningApi->patch_potential_role_0:\n") - pprint(api_response) + # Update a potential role + new_patch_potential_role_request_inner = PatchPotentialRoleRequestInner.from_json(patch_potential_role_request_inner) + results = IAIRoleMiningApi(api_client).patch_potential_role_0(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental, patch_potential_role_request_inner=new_patch_potential_role_request_inner) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IAIRoleMiningApi->patch_potential_role_0: %s\n" % e) + print("Exception when calling IAIRoleMiningApi->patch_potential_role_0: %s\n" % e) - path: /role-mining-sessions/{sessionId} method: PATCH xCodeSample: @@ -6455,24 +6061,17 @@ source: | 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. - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_role_mining_session(session_id, x_sail_point_experimental, Result) - print("The response of IAIRoleMiningApi->patch_role_mining_session:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->patch_role_mining_session: %s\n" % e) + json_patch_operation = '''[{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. + try: + # Patch a role mining session + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = IAIRoleMiningApi(api_client).patch_role_mining_session(session_id=session_id, x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_role_mining_session: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements method: POST xCodeSample: @@ -6482,21 +6081,20 @@ 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') - role_mining_potential_role_edit_entitlements = { + role_mining_potential_role_edit_entitlements = '''{ "ids" : [ "entId1", "entId2" ], "exclude" : true - } # RoleMiningPotentialRoleEditEntitlements | Role mining session parameters - 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) - - # 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) - print("The response of IAIRoleMiningApi->update_entitlements_potential_role:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IAIRoleMiningApi->update_entitlements_potential_role: %s\n" % e) + }''' # RoleMiningPotentialRoleEditEntitlements | Role mining session parameters + try: + # Edit entitlements for a potential role to exclude some entitlements + new_role_mining_potential_role_edit_entitlements = RoleMiningPotentialRoleEditEntitlements.from_json(role_mining_potential_role_edit_entitlements) + results = IAIRoleMiningApi(api_client).update_entitlements_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental, role_mining_potential_role_edit_entitlements=new_role_mining_potential_role_edit_entitlements) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->update_entitlements_potential_role: %s\n" % e) - path: /icons/{objectType}/{objectId} method: DELETE xCodeSample: @@ -6507,14 +6105,13 @@ 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') try: - # Delete an icon - - api_instance.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) + # Delete an icon + + IconsApi(api_client).delete_icon(object_type=object_type, object_id=object_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling IconsApi->delete_icon: %s\n" % e) - path: /icons/{objectType}/{objectId} method: PUT xCodeSample: @@ -6526,16 +6123,15 @@ x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') image = None # bytearray | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] # bytearray | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] try: - # Update an icon - - api_response = api_instance.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) - print("The response of IconsApi->set_icon:\n") - pprint(api_response) + # Update an icon + + results = IconsApi(api_client).set_icon(object_type=object_type, object_id=object_id, x_sail_point_experimental=x_sail_point_experimental, image=image) + # Below is a request that includes all optional parameters + # results = IconsApi(api_client).set_icon(object_type, object_id, x_sail_point_experimental, image) + print("The response of IconsApi->set_icon:\n") + pprint(results) except Exception as e: - print("Exception when calling IconsApi->set_icon: %s\n" % e) + print("Exception when calling IconsApi->set_icon: %s\n" % e) - path: /identities/{id} method: DELETE xCodeSample: @@ -6545,14 +6141,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_identity(id, x_sail_point_experimental) + # Delete identity + + IdentitiesApi(api_client).delete_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # IdentitiesApi(api_client).delete_identity(id, x_sail_point_experimental) except Exception as e: - print("Exception when calling IdentitiesApi->delete_identity: %s\n" % e) + print("Exception when calling IdentitiesApi->delete_identity: %s\n" % e) - path: /identities/{id} method: GET xCodeSample: @@ -6562,16 +6157,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity(id, x_sail_point_experimental) - print("The response of IdentitiesApi->get_identity:\n") - pprint(api_response) + # Identity Details + + results = IdentitiesApi(api_client).get_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).get_identity(id, x_sail_point_experimental) + print("The response of IdentitiesApi->get_identity:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentitiesApi->get_identity: %s\n" % e) + print("Exception when calling IdentitiesApi->get_identity: %s\n" % e) - path: /identities/{identityId}/ownership method: GET xCodeSample: @@ -6581,16 +6175,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_ownership_details(identity_id, x_sail_point_experimental) - print("The response of IdentitiesApi->get_identity_ownership_details:\n") - pprint(api_response) + # Get ownership details + + results = IdentitiesApi(api_client).get_identity_ownership_details(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IdentitiesApi->get_identity_ownership_details: %s\n" % e) + print("Exception when calling IdentitiesApi->get_identity_ownership_details: %s\n" % e) - path: /identities/{identityId}/role-assignments/{assignmentId} method: GET xCodeSample: @@ -6601,16 +6194,15 @@ 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') try: - # Role assignment details - - api_response = api_instance.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) - print("The response of IdentitiesApi->get_role_assignment:\n") - pprint(api_response) + # Role assignment details + + results = IdentitiesApi(api_client).get_role_assignment(identity_id=identity_id, assignment_id=assignment_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IdentitiesApi->get_role_assignment: %s\n" % e) + print("Exception when calling IdentitiesApi->get_role_assignment: %s\n" % e) - path: /identities/{identityId}/role-assignments method: GET xCodeSample: @@ -6622,16 +6214,15 @@ 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) try: - # List role assignments - - api_response = api_instance.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) - print("The response of IdentitiesApi->get_role_assignments:\n") - pprint(api_response) + # List role assignments + + results = IdentitiesApi(api_client).get_role_assignments(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) + print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) - path: /identities method: GET xCodeSample: @@ -6646,16 +6237,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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 Identities - - api_response = api_instance.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) - print("The response of IdentitiesApi->list_identities:\n") - pprint(api_response) + # List Identities + + results = IdentitiesApi(api_client).list_identities(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) + print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) - path: /identities/{id}/reset method: POST xCodeSample: @@ -6665,14 +6255,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.reset_identity(identity_id, x_sail_point_experimental) + # Reset an identity + + IdentitiesApi(api_client).reset_identity(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling IdentitiesApi->reset_identity: %s\n" % e) - path: /identities/{id}/verification/account/send method: POST xCodeSample: @@ -6681,19 +6270,18 @@ 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') id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID - send_account_verification_request = { + send_account_verification_request = '''{ "sourceName" : "Active Directory Source", "via" : "EMAIL_WORK" - } # SendAccountVerificationRequest | + }''' # SendAccountVerificationRequest | 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) - - # Below is a request that includes all optional parameters - # api_instance.send_identity_verification_account_token(x_sail_point_experimental, id, Result) + # Send password reset email + new_send_account_verification_request = SendAccountVerificationRequest.from_json(send_account_verification_request) + IdentitiesApi(api_client).send_identity_verification_account_token(x_sail_point_experimental=x_sail_point_experimental, id=id, send_account_verification_request=new_send_account_verification_request) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling IdentitiesApi->send_identity_verification_account_token: %s\n" % e) - path: /identities/invite method: POST xCodeSample: @@ -6701,21 +6289,20 @@ label: SDK_tools/sdk/python/v2024/methods/identities#start-identities-invite 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') - invite_identities_request = { + invite_identities_request = '''{ "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], "uninvited" : false - } # InviteIdentitiesRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_identities_invite(x_sail_point_experimental, Result) - print("The response of IdentitiesApi->start_identities_invite:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IdentitiesApi->start_identities_invite: %s\n" % e) + }''' # InviteIdentitiesRequest | + try: + # Invite identities to register + new_invite_identities_request = InviteIdentitiesRequest.from_json(invite_identities_request) + results = IdentitiesApi(api_client).start_identities_invite(x_sail_point_experimental=x_sail_point_experimental, invite_identities_request=new_invite_identities_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling IdentitiesApi->start_identities_invite: %s\n" % e) - path: /identities/process method: POST xCodeSample: @@ -6723,20 +6310,19 @@ label: SDK_tools/sdk/python/v2024/methods/identities#start-identity-processing 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') - process_identities_request = { + 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(x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_identity_processing(x_sail_point_experimental, Result) - print("The response of IdentitiesApi->start_identity_processing:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IdentitiesApi->start_identity_processing: %s\n" % e) + }''' # ProcessIdentitiesRequest | + try: + # Process a list of identityIds + new_process_identities_request = ProcessIdentitiesRequest.from_json(process_identities_request) + results = IdentitiesApi(api_client).start_identity_processing(x_sail_point_experimental=x_sail_point_experimental, process_identities_request=new_process_identities_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling IdentitiesApi->start_identity_processing: %s\n" % e) - path: /identities/{identityId}/synchronize-attributes method: POST xCodeSample: @@ -6746,16 +6332,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.synchronize_attributes_for_identity(identity_id, x_sail_point_experimental) - print("The response of IdentitiesApi->synchronize_attributes_for_identity:\n") - pprint(api_response) + # Attribute synchronization for single identity. + + results = IdentitiesApi(api_client).synchronize_attributes_for_identity(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IdentitiesApi->synchronize_attributes_for_identity: %s\n" % e) + print("Exception when calling IdentitiesApi->synchronize_attributes_for_identity: %s\n" % e) - path: /identity-attributes method: POST xCodeSample: @@ -6763,7 +6348,7 @@ label: SDK_tools/sdk/python/v2024/methods/identity-attributes#create-identity-attribute 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') - identity_attribute = { + identity_attribute = '''{ "standard" : false, "system" : false, "sources" : [ { @@ -6784,18 +6369,17 @@ "type" : "string", "searchable" : false, "multi" : false - } # IdentityAttribute | - try: - # Create Identity Attribute - Result = identity_attribute.from_json(identity_attribute) - api_response = api_instance.create_identity_attribute(x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_identity_attribute(x_sail_point_experimental, Result) - print("The response of IdentityAttributesApi->create_identity_attribute:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IdentityAttributesApi->create_identity_attribute: %s\n" % e) + }''' # IdentityAttribute | + try: + # Create Identity Attribute + new_identity_attribute = IdentityAttribute.from_json(identity_attribute) + results = IdentityAttributesApi(api_client).create_identity_attribute(x_sail_point_experimental=x_sail_point_experimental, identity_attribute=new_identity_attribute) + # Below is a request that includes all optional parameters + # results = IdentityAttributesApi(api_client).create_identity_attribute(x_sail_point_experimental, new_identity_attribute) + print("The response of IdentityAttributesApi->create_identity_attribute:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityAttributesApi->create_identity_attribute: %s\n" % e) - path: /identity-attributes/{name} method: DELETE xCodeSample: @@ -6805,14 +6389,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_identity_attribute(name, x_sail_point_experimental) + # Delete Identity Attribute + + IdentityAttributesApi(api_client).delete_identity_attribute(name=name, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling IdentityAttributesApi->delete_identity_attribute: %s\n" % e) - path: /identity-attributes/bulk-delete method: DELETE xCodeSample: @@ -6820,18 +6403,17 @@ label: SDK_tools/sdk/python/v2024/methods/identity-attributes#delete-identity-attributes-in-bulk 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') - identity_attribute_names = { + identity_attribute_names = '''{ "ids" : [ "name", "displayName" ] - } # IdentityAttributeNames | + }''' # IdentityAttributeNames | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_identity_attributes_in_bulk(x_sail_point_experimental, Result) + # Bulk delete Identity Attributes + new_identity_attribute_names = IdentityAttributeNames.from_json(identity_attribute_names) + IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(x_sail_point_experimental=x_sail_point_experimental, identity_attribute_names=new_identity_attribute_names) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling IdentityAttributesApi->delete_identity_attributes_in_bulk: %s\n" % e) - path: /identity-attributes/{name} method: GET xCodeSample: @@ -6841,16 +6423,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_attribute(name, x_sail_point_experimental) - print("The response of IdentityAttributesApi->get_identity_attribute:\n") - pprint(api_response) + # Get Identity Attribute + + results = IdentityAttributesApi(api_client).get_identity_attribute(name=name, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentityAttributesApi(api_client).get_identity_attribute(name, x_sail_point_experimental) + print("The response of IdentityAttributesApi->get_identity_attribute:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityAttributesApi->get_identity_attribute: %s\n" % e) + print("Exception when calling IdentityAttributesApi->get_identity_attribute: %s\n" % e) - path: /identity-attributes method: GET xCodeSample: @@ -6863,16 +6444,15 @@ 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) 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) try: - # List Identity Attributes - - api_response = api_instance.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) - print("The response of IdentityAttributesApi->list_identity_attributes:\n") - pprint(api_response) + # List Identity Attributes + + results = IdentityAttributesApi(api_client).list_identity_attributes(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) + print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) - path: /identity-attributes/{name} method: PUT xCodeSample: @@ -6881,7 +6461,7 @@ source: | 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 = { + identity_attribute = '''{ "standard" : false, "system" : false, "sources" : [ { @@ -6902,18 +6482,17 @@ "type" : "string", "searchable" : false, "multi" : false - } # IdentityAttribute | - try: - # Update Identity Attribute - Result = identity_attribute.from_json(identity_attribute) - api_response = api_instance.put_identity_attribute(name, x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_identity_attribute(name, x_sail_point_experimental, Result) - print("The response of IdentityAttributesApi->put_identity_attribute:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IdentityAttributesApi->put_identity_attribute: %s\n" % e) + }''' # IdentityAttribute | + try: + # Update Identity Attribute + new_identity_attribute = IdentityAttribute.from_json(identity_attribute) + results = IdentityAttributesApi(api_client).put_identity_attribute(name=name, x_sail_point_experimental=x_sail_point_experimental, identity_attribute=new_identity_attribute) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling IdentityAttributesApi->put_identity_attribute: %s\n" % e) - path: /historical-identities/{id}/compare method: GET xCodeSample: @@ -6924,23 +6503,20 @@ x_sail_point_experimental = 'true' # 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) snapshot2 = '2008-03-01T13:00:00Z' # str | The snapshot 2 of identity (optional) # str | The snapshot 2 of identity (optional) - access_item_types = ['access_item_types_example'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) - - access_item_types = ['access_item_types_example'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) + access_item_types = '''['access_item_types_example']''' # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (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) 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) 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, ) - - # 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) - print("The response of IdentityHistoryApi->compare_identity_snapshots:\n") - pprint(api_response) + # Gets a difference of count for each access item types for the given identity between 2 snapshots + + results = IdentityHistoryApi(api_client).compare_identity_snapshots(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) + print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) - path: /historical-identities/{id}/compare/{access-type} method: GET xCodeSample: @@ -6957,16 +6533,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) 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) 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, ) - - # 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) - print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n") - pprint(api_response) + # Gets a list of differences of specific accessType for the given identity between 2 snapshots + + results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id=id, access_type=access_type, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) + print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) - path: /historical-identities/{id} method: GET xCodeSample: @@ -6976,16 +6551,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_historical_identity(id, x_sail_point_experimental) - print("The response of IdentityHistoryApi->get_historical_identity:\n") - pprint(api_response) + # Get latest snapshot of identity + + results = IdentityHistoryApi(api_client).get_historical_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).get_historical_identity(id, x_sail_point_experimental) + print("The response of IdentityHistoryApi->get_historical_identity:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityHistoryApi->get_historical_identity: %s\n" % e) + print("Exception when calling IdentityHistoryApi->get_historical_identity: %s\n" % e) - path: /historical-identities/{id}/events method: GET xCodeSample: @@ -6995,26 +6569,21 @@ 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) - event_types = ['[AccessAddedEvent, AccessRemovedEvent]'] # List[str] | An optional list of event types to return. If null or empty, all 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) - access_item_types = ['[entitlement, account]'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) - - access_item_types = ['[entitlement, account]'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types 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) + access_item_types = '''['[entitlement, account]']''' # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (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) 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) try: - # Lists all events for the given identity - - api_response = api_instance.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) - print("The response of IdentityHistoryApi->get_historical_identity_events:\n") - pprint(api_response) + # Lists all events for the given identity + + results = IdentityHistoryApi(api_client).get_historical_identity_events(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) + print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) - path: /historical-identities/{id}/snapshots/{date} method: GET xCodeSample: @@ -7025,16 +6594,15 @@ 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') try: - # Gets an identity snapshot at a given date - - api_response = api_instance.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) - print("The response of IdentityHistoryApi->get_identity_snapshot:\n") - pprint(api_response) + # Gets an identity snapshot at a given date + + results = IdentityHistoryApi(api_client).get_identity_snapshot(id=id, var_date=var_date, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).get_identity_snapshot(id, var_date, x_sail_point_experimental) + print("The response of IdentityHistoryApi->get_identity_snapshot:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityHistoryApi->get_identity_snapshot: %s\n" % e) + print("Exception when calling IdentityHistoryApi->get_identity_snapshot: %s\n" % e) - path: /historical-identities/{id}/snapshot-summary method: GET xCodeSample: @@ -7050,16 +6618,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) 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) 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, ) - - # 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) - print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n") - pprint(api_response) + # Gets the summary for the event count for a specific identity + + results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) + print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) - path: /historical-identities/{id}/start-date method: GET xCodeSample: @@ -7069,16 +6636,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_start_date(id, x_sail_point_experimental) - print("The response of IdentityHistoryApi->get_identity_start_date:\n") - pprint(api_response) + # Gets the start date of the identity + + results = IdentityHistoryApi(api_client).get_identity_start_date(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).get_identity_start_date(id, x_sail_point_experimental) + print("The response of IdentityHistoryApi->get_identity_start_date:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityHistoryApi->get_identity_start_date: %s\n" % e) + print("Exception when calling IdentityHistoryApi->get_identity_start_date: %s\n" % e) - path: /historical-identities method: GET xCodeSample: @@ -7092,16 +6658,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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: - # Lists all the identities - - api_response = api_instance.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) - print("The response of IdentityHistoryApi->list_historical_identities:\n") - pprint(api_response) + # Lists all the identities + + results = IdentityHistoryApi(api_client).list_historical_identities(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) + print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) - path: /historical-identities/{id}/access-items method: GET xCodeSample: @@ -7115,16 +6680,15 @@ 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) try: - # List Access Items by Identity - - api_response = api_instance.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) - print("The response of IdentityHistoryApi->list_identity_access_items:\n") - pprint(api_response) + # List Access Items by Identity + + results = IdentityHistoryApi(api_client).list_identity_access_items(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) + print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) - path: /historical-identities/{id}/snapshots/{date}/access-items method: GET xCodeSample: @@ -7136,16 +6700,15 @@ x_sail_point_experimental = 'true' # 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 access item type (optional) # str | The access item type (optional) 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, ) - - # 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) - print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") - pprint(api_response) + # Gets the list of identity access items at a given date filterd by item type + + results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id=id, var_date=var_date, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) + print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) - path: /historical-identities/{id}/snapshots method: GET xCodeSample: @@ -7160,23 +6723,22 @@ 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) try: - # Lists all the snapshots for the identity - - api_response = api_instance.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) - print("The response of IdentityHistoryApi->list_identity_snapshots:\n") - pprint(api_response) + # Lists all the snapshots for the identity + + results = IdentityHistoryApi(api_client).list_identity_snapshots(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) + print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) - path: /identity-profiles method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-profiles#create-identity-profile source: | - identity_profile = { + identity_profile = '''{ "owner" : { "name" : "William Wilson", "id" : "2c9180835d191a86015d28455b4b232a", @@ -7224,18 +6786,17 @@ "name" : "aName", "modified" : "2015-05-28T14:07:17Z", "id" : "id12345" - } # IdentityProfile | - try: - # Create Identity Profile - Result = identity_profile.from_json(identity_profile) - api_response = api_instance.create_identity_profile(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_identity_profile(Result) - print("The response of IdentityProfilesApi->create_identity_profile:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IdentityProfilesApi->create_identity_profile: %s\n" % e) + }''' # IdentityProfile | + try: + # Create Identity Profile + new_identity_profile = IdentityProfile.from_json(identity_profile) + results = IdentityProfilesApi(api_client).create_identity_profile(identity_profile=new_identity_profile) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).create_identity_profile(new_identity_profile) + print("The response of IdentityProfilesApi->create_identity_profile:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->create_identity_profile: %s\n" % e) - path: /identity-profiles/{identity-profile-id} method: DELETE xCodeSample: @@ -7244,36 +6805,32 @@ source: | identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. try: - # Delete Identity Profile - - api_response = api_instance.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) - print("The response of IdentityProfilesApi->delete_identity_profile:\n") - pprint(api_response) + # Delete Identity Profile + + results = IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id=identity_profile_id) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->delete_identity_profile:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityProfilesApi->delete_identity_profile: %s\n" % e) + print("Exception when calling IdentityProfilesApi->delete_identity_profile: %s\n" % e) - path: /identity-profiles/bulk-delete method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-profiles#delete-identity-profiles source: | - 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. - + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_identity_profiles(Result) - print("The response of IdentityProfilesApi->delete_identity_profiles:\n") - pprint(api_response) + # Delete Identity Profiles + new_request_body = RequestBody.from_json(request_body) + results = IdentityProfilesApi(api_client).delete_identity_profiles(request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).delete_identity_profiles(new_request_body) + print("The response of IdentityProfilesApi->delete_identity_profiles:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityProfilesApi->delete_identity_profiles: %s\n" % e) + print("Exception when calling IdentityProfilesApi->delete_identity_profiles: %s\n" % e) - path: /identity-profiles/export method: GET xCodeSample: @@ -7286,16 +6843,15 @@ filters = '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: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (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, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) sorters = 'id,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: **id, name, priority** (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: **id, name, priority** (optional) try: - # Export Identity Profiles - - api_response = api_instance.export_identity_profiles() - - # Below is a request that includes all optional parameters - # api_response = api_instance.export_identity_profiles(limit, offset, count, filters, sorters) - print("The response of IdentityProfilesApi->export_identity_profiles:\n") - pprint(api_response) + # Export Identity Profiles + + results = IdentityProfilesApi(api_client).export_identity_profiles() + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->export_identity_profiles:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) + print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) - path: /identity-profiles/identity-preview method: POST xCodeSample: @@ -7303,7 +6859,7 @@ label: SDK_tools/sdk/python/v2024/methods/identity-profiles#generate-identity-preview 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') - identity_preview_request = { + identity_preview_request = '''{ "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "identityAttributeConfig" : { "attributeTransforms" : [ { @@ -7329,18 +6885,17 @@ } ], "enabled" : true } - } # IdentityPreviewRequest | Identity Preview request body. - try: - # Generate Identity Profile Preview - Result = identity_preview_request.from_json(identity_preview_request) - api_response = api_instance.generate_identity_preview(x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.generate_identity_preview(x_sail_point_experimental, Result) - print("The response of IdentityProfilesApi->generate_identity_preview:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IdentityProfilesApi->generate_identity_preview: %s\n" % e) + }''' # IdentityPreviewRequest | Identity Preview request body. + try: + # Generate Identity Profile Preview + new_identity_preview_request = IdentityPreviewRequest.from_json(identity_preview_request) + results = IdentityProfilesApi(api_client).generate_identity_preview(x_sail_point_experimental=x_sail_point_experimental, identity_preview_request=new_identity_preview_request) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).generate_identity_preview(x_sail_point_experimental, new_identity_preview_request) + print("The response of IdentityProfilesApi->generate_identity_preview:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->generate_identity_preview: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config method: GET xCodeSample: @@ -7349,16 +6904,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) - print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n") - pprint(api_response) + # Get default Identity Attribute Config + + results = IdentityProfilesApi(api_client).get_default_identity_attribute_config(identity_profile_id=identity_profile_id) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).get_default_identity_attribute_config(identity_profile_id) + print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e) + print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e) - path: /identity-profiles/{identity-profile-id} method: GET xCodeSample: @@ -7367,92 +6921,32 @@ source: | identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. try: - # Get Identity Profile - - api_response = api_instance.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) - print("The response of IdentityProfilesApi->get_identity_profile:\n") - pprint(api_response) + # Get Identity Profile + + results = IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id=identity_profile_id) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->get_identity_profile:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityProfilesApi->get_identity_profile: %s\n" % e) + print("Exception when calling IdentityProfilesApi->get_identity_profile: %s\n" % e) - path: /identity-profiles/import method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-profiles#import-identity-profiles source: | - [sailpoint.v2024.IdentityProfileExportedObject()] # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. - identity_profile_exported_object = { - "self" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "version" : 1, - "object" : { - "owner" : { - "name" : "William Wilson", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "IDENTITY" - }, - "identityExceptionReportReference" : { - "reportName" : "My annual report", - "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" - }, - "authoritativeSource" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "hasTimeBasedAttr" : true, - "created" : "2015-05-28T14:07:17Z", - "description" : "My custom flat file profile", - "identityRefreshRequired" : true, - "identityCount" : 8, - "priority" : 10, - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - }, - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "id" : "id12345" - } - } # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. - - try: - # Import Identity Profiles - Result = identity_profile_exported_object.from_json(identity_profile_exported_object) - api_response = api_instance.import_identity_profiles(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.import_identity_profiles(Result) - print("The response of IdentityProfilesApi->import_identity_profiles:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IdentityProfilesApi->import_identity_profiles: %s\n" % e) + identity_profile_exported_object = '''[sailpoint.v2024.IdentityProfileExportedObject()]''' # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + try: + # Import Identity Profiles + new_identity_profile_exported_object = IdentityProfileExportedObject.from_json(identity_profile_exported_object) + results = IdentityProfilesApi(api_client).import_identity_profiles(identity_profile_exported_object=new_identity_profile_exported_object) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).import_identity_profiles(new_identity_profile_exported_object) + print("The response of IdentityProfilesApi->import_identity_profiles:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->import_identity_profiles: %s\n" % e) - path: /identity-profiles method: GET xCodeSample: @@ -7465,16 +6959,15 @@ filters = '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: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) sorters = 'id,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: **id, name, priority, created, modified, owner.id, owner.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: **id, name, priority, created, modified, owner.id, owner.name** (optional) try: - # List Identity Profiles - - api_response = api_instance.list_identity_profiles() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_identity_profiles(limit, offset, count, filters, sorters) - print("The response of IdentityProfilesApi->list_identity_profiles:\n") - pprint(api_response) + # List Identity Profiles + + results = IdentityProfilesApi(api_client).list_identity_profiles() + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->list_identity_profiles:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) + print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/process-identities method: POST xCodeSample: @@ -7483,16 +6976,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.sync_identity_profile(identity_profile_id) - print("The response of IdentityProfilesApi->sync_identity_profile:\n") - pprint(api_response) + # Process identities under profile + + results = IdentityProfilesApi(api_client).sync_identity_profile(identity_profile_id=identity_profile_id) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).sync_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->sync_identity_profile:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityProfilesApi->sync_identity_profile: %s\n" % e) + print("Exception when calling IdentityProfilesApi->sync_identity_profile: %s\n" % e) - path: /identity-profiles/{identity-profile-id} method: PATCH xCodeSample: @@ -7500,24 +6992,17 @@ label: SDK_tools/sdk/python/v2024/methods/identity-profiles#update-identity-profile source: | identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. - [{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}] # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - try: - # Update Identity Profile - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_identity_profile(identity_profile_id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_identity_profile(identity_profile_id, Result) - print("The response of IdentityProfilesApi->update_identity_profile:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e) + json_patch_operation = '''[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}]''' # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + try: + # Update Identity Profile + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id=identity_profile_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id, new_json_patch_operation) + print("The response of IdentityProfilesApi->update_identity_profile:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/lifecycle-states method: POST xCodeSample: @@ -7525,7 +7010,7 @@ label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#create-lifecycle-state source: | identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. - lifecycle_state = { + lifecycle_state = '''{ "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], "emailNotificationOption" : { "notifyManagers" : true, @@ -7549,18 +7034,17 @@ "technicalName" : "Technical Name", "identityState" : "identityState", "enabled" : true - } # LifecycleState | Lifecycle state to be created. - try: - # Create Lifecycle State - Result = lifecycle_state.from_json(lifecycle_state) - api_response = api_instance.create_lifecycle_state(identity_profile_id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_lifecycle_state(identity_profile_id, Result) - print("The response of LifecycleStatesApi->create_lifecycle_state:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling LifecycleStatesApi->create_lifecycle_state: %s\n" % e) + }''' # LifecycleState | Lifecycle state to be created. + try: + # Create Lifecycle State + new_lifecycle_state = LifecycleState.from_json(lifecycle_state) + results = LifecycleStatesApi(api_client).create_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state=new_lifecycle_state) + # Below is a request that includes all optional parameters + # results = LifecycleStatesApi(api_client).create_lifecycle_state(identity_profile_id, new_lifecycle_state) + print("The response of LifecycleStatesApi->create_lifecycle_state:\n") + pprint(results) + except Exception as e: + print("Exception when calling LifecycleStatesApi->create_lifecycle_state: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} method: DELETE xCodeSample: @@ -7570,16 +7054,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_lifecycle_state(identity_profile_id, lifecycle_state_id) - print("The response of LifecycleStatesApi->delete_lifecycle_state:\n") - pprint(api_response) + # Delete Lifecycle State + + results = LifecycleStatesApi(api_client).delete_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id) + # Below is a request that includes all optional parameters + # results = LifecycleStatesApi(api_client).delete_lifecycle_state(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->delete_lifecycle_state:\n") + pprint(results) except Exception as e: - print("Exception when calling LifecycleStatesApi->delete_lifecycle_state: %s\n" % e) + print("Exception when calling LifecycleStatesApi->delete_lifecycle_state: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} method: GET xCodeSample: @@ -7589,16 +7072,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_lifecycle_state(identity_profile_id, lifecycle_state_id) - print("The response of LifecycleStatesApi->get_lifecycle_state:\n") - pprint(api_response) + # Get Lifecycle State + + results = LifecycleStatesApi(api_client).get_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id) + # Below is a request that includes all optional parameters + # results = LifecycleStatesApi(api_client).get_lifecycle_state(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->get_lifecycle_state:\n") + pprint(results) except Exception as e: - print("Exception when calling LifecycleStatesApi->get_lifecycle_state: %s\n" % e) + print("Exception when calling LifecycleStatesApi->get_lifecycle_state: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/lifecycle-states method: GET xCodeSample: @@ -7611,16 +7093,15 @@ 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) sorters = 'created,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-results) Sorting is supported for the following fields: **created, 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-results) Sorting is supported for the following fields: **created, modified** (optional) try: - # Lists LifecycleStates - - api_response = api_instance.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) - print("The response of LifecycleStatesApi->get_lifecycle_states:\n") - pprint(api_response) + # Lists LifecycleStates + + results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id=identity_profile_id) + # Below is a request that includes all optional parameters + # results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) + print("The response of LifecycleStatesApi->get_lifecycle_states:\n") + pprint(results) except Exception as e: - print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) + print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) - path: /identities/{identity-id}/set-lifecycle-state method: POST xCodeSample: @@ -7628,18 +7109,17 @@ label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#set-lifecycle-state source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_lifecycle_state(identity_id, Result) - print("The response of LifecycleStatesApi->set_lifecycle_state:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling LifecycleStatesApi->set_lifecycle_state: %s\n" % e) + set_lifecycle_state_request = '''sailpoint.v2024.SetLifecycleStateRequest()''' # SetLifecycleStateRequest | + try: + # Set Lifecycle State + new_set_lifecycle_state_request = SetLifecycleStateRequest.from_json(set_lifecycle_state_request) + results = LifecycleStatesApi(api_client).set_lifecycle_state(identity_id=identity_id, set_lifecycle_state_request=new_set_lifecycle_state_request) + # Below is a request that includes all optional parameters + # results = LifecycleStatesApi(api_client).set_lifecycle_state(identity_id, new_set_lifecycle_state_request) + print("The response of LifecycleStatesApi->set_lifecycle_state:\n") + pprint(results) + except Exception as e: + print("Exception when calling LifecycleStatesApi->set_lifecycle_state: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} method: PATCH xCodeSample: @@ -7648,24 +7128,17 @@ source: | 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 - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # 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 - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result) - print("The response of LifecycleStatesApi->update_lifecycle_states:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) + json_patch_operation = '''[{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 + try: + # Update Lifecycle State + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = LifecycleStatesApi(api_client).update_lifecycle_states(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) - path: /machine-accounts/{id} method: GET xCodeSample: @@ -7675,16 +7148,15 @@ id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine 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: - # Machine Account Details - - api_response = api_instance.get_machine_account(id, x_sail_point_experimental) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_machine_account(id, x_sail_point_experimental) - print("The response of MachineAccountsApi->get_machine_account:\n") - pprint(api_response) + # Machine Account Details + + results = MachineAccountsApi(api_client).get_machine_account(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = MachineAccountsApi(api_client).get_machine_account(id, x_sail_point_experimental) + print("The response of MachineAccountsApi->get_machine_account:\n") + pprint(results) except Exception as e: - print("Exception when calling MachineAccountsApi->get_machine_account: %s\n" % e) + print("Exception when calling MachineAccountsApi->get_machine_account: %s\n" % e) - path: /machine-accounts method: GET xCodeSample: @@ -7698,16 +7170,15 @@ filters = 'identityId eq \"2c9180858082150f0180893dbaf44201\"' # 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, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **source.name**: *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: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **source.name**: *eq, in* (optional) sorters = 'id,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: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (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: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) try: - # Machine Accounts List - - api_response = api_instance.list_machine_accounts(x_sail_point_experimental, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_machine_accounts(x_sail_point_experimental, limit, offset, count, filters, sorters) - print("The response of MachineAccountsApi->list_machine_accounts:\n") - pprint(api_response) + # Machine Accounts List + + results = MachineAccountsApi(api_client).list_machine_accounts(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = MachineAccountsApi(api_client).list_machine_accounts(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of MachineAccountsApi->list_machine_accounts:\n") + pprint(results) except Exception as e: - print("Exception when calling MachineAccountsApi->list_machine_accounts: %s\n" % e) + print("Exception when calling MachineAccountsApi->list_machine_accounts: %s\n" % e) - path: /machine-accounts/{id} method: PATCH xCodeSample: @@ -7716,20 +7187,17 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine 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') - request_body = {Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}} # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - request_body = {Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}} # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - + request_body = '''{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. try: - # Update a Machine Account - Result = request_body.from_json(request_body) - api_response = api_instance.update_machine_account(id, x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_machine_account(id, x_sail_point_experimental, Result) - print("The response of MachineAccountsApi->update_machine_account:\n") - pprint(api_response) + # Update a Machine Account + new_request_body = RequestBody.from_json(request_body) + results = MachineAccountsApi(api_client).update_machine_account(id=id, x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = MachineAccountsApi(api_client).update_machine_account(id, x_sail_point_experimental, new_request_body) + print("The response of MachineAccountsApi->update_machine_account:\n") + pprint(results) except Exception as e: - print("Exception when calling MachineAccountsApi->update_machine_account: %s\n" % e) + print("Exception when calling MachineAccountsApi->update_machine_account: %s\n" % e) - path: /machine-identities method: POST xCodeSample: @@ -7737,7 +7205,7 @@ label: SDK_tools/sdk/python/v2024/methods/machine-identities#create-machine-identity 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') - machine_identity = { + machine_identity = '''{ "created" : "2015-05-28T14:07:17Z", "businessApplication" : "ADService", "name" : "aName", @@ -7746,18 +7214,17 @@ "attributes" : "{\"Region\":\"EU\"}", "id" : "id12345", "manuallyEdited" : true - } # MachineIdentity | - try: - # Create Machine Identities - Result = machine_identity.from_json(machine_identity) - api_response = api_instance.create_machine_identity(x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_machine_identity(x_sail_point_experimental, Result) - print("The response of MachineIdentitiesApi->create_machine_identity:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MachineIdentitiesApi->create_machine_identity: %s\n" % e) + }''' # MachineIdentity | + try: + # Create Machine Identities + new_machine_identity = MachineIdentity.from_json(machine_identity) + results = MachineIdentitiesApi(api_client).create_machine_identity(x_sail_point_experimental=x_sail_point_experimental, machine_identity=new_machine_identity) + # Below is a request that includes all optional parameters + # results = MachineIdentitiesApi(api_client).create_machine_identity(x_sail_point_experimental, new_machine_identity) + print("The response of MachineIdentitiesApi->create_machine_identity:\n") + pprint(results) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->create_machine_identity: %s\n" % e) - path: /machine-identities/{id} method: DELETE xCodeSample: @@ -7767,14 +7234,13 @@ id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine 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 machine identity - - api_instance.delete_machine_identity(id, x_sail_point_experimental) - - # Below is a request that includes all optional parameters - # api_instance.delete_machine_identity(id, x_sail_point_experimental) + # Delete machine identity + + MachineIdentitiesApi(api_client).delete_machine_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # MachineIdentitiesApi(api_client).delete_machine_identity(id, x_sail_point_experimental) except Exception as e: - print("Exception when calling MachineIdentitiesApi->delete_machine_identity: %s\n" % e) + print("Exception when calling MachineIdentitiesApi->delete_machine_identity: %s\n" % e) - path: /machine-identities/{id} method: GET xCodeSample: @@ -7784,16 +7250,15 @@ id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine 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: - # Machine Identity Details - - api_response = api_instance.get_machine_identity(id, x_sail_point_experimental) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_machine_identity(id, x_sail_point_experimental) - print("The response of MachineIdentitiesApi->get_machine_identity:\n") - pprint(api_response) + # Machine Identity Details + + results = MachineIdentitiesApi(api_client).get_machine_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = MachineIdentitiesApi(api_client).get_machine_identity(id, x_sail_point_experimental) + print("The response of MachineIdentitiesApi->get_machine_identity:\n") + pprint(results) except Exception as e: - print("Exception when calling MachineIdentitiesApi->get_machine_identity: %s\n" % e) + print("Exception when calling MachineIdentitiesApi->get_machine_identity: %s\n" % e) - path: /machine-identities method: GET xCodeSample: @@ -7806,16 +7271,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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 Machine Identities - - api_response = api_instance.list_machine_identities(x_sail_point_experimental, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_machine_identities(x_sail_point_experimental, sorters, count, limit, offset) - print("The response of MachineIdentitiesApi->list_machine_identities:\n") - pprint(api_response) + # List Machine Identities + + results = MachineIdentitiesApi(api_client).list_machine_identities(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = MachineIdentitiesApi(api_client).list_machine_identities(x_sail_point_experimental, sorters, count, limit, offset) + print("The response of MachineIdentitiesApi->list_machine_identities:\n") + pprint(results) except Exception as e: - print("Exception when calling MachineIdentitiesApi->list_machine_identities: %s\n" % e) + print("Exception when calling MachineIdentitiesApi->list_machine_identities: %s\n" % e) - path: /machine-identities/{id} method: PATCH xCodeSample: @@ -7824,43 +7288,39 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID. # str | Machine 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') - request_body = {Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}} # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - request_body = {Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}} # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - + request_body = '''{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. try: - # Update a Machine Identity - Result = request_body.from_json(request_body) - api_response = api_instance.update_machine_identity(id, x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_machine_identity(id, x_sail_point_experimental, Result) - print("The response of MachineIdentitiesApi->update_machine_identity:\n") - pprint(api_response) + # Update a Machine Identity + new_request_body = RequestBody.from_json(request_body) + results = MachineIdentitiesApi(api_client).update_machine_identity(id=id, x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = MachineIdentitiesApi(api_client).update_machine_identity(id, x_sail_point_experimental, new_request_body) + print("The response of MachineIdentitiesApi->update_machine_identity:\n") + pprint(results) except Exception as e: - print("Exception when calling MachineIdentitiesApi->update_machine_identity: %s\n" % e) + print("Exception when calling MachineIdentitiesApi->update_machine_identity: %s\n" % e) - path: /managed-clients method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clients#create-managed-client source: | - managed_client_request = { + managed_client_request = '''{ "name" : "aName", "description" : "A short description of the ManagedClient", "clusterId" : "aClusterId", "type" : "VA" - } # ManagedClientRequest | - try: - # Create Managed Client - Result = managed_client_request.from_json(managed_client_request) - api_response = api_instance.create_managed_client(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_managed_client(Result) - print("The response of ManagedClientsApi->create_managed_client:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) + }''' # ManagedClientRequest | + try: + # Create Managed Client + new_managed_client_request = ManagedClientRequest.from_json(managed_client_request) + results = ManagedClientsApi(api_client).create_managed_client(managed_client_request=new_managed_client_request) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).create_managed_client(new_managed_client_request) + print("The response of ManagedClientsApi->create_managed_client:\n") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) - path: /managed-clients/{id} method: DELETE xCodeSample: @@ -7869,14 +7329,13 @@ source: | id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. try: - # Delete Managed Client - - api_instance.delete_managed_client(id) - - # Below is a request that includes all optional parameters - # api_instance.delete_managed_client(id) + # Delete Managed Client + + ManagedClientsApi(api_client).delete_managed_client(id=id) + # Below is a request that includes all optional parameters + # ManagedClientsApi(api_client).delete_managed_client(id) except Exception as e: - print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e) + print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e) - path: /managed-clients/{id} method: GET xCodeSample: @@ -7885,16 +7344,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_managed_client(id) - print("The response of ManagedClientsApi->get_managed_client:\n") - pprint(api_response) + # Get Managed Client + + results = ManagedClientsApi(api_client).get_managed_client(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client(id) + print("The response of ManagedClientsApi->get_managed_client:\n") + pprint(results) except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) + print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) - path: /managed-clients/{id}/status method: GET xCodeSample: @@ -7904,16 +7362,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_managed_client_status(id, type) - print("The response of ManagedClientsApi->get_managed_client_status:\n") - pprint(api_response) + # Get Managed Client Status + + results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + pprint(results) except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) - path: /managed-clients method: GET xCodeSample: @@ -7925,16 +7382,15 @@ 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) filters = 'name eq \"client 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* **name**: *eq* **clientId**: *eq* **clusterId**: *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* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) try: - # Get Managed Clients - - api_response = api_instance.get_managed_clients() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_managed_clients(offset, limit, count, filters) - print("The response of ManagedClientsApi->get_managed_clients:\n") - pprint(api_response) + # Get Managed Clients + + results = ManagedClientsApi(api_client).get_managed_clients() + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) + print("The response of ManagedClientsApi->get_managed_clients:\n") + pprint(results) except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) + print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) - path: /managed-clients/{id} method: PATCH xCodeSample: @@ -7942,31 +7398,24 @@ label: SDK_tools/sdk/python/v2024/methods/managed-clients#update-managed-client source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | JSONPatch payload used to update the object. - - try: - # Update Managed Client - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_managed_client(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_managed_client(id, Result) - print("The response of ManagedClientsApi->update_managed_client:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) + json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. + try: + # Update Managed Client + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ManagedClientsApi(api_client).update_managed_client(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation) + print("The response of ManagedClientsApi->update_managed_client:\n") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) - path: /managed-clusters method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clusters#create-managed-cluster source: | - managed_cluster_request = { + managed_cluster_request = '''{ "configuration" : { "clusterExternalId" : "externalId", "ccgVersion" : "77.0.0" @@ -7974,18 +7423,17 @@ "name" : "Managed Cluster Name", "description" : "A short description of the managed cluster.", "type" : "idn" - } # ManagedClusterRequest | - try: - # Create Create Managed Cluster - Result = managed_cluster_request.from_json(managed_cluster_request) - api_response = api_instance.create_managed_cluster(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_managed_cluster(Result) - print("The response of ManagedClustersApi->create_managed_cluster:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) + }''' # ManagedClusterRequest | + try: + # Create Create Managed Cluster + new_managed_cluster_request = ManagedClusterRequest.from_json(managed_cluster_request) + results = ManagedClustersApi(api_client).create_managed_cluster(managed_cluster_request=new_managed_cluster_request) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request) + print("The response of ManagedClustersApi->create_managed_cluster:\n") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) - path: /managed-clusters/{id} method: DELETE xCodeSample: @@ -7995,14 +7443,13 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_instance.delete_managed_cluster(id, remove_clients) + # Delete Managed Cluster + + ManagedClustersApi(api_client).delete_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # ManagedClustersApi(api_client).delete_managed_cluster(id, remove_clients) except Exception as e: - print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) + print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) - path: /managed-clusters/{id}/log-config method: GET xCodeSample: @@ -8011,16 +7458,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_client_log_configuration(id) - print("The response of ManagedClustersApi->get_client_log_configuration:\n") - pprint(api_response) + # Get Managed Cluster Log Configuration + + results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + pprint(results) except Exception as e: - print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) - path: /managed-clusters/{id} method: GET xCodeSample: @@ -8029,16 +7475,15 @@ source: | id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. try: - # Get Managed Cluster - - api_response = api_instance.get_managed_cluster(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_managed_cluster(id) - print("The response of ManagedClustersApi->get_managed_cluster:\n") - pprint(api_response) + # Get Managed Cluster + + results = ManagedClustersApi(api_client).get_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + pprint(results) except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) - path: /managed-clusters method: GET xCodeSample: @@ -8050,16 +7495,15 @@ 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) filters = 'operational eq \"operation\"' # 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: **operational**: *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: **operational**: *eq* (optional) try: - # Get Managed Clusters - - api_response = api_instance.get_managed_clusters() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_managed_clusters(offset, limit, count, filters) - print("The response of ManagedClustersApi->get_managed_clusters:\n") - pprint(api_response) + # Get Managed Clusters + + results = ManagedClustersApi(api_client).get_managed_clusters() + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + pprint(results) except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) - path: /managed-clusters/{id}/log-config method: PUT xCodeSample: @@ -8067,18 +7511,17 @@ label: SDK_tools/sdk/python/v2024/methods/managed-clusters#put-client-log-configuration source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_client_log_configuration(id, Result) - print("The response of ManagedClustersApi->put_client_log_configuration:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) + put_client_log_configuration_request = '''sailpoint.v2024.PutClientLogConfigurationRequest()''' # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. + try: + # Update Managed Cluster Log Configuration + new_put_client_log_configuration_request = PutClientLogConfigurationRequest.from_json(put_client_log_configuration_request) + results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, put_client_log_configuration_request=new_put_client_log_configuration_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) - path: /managed-clusters/{id} method: PATCH xCodeSample: @@ -8086,24 +7529,17 @@ label: SDK_tools/sdk/python/v2024/methods/managed-clusters#update-managed-cluster source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | JSONPatch payload used to update the object. - - try: - # Update Managed Cluster - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_managed_cluster(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_managed_cluster(id, Result) - print("The response of ManagedClustersApi->update_managed_cluster:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) + json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. + try: + # Update Managed Cluster + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ManagedClustersApi(api_client).update_managed_cluster(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation) + print("The response of ManagedClustersApi->update_managed_cluster:\n") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) - path: /mfa/duo-web/config method: GET xCodeSample: @@ -8111,16 +7547,15 @@ label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-duo-config source: | try: - # Configuration of Duo MFA method - - api_response = api_instance.get_mfa_duo_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_mfa_duo_config() - print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") - pprint(api_response) + # Configuration of Duo MFA method + + results = MFAConfigurationApi(api_client).get_mfa_duo_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + pprint(results) except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) - path: /mfa/kba/config method: GET xCodeSample: @@ -8129,16 +7564,15 @@ source: | 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_mfa_kba_config(all_languages) - print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - pprint(api_response) + # Configuration of KBA MFA method + + results = MFAConfigurationApi(api_client).get_mfa_kba_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + pprint(results) except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) + print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) - path: /mfa/okta-verify/config method: GET xCodeSample: @@ -8146,23 +7580,22 @@ label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-okta-config source: | try: - # Configuration of Okta MFA method - - api_response = api_instance.get_mfa_okta_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_mfa_okta_config() - print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") - pprint(api_response) + # Configuration of Okta MFA method + + results = MFAConfigurationApi(api_client).get_mfa_okta_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + pprint(results) except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) - path: /mfa/duo-web/config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-duo-config source: | - mfa_duo_config = { + mfa_duo_config = '''{ "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", "host" : "example.com", "configProperties" : { @@ -8172,65 +7605,57 @@ "mfaMethod" : "duo-web", "enabled" : true, "identityAttribute" : "email" - } # MfaDuoConfig | - try: - # Set Duo MFA configuration - Result = mfa_duo_config.from_json(mfa_duo_config) - api_response = api_instance.set_mfa_duo_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_mfa_duo_config(Result) - print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) + }''' # MfaDuoConfig | + try: + # Set Duo MFA configuration + new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) + results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) - path: /mfa/okta-verify/config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-okta-config source: | - mfa_okta_config = { + mfa_okta_config = '''{ "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", "host" : "example.com", "mfaMethod" : "okta-verify", "enabled" : true, "identityAttribute" : "email" - } # MfaOktaConfig | - try: - # Set Okta MFA configuration - Result = mfa_okta_config.from_json(mfa_okta_config) - api_response = api_instance.set_mfa_okta_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_mfa_okta_config(Result) - print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) + }''' # MfaOktaConfig | + try: + # Set Okta MFA configuration + new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) + results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) - path: /mfa/kba/config/answers method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfakba-config source: | - [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | - kba_answer_request_item = { - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - } # List[KbaAnswerRequestItem] | - - try: - # Set MFA KBA configuration - Result = kba_answer_request_item.from_json(kba_answer_request_item) - api_response = api_instance.set_mfakba_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_mfakba_config(Result) - print("The response of MFAConfigurationApi->set_mfakba_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) + kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | + try: + # Set MFA KBA configuration + new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) + results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) - path: /mfa/{method}/test method: GET xCodeSample: @@ -8239,16 +7664,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.test_mfa_config(method) - print("The response of MFAConfigurationApi->test_mfa_config:\n") - pprint(api_response) + # MFA method's test configuration + + results = MFAConfigurationApi(api_client).test_mfa_config(method=method) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + pprint(results) except Exception as e: - print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /non-employee-approvals/{id}/approve method: POST xCodeSample: @@ -8256,27 +7680,26 @@ label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#approve-non-employee-request source: | id = 'e136567de87e4d029e60b3c3c55db56d' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) - non_employee_approval_decision = { + non_employee_approval_decision = '''{ "comment" : "Approved by manager" - } # NonEmployeeApprovalDecision | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.approve_non_employee_request(id, Result) - print("The response of NonEmployeeLifecycleManagementApi->approve_non_employee_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->approve_non_employee_request: %s\n" % e) + }''' # NonEmployeeApprovalDecision | + try: + # Approve a Non-Employee Request + new_non_employee_approval_decision = NonEmployeeApprovalDecision.from_json(non_employee_approval_decision) + results = NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id=id, non_employee_approval_decision=new_non_employee_approval_decision) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->approve_non_employee_request: %s\n" % e) - path: /non-employee-records method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#create-non-employee-record source: | - non_employee_request_body = { + non_employee_request_body = '''{ "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", "lastName" : "Smith", @@ -8289,25 +7712,24 @@ "endDate" : "2021-03-25T00:00:00-05:00", "email" : "william.smith@example.com", "startDate" : "2020-03-24T00:00:00-05:00" - } # NonEmployeeRequestBody | Non-Employee record creation request body. - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_record(Result) - print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_record:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_record: %s\n" % e) + }''' # NonEmployeeRequestBody | Non-Employee record creation request body. + try: + # Create Non-Employee Record + new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body) + results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(non_employee_request_body=new_non_employee_request_body) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(new_non_employee_request_body) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_record:\n") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_record: %s\n" % e) - path: /non-employee-requests method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#create-non-employee-request source: | - non_employee_request_body = { + non_employee_request_body = '''{ "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", "lastName" : "Smith", @@ -8320,25 +7742,24 @@ "endDate" : "2021-03-25T00:00:00-05:00", "email" : "william.smith@example.com", "startDate" : "2020-03-24T00:00:00-05:00" - } # NonEmployeeRequestBody | Non-Employee creation request body - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_request(Result) - print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_request: %s\n" % e) + }''' # NonEmployeeRequestBody | Non-Employee creation request body + try: + # Create Non-Employee Request + new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body) + results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(non_employee_request_body=new_non_employee_request_body) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(new_non_employee_request_body) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_request: %s\n" % e) - path: /non-employee-sources method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#create-non-employee-source source: | - non_employee_source_request_body = { + non_employee_source_request_body = '''{ "owner" : { "id" : "2c91808570313110017040b06f344ec9" }, @@ -8363,18 +7784,17 @@ }, { "id" : "2c91808570313110017040b06f344ec9" } ] - } # NonEmployeeSourceRequestBody | Non-Employee source creation request body. - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_source(Result) - print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source: %s\n" % e) + }''' # NonEmployeeSourceRequestBody | Non-Employee source creation request body. + try: + # Create Non-Employee Source + new_non_employee_source_request_body = NonEmployeeSourceRequestBody.from_json(non_employee_source_request_body) + results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(non_employee_source_request_body=new_non_employee_source_request_body) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes method: POST xCodeSample: @@ -8382,25 +7802,24 @@ label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes source: | source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id - non_employee_schema_attribute_body = { + non_employee_schema_attribute_body = '''{ "helpText" : "The unique identifier for the account", "label" : "Account Name", "placeholder" : "Enter a unique user name for this account.", "type" : "TEXT", "technicalName" : "account.name", "required" : true - } # NonEmployeeSchemaAttributeBody | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) - print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes: %s\n" % e) + }''' # NonEmployeeSchemaAttributeBody | + try: + # Create a new Schema Attribute for Non-Employee Source + new_non_employee_schema_attribute_body = NonEmployeeSchemaAttributeBody.from_json(non_employee_schema_attribute_body) + results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id=source_id, non_employee_schema_attribute_body=new_non_employee_schema_attribute_body) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes: %s\n" % e) - path: /non-employee-records/{id} method: DELETE xCodeSample: @@ -8409,30 +7828,28 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_record(id) + # Delete Non-Employee Record + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id=id) + # Below is a request that includes all optional parameters + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record: %s\n" % e) - path: /non-employee-records/bulk-delete method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk source: | - delete_non_employee_records_in_bulk_request = sailpoint.v2024.DeleteNonEmployeeRecordsInBulkRequest() # DeleteNonEmployeeRecordsInBulkRequest | Non-Employee bulk delete request body. + 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_records_in_bulk(Result) + # Delete Multiple Non-Employee Records + new_delete_non_employee_records_in_bulk_request = DeleteNonEmployeeRecordsInBulkRequest.from_json(delete_non_employee_records_in_bulk_request) + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_records_in_bulk(delete_non_employee_records_in_bulk_request=new_delete_non_employee_records_in_bulk_request) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_records_in_bulk: %s\n" % e) - path: /non-employee-requests/{id} method: DELETE xCodeSample: @@ -8441,14 +7858,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_request(id) + # Delete Non-Employee Request + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id=id) + # Below is a request that includes all optional parameters + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_request: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_request: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} method: DELETE xCodeSample: @@ -8458,14 +7874,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_schema_attribute(attribute_id, source_id) + # Delete a Schema Attribute for Non-Employee Source + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_schema_attribute: %s\n" % e) - path: /non-employee-sources/{sourceId} method: DELETE xCodeSample: @@ -8474,14 +7889,13 @@ source: | source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id try: - # Delete Non-Employee Source - - api_instance.delete_non_employee_source(source_id) - - # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_source(source_id) + # Delete Non-Employee Source + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source(source_id=source_id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes method: DELETE xCodeSample: @@ -8490,14 +7904,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_source_schema_attributes(source_id) + # Delete all custom schema attributes for Non-Employee Source + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source_schema_attributes(source_id=source_id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source_schema_attributes: %s\n" % e) - path: /non-employee-sources/{id}/non-employees/download method: GET xCodeSample: @@ -8506,14 +7919,13 @@ source: | id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) try: - # Exports Non-Employee Records to CSV - - api_instance.export_non_employee_records(id) - - # Below is a request that includes all optional parameters - # api_instance.export_non_employee_records(id) + # Exports Non-Employee Records to CSV + + NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id=id) + # Below is a request that includes all optional parameters + # NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_records: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_records: %s\n" % e) - path: /non-employee-sources/{id}/schema-attributes-template/download method: GET xCodeSample: @@ -8522,14 +7934,13 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id (UUID) # str | Source Id (UUID) try: - # Exports Source Schema Template - - api_instance.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) + # Exports Source Schema Template + + NonEmployeeLifecycleManagementApi(api_client).export_non_employee_source_schema_template(id=id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_source_schema_template: %s\n" % e) - path: /non-employee-approvals/{id} method: GET xCodeSample: @@ -8539,16 +7950,15 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_approval(id, include_detail) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n") - pprint(api_response) + # Get a non-employee approval item detail + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval(id=id) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval(id, include_detail) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval: %s\n" % e) - path: /non-employee-approvals/summary/{requested-for} method: GET xCodeSample: @@ -8557,16 +7967,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_approval_summary(requested_for) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n") - pprint(api_response) + # Get Summary of Non-Employee Approval Requests + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for=requested_for) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary: %s\n" % e) - path: /non-employee-sources/{id}/non-employee-bulk-upload/status method: GET xCodeSample: @@ -8575,16 +7984,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_bulk_upload_status(id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n") - pprint(api_response) + # Obtain the status of bulk upload on the source + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_bulk_upload_status(id=id) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_bulk_upload_status(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) - path: /non-employee-records/{id} method: GET xCodeSample: @@ -8593,16 +8001,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_record(id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n") - pprint(api_response) + # Get a Non-Employee Record + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id=id) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) - path: /non-employee-requests/{id} method: GET xCodeSample: @@ -8611,16 +8018,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_request(id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n") - pprint(api_response) + # Get a Non-Employee Request + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id=id) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) - path: /non-employee-requests/summary/{requested-for} method: GET xCodeSample: @@ -8629,16 +8035,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_request_summary(requested_for) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n") - pprint(api_response) + # Get Summary of Non-Employee Requests + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for=requested_for) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request_summary: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request_summary: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} method: GET xCodeSample: @@ -8648,16 +8053,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute:\n") - pprint(api_response) + # Get Schema Attribute Non-Employee Source + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) - path: /non-employee-sources/{sourceId} method: GET xCodeSample: @@ -8666,16 +8070,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_source(source_id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source:\n") - pprint(api_response) + # Get a Non-Employee Source + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id=source_id) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes method: GET xCodeSample: @@ -8684,16 +8087,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_source_schema_attributes(source_id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - pprint(api_response) + # List Schema Attributes Non-Employee Source + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id=source_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) - path: /non-employee-sources/{id}/non-employee-bulk-upload method: POST xCodeSample: @@ -8703,16 +8105,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.import_non_employee_records_in_bulk(id, data) - print("The response of NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk:\n") - pprint(api_response) + # Imports, or Updates, Non-Employee Records + + results = NonEmployeeLifecycleManagementApi(api_client).import_non_employee_records_in_bulk(id=id, data=data) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk: %s\n" % e) - path: /non-employee-approvals method: GET xCodeSample: @@ -8726,16 +8127,15 @@ filters = 'approvalStatus 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: **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: **approvalStatus**: *eq* (optional) sorters = 'created' # 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: **created, 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-results) Sorting is supported for the following fields: **created, modified** (optional) try: - # Get List of Non-Employee Approval Requests - - api_response = api_instance.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) - print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") - pprint(api_response) + # Get List of Non-Employee Approval Requests + + results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) - path: /non-employee-records method: GET xCodeSample: @@ -8748,16 +8148,15 @@ sorters = 'accountName,sourceId' # 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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, 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-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) filters = 'sourceId eq \"2c91808568c529c60168cca6f90c1313\"' # 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: **sourceId**: *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: **sourceId**: *eq* (optional) try: - # List Non-Employee Records - - api_response = api_instance.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) - print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - pprint(api_response) + # List Non-Employee Records + + results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records() + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) - path: /non-employee-requests method: GET xCodeSample: @@ -8771,16 +8170,15 @@ sorters = 'created,approvalStatus' # 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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) filters = 'sourceId eq \"2c91808568c529c60168cca6f90c1313\"' # 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: **sourceId**: *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: **sourceId**: *eq* (optional) try: - # List Non-Employee Requests - - api_response = api_instance.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) - print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - pprint(api_response) + # List Non-Employee Requests + + results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for=requested_for) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) - path: /non-employee-sources method: GET xCodeSample: @@ -8794,16 +8192,15 @@ non_employee_count = False # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to False) # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to False) sorters = 'name,created' # 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, created, sourceId** (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, created, sourceId** (optional) try: - # List Non-Employee Sources - - api_response = api_instance.list_non_employee_sources() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) - print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - pprint(api_response) + # List Non-Employee Sources + + results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources() + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) - path: /non-employee-records/{id} method: PATCH xCodeSample: @@ -8811,24 +8208,17 @@ label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#patch-non-employee-record source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # 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. - - try: - # Patch Non-Employee Record - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_non_employee_record(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_non_employee_record(id, Result) - print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_record: %s\n" % e) + json_patch_operation = '''[{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. + try: + # Patch Non-Employee Record + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id, new_json_patch_operation) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_record: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} method: PATCH xCodeSample: @@ -8837,24 +8227,17 @@ source: | 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'. - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # 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'. - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) - print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute: %s\n" % e) + json_patch_operation = '''[{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'. + try: + # Patch a Schema Attribute for Non-Employee Source + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute: %s\n" % e) - path: /non-employee-sources/{sourceId} method: PATCH xCodeSample: @@ -8862,24 +8245,17 @@ label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#patch-non-employee-source source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_non_employee_source(source_id, Result) - print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_source:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_source: %s\n" % e) + json_patch_operation = '''[{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. + try: + # Patch a Non-Employee Source + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id=source_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_source: %s\n" % e) - path: /non-employee-approvals/{id}/reject method: POST xCodeSample: @@ -8887,20 +8263,19 @@ label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#reject-non-employee-request source: | id = 'e136567de87e4d029e60b3c3c55db56d' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) - non_employee_reject_approval_decision = { + non_employee_reject_approval_decision = '''{ "comment" : "approved" - } # NonEmployeeRejectApprovalDecision | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.reject_non_employee_request(id, Result) - print("The response of NonEmployeeLifecycleManagementApi->reject_non_employee_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->reject_non_employee_request: %s\n" % e) + }''' # NonEmployeeRejectApprovalDecision | + try: + # Reject a Non-Employee Request + new_non_employee_reject_approval_decision = NonEmployeeRejectApprovalDecision.from_json(non_employee_reject_approval_decision) + results = NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id=id, non_employee_reject_approval_decision=new_non_employee_reject_approval_decision) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->reject_non_employee_request: %s\n" % e) - path: /non-employee-records/{id} method: PUT xCodeSample: @@ -8908,7 +8283,7 @@ label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#update-non-employee-record source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) - non_employee_request_body = { + non_employee_request_body = '''{ "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", "lastName" : "Smith", @@ -8921,18 +8296,17 @@ "endDate" : "2021-03-25T00:00:00-05:00", "email" : "william.smith@example.com", "startDate" : "2020-03-24T00:00:00-05:00" - } # NonEmployeeRequestBody | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_non_employee_record(id, Result) - print("The response of NonEmployeeLifecycleManagementApi->update_non_employee_record:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->update_non_employee_record: %s\n" % e) + }''' # NonEmployeeRequestBody | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + try: + # Update Non-Employee Record + new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body) + results = NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id=id, non_employee_request_body=new_non_employee_request_body) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->update_non_employee_record: %s\n" % e) - path: /verified-domains method: POST xCodeSample: @@ -8940,20 +8314,19 @@ label: SDK_tools/sdk/python/v2024/methods/notifications#create-domain-dkim 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') - domain_address = { + 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(x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_domain_dkim(x_sail_point_experimental, Result) - print("The response of NotificationsApi->create_domain_dkim:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NotificationsApi->create_domain_dkim: %s\n" % e) + }''' # DomainAddress | + try: + # Verify domain address via DKIM + new_domain_address = DomainAddress.from_json(domain_address) + results = NotificationsApi(api_client).create_domain_dkim(x_sail_point_experimental=x_sail_point_experimental, domain_address=new_domain_address) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).create_domain_dkim(x_sail_point_experimental, new_domain_address) + print("The response of NotificationsApi->create_domain_dkim:\n") + pprint(results) + except Exception as e: + print("Exception when calling NotificationsApi->create_domain_dkim: %s\n" % e) - path: /notification-templates method: POST xCodeSample: @@ -8961,7 +8334,7 @@ label: SDK_tools/sdk/python/v2024/methods/notifications#create-notification-template 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') - template_dto = { + template_dto = '''{ "slackTemplate" : "slackTemplate", "footer" : "footer", "teamsTemplate" : "teamsTemplate", @@ -8978,18 +8351,17 @@ "from" : "$__global.emailFromAddress", "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", "key" : "cloud_manual_work_item_summary" - } # TemplateDto | - try: - # Create Notification Template - Result = template_dto.from_json(template_dto) - api_response = api_instance.create_notification_template(x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_notification_template(x_sail_point_experimental, Result) - print("The response of NotificationsApi->create_notification_template:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NotificationsApi->create_notification_template: %s\n" % e) + }''' # TemplateDto | + try: + # Create Notification Template + new_template_dto = TemplateDto.from_json(template_dto) + results = NotificationsApi(api_client).create_notification_template(x_sail_point_experimental=x_sail_point_experimental, template_dto=new_template_dto) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).create_notification_template(x_sail_point_experimental, new_template_dto) + print("The response of NotificationsApi->create_notification_template:\n") + pprint(results) + except Exception as e: + print("Exception when calling NotificationsApi->create_notification_template: %s\n" % e) - path: /verified-from-addresses method: POST xCodeSample: @@ -8997,23 +8369,22 @@ label: SDK_tools/sdk/python/v2024/methods/notifications#create-verified-from-address 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') - email_status_dto = { + email_status_dto = '''{ "isVerifiedByDomain" : false, "verificationStatus" : "PENDING", "id" : "id", "email" : "sender@example.com" - } # EmailStatusDto | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_verified_from_address(x_sail_point_experimental, Result) - print("The response of NotificationsApi->create_verified_from_address:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NotificationsApi->create_verified_from_address: %s\n" % e) + }''' # EmailStatusDto | + try: + # Create Verified From Address + new_email_status_dto = EmailStatusDto.from_json(email_status_dto) + results = NotificationsApi(api_client).create_verified_from_address(x_sail_point_experimental=x_sail_point_experimental, email_status_dto=new_email_status_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NotificationsApi->create_verified_from_address: %s\n" % e) - path: /notification-templates/bulk-delete method: POST xCodeSample: @@ -9021,22 +8392,15 @@ label: SDK_tools/sdk/python/v2024/methods/notifications#delete-notification-templates-in-bulk 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') - [sailpoint.v2024.TemplateBulkDeleteDto()] # List[TemplateBulkDeleteDto] | - template_bulk_delete_dto = { - "medium" : "EMAIL", - "locale" : "en", - "key" : "cloud_manual_work_item_summary" - } # List[TemplateBulkDeleteDto] | - + template_bulk_delete_dto = '''[sailpoint.v2024.TemplateBulkDeleteDto()]''' # List[TemplateBulkDeleteDto] | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_notification_templates_in_bulk(x_sail_point_experimental, Result) + # Bulk Delete Notification Templates + new_template_bulk_delete_dto = TemplateBulkDeleteDto.from_json(template_bulk_delete_dto) + NotificationsApi(api_client).delete_notification_templates_in_bulk(x_sail_point_experimental=x_sail_point_experimental, template_bulk_delete_dto=new_template_bulk_delete_dto) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling NotificationsApi->delete_notification_templates_in_bulk: %s\n" % e) - path: /verified-from-addresses/{id} method: DELETE xCodeSample: @@ -9046,14 +8410,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_verified_from_address(id, x_sail_point_experimental) + # Delete Verified From Address + + NotificationsApi(api_client).delete_verified_from_address(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling NotificationsApi->delete_verified_from_address: %s\n" % e) - path: /verified-domains method: GET xCodeSample: @@ -9062,16 +8425,15 @@ 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: - # Get DKIM Attributes - - api_response = api_instance.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) - print("The response of NotificationsApi->get_dkim_attributes:\n") - pprint(api_response) + # Get DKIM Attributes + + results = NotificationsApi(api_client).get_dkim_attributes(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).get_dkim_attributes(x_sail_point_experimental) + print("The response of NotificationsApi->get_dkim_attributes:\n") + pprint(results) except Exception as e: - print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) + print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) - path: /mail-from-attributes/{identity} method: GET xCodeSample: @@ -9081,16 +8443,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_mail_from_attributes(id, x_sail_point_experimental) - print("The response of NotificationsApi->get_mail_from_attributes:\n") - pprint(api_response) + # Get MAIL FROM Attributes + + results = NotificationsApi(api_client).get_mail_from_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).get_mail_from_attributes(id, x_sail_point_experimental) + print("The response of NotificationsApi->get_mail_from_attributes:\n") + pprint(results) except Exception as e: - print("Exception when calling NotificationsApi->get_mail_from_attributes: %s\n" % e) + print("Exception when calling NotificationsApi->get_mail_from_attributes: %s\n" % e) - path: /notification-templates/{id} method: GET xCodeSample: @@ -9100,16 +8461,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_notification_template(id, x_sail_point_experimental) - print("The response of NotificationsApi->get_notification_template:\n") - pprint(api_response) + # Get Notification Template By Id + + results = NotificationsApi(api_client).get_notification_template(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).get_notification_template(id, x_sail_point_experimental) + print("The response of NotificationsApi->get_notification_template:\n") + pprint(results) except Exception as e: - print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e) + print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e) - path: /notification-template-context method: GET xCodeSample: @@ -9118,16 +8478,15 @@ 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: - # Get Notification Template Context - - api_response = api_instance.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) - print("The response of NotificationsApi->get_notifications_template_context:\n") - pprint(api_response) + # Get Notification Template Context + + results = NotificationsApi(api_client).get_notifications_template_context(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).get_notifications_template_context(x_sail_point_experimental) + print("The response of NotificationsApi->get_notifications_template_context:\n") + pprint(results) except Exception as e: - print("Exception when calling NotificationsApi->get_notifications_template_context: %s\n" % e) + print("Exception when calling NotificationsApi->get_notifications_template_context: %s\n" % e) - path: /verified-from-addresses method: GET xCodeSample: @@ -9141,16 +8500,15 @@ filters = 'email eq \"john.doe@company.com\"' # 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: **email**: *eq, ge, le, 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: **email**: *eq, ge, le, sw* (optional) sorters = 'email' # 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: **email** (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: **email** (optional) try: - # List From Addresses - - api_response = api_instance.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) - print("The response of NotificationsApi->list_from_addresses:\n") - pprint(api_response) + # List From Addresses + + results = NotificationsApi(api_client).list_from_addresses(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) + print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) - path: /notification-preferences/{key} method: GET xCodeSample: @@ -9159,16 +8517,15 @@ 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: - # List Notification Preferences for tenant. - - api_response = api_instance.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) - print("The response of NotificationsApi->list_notification_preferences:\n") - pprint(api_response) + # List Notification Preferences for tenant. + + results = NotificationsApi(api_client).list_notification_preferences(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).list_notification_preferences(x_sail_point_experimental) + print("The response of NotificationsApi->list_notification_preferences:\n") + pprint(results) except Exception as e: - print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e) + print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e) - path: /notification-template-defaults method: GET xCodeSample: @@ -9180,16 +8537,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) 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) try: - # List Notification Template Defaults - - api_response = api_instance.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) - print("The response of NotificationsApi->list_notification_template_defaults:\n") - pprint(api_response) + # List Notification Template Defaults + + results = NotificationsApi(api_client).list_notification_template_defaults(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) + print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) - path: /notification-templates method: GET xCodeSample: @@ -9201,16 +8557,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) 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) try: - # List Notification Templates - - api_response = api_instance.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) - print("The response of NotificationsApi->list_notification_templates:\n") - pprint(api_response) + # List Notification Templates + + results = NotificationsApi(api_client).list_notification_templates(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).list_notification_templates(x_sail_point_experimental, limit, offset, filters) + print("The response of NotificationsApi->list_notification_templates:\n") + pprint(results) except Exception as e: - print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) + print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) - path: /mail-from-attributes method: PUT xCodeSample: @@ -9218,21 +8573,20 @@ label: SDK_tools/sdk/python/v2024/methods/notifications#put-mail-from-attributes 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') - mail_from_attributes_dto = { + mail_from_attributes_dto = '''{ "identity" : "BobSmith@sailpoint.com", "mailFromDomain" : "example.sailpoint.com" - } # MailFromAttributesDto | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_mail_from_attributes(x_sail_point_experimental, Result) - print("The response of NotificationsApi->put_mail_from_attributes:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NotificationsApi->put_mail_from_attributes: %s\n" % e) + }''' # MailFromAttributesDto | + try: + # Change MAIL FROM domain + new_mail_from_attributes_dto = MailFromAttributesDto.from_json(mail_from_attributes_dto) + results = NotificationsApi(api_client).put_mail_from_attributes(x_sail_point_experimental=x_sail_point_experimental, mail_from_attributes_dto=new_mail_from_attributes_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NotificationsApi->put_mail_from_attributes: %s\n" % e) - path: /send-test-notification method: POST xCodeSample: @@ -9240,27 +8594,26 @@ label: SDK_tools/sdk/python/v2024/methods/notifications#send-test-notification 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') - send_test_notification_request_dto = { + send_test_notification_request_dto = '''{ "context" : "{}", "medium" : "EMAIL", "key" : "cloud_manual_work_item_summary" - } # SendTestNotificationRequestDto | + }''' # SendTestNotificationRequestDto | 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) - - # Below is a request that includes all optional parameters - # api_instance.send_test_notification(x_sail_point_experimental, Result) + # Send Test Notification + new_send_test_notification_request_dto = SendTestNotificationRequestDto.from_json(send_test_notification_request_dto) + NotificationsApi(api_client).send_test_notification(x_sail_point_experimental=x_sail_point_experimental, send_test_notification_request_dto=new_send_test_notification_request_dto) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling NotificationsApi->send_test_notification: %s\n" % e) - path: /oauth-clients method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/o-auth-clients#create-oauth-client source: | - create_o_auth_client_request = { + create_o_auth_client_request = '''{ "internal" : false, "businessName" : "Acme-Solar", "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", @@ -9276,18 +8629,17 @@ "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], "name" : "Demo API Client", "claimsSupported" : false - } # CreateOAuthClientRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_oauth_client(Result) - print("The response of OAuthClientsApi->create_oauth_client:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling OAuthClientsApi->create_oauth_client: %s\n" % e) + }''' # CreateOAuthClientRequest | + try: + # Create OAuth Client + new_create_o_auth_client_request = CreateOAuthClientRequest.from_json(create_o_auth_client_request) + results = OAuthClientsApi(api_client).create_oauth_client(create_o_auth_client_request=new_create_o_auth_client_request) + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).create_oauth_client(new_create_o_auth_client_request) + print("The response of OAuthClientsApi->create_oauth_client:\n") + pprint(results) + except Exception as e: + print("Exception when calling OAuthClientsApi->create_oauth_client: %s\n" % e) - path: /oauth-clients/{id} method: DELETE xCodeSample: @@ -9296,14 +8648,13 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id try: - # Delete OAuth Client - - api_instance.delete_oauth_client(id) - - # Below is a request that includes all optional parameters - # api_instance.delete_oauth_client(id) + # Delete OAuth Client + + OAuthClientsApi(api_client).delete_oauth_client(id=id) + # Below is a request that includes all optional parameters + # OAuthClientsApi(api_client).delete_oauth_client(id) except Exception as e: - print("Exception when calling OAuthClientsApi->delete_oauth_client: %s\n" % e) + print("Exception when calling OAuthClientsApi->delete_oauth_client: %s\n" % e) - path: /oauth-clients/{id} method: GET xCodeSample: @@ -9312,16 +8663,15 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id try: - # Get OAuth Client - - api_response = api_instance.get_oauth_client(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_oauth_client(id) - print("The response of OAuthClientsApi->get_oauth_client:\n") - pprint(api_response) + # Get OAuth Client + + results = OAuthClientsApi(api_client).get_oauth_client(id=id) + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).get_oauth_client(id) + print("The response of OAuthClientsApi->get_oauth_client:\n") + pprint(results) except Exception as e: - print("Exception when calling OAuthClientsApi->get_oauth_client: %s\n" % e) + print("Exception when calling OAuthClientsApi->get_oauth_client: %s\n" % e) - path: /oauth-clients method: GET xCodeSample: @@ -9330,16 +8680,15 @@ source: | 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_oauth_clients(filters) - print("The response of OAuthClientsApi->list_oauth_clients:\n") - pprint(api_response) + # List OAuth Clients + + results = OAuthClientsApi(api_client).list_oauth_clients() + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).list_oauth_clients(filters) + print("The response of OAuthClientsApi->list_oauth_clients:\n") + pprint(results) except Exception as e: - print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) + print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) - path: /oauth-clients/{id} method: PATCH xCodeSample: @@ -9347,24 +8696,17 @@ label: SDK_tools/sdk/python/v2024/methods/o-auth-clients#patch-oauth-client source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # 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 - - try: - # Patch OAuth Client - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_oauth_client(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_oauth_client(id, Result) - print("The response of OAuthClientsApi->patch_oauth_client:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e) + json_patch_operation = '''[{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 + try: + # Patch OAuth Client + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = OAuthClientsApi(api_client).patch_oauth_client(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).patch_oauth_client(id, new_json_patch_operation) + print("The response of OAuthClientsApi->patch_oauth_client:\n") + pprint(results) + except Exception as e: + print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e) - path: /org-config method: GET xCodeSample: @@ -9373,16 +8715,15 @@ 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: - # Get Org Config Settings - - api_response = api_instance.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) - print("The response of OrgConfigApi->get_org_config:\n") - pprint(api_response) + # Get Org Config Settings + + results = OrgConfigApi(api_client).get_org_config(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = OrgConfigApi(api_client).get_org_config(x_sail_point_experimental) + print("The response of OrgConfigApi->get_org_config:\n") + pprint(results) except Exception as e: - print("Exception when calling OrgConfigApi->get_org_config: %s\n" % e) + print("Exception when calling OrgConfigApi->get_org_config: %s\n" % e) - path: /org-config/valid-time-zones method: GET xCodeSample: @@ -9394,16 +8735,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) 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) try: - # Get Valid Time Zones - - api_response = api_instance.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) - print("The response of OrgConfigApi->get_valid_time_zones:\n") - pprint(api_response) + # Get Valid Time Zones + + results = OrgConfigApi(api_client).get_valid_time_zones(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) + print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) - path: /org-config method: PATCH xCodeSample: @@ -9411,47 +8751,39 @@ label: SDK_tools/sdk/python/v2024/methods/org-config#patch-org-config 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') - [{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", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_org_config(x_sail_point_experimental, Result) - print("The response of OrgConfigApi->patch_org_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling OrgConfigApi->patch_org_config: %s\n" % e) + json_patch_operation = '''[{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. + try: + # Patch Org Config + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = OrgConfigApi(api_client).patch_org_config(x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling OrgConfigApi->patch_org_config: %s\n" % e) - path: /password-org-config method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-configuration#create-password-org-config source: | - password_org_config = { + password_org_config = '''{ "digitTokenLength" : 9, "digitTokenEnabled" : true, "digitTokenDurationMinutes" : 10, "customInstructionsEnabled" : true - } # PasswordOrgConfig | - try: - # Create Password Org Config - Result = password_org_config.from_json(password_org_config) - api_response = api_instance.create_password_org_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_password_org_config(Result) - print("The response of PasswordConfigurationApi->create_password_org_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordConfigurationApi->create_password_org_config: %s\n" % e) + }''' # PasswordOrgConfig | + try: + # Create Password Org Config + new_password_org_config = PasswordOrgConfig.from_json(password_org_config) + results = PasswordConfigurationApi(api_client).create_password_org_config(password_org_config=new_password_org_config) + # Below is a request that includes all optional parameters + # results = PasswordConfigurationApi(api_client).create_password_org_config(new_password_org_config) + print("The response of PasswordConfigurationApi->create_password_org_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->create_password_org_config: %s\n" % e) - path: /password-org-config method: GET xCodeSample: @@ -9459,39 +8791,37 @@ label: SDK_tools/sdk/python/v2024/methods/password-configuration#get-password-org-config source: | try: - # Get Password Org Config - - api_response = api_instance.get_password_org_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_password_org_config() - print("The response of PasswordConfigurationApi->get_password_org_config:\n") - pprint(api_response) + # Get Password Org Config + + results = PasswordConfigurationApi(api_client).get_password_org_config() + # Below is a request that includes all optional parameters + # results = PasswordConfigurationApi(api_client).get_password_org_config() + print("The response of PasswordConfigurationApi->get_password_org_config:\n") + pprint(results) except Exception as e: - print("Exception when calling PasswordConfigurationApi->get_password_org_config: %s\n" % e) + print("Exception when calling PasswordConfigurationApi->get_password_org_config: %s\n" % e) - path: /password-org-config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-configuration#put-password-org-config source: | - password_org_config = { + password_org_config = '''{ "digitTokenLength" : 9, "digitTokenEnabled" : true, "digitTokenDurationMinutes" : 10, "customInstructionsEnabled" : true - } # PasswordOrgConfig | - try: - # Update Password Org Config - Result = password_org_config.from_json(password_org_config) - api_response = api_instance.put_password_org_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_password_org_config(Result) - print("The response of PasswordConfigurationApi->put_password_org_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordConfigurationApi->put_password_org_config: %s\n" % e) + }''' # PasswordOrgConfig | + try: + # Update Password Org Config + new_password_org_config = PasswordOrgConfig.from_json(password_org_config) + results = PasswordConfigurationApi(api_client).put_password_org_config(password_org_config=new_password_org_config) + # Below is a request that includes all optional parameters + # results = PasswordConfigurationApi(api_client).put_password_org_config(new_password_org_config) + print("The response of PasswordConfigurationApi->put_password_org_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->put_password_org_config: %s\n" % e) - path: /password-dictionary method: GET xCodeSample: @@ -9499,16 +8829,15 @@ label: SDK_tools/sdk/python/v2024/methods/password-dictionary#get-password-dictionary source: | try: - # Get Password Dictionary - - api_response = api_instance.get_password_dictionary() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_password_dictionary() - print("The response of PasswordDictionaryApi->get_password_dictionary:\n") - pprint(api_response) + # Get Password Dictionary + + results = PasswordDictionaryApi(api_client).get_password_dictionary() + # Below is a request that includes all optional parameters + # results = PasswordDictionaryApi(api_client).get_password_dictionary() + print("The response of PasswordDictionaryApi->get_password_dictionary:\n") + pprint(results) except Exception as e: - print("Exception when calling PasswordDictionaryApi->get_password_dictionary: %s\n" % e) + print("Exception when calling PasswordDictionaryApi->get_password_dictionary: %s\n" % e) - path: /password-dictionary method: PUT xCodeSample: @@ -9517,14 +8846,13 @@ source: | file = None # bytearray | (optional) # bytearray | (optional) try: - # Update Password Dictionary - - api_instance.put_password_dictionary() - - # Below is a request that includes all optional parameters - # api_instance.put_password_dictionary(file) + # Update Password Dictionary + + PasswordDictionaryApi(api_client).put_password_dictionary() + # Below is a request that includes all optional parameters + # PasswordDictionaryApi(api_client).put_password_dictionary(file) except Exception as e: - print("Exception when calling PasswordDictionaryApi->put_password_dictionary: %s\n" % e) + print("Exception when calling PasswordDictionaryApi->put_password_dictionary: %s\n" % e) - path: /generate-password-reset-token/digit method: POST xCodeSample: @@ -9532,22 +8860,21 @@ label: SDK_tools/sdk/python/v2024/methods/password-management#create-digit-token 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') - password_digit_token_reset = { + password_digit_token_reset = '''{ "durationMinutes" : 5, "length" : 8, "userId" : "Abby.Smith" - } # PasswordDigitTokenReset | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_digit_token(x_sail_point_experimental, Result) - print("The response of PasswordManagementApi->create_digit_token:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordManagementApi->create_digit_token: %s\n" % e) + }''' # PasswordDigitTokenReset | + try: + # Generate a digit token + new_password_digit_token_reset = PasswordDigitTokenReset.from_json(password_digit_token_reset) + results = PasswordManagementApi(api_client).create_digit_token(x_sail_point_experimental=x_sail_point_experimental, password_digit_token_reset=new_password_digit_token_reset) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling PasswordManagementApi->create_digit_token: %s\n" % e) - path: /password-change-status/{id} method: GET xCodeSample: @@ -9556,68 +8883,65 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_password_change_status(id) - print("The response of PasswordManagementApi->get_password_change_status:\n") - pprint(api_response) + # Get Password Change Request Status + + results = PasswordManagementApi(api_client).get_password_change_status(id=id) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).get_password_change_status(id) + print("The response of PasswordManagementApi->get_password_change_status:\n") + pprint(results) except Exception as e: - print("Exception when calling PasswordManagementApi->get_password_change_status: %s\n" % e) + print("Exception when calling PasswordManagementApi->get_password_change_status: %s\n" % e) - path: /query-password-info method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-management#query-password-info source: | - password_info_query_dto = { + password_info_query_dto = '''{ "sourceName" : "My-AD", "userName" : "Abby.Smith" - } # PasswordInfoQueryDTO | - try: - # Query Password Info - Result = password_info_query_dto.from_json(password_info_query_dto) - api_response = api_instance.query_password_info(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.query_password_info(Result) - print("The response of PasswordManagementApi->query_password_info:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordManagementApi->query_password_info: %s\n" % e) + }''' # PasswordInfoQueryDTO | + try: + # Query Password Info + new_password_info_query_dto = PasswordInfoQueryDto.from_json(password_info_query_dto) + results = PasswordManagementApi(api_client).query_password_info(password_info_query_dto=new_password_info_query_dto) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).query_password_info(new_password_info_query_dto) + print("The response of PasswordManagementApi->query_password_info:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordManagementApi->query_password_info: %s\n" % e) - path: /set-password method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-management#set-password source: | - password_change_request = { + password_change_request = '''{ "sourceId" : "8a807d4c73c545510173c545d4b60246", "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", "identityId" : "8a807d4c73c545510173c545f0a002ff", "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" - } # PasswordChangeRequest | - try: - # Set Identity's Password - Result = password_change_request.from_json(password_change_request) - api_response = api_instance.set_password(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_password(Result) - print("The response of PasswordManagementApi->set_password:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordManagementApi->set_password: %s\n" % e) + }''' # PasswordChangeRequest | + try: + # Set Identity's Password + new_password_change_request = PasswordChangeRequest.from_json(password_change_request) + results = PasswordManagementApi(api_client).set_password(password_change_request=new_password_change_request) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).set_password(new_password_change_request) + print("The response of PasswordManagementApi->set_password:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordManagementApi->set_password: %s\n" % e) - path: /password-policies method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-policies#create-password-policy source: | - password_policy_v3_dto = { + password_policy_v3_dto = '''{ "validateAgainstAccountName" : true, "minLength" : 8, "description" : "Information about the Password Policy", @@ -9649,18 +8973,17 @@ "requireStrongAuthOffNetwork" : true, "name" : "PasswordPolicy Example", "maxLength" : 25 - } # PasswordPolicyV3Dto | - try: - # Create Password Policy - Result = password_policy_v3_dto.from_json(password_policy_v3_dto) - api_response = api_instance.create_password_policy(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_password_policy(Result) - print("The response of PasswordPoliciesApi->create_password_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordPoliciesApi->create_password_policy: %s\n" % e) + }''' # PasswordPolicyV3Dto | + try: + # Create Password Policy + new_password_policy_v3_dto = PasswordPolicyV3Dto.from_json(password_policy_v3_dto) + results = PasswordPoliciesApi(api_client).create_password_policy(password_policy_v3_dto=new_password_policy_v3_dto) + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).create_password_policy(new_password_policy_v3_dto) + print("The response of PasswordPoliciesApi->create_password_policy:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->create_password_policy: %s\n" % e) - path: /password-policies/{id} method: DELETE xCodeSample: @@ -9669,14 +8992,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_password_policy(id) + # Delete Password Policy by ID + + PasswordPoliciesApi(api_client).delete_password_policy(id=id) + # Below is a request that includes all optional parameters + # PasswordPoliciesApi(api_client).delete_password_policy(id) except Exception as e: - print("Exception when calling PasswordPoliciesApi->delete_password_policy: %s\n" % e) + print("Exception when calling PasswordPoliciesApi->delete_password_policy: %s\n" % e) - path: /password-policies/{id} method: GET xCodeSample: @@ -9685,16 +9007,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_password_policy_by_id(id) - print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n") - pprint(api_response) + # Get Password Policy by ID + + results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id=id) + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id) + print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n") + pprint(results) except Exception as e: - print("Exception when calling PasswordPoliciesApi->get_password_policy_by_id: %s\n" % e) + print("Exception when calling PasswordPoliciesApi->get_password_policy_by_id: %s\n" % e) - path: /password-policies method: GET xCodeSample: @@ -9705,16 +9026,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) 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) try: - # List Password Policies - - api_response = api_instance.list_password_policies() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_password_policies(limit, offset, count) - print("The response of PasswordPoliciesApi->list_password_policies:\n") - pprint(api_response) + # List Password Policies + + results = PasswordPoliciesApi(api_client).list_password_policies() + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) + print("The response of PasswordPoliciesApi->list_password_policies:\n") + pprint(results) except Exception as e: - print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) + print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) - path: /password-policies/{id} method: PUT xCodeSample: @@ -9722,7 +9042,7 @@ label: SDK_tools/sdk/python/v2024/methods/password-policies#set-password-policy source: | id = 'ff808081838d9e9d01838da6a03e0007' # str | The ID of password policy to update. # str | The ID of password policy to update. - password_policy_v3_dto = { + password_policy_v3_dto = '''{ "validateAgainstAccountName" : true, "minLength" : 8, "description" : "Information about the Password Policy", @@ -9754,43 +9074,41 @@ "requireStrongAuthOffNetwork" : true, "name" : "PasswordPolicy Example", "maxLength" : 25 - } # PasswordPolicyV3Dto | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_password_policy(id, Result) - print("The response of PasswordPoliciesApi->set_password_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordPoliciesApi->set_password_policy: %s\n" % e) + }''' # PasswordPolicyV3Dto | + try: + # Update Password Policy by ID + new_password_policy_v3_dto = PasswordPolicyV3Dto.from_json(password_policy_v3_dto) + results = PasswordPoliciesApi(api_client).set_password_policy(id=id, password_policy_v3_dto=new_password_policy_v3_dto) + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).set_password_policy(id, new_password_policy_v3_dto) + print("The response of PasswordPoliciesApi->set_password_policy:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->set_password_policy: %s\n" % e) - path: /password-sync-groups method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-sync-groups#create-password-sync-group source: | - password_sync_group = { + password_sync_group = '''{ "created" : "2023-03-16T04:00:00Z", "name" : "Password Sync Group 1", "modified" : "2023-03-16T04:00:00Z", "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } # PasswordSyncGroup | - try: - # Create Password Sync Group - Result = password_sync_group.from_json(password_sync_group) - api_response = api_instance.create_password_sync_group(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_password_sync_group(Result) - print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->create_password_sync_group: %s\n" % e) + }''' # PasswordSyncGroup | + try: + # Create Password Sync Group + new_password_sync_group = PasswordSyncGroup.from_json(password_sync_group) + results = PasswordSyncGroupsApi(api_client).create_password_sync_group(password_sync_group=new_password_sync_group) + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).create_password_sync_group(new_password_sync_group) + print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->create_password_sync_group: %s\n" % e) - path: /password-sync-groups/{id} method: DELETE xCodeSample: @@ -9799,14 +9117,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_password_sync_group(id) + # Delete Password Sync Group by ID + + PasswordSyncGroupsApi(api_client).delete_password_sync_group(id=id) + # Below is a request that includes all optional parameters + # PasswordSyncGroupsApi(api_client).delete_password_sync_group(id) except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->delete_password_sync_group: %s\n" % e) + print("Exception when calling PasswordSyncGroupsApi->delete_password_sync_group: %s\n" % e) - path: /password-sync-groups/{id} method: GET xCodeSample: @@ -9815,16 +9132,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_password_sync_group(id) - print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n") - pprint(api_response) + # Get Password Sync Group by ID + + results = PasswordSyncGroupsApi(api_client).get_password_sync_group(id=id) + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).get_password_sync_group(id) + print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n") + pprint(results) except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->get_password_sync_group: %s\n" % e) + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_group: %s\n" % e) - path: /password-sync-groups method: GET xCodeSample: @@ -9835,16 +9151,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) 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) try: - # Get Password Sync Group List - - api_response = api_instance.get_password_sync_groups() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_password_sync_groups(limit, offset, count) - print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") - pprint(api_response) + # Get Password Sync Group List + + results = PasswordSyncGroupsApi(api_client).get_password_sync_groups() + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) + print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") + pprint(results) except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) - path: /password-sync-groups/{id} method: PUT xCodeSample: @@ -9852,47 +9167,45 @@ label: SDK_tools/sdk/python/v2024/methods/password-sync-groups#update-password-sync-group source: | 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 = { + password_sync_group = '''{ "created" : "2023-03-16T04:00:00Z", "name" : "Password Sync Group 1", "modified" : "2023-03-16T04:00:00Z", "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } # PasswordSyncGroup | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_password_sync_group(id, Result) - print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->update_password_sync_group: %s\n" % e) + }''' # PasswordSyncGroup | + try: + # Update Password Sync Group by ID + new_password_sync_group = PasswordSyncGroup.from_json(password_sync_group) + results = PasswordSyncGroupsApi(api_client).update_password_sync_group(id=id, password_sync_group=new_password_sync_group) + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).update_password_sync_group(id, new_password_sync_group) + print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->update_password_sync_group: %s\n" % e) - path: /personal-access-tokens method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/personal-access-tokens#create-personal-access-token source: | - create_personal_access_token_request = { + create_personal_access_token_request = '''{ "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], "accessTokenValiditySeconds" : 36900, "name" : "NodeJS Integration" - } # CreatePersonalAccessTokenRequest | Name and scope of personal access token. - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_personal_access_token(Result) - print("The response of PersonalAccessTokensApi->create_personal_access_token:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PersonalAccessTokensApi->create_personal_access_token: %s\n" % e) + }''' # CreatePersonalAccessTokenRequest | Name and scope of personal access token. + try: + # Create Personal Access Token + new_create_personal_access_token_request = CreatePersonalAccessTokenRequest.from_json(create_personal_access_token_request) + results = PersonalAccessTokensApi(api_client).create_personal_access_token(create_personal_access_token_request=new_create_personal_access_token_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->create_personal_access_token: %s\n" % e) - path: /personal-access-tokens/{id} method: DELETE xCodeSample: @@ -9901,14 +9214,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_personal_access_token(id) + # Delete Personal Access Token + + PersonalAccessTokensApi(api_client).delete_personal_access_token(id=id) + # Below is a request that includes all optional parameters + # PersonalAccessTokensApi(api_client).delete_personal_access_token(id) except Exception as e: - print("Exception when calling PersonalAccessTokensApi->delete_personal_access_token: %s\n" % e) + print("Exception when calling PersonalAccessTokensApi->delete_personal_access_token: %s\n" % e) - path: /personal-access-tokens method: GET xCodeSample: @@ -9918,16 +9230,15 @@ 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_personal_access_tokens(owner_id, filters) - print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") - pprint(api_response) + # List Personal Access Tokens + + results = PersonalAccessTokensApi(api_client).list_personal_access_tokens() + # Below is a request that includes all optional parameters + # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) + print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") + pprint(results) except Exception as e: - print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) + print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) - path: /personal-access-tokens/{id} method: PATCH xCodeSample: @@ -9935,24 +9246,17 @@ label: SDK_tools/sdk/python/v2024/methods/personal-access-tokens#patch-personal-access-token source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # 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 - - try: - # Patch Personal Access Token - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_personal_access_token(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_personal_access_token(id, Result) - print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PersonalAccessTokensApi->patch_personal_access_token: %s\n" % e) + json_patch_operation = '''[{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 + try: + # Patch Personal Access Token + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = PersonalAccessTokensApi(api_client).patch_personal_access_token(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = PersonalAccessTokensApi(api_client).patch_personal_access_token(id, new_json_patch_operation) + print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n") + pprint(results) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->patch_personal_access_token: %s\n" % e) - path: /public-identities method: GET xCodeSample: @@ -9966,16 +9270,15 @@ add_core_filters = False # bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to False) # bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to False) 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) try: - # Get list of public identities - - api_response = api_instance.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) - print("The response of PublicIdentitiesApi->get_public_identities:\n") - pprint(api_response) + # Get list of public identities + + results = PublicIdentitiesApi(api_client).get_public_identities() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) + print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) - path: /public-identities-config method: GET xCodeSample: @@ -9983,23 +9286,22 @@ label: SDK_tools/sdk/python/v2024/methods/public-identities-config#get-public-identity-config source: | try: - # Get the Public Identities Configuration - - api_response = api_instance.get_public_identity_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_public_identity_config() - print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n") - pprint(api_response) + # Get the Public Identities Configuration + + results = PublicIdentitiesConfigApi(api_client).get_public_identity_config() + # Below is a request that includes all optional parameters + # results = PublicIdentitiesConfigApi(api_client).get_public_identity_config() + print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n") + pprint(results) except Exception as e: - print("Exception when calling PublicIdentitiesConfigApi->get_public_identity_config: %s\n" % e) + print("Exception when calling PublicIdentitiesConfigApi->get_public_identity_config: %s\n" % e) - path: /public-identities-config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/public-identities-config#update-public-identity-config source: | - public_identity_config = { + public_identity_config = '''{ "modified" : "2018-06-25T20:22:28.104Z", "attributes" : [ { "name" : "Country", @@ -10013,18 +9315,17 @@ "id" : "2c9180a46faadee4016fb4e018c20639", "type" : "IDENTITY" } - } # PublicIdentityConfig | - try: - # Update the Public Identities Configuration - Result = public_identity_config.from_json(public_identity_config) - api_response = api_instance.update_public_identity_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_public_identity_config(Result) - print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PublicIdentitiesConfigApi->update_public_identity_config: %s\n" % e) + }''' # PublicIdentityConfig | + try: + # Update the Public Identities Configuration + new_public_identity_config = PublicIdentityConfig.from_json(public_identity_config) + results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(public_identity_config=new_public_identity_config) + # Below is a request that includes all optional parameters + # results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(new_public_identity_config) + print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->update_public_identity_config: %s\n" % e) - path: /reports/{id}/cancel method: POST xCodeSample: @@ -10033,14 +9334,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.cancel_report(id) + # Cancel Report + + ReportsDataExtractionApi(api_client).cancel_report(id=id) + # Below is a request that includes all optional parameters + # ReportsDataExtractionApi(api_client).cancel_report(id) except Exception as e: - print("Exception when calling ReportsDataExtractionApi->cancel_report: %s\n" % e) + print("Exception when calling ReportsDataExtractionApi->cancel_report: %s\n" % e) - path: /reports/{taskResultId} method: GET xCodeSample: @@ -10052,16 +9352,15 @@ 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) auditable = False # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to False) # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to False) try: - # Get Report File - - api_response = api_instance.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) - print("The response of ReportsDataExtractionApi->get_report:\n") - pprint(api_response) + # Get Report File + + results = ReportsDataExtractionApi(api_client).get_report(task_result_id=task_result_id, file_format=file_format) + # Below is a request that includes all optional parameters + # results = ReportsDataExtractionApi(api_client).get_report(task_result_id, file_format, name, auditable) + print("The response of ReportsDataExtractionApi->get_report:\n") + pprint(results) except Exception as e: - print("Exception when calling ReportsDataExtractionApi->get_report: %s\n" % e) + print("Exception when calling ReportsDataExtractionApi->get_report: %s\n" % e) - path: /reports/{taskResultId}/result method: GET xCodeSample: @@ -10071,40 +9370,38 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_report_result(task_result_id, completed) - print("The response of ReportsDataExtractionApi->get_report_result:\n") - pprint(api_response) + # Get Report Result + + results = ReportsDataExtractionApi(api_client).get_report_result(task_result_id=task_result_id) + # Below is a request that includes all optional parameters + # results = ReportsDataExtractionApi(api_client).get_report_result(task_result_id, completed) + print("The response of ReportsDataExtractionApi->get_report_result:\n") + pprint(results) except Exception as e: - print("Exception when calling ReportsDataExtractionApi->get_report_result: %s\n" % e) + print("Exception when calling ReportsDataExtractionApi->get_report_result: %s\n" % e) - path: /reports/run method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/reports-data-extraction#start-report source: | - report_details = { + report_details = '''{ "reportType" : "ACCOUNTS", "arguments" : { "application" : "2c9180897e7742b2017e781782f705b9", "sourceName" : "Active Directory" } - } # ReportDetails | - try: - # Run Report - Result = report_details.from_json(report_details) - api_response = api_instance.start_report(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_report(Result) - print("The response of ReportsDataExtractionApi->start_report:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ReportsDataExtractionApi->start_report: %s\n" % e) + }''' # ReportDetails | + try: + # Run Report + new_report_details = ReportDetails.from_json(report_details) + results = ReportsDataExtractionApi(api_client).start_report(report_details=new_report_details) + # Below is a request that includes all optional parameters + # results = ReportsDataExtractionApi(api_client).start_report(new_report_details) + print("The response of ReportsDataExtractionApi->start_report:\n") + pprint(results) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->start_report: %s\n" % e) - path: /requestable-objects method: GET xCodeSample: @@ -10112,29 +9409,24 @@ label: SDK_tools/sdk/python/v2024/methods/requestable-objects#list-requestable-objects source: | 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) - - 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) + 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) term = 'Finance Role' # str | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) # str | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) - statuses = [sailpoint.v2024.RequestableObjectRequestStatus()] # List[RequestableObjectRequestStatus] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) - - statuses = [sailpoint.v2024.RequestableObjectRequestStatus()] # List[RequestableObjectRequestStatus] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) + statuses = '''[sailpoint.v2024.RequestableObjectRequestStatus()]''' # List[RequestableObjectRequestStatus] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (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) 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) filters = 'name sw \"bob\"' # 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, in, 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: **id**: *eq, in* **name**: *eq, in, sw* (optional) 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) try: - # Requestable Objects List - - api_response = api_instance.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) - print("The response of RequestableObjectsApi->list_requestable_objects:\n") - pprint(api_response) + # Requestable Objects List + + results = RequestableObjectsApi(api_client).list_requestable_objects() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) + print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) - path: /role-insights/requests method: POST xCodeSample: @@ -10143,16 +9435,15 @@ 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: - # Generate insights for roles - - api_response = api_instance.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) - print("The response of RoleInsightsApi->create_role_insight_requests:\n") - pprint(api_response) + # Generate insights for roles + + results = RoleInsightsApi(api_client).create_role_insight_requests(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).create_role_insight_requests(x_sail_point_experimental) + print("The response of RoleInsightsApi->create_role_insight_requests:\n") + pprint(results) except Exception as e: - print("Exception when calling RoleInsightsApi->create_role_insight_requests: %s\n" % e) + print("Exception when calling RoleInsightsApi->create_role_insight_requests: %s\n" % e) - path: /role-insights/{insightId}/entitlement-changes/download method: GET xCodeSample: @@ -10164,16 +9455,15 @@ 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) try: - # Download entitlement insights for a role - - api_response = api_instance.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) - print("The response of RoleInsightsApi->download_role_insights_entitlements_changes:\n") - pprint(api_response) + # Download entitlement insights for a role + + results = RoleInsightsApi(api_client).download_role_insights_entitlements_changes(insight_id=insight_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling RoleInsightsApi->download_role_insights_entitlements_changes: %s\n" % e) + print("Exception when calling RoleInsightsApi->download_role_insights_entitlements_changes: %s\n" % e) - path: /role-insights/{insightId}/entitlement-changes/{entitlementId}/identities method: GET xCodeSample: @@ -10190,16 +9480,15 @@ 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) filters = 'name sw \"Jan\"' # 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* (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* (optional) 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, ) - - # 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) - print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") - pprint(api_response) + # Get identities for a suggested entitlement (for a role) + + results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id=insight_id, entitlement_id=entitlement_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) + print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) - path: /role-insights/{insightId} method: GET xCodeSample: @@ -10209,16 +9498,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_insight(insight_id, x_sail_point_experimental) - print("The response of RoleInsightsApi->get_role_insight:\n") - pprint(api_response) + # Get a single role insight + + results = RoleInsightsApi(api_client).get_role_insight(insight_id=insight_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insight(insight_id, x_sail_point_experimental) + print("The response of RoleInsightsApi->get_role_insight:\n") + pprint(results) except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insight: %s\n" % e) + print("Exception when calling RoleInsightsApi->get_role_insight: %s\n" % e) - path: /role-insights method: GET xCodeSample: @@ -10232,16 +9520,15 @@ sorters = 'numberOfUpdates' # 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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) filters = 'name sw \"John\"' # 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* **ownerName**: *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* **ownerName**: *sw* **description**: *sw* (optional) try: - # Get role insights - - api_response = api_instance.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) - print("The response of RoleInsightsApi->get_role_insights:\n") - pprint(api_response) + # Get role insights + + results = RoleInsightsApi(api_client).get_role_insights(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) + print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) - path: /role-insights/{insightId}/current-entitlements method: GET xCodeSample: @@ -10252,16 +9539,15 @@ x_sail_point_experimental = 'true' # 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) try: - # Get current entitlement for a role - - api_response = api_instance.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) - print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") - pprint(api_response) + # Get current entitlement for a role + + results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id=insight_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) + print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) - path: /role-insights/{insightId}/entitlement-changes method: GET xCodeSample: @@ -10273,16 +9559,15 @@ 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) try: - # Get entitlement insights for a role - - api_response = api_instance.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) - print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") - pprint(api_response) + # Get entitlement insights for a role + + results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id=insight_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) + print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) - path: /role-insights/requests/{id} method: GET xCodeSample: @@ -10292,16 +9577,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_role_insights_requests(id, x_sail_point_experimental) - print("The response of RoleInsightsApi->get_role_insights_requests:\n") - pprint(api_response) + # Returns metadata from prior request. + + results = RoleInsightsApi(api_client).get_role_insights_requests(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insights_requests(id, x_sail_point_experimental) + print("The response of RoleInsightsApi->get_role_insights_requests:\n") + pprint(results) except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insights_requests: %s\n" % e) + print("Exception when calling RoleInsightsApi->get_role_insights_requests: %s\n" % e) - path: /role-insights/summary method: GET xCodeSample: @@ -10310,23 +9594,22 @@ 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: - # Get role insights summary information - - api_response = api_instance.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) - print("The response of RoleInsightsApi->get_role_insights_summary:\n") - pprint(api_response) + # Get role insights summary information + + results = RoleInsightsApi(api_client).get_role_insights_summary(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insights_summary(x_sail_point_experimental) + print("The response of RoleInsightsApi->get_role_insights_summary:\n") + pprint(results) except Exception as e: - print("Exception when calling RoleInsightsApi->get_role_insights_summary: %s\n" % e) + print("Exception when calling RoleInsightsApi->get_role_insights_summary: %s\n" % e) - path: /roles method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#create-role source: | - role = { + role = '''{ "owner" : { "name" : "support", "id" : "2c9180a46faadee4016fb4e018c20639", @@ -10483,38 +9766,36 @@ }, "id" : "2c918086749d78830174a1a40e121518", "requestable" : true - } # Role | - try: - # Create a Role - Result = role.from_json(role) - api_response = api_instance.create_role(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_role(Result) - print("The response of RolesApi->create_role:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling RolesApi->create_role: %s\n" % e) + }''' # Role | + try: + # Create a Role + new_role = Role.from_json(role) + results = RolesApi(api_client).create_role(role=new_role) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).create_role(new_role) + print("The response of RolesApi->create_role:\n") + pprint(results) + except Exception as e: + print("Exception when calling RolesApi->create_role: %s\n" % e) - path: /roles/bulk-delete method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#delete-bulk-roles source: | - role_bulk_delete_request = { + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_bulk_roles(Result) - print("The response of RolesApi->delete_bulk_roles:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling RolesApi->delete_bulk_roles: %s\n" % e) + }''' # RoleBulkDeleteRequest | + try: + # Delete Role(s) + new_role_bulk_delete_request = RoleBulkDeleteRequest.from_json(role_bulk_delete_request) + results = RolesApi(api_client).delete_bulk_roles(role_bulk_delete_request=new_role_bulk_delete_request) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).delete_bulk_roles(new_role_bulk_delete_request) + print("The response of RolesApi->delete_bulk_roles:\n") + pprint(results) + except Exception as e: + print("Exception when calling RolesApi->delete_bulk_roles: %s\n" % e) - path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} method: DELETE xCodeSample: @@ -10525,14 +9806,13 @@ 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. try: - # Remove a Metadata From Role. - - api_instance.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) + # Remove a Metadata From Role. + + RolesApi(api_client).delete_metadata_from_role_by_key_and_value(id=id, attribute_key=attribute_key, attribute_value=attribute_value) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling RolesApi->delete_metadata_from_role_by_key_and_value: %s\n" % e) - path: /roles/{id} method: DELETE xCodeSample: @@ -10541,14 +9821,13 @@ source: | id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role try: - # Delete a Role - - api_instance.delete_role(id) - - # Below is a request that includes all optional parameters - # api_instance.delete_role(id) + # Delete a Role + + RolesApi(api_client).delete_role(id=id) + # Below is a request that includes all optional parameters + # RolesApi(api_client).delete_role(id) except Exception as e: - print("Exception when calling RolesApi->delete_role: %s\n" % e) + print("Exception when calling RolesApi->delete_role: %s\n" % e) - path: /roles/access-model-metadata/bulk-update method: GET xCodeSample: @@ -10556,16 +9835,15 @@ label: SDK_tools/sdk/python/v2024/methods/roles#get-bulk-update-status source: | try: - # Get Bulk-Update Statuses - - api_response = api_instance.get_bulk_update_status() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_bulk_update_status() - print("The response of RolesApi->get_bulk_update_status:\n") - pprint(api_response) + # Get Bulk-Update Statuses + + results = RolesApi(api_client).get_bulk_update_status() + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).get_bulk_update_status() + print("The response of RolesApi->get_bulk_update_status:\n") + pprint(results) except Exception as e: - print("Exception when calling RolesApi->get_bulk_update_status: %s\n" % e) + print("Exception when calling RolesApi->get_bulk_update_status: %s\n" % e) - path: /roles/access-model-metadata/bulk-update/id method: GET xCodeSample: @@ -10574,16 +9852,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_bulk_update_status_by_id(id) - print("The response of RolesApi->get_bulk_update_status_by_id:\n") - pprint(api_response) + # Get Bulk-Update Status by ID + + results = RolesApi(api_client).get_bulk_update_status_by_id(id=id) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).get_bulk_update_status_by_id(id) + print("The response of RolesApi->get_bulk_update_status_by_id:\n") + pprint(results) except Exception as e: - print("Exception when calling RolesApi->get_bulk_update_status_by_id: %s\n" % e) + print("Exception when calling RolesApi->get_bulk_update_status_by_id: %s\n" % e) - path: /roles/{id} method: GET xCodeSample: @@ -10592,16 +9869,15 @@ source: | id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role try: - # Get a Role - - api_response = api_instance.get_role(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_role(id) - print("The response of RolesApi->get_role:\n") - pprint(api_response) + # Get a Role + + results = RolesApi(api_client).get_role(id=id) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).get_role(id) + print("The response of RolesApi->get_role:\n") + pprint(results) except Exception as e: - print("Exception when calling RolesApi->get_role: %s\n" % e) + print("Exception when calling RolesApi->get_role: %s\n" % e) - path: /roles/{id}/assigned-identities method: GET xCodeSample: @@ -10615,16 +9891,15 @@ filters = 'name sw Joe' # 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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, 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: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) sorters = 'aliasName,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: **id, name, aliasName, email** (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: **id, name, aliasName, email** (optional) try: - # List Identities assigned a Role - - api_response = api_instance.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) - print("The response of RolesApi->get_role_assigned_identities:\n") - pprint(api_response) + # List Identities assigned a Role + + results = RolesApi(api_client).get_role_assigned_identities(id=id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) + print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) - path: /roles/{id}/entitlements method: GET xCodeSample: @@ -10639,16 +9914,15 @@ filters = 'attribute eq \"memberOf\"' # 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.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: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) sorters = 'name,-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-results) Sorting is supported for the following fields: **name, attribute, value, created, 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-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) try: - # List role's Entitlements - - api_response = api_instance.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) - print("The response of RolesApi->get_role_entitlements:\n") - pprint(api_response) + # List role's Entitlements + + results = RolesApi(api_client).get_role_entitlements(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) + print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) - path: /roles method: GET xCodeSample: @@ -10664,16 +9938,15 @@ for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) try: - # List Roles - - api_response = api_instance.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) - print("The response of RolesApi->list_roles:\n") - pprint(api_response) + # List Roles + + results = RolesApi(api_client).list_roles() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling RolesApi->list_roles: %s\n" % e) + print("Exception when calling RolesApi->list_roles: %s\n" % e) - path: /roles/{id} method: PATCH xCodeSample: @@ -10681,24 +9954,17 @@ label: SDK_tools/sdk/python/v2024/methods/roles#patch-role source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | - - try: - # Patch a specified Role - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_role(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_role(id, Result) - print("The response of RolesApi->patch_role:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling RolesApi->patch_role: %s\n" % e) + json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]''' # List[JsonPatchOperation] | + try: + # Patch a specified Role + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = RolesApi(api_client).patch_role(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).patch_role(id, new_json_patch_operation) + print("The response of RolesApi->patch_role:\n") + pprint(results) + except Exception as e: + print("Exception when calling RolesApi->patch_role: %s\n" % e) - path: /roles/filter method: POST xCodeSample: @@ -10712,24 +9978,23 @@ sorters = 'name,-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-results) Sorting is supported for the following fields: **name, created, 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-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) - role_list_filter_dto = { + role_list_filter_dto = '''{ "ammKeyValues" : [ { "attribute" : "iscFederalClassifications", "values" : [ "secret" ] } ], "filters" : "dimensional eq false" - } # RoleListFilterDTO | (optional) - try: - # Filter Roles by Metadata - - api_response = api_instance.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) - print("The response of RolesApi->search_roles_by_filter:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling RolesApi->search_roles_by_filter: %s\n" % e) + }''' # RoleListFilterDTO | (optional) + try: + # Filter Roles by Metadata + + results = RolesApi(api_client).search_roles_by_filter() + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling RolesApi->search_roles_by_filter: %s\n" % e) - path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} method: POST xCodeSample: @@ -10740,23 +10005,22 @@ 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. try: - # Add a Metadata to Role. - - api_response = api_instance.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) - print("The response of RolesApi->update_attribute_key_and_value_to_role:\n") - pprint(api_response) + # Add a Metadata to Role. + + results = RolesApi(api_client).update_attribute_key_and_value_to_role(id=id, attribute_key=attribute_key, attribute_value=attribute_value) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling RolesApi->update_attribute_key_and_value_to_role: %s\n" % e) + print("Exception when calling RolesApi->update_attribute_key_and_value_to_role: %s\n" % e) - path: /roles/access-model-metadata/bulk-update/filter method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#update-roles-metadata-by-filter source: | - role_metadata_bulk_update_by_filter_request = { + role_metadata_bulk_update_by_filter_request = '''{ "values" : [ { "attribute" : "iscFederalClassifications", "values" : [ "topSecret" ] @@ -10764,25 +10028,24 @@ "filters" : " requestable eq false", "replaceScope" : "ALL", "operation" : "REPLACE" - } # RoleMetadataBulkUpdateByFilterRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_roles_metadata_by_filter(Result) - print("The response of RolesApi->update_roles_metadata_by_filter:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling RolesApi->update_roles_metadata_by_filter: %s\n" % e) + }''' # RoleMetadataBulkUpdateByFilterRequest | + try: + # Bulk-Update Roles' Metadata by Filters + new_role_metadata_bulk_update_by_filter_request = RoleMetadataBulkUpdateByFilterRequest.from_json(role_metadata_bulk_update_by_filter_request) + results = RolesApi(api_client).update_roles_metadata_by_filter(role_metadata_bulk_update_by_filter_request=new_role_metadata_bulk_update_by_filter_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling RolesApi->update_roles_metadata_by_filter: %s\n" % e) - path: /roles/access-model-metadata/bulk-update/ids method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#update-roles-metadata-by-ids source: | - role_metadata_bulk_update_by_id_request = { + role_metadata_bulk_update_by_id_request = '''{ "roles" : [ "b1db89554cfa431cb8b9921ea38d9367" ], "values" : [ { "attribute" : "iscFederalClassifications", @@ -10790,25 +10053,24 @@ } ], "replaceScope" : "ALL", "operation" : "REPLACE" - } # RoleMetadataBulkUpdateByIdRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_roles_metadata_by_ids(Result) - print("The response of RolesApi->update_roles_metadata_by_ids:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling RolesApi->update_roles_metadata_by_ids: %s\n" % e) + }''' # RoleMetadataBulkUpdateByIdRequest | + try: + # Bulk-Update Roles' Metadata by ID + new_role_metadata_bulk_update_by_id_request = RoleMetadataBulkUpdateByIdRequest.from_json(role_metadata_bulk_update_by_id_request) + results = RolesApi(api_client).update_roles_metadata_by_ids(role_metadata_bulk_update_by_id_request=new_role_metadata_bulk_update_by_id_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling RolesApi->update_roles_metadata_by_ids: %s\n" % e) - path: /roles/access-model-metadata/bulk-update/query method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#update-roles-metadata-by-query source: | - role_metadata_bulk_update_by_query_request = { + role_metadata_bulk_update_by_query_request = '''{ "query" : { "query\"" : { "indices" : [ "roles" ], @@ -10831,36 +10093,34 @@ } ], "replaceScope" : "ALL", "operation" : "REPLACE" - } # RoleMetadataBulkUpdateByQueryRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_roles_metadata_by_query(Result) - print("The response of RolesApi->update_roles_metadata_by_query:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling RolesApi->update_roles_metadata_by_query: %s\n" % e) + }''' # RoleMetadataBulkUpdateByQueryRequest | + try: + # Bulk-Update Roles' Metadata by Query + new_role_metadata_bulk_update_by_query_request = RoleMetadataBulkUpdateByQueryRequest.from_json(role_metadata_bulk_update_by_query_request) + results = RolesApi(api_client).update_roles_metadata_by_query(role_metadata_bulk_update_by_query_request=new_role_metadata_bulk_update_by_query_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling RolesApi->update_roles_metadata_by_query: %s\n" % e) - path: /saved-searches method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/saved-search#create-saved-search source: | - create_saved_search_request = sailpoint.v2024.CreateSavedSearchRequest() # CreateSavedSearchRequest | The saved search to persist. + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_saved_search(Result) - print("The response of SavedSearchApi->create_saved_search:\n") - pprint(api_response) + # Create a saved search + new_create_saved_search_request = CreateSavedSearchRequest.from_json(create_saved_search_request) + results = SavedSearchApi(api_client).create_saved_search(create_saved_search_request=new_create_saved_search_request) + # Below is a request that includes all optional parameters + # results = SavedSearchApi(api_client).create_saved_search(new_create_saved_search_request) + print("The response of SavedSearchApi->create_saved_search:\n") + pprint(results) except Exception as e: - print("Exception when calling SavedSearchApi->create_saved_search: %s\n" % e) + print("Exception when calling SavedSearchApi->create_saved_search: %s\n" % e) - path: /saved-searches/{id} method: DELETE xCodeSample: @@ -10869,14 +10129,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_saved_search(id) + # Delete document by ID + + SavedSearchApi(api_client).delete_saved_search(id=id) + # Below is a request that includes all optional parameters + # SavedSearchApi(api_client).delete_saved_search(id) except Exception as e: - print("Exception when calling SavedSearchApi->delete_saved_search: %s\n" % e) + print("Exception when calling SavedSearchApi->delete_saved_search: %s\n" % e) - path: /saved-searches/{id}/execute method: POST xCodeSample: @@ -10884,7 +10143,7 @@ label: SDK_tools/sdk/python/v2024/methods/saved-search#execute-saved-search source: | id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - search_arguments = { + search_arguments = '''{ "owner" : "", "recipients" : [ { "id" : "2c91808568c529c60168cca6f90c1313", @@ -10894,16 +10153,15 @@ "type" : "IDENTITY" } ], "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" - } # SearchArguments | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. + }''' # SearchArguments | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. try: - # Execute a saved search by ID - Result = search_arguments.from_json(search_arguments) - api_instance.execute_saved_search(id, Result) - - # Below is a request that includes all optional parameters - # api_instance.execute_saved_search(id, Result) + # Execute a saved search by ID + new_search_arguments = SearchArguments.from_json(search_arguments) + SavedSearchApi(api_client).execute_saved_search(id=id, search_arguments=new_search_arguments) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling SavedSearchApi->execute_saved_search: %s\n" % e) - path: /saved-searches/{id} method: GET xCodeSample: @@ -10912,16 +10170,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_saved_search(id) - print("The response of SavedSearchApi->get_saved_search:\n") - pprint(api_response) + # Return saved search by ID + + results = SavedSearchApi(api_client).get_saved_search(id=id) + # Below is a request that includes all optional parameters + # results = SavedSearchApi(api_client).get_saved_search(id) + print("The response of SavedSearchApi->get_saved_search:\n") + pprint(results) except Exception as e: - print("Exception when calling SavedSearchApi->get_saved_search: %s\n" % e) + print("Exception when calling SavedSearchApi->get_saved_search: %s\n" % e) - path: /saved-searches method: GET xCodeSample: @@ -10933,16 +10190,15 @@ 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) filters = 'owner.id eq \"7a724640-0c17-4ce9-a8c3-4a89738459c8\"' # 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: **owner.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: **owner.id**: *eq* (optional) try: - # A list of Saved Searches - - api_response = api_instance.list_saved_searches() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_saved_searches(offset, limit, count, filters) - print("The response of SavedSearchApi->list_saved_searches:\n") - pprint(api_response) + # A list of Saved Searches + + results = SavedSearchApi(api_client).list_saved_searches() + # Below is a request that includes all optional parameters + # results = SavedSearchApi(api_client).list_saved_searches(offset, limit, count, filters) + print("The response of SavedSearchApi->list_saved_searches:\n") + pprint(results) except Exception as e: - print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) + print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) - path: /saved-searches/{id} method: PUT xCodeSample: @@ -10950,7 +10206,7 @@ label: SDK_tools/sdk/python/v2024/methods/saved-search#put-saved-search source: | id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - saved_search = { + saved_search = '''{ "owner" : { "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" @@ -10994,36 +10250,34 @@ "modified" : "2018-06-25T20:22:28.104Z", "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", "fields" : [ "disabled" ] - } # SavedSearch | The saved search to persist. - try: - # Updates an existing saved search - Result = saved_search.from_json(saved_search) - api_response = api_instance.put_saved_search(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_saved_search(id, Result) - print("The response of SavedSearchApi->put_saved_search:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SavedSearchApi->put_saved_search: %s\n" % e) + }''' # SavedSearch | The saved search to persist. + try: + # Updates an existing saved search + new_saved_search = SavedSearch.from_json(saved_search) + results = SavedSearchApi(api_client).put_saved_search(id=id, saved_search=new_saved_search) + # Below is a request that includes all optional parameters + # results = SavedSearchApi(api_client).put_saved_search(id, new_saved_search) + print("The response of SavedSearchApi->put_saved_search:\n") + pprint(results) + except Exception as e: + print("Exception when calling SavedSearchApi->put_saved_search: %s\n" % e) - path: /scheduled-searches method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/scheduled-search#create-scheduled-search source: | - 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. + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_scheduled_search(Result) - print("The response of ScheduledSearchApi->create_scheduled_search:\n") - pprint(api_response) + # Create a new scheduled search + new_create_scheduled_search_request = CreateScheduledSearchRequest.from_json(create_scheduled_search_request) + results = ScheduledSearchApi(api_client).create_scheduled_search(create_scheduled_search_request=new_create_scheduled_search_request) + # Below is a request that includes all optional parameters + # results = ScheduledSearchApi(api_client).create_scheduled_search(new_create_scheduled_search_request) + print("The response of ScheduledSearchApi->create_scheduled_search:\n") + pprint(results) except Exception as e: - print("Exception when calling ScheduledSearchApi->create_scheduled_search: %s\n" % e) + print("Exception when calling ScheduledSearchApi->create_scheduled_search: %s\n" % e) - path: /scheduled-searches/{id} method: DELETE xCodeSample: @@ -11032,14 +10286,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_scheduled_search(id) + # Delete a Scheduled Search + + ScheduledSearchApi(api_client).delete_scheduled_search(id=id) + # Below is a request that includes all optional parameters + # ScheduledSearchApi(api_client).delete_scheduled_search(id) except Exception as e: - print("Exception when calling ScheduledSearchApi->delete_scheduled_search: %s\n" % e) + print("Exception when calling ScheduledSearchApi->delete_scheduled_search: %s\n" % e) - path: /scheduled-searches/{id} method: GET xCodeSample: @@ -11048,16 +10301,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_scheduled_search(id) - print("The response of ScheduledSearchApi->get_scheduled_search:\n") - pprint(api_response) + # Get a Scheduled Search + + results = ScheduledSearchApi(api_client).get_scheduled_search(id=id) + # Below is a request that includes all optional parameters + # results = ScheduledSearchApi(api_client).get_scheduled_search(id) + print("The response of ScheduledSearchApi->get_scheduled_search:\n") + pprint(results) except Exception as e: - print("Exception when calling ScheduledSearchApi->get_scheduled_search: %s\n" % e) + print("Exception when calling ScheduledSearchApi->get_scheduled_search: %s\n" % e) - path: /scheduled-searches method: GET xCodeSample: @@ -11069,16 +10321,15 @@ 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) filters = 'savedSearchId eq \"6cc0945d-9eeb-4948-9033-72d066e1153e\"' # 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: **owner.id**: *eq* **savedSearchId**: *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: **owner.id**: *eq* **savedSearchId**: *eq* (optional) try: - # List scheduled searches - - api_response = api_instance.list_scheduled_search() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_scheduled_search(offset, limit, count, filters) - print("The response of ScheduledSearchApi->list_scheduled_search:\n") - pprint(api_response) + # List scheduled searches + + results = ScheduledSearchApi(api_client).list_scheduled_search() + # Below is a request that includes all optional parameters + # results = ScheduledSearchApi(api_client).list_scheduled_search(offset, limit, count, filters) + print("The response of ScheduledSearchApi->list_scheduled_search:\n") + pprint(results) except Exception as e: - print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) + print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) - path: /scheduled-searches/{id}/unsubscribe method: POST xCodeSample: @@ -11086,19 +10337,18 @@ label: SDK_tools/sdk/python/v2024/methods/scheduled-search#unsubscribe-scheduled-search source: | id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - typed_reference = { + typed_reference = '''{ "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" - } # TypedReference | The recipient to be removed from the scheduled search. + }''' # TypedReference | The recipient to be removed from the scheduled search. try: - # Unsubscribe a recipient from Scheduled Search - Result = typed_reference.from_json(typed_reference) - api_instance.unsubscribe_scheduled_search(id, Result) - - # Below is a request that includes all optional parameters - # api_instance.unsubscribe_scheduled_search(id, Result) + # Unsubscribe a recipient from Scheduled Search + new_typed_reference = TypedReference.from_json(typed_reference) + ScheduledSearchApi(api_client).unsubscribe_scheduled_search(id=id, typed_reference=new_typed_reference) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling ScheduledSearchApi->unsubscribe_scheduled_search: %s\n" % e) - path: /scheduled-searches/{id} method: PUT xCodeSample: @@ -11106,7 +10356,7 @@ label: SDK_tools/sdk/python/v2024/methods/scheduled-search#update-scheduled-search source: | id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - scheduled_search = { + scheduled_search = '''{ "owner" : { "id" : "2c9180867624cbd7017642d8c8c81f67", "type" : "IDENTITY" @@ -11196,25 +10446,24 @@ "modified" : "", "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", "emailEmptyResults" : false - } # ScheduledSearch | The scheduled search to persist. - try: - # Update an existing Scheduled Search - Result = scheduled_search.from_json(scheduled_search) - api_response = api_instance.update_scheduled_search(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_scheduled_search(id, Result) - print("The response of ScheduledSearchApi->update_scheduled_search:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ScheduledSearchApi->update_scheduled_search: %s\n" % e) + }''' # ScheduledSearch | The scheduled search to persist. + try: + # Update an existing Scheduled Search + new_scheduled_search = ScheduledSearch.from_json(scheduled_search) + results = ScheduledSearchApi(api_client).update_scheduled_search(id=id, scheduled_search=new_scheduled_search) + # Below is a request that includes all optional parameters + # results = ScheduledSearchApi(api_client).update_scheduled_search(id, new_scheduled_search) + print("The response of ScheduledSearchApi->update_scheduled_search:\n") + pprint(results) + except Exception as e: + print("Exception when calling ScheduledSearchApi->update_scheduled_search: %s\n" % e) - path: /search/aggregate method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/search#search-aggregate source: | - search = { + search = '''{ "queryDsl" : { "match" : { "name" : "john.doe" @@ -11330,28 +10579,27 @@ "type" : "access" } } - } # Search | + }''' # Search | 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) try: - # Perform a Search Query Aggregation - Result = search.from_json(search) - api_response = api_instance.search_aggregate(Result, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.search_aggregate(Result, offset, limit, count) - print("The response of SearchApi->search_aggregate:\n") - pprint(api_response) + # Perform a Search Query Aggregation + new_search = Search.from_json(search) + results = SearchApi(api_client).search_aggregate(search=new_search) + # Below is a request that includes all optional parameters + # results = SearchApi(api_client).search_aggregate(new_search, offset, limit, count) + print("The response of SearchApi->search_aggregate:\n") + pprint(results) except Exception as e: - print("Exception when calling SearchApi->search_aggregate: %s\n" % e) + print("Exception when calling SearchApi->search_aggregate: %s\n" % e) - path: /search/count method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/search#search-count source: | - search = { + search = '''{ "queryDsl" : { "match" : { "name" : "john.doe" @@ -11467,16 +10715,15 @@ "type" : "access" } } - } # Search | + }''' # Search | try: - # Count Documents Satisfying a Query - Result = search.from_json(search) - api_instance.search_count(Result) - - # Below is a request that includes all optional parameters - # api_instance.search_count(Result) + # Count Documents Satisfying a Query + new_search = Search.from_json(search) + SearchApi(api_client).search_count(search=new_search) + # Below is a request that includes all optional parameters + # SearchApi(api_client).search_count(new_search) except Exception as e: - print("Exception when calling SearchApi->search_count: %s\n" % e) + print("Exception when calling SearchApi->search_count: %s\n" % e) - path: /search/{index}/{id} method: GET xCodeSample: @@ -11486,23 +10733,22 @@ index = 'identities' # 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.search_get(index, id) - print("The response of SearchApi->search_get:\n") - pprint(api_response) + # Get a Document by ID + + results = SearchApi(api_client).search_get(index=index, id=id) + # Below is a request that includes all optional parameters + # results = SearchApi(api_client).search_get(index, id) + print("The response of SearchApi->search_get:\n") + pprint(results) except Exception as e: - print("Exception when calling SearchApi->search_get: %s\n" % e) + print("Exception when calling SearchApi->search_get: %s\n" % e) - path: /search method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/search#search-post source: | - search = { + search = '''{ "queryDsl" : { "match" : { "name" : "john.doe" @@ -11618,21 +10864,20 @@ "type" : "access" } } - } # Search | + }''' # Search | 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) try: - # Perform Search - Result = search.from_json(search) - api_response = api_instance.search_post(Result, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.search_post(Result, offset, limit, count) - print("The response of SearchApi->search_post:\n") - pprint(api_response) + # Perform Search + new_search = Search.from_json(search) + results = SearchApi(api_client).search_post(search=new_search) + # Below is a request that includes all optional parameters + # results = SearchApi(api_client).search_post(new_search, offset, limit, count) + print("The response of SearchApi->search_post:\n") + pprint(results) except Exception as e: - print("Exception when calling SearchApi->search_post: %s\n" % e) + print("Exception when calling SearchApi->search_post: %s\n" % e) - path: /accounts/search-attribute-config method: POST xCodeSample: @@ -11640,25 +10885,24 @@ label: SDK_tools/sdk/python/v2024/methods/search-attribute-configuration#create-search-attribute-config 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') - search_attribute_config = { + search_attribute_config = '''{ "displayName" : "New Mail Attribute", "name" : "newMailAttribute", "applicationAttributes" : { "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" } - } # SearchAttributeConfig | - try: - # Create Extended Search Attributes - Result = search_attribute_config.from_json(search_attribute_config) - api_response = api_instance.create_search_attribute_config(x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_search_attribute_config(x_sail_point_experimental, Result) - print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) + }''' # SearchAttributeConfig | + try: + # Create Extended Search Attributes + new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config) + results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(x_sail_point_experimental=x_sail_point_experimental, search_attribute_config=new_search_attribute_config) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(x_sail_point_experimental, new_search_attribute_config) + print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} method: DELETE xCodeSample: @@ -11668,14 +10912,13 @@ name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration 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 Extended Search Attribute - - api_instance.delete_search_attribute_config(name, x_sail_point_experimental) - - # Below is a request that includes all optional parameters - # api_instance.delete_search_attribute_config(name, x_sail_point_experimental) + # Delete Extended Search Attribute + + SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name, x_sail_point_experimental) except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) + print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config method: GET xCodeSample: @@ -11684,16 +10927,15 @@ 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: - # List Extended Search Attributes - - api_response = api_instance.get_search_attribute_config(x_sail_point_experimental) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_search_attribute_config(x_sail_point_experimental) - print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - pprint(api_response) + # List Extended Search Attributes + + results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(x_sail_point_experimental) + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + pprint(results) except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) + print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} method: GET xCodeSample: @@ -11703,16 +10945,15 @@ name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration 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 Extended Search Attribute - - api_response = api_instance.get_single_search_attribute_config(name, x_sail_point_experimental) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_single_search_attribute_config(name, x_sail_point_experimental) - print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") - pprint(api_response) + # Get Extended Search Attribute + + results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name, x_sail_point_experimental) + print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") + pprint(results) except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) + print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} method: PATCH xCodeSample: @@ -11721,31 +10962,24 @@ source: | name = 'promotedMailAttribute' # str | Name of the search attribute configuration to patch. # str | Name of the search attribute configuration 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=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}] # List[JsonPatchOperation] | - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | - - try: - # Update Extended Search Attribute - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_search_attribute_config(name, x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_search_attribute_config(name, x_sail_point_experimental, Result) - print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) + json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | + try: + # Update Extended Search Attribute + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, x_sail_point_experimental, new_json_patch_operation) + print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) - path: /segments method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/segments#create-segment source: | - segment = { + segment = '''{ "owner" : { "name" : "support", "id" : "2c9180a46faadee4016fb4e018c20639", @@ -11768,18 +11002,17 @@ "description" : "This segment represents xyz", "active" : true, "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - } # Segment | - try: - # Create Segment - Result = segment.from_json(segment) - api_response = api_instance.create_segment(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_segment(Result) - print("The response of SegmentsApi->create_segment:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SegmentsApi->create_segment: %s\n" % e) + }''' # Segment | + try: + # Create Segment + new_segment = Segment.from_json(segment) + results = SegmentsApi(api_client).create_segment(segment=new_segment) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).create_segment(new_segment) + print("The response of SegmentsApi->create_segment:\n") + pprint(results) + except Exception as e: + print("Exception when calling SegmentsApi->create_segment: %s\n" % e) - path: /segments/{id} method: DELETE xCodeSample: @@ -11788,14 +11021,13 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. try: - # Delete Segment by ID - - api_instance.delete_segment(id) - - # Below is a request that includes all optional parameters - # api_instance.delete_segment(id) + # Delete Segment by ID + + SegmentsApi(api_client).delete_segment(id=id) + # Below is a request that includes all optional parameters + # SegmentsApi(api_client).delete_segment(id) except Exception as e: - print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) + print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) - path: /segments/{id} method: GET xCodeSample: @@ -11804,16 +11036,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_segment(id) - print("The response of SegmentsApi->get_segment:\n") - pprint(api_response) + # Get Segment by ID + + results = SegmentsApi(api_client).get_segment(id=id) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + pprint(results) except Exception as e: - print("Exception when calling SegmentsApi->get_segment: %s\n" % e) + print("Exception when calling SegmentsApi->get_segment: %s\n" % e) - path: /segments method: GET xCodeSample: @@ -11824,16 +11055,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) 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) try: - # List Segments - - api_response = api_instance.list_segments() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_segments(limit, offset, count) - print("The response of SegmentsApi->list_segments:\n") - pprint(api_response) + # List Segments + + results = SegmentsApi(api_client).list_segments() + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).list_segments(limit, offset, count) + print("The response of SegmentsApi->list_segments:\n") + pprint(results) except Exception as e: - print("Exception when calling SegmentsApi->list_segments: %s\n" % e) + print("Exception when calling SegmentsApi->list_segments: %s\n" % e) - path: /segments/{id} method: PATCH xCodeSample: @@ -11841,27 +11071,24 @@ label: SDK_tools/sdk/python/v2024/methods/segments#patch-segment source: | 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 - - try: - # Update Segment - Result = request_body.from_json(request_body) - api_response = api_instance.patch_segment(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_segment(id, Result) - print("The response of SegmentsApi->patch_segment:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) + 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 + try: + # Update Segment + new_request_body = RequestBody.from_json(request_body) + results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).patch_segment(id, new_request_body) + print("The response of SegmentsApi->patch_segment:\n") + pprint(results) + except Exception as e: + print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) - path: /service-desk-integrations method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#create-service-desk-integration source: | - service_desk_integration_dto = { + service_desk_integration_dto = '''{ "ownerRef" : "", "cluster" : "xyzzy999", "created" : "2024-01-17T18:45:25.994Z", @@ -11894,18 +11121,17 @@ }, "id" : "62945a496ef440189b1f03e3623411c8", "beforeProvisioningRule" : "" - } # ServiceDeskIntegrationDto | The specifics of a new integration to create - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_service_desk_integration(Result) - print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) + }''' # ServiceDeskIntegrationDto | The specifics of a new integration to create + try: + # Create new Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) + results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(service_desk_integration_dto=new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) + print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) - path: /service-desk-integrations/{id} method: DELETE xCodeSample: @@ -11914,14 +11140,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_service_desk_integration(id) + # Delete a Service Desk integration + + ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id=id) + # Below is a request that includes all optional parameters + # ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) + print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) - path: /service-desk-integrations/{id} method: GET xCodeSample: @@ -11930,16 +11155,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_service_desk_integration(id) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") - pprint(api_response) + # Get a Service Desk integration + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id=id) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") + pprint(results) except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) - path: /service-desk-integrations/templates/{scriptName} method: GET xCodeSample: @@ -11948,16 +11172,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_service_desk_integration_template(script_name) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") - pprint(api_response) + # Service Desk integration template by scriptName + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name=script_name) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") + pprint(results) except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) - path: /service-desk-integrations/types method: GET xCodeSample: @@ -11965,16 +11188,15 @@ label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-service-desk-integration-types source: | try: - # List Service Desk integration types - - api_response = api_instance.get_service_desk_integration_types() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_service_desk_integration_types() - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - pprint(api_response) + # List Service Desk integration types + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") + pprint(results) except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) - path: /service-desk-integrations method: GET xCodeSample: @@ -11987,16 +11209,15 @@ filters = 'name eq \"John Doe\"' # 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* **type**: *eq, in* **cluster**: *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: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) 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) try: - # List existing Service Desk integrations - - api_response = api_instance.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) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") - pprint(api_response) + # List existing Service Desk integrations + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations(offset, limit, sorters, filters, count) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") + pprint(results) except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) - path: /service-desk-integrations/status-check-configuration method: GET xCodeSample: @@ -12004,16 +11225,15 @@ label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-status-check-details source: | try: - # Get the time check configuration - - api_response = api_instance.get_status_check_details() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_status_check_details() - print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") - pprint(api_response) + # Get the time check configuration + + results = ServiceDeskIntegrationApi(api_client).get_status_check_details() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_status_check_details() + print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") + pprint(results) except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) + print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) - path: /service-desk-integrations/{id} method: PATCH xCodeSample: @@ -12021,18 +11241,17 @@ label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#patch-service-desk-integration source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_service_desk_integration(id, Result) - print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) + 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 + new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) - path: /service-desk-integrations/{id} method: PUT xCodeSample: @@ -12040,7 +11259,7 @@ label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#put-service-desk-integration source: | id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - service_desk_integration_dto = { + service_desk_integration_dto = '''{ "ownerRef" : "", "cluster" : "xyzzy999", "created" : "2024-01-17T18:45:25.994Z", @@ -12073,39 +11292,37 @@ }, "id" : "62945a496ef440189b1f03e3623411c8", "beforeProvisioningRule" : "" - } # ServiceDeskIntegrationDto | The specifics of the integration to update - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_service_desk_integration(id, Result) - print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) + }''' # ServiceDeskIntegrationDto | The specifics of the integration to update + try: + # Update a Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) + results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id=id, service_desk_integration_dto=new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) - path: /service-desk-integrations/status-check-configuration method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#update-status-check-details source: | - queued_check_config_details = { + queued_check_config_details = '''{ "provisioningStatusCheckIntervalMinutes" : "30", "provisioningMaxStatusCheckDays" : "2" - } # QueuedCheckConfigDetails | The modified time check configuration - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_status_check_details(Result) - print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) + }''' # QueuedCheckConfigDetails | The modified time check configuration + try: + # Update the time check configuration + new_queued_check_config_details = QueuedCheckConfigDetails.from_json(queued_check_config_details) + results = ServiceDeskIntegrationApi(api_client).update_status_check_details(queued_check_config_details=new_queued_check_config_details) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) + print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) - path: /sim-integrations method: POST xCodeSample: @@ -12113,7 +11330,7 @@ label: SDK_tools/sdk/python/v2024/methods/sim-integrations#create-sim-integration 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') - sim_integration_details = { + sim_integration_details = '''{ "cluster" : "xyzzy999", "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", @@ -12130,18 +11347,17 @@ "id" : "2c918085708c274401708c2a8a760001", "type" : "IDENTITY" } - } # SimIntegrationDetails | DTO containing the details of the SIM integration - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_sim_integration(x_sail_point_experimental, Result) - print("The response of SIMIntegrationsApi->create_sim_integration:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) + }''' # SimIntegrationDetails | DTO containing the details of the SIM integration + try: + # Create new SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) - path: /sim-integrations/{id} method: DELETE xCodeSample: @@ -12151,14 +11367,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_sim_integration(id, x_sail_point_experimental) + # Delete a SIM integration + + SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) - path: /sim-integrations/{id} method: GET xCodeSample: @@ -12168,16 +11383,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sim_integration(id, x_sail_point_experimental) - print("The response of SIMIntegrationsApi->get_sim_integration:\n") - pprint(api_response) + # Get a SIM integration details. + + results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + pprint(results) except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) - path: /sim-integrations method: GET xCodeSample: @@ -12186,16 +11400,15 @@ 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: - # List the existing SIM integrations. - - api_response = api_instance.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) - print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - pprint(api_response) + # List the existing SIM integrations. + + results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") + pprint(results) except Exception as e: - print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) - path: /sim-integrations/{id}/beforeProvisioningRule method: PATCH xCodeSample: @@ -12204,7 +11417,7 @@ source: | 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 = { + json_patch = '''{ "operations" : [ { "op" : "replace", "path" : "/description", @@ -12214,18 +11427,17 @@ "path" : "/description", "value" : "New description" } ] - } # 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_before_provisioning_rule(id, x_sail_point_experimental, Result) - print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + try: + # Patch a SIM beforeProvisioningRule attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) - path: /sim-integrations/{id} method: PATCH xCodeSample: @@ -12234,7 +11446,7 @@ source: | 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 = { + json_patch = '''{ "operations" : [ { "op" : "replace", "path" : "/description", @@ -12244,18 +11456,17 @@ "path" : "/description", "value" : "New description" } ] - } # 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_sim_attributes(id, x_sail_point_experimental, Result) - print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM + try: + # Patch a SIM attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) - path: /sim-integrations/{id} method: PUT xCodeSample: @@ -12264,7 +11475,7 @@ source: | 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 = { + sim_integration_details = '''{ "cluster" : "xyzzy999", "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", @@ -12281,25 +11492,24 @@ "id" : "2c918085708c274401708c2a8a760001", "type" : "IDENTITY" } - } # SimIntegrationDetails | The full DTO of the integration containing the updated model - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_sim_integration(id, x_sail_point_experimental, Result) - print("The response of SIMIntegrationsApi->put_sim_integration:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) + }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model + try: + # Update an existing SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) - path: /sod-policies method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#create-sod-policy source: | - sod_policy = { + sod_policy = '''{ "conflictingAccessCriteria" : { "leftCriteria" : { "name" : "money-in", @@ -12354,18 +11564,17 @@ "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", "state" : "ENFORCED", "externalPolicyReference" : "XYZ policy" - } # SodPolicy | - try: - # Create SOD policy - Result = sod_policy.from_json(sod_policy) - api_response = api_instance.create_sod_policy(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_sod_policy(Result) - print("The response of SODPoliciesApi->create_sod_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) + }''' # SodPolicy | + try: + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") + pprint(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) - path: /sod-policies/{id} method: DELETE xCodeSample: @@ -12375,14 +11584,13 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_instance.delete_sod_policy(id, logical) + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) - path: /sod-policies/{id}/schedule method: DELETE xCodeSample: @@ -12391,14 +11599,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_sod_policy_schedule(id) + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) - path: /sod-violation-report/{reportResultId}/download/{fileName} method: GET xCodeSample: @@ -12408,16 +11615,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") - pprint(api_response) + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) - path: /sod-violation-report/{reportResultId}/download method: GET xCodeSample: @@ -12426,16 +11632,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - pprint(api_response) + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) - path: /sod-violation-report method: GET xCodeSample: @@ -12443,16 +11648,15 @@ label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-all-report-run-status source: | try: - # Get multi-report run task status - - api_response = api_instance.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() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - pprint(api_response) + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) - path: /sod-policies/{id} method: GET xCodeSample: @@ -12461,16 +11665,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - pprint(api_response) + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) - path: /sod-policies/{id}/schedule method: GET xCodeSample: @@ -12479,16 +11682,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - pprint(api_response) + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) - path: /sod-policies/sod-violation-report-status/{reportResultId} method: GET xCodeSample: @@ -12497,16 +11699,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - pprint(api_response) + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) - path: /sod-policies/{id}/violation-report method: GET xCodeSample: @@ -12515,16 +11716,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - pprint(api_response) + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) - path: /sod-policies method: GET xCodeSample: @@ -12537,16 +11737,15 @@ filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # 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, in* **state**: *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: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) sorters = 'id,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: **id, name, created, modified, description** (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: **id, name, created, modified, description** (optional) try: - # List SOD policies - - api_response = api_instance.list_sod_policies() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") - pprint(api_response) + # List SOD policies + + results = SODPoliciesApi(api_client).list_sod_policies() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) - path: /sod-policies/{id} method: PATCH xCodeSample: @@ -12554,24 +11753,17 @@ label: SDK_tools/sdk/python/v2024/methods/sod-policies#patch-sod-policy source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # 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 - - try: - # Patch SOD policy by ID - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_sod_policy(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_sod_policy(id, Result) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) + json_patch_operation = '''[{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 + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + pprint(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) - path: /sod-policies/{id}/schedule method: PUT xCodeSample: @@ -12579,7 +11771,7 @@ label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-policy-schedule source: | 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 = { + sod_policy_schedule = '''{ "schedule" : { "hours" : { "accountMatchConfig" : { @@ -12664,18 +11856,17 @@ "modified" : "2020-01-01T00:00:00Z", "description" : "Schedule for policy xyz", "emailEmptyResults" : false - } # SodPolicySchedule | - try: - # Update SOD Policy schedule - Result = sod_policy_schedule.from_json(sod_policy_schedule) - api_response = api_instance.put_policy_schedule(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_policy_schedule(id, Result) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + pprint(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) - path: /sod-policies/{id} method: PUT xCodeSample: @@ -12683,7 +11874,7 @@ label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-sod-policy source: | 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 = { + sod_policy = '''{ "conflictingAccessCriteria" : { "leftCriteria" : { "name" : "money-in", @@ -12738,18 +11929,17 @@ "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", "state" : "ENFORCED", "externalPolicyReference" : "XYZ policy" - } # SodPolicy | - try: - # Update SOD policy by ID - Result = sod_policy.from_json(sod_policy) - api_response = api_instance.put_sod_policy(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_sod_policy(id, Result) - print("The response of SODPoliciesApi->put_sod_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + pprint(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) - path: /sod-policies/{id}/evaluate method: POST xCodeSample: @@ -12758,36 +11948,34 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_evaluate_sod_policy(id) - print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") - pprint(api_response) + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) - path: /sod-violation-report/run method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-all-policies-for-org source: | - multi_policy_request = { + 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) - try: - # Runs all policies for org - - api_response = api_instance.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) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) - path: /sod-policies/{id}/violation-report/run method: POST xCodeSample: @@ -12796,23 +11984,22 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - pprint(api_response) + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) - path: /sod-violations/predict method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-predict-sod-violations source: | - identity_with_new_access = { + identity_with_new_access = '''{ "identityId" : "2c91808568c529c60168cca6f90c1313", "accessRefs" : [ { "type" : "ENTITLEMENT", @@ -12823,36 +12010,34 @@ "id" : "2c918087682f9a86016839c0509c1ab2", "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" } ] - } # IdentityWithNewAccess | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_predict_sod_violations(Result) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + pprint(results) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) - path: /sod-violations/check method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-violation-check source: | - 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 | + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_violation_check(Result) - print("The response of SODViolationsApi->start_violation_check:\n") - pprint(api_response) + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + pprint(results) except Exception as e: - print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -12860,7 +12045,7 @@ label: SDK_tools/sdk/python/v2024/methods/sources#create-provisioning-policy source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id - provisioning_policy_dto = { + provisioning_policy_dto = '''{ "name" : "example provisioning policy for inactive identities", "description" : "this provisioning policy creates access based on an identity going inactive", "fields" : [ { @@ -12899,25 +12084,24 @@ "type" : "string" } ], "usageType" : "CREATE" - } # ProvisioningPolicyDto | - try: - # Create Provisioning Policy - Result = provisioning_policy_dto.from_json(provisioning_policy_dto) - api_response = api_instance.create_provisioning_policy(source_id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_provisioning_policy(source_id, Result) - print("The response of SourcesApi->create_provisioning_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) + }''' # ProvisioningPolicyDto | + try: + # Create Provisioning Policy + new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto) + results = SourcesApi(api_client).create_provisioning_policy(source_id=source_id, provisioning_policy_dto=new_provisioning_policy_dto) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).create_provisioning_policy(source_id, new_provisioning_policy_dto) + print("The response of SourcesApi->create_provisioning_policy:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) - path: /sources method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#create-source source: | - source = { + source = '''{ "cluster" : { "name" : "Corporate Cluster", "id" : "2c9180866166b5b0016167c32ef31a66", @@ -12999,19 +12183,18 @@ }, "status" : "SOURCE_STATE_HEALTHY", "since" : "2021-09-28T15:48:29.3801666300Z" - } # Source | + }''' # Source | provision_as_csv = false # bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) # bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) try: - # Creates a source in IdentityNow. - Result = source.from_json(source) - api_response = api_instance.create_source(Result, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_source(Result, provision_as_csv) - print("The response of SourcesApi->create_source:\n") - pprint(api_response) + # Creates a source in IdentityNow. + new_source = Source.from_json(source) + results = SourcesApi(api_client).create_source(source=new_source) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).create_source(new_source, provision_as_csv) + print("The response of SourcesApi->create_source:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->create_source: %s\n" % e) + print("Exception when calling SourcesApi->create_source: %s\n" % e) - path: /sources/{sourceId}/schedules method: POST xCodeSample: @@ -13019,18 +12202,17 @@ label: SDK_tools/sdk/python/v2024/methods/sources#create-source-schedule source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_source_schedule(source_id, Result) - print("The response of SourcesApi->create_source_schedule:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->create_source_schedule: %s\n" % e) + schedule1 = '''sailpoint.v2024.Schedule1()''' # Schedule1 | + try: + # Create Schedule on Source + new_schedule1 = Schedule1.from_json(schedule1) + results = SourcesApi(api_client).create_source_schedule(source_id=source_id, schedule1=new_schedule1) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).create_source_schedule(source_id, new_schedule1) + print("The response of SourcesApi->create_source_schedule:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->create_source_schedule: %s\n" % e) - path: /sources/{sourceId}/schemas method: POST xCodeSample: @@ -13038,18 +12220,17 @@ label: SDK_tools/sdk/python/v2024/methods/sources#create-source-schema source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_source_schema(source_id, Result) - print("The response of SourcesApi->create_source_schema:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) + model_schema = '''sailpoint.v2024.ModelSchema()''' # ModelSchema | + try: + # Create Schema on Source + new_model_schema = ModelSchema.from_json(model_schema) + results = SourcesApi(api_client).create_source_schema(source_id=source_id, model_schema=new_model_schema) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).create_source_schema(source_id, new_model_schema) + print("The response of SourcesApi->create_source_schema:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) - path: /sources/{id}/remove-accounts method: POST xCodeSample: @@ -13059,16 +12240,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_accounts_async(id, x_sail_point_experimental) - print("The response of SourcesApi->delete_accounts_async:\n") - pprint(api_response) + # Remove All Accounts in a Source + + results = SourcesApi(api_client).delete_accounts_async(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).delete_accounts_async(id, x_sail_point_experimental) + print("The response of SourcesApi->delete_accounts_async:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->delete_accounts_async: %s\n" % e) + print("Exception when calling SourcesApi->delete_accounts_async: %s\n" % e) - path: /sources/{sourceId}/native-change-detection-config method: DELETE xCodeSample: @@ -13078,14 +12258,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_native_change_detection_config(id, x_sail_point_experimental) + # Delete Native Change Detection Configuration + + SourcesApi(api_client).delete_native_change_detection_config(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling SourcesApi->delete_native_change_detection_config: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} method: DELETE xCodeSample: @@ -13095,14 +12274,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_provisioning_policy(source_id, usage_type) + # Delete Provisioning Policy by UsageType + + SourcesApi(api_client).delete_provisioning_policy(source_id=source_id, usage_type=usage_type) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling SourcesApi->delete_provisioning_policy: %s\n" % e) - path: /sources/{id} method: DELETE xCodeSample: @@ -13111,16 +12289,15 @@ source: | id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. try: - # Delete Source by ID - - api_response = api_instance.delete_source(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_source(id) - print("The response of SourcesApi->delete_source:\n") - pprint(api_response) + # Delete Source by ID + + results = SourcesApi(api_client).delete_source(id=id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).delete_source(id) + print("The response of SourcesApi->delete_source:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->delete_source: %s\n" % e) + print("Exception when calling SourcesApi->delete_source: %s\n" % e) - path: /sources/{sourceId}/schedules/{scheduleType} method: DELETE xCodeSample: @@ -13130,14 +12307,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_source_schedule(source_id, schedule_type) + # Delete Source Schedule by type. + + SourcesApi(api_client).delete_source_schedule(source_id=source_id, schedule_type=schedule_type) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling SourcesApi->delete_source_schedule: %s\n" % e) - path: /sources/{sourceId}/schemas/{schemaId} method: DELETE xCodeSample: @@ -13147,14 +12323,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_source_schema(source_id, schema_id) + # Delete Source Schema by ID + + SourcesApi(api_client).delete_source_schema(source_id=source_id, schema_id=schema_id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling SourcesApi->delete_source_schema: %s\n" % e) - path: /sources/{id}/schemas/accounts method: GET xCodeSample: @@ -13163,14 +12338,13 @@ source: | id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id try: - # Downloads source accounts schema template - - api_instance.get_accounts_schema(id) - - # Below is a request that includes all optional parameters - # api_instance.get_accounts_schema(id) + # Downloads source accounts schema template + + SourcesApi(api_client).get_accounts_schema(id=id) + # Below is a request that includes all optional parameters + # SourcesApi(api_client).get_accounts_schema(id) except Exception as e: - print("Exception when calling SourcesApi->get_accounts_schema: %s\n" % e) + print("Exception when calling SourcesApi->get_accounts_schema: %s\n" % e) - path: /sources/{id}/correlation-config method: GET xCodeSample: @@ -13179,16 +12353,15 @@ source: | id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id try: - # Get Source Correlation Configuration - - api_response = api_instance.get_correlation_config(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_correlation_config(id) - print("The response of SourcesApi->get_correlation_config:\n") - pprint(api_response) + # Get Source Correlation Configuration + + results = SourcesApi(api_client).get_correlation_config(id=id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_correlation_config(id) + print("The response of SourcesApi->get_correlation_config:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_correlation_config: %s\n" % e) + print("Exception when calling SourcesApi->get_correlation_config: %s\n" % e) - path: /sources/{id}/schemas/entitlements method: GET xCodeSample: @@ -13198,14 +12371,13 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_instance.get_entitlements_schema(id, schema_name) + # Downloads source entitlements schema template + + SourcesApi(api_client).get_entitlements_schema(id=id) + # Below is a request that includes all optional parameters + # SourcesApi(api_client).get_entitlements_schema(id, schema_name) except Exception as e: - print("Exception when calling SourcesApi->get_entitlements_schema: %s\n" % e) + print("Exception when calling SourcesApi->get_entitlements_schema: %s\n" % e) - path: /sources/{sourceId}/native-change-detection-config method: GET xCodeSample: @@ -13215,16 +12387,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_native_change_detection_config(id, x_sail_point_experimental) - print("The response of SourcesApi->get_native_change_detection_config:\n") - pprint(api_response) + # Native Change Detection Configuration + + results = SourcesApi(api_client).get_native_change_detection_config(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling SourcesApi->get_native_change_detection_config: %s\n" % e) + print("Exception when calling SourcesApi->get_native_change_detection_config: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} method: GET xCodeSample: @@ -13234,16 +12405,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_provisioning_policy(source_id, usage_type) - print("The response of SourcesApi->get_provisioning_policy:\n") - pprint(api_response) + # Get Provisioning Policy by UsageType + + results = SourcesApi(api_client).get_provisioning_policy(source_id=source_id, usage_type=usage_type) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_provisioning_policy(source_id, usage_type) + print("The response of SourcesApi->get_provisioning_policy:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) + print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) - path: /sources/{id} method: GET xCodeSample: @@ -13252,16 +12422,15 @@ source: | id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. try: - # Get Source by ID - - api_response = api_instance.get_source(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_source(id) - print("The response of SourcesApi->get_source:\n") - pprint(api_response) + # Get Source by ID + + results = SourcesApi(api_client).get_source(id=id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source(id) + print("The response of SourcesApi->get_source:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_source: %s\n" % e) + print("Exception when calling SourcesApi->get_source: %s\n" % e) - path: /sources/{id}/attribute-sync-config method: GET xCodeSample: @@ -13271,16 +12440,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_attr_sync_config(id, x_sail_point_experimental) - print("The response of SourcesApi->get_source_attr_sync_config:\n") - pprint(api_response) + # Attribute Sync Config + + results = SourcesApi(api_client).get_source_attr_sync_config(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling SourcesApi->get_source_attr_sync_config: %s\n" % e) + print("Exception when calling SourcesApi->get_source_attr_sync_config: %s\n" % e) - path: /sources/{id}/connectors/source-config method: GET xCodeSample: @@ -13291,16 +12459,15 @@ x_sail_point_experimental = 'true' # 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) try: - # Gets source config with language translations - - api_response = api_instance.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) - print("The response of SourcesApi->get_source_config:\n") - pprint(api_response) + # Gets source config with language translations + + results = SourcesApi(api_client).get_source_config(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_config(id, x_sail_point_experimental, locale) + print("The response of SourcesApi->get_source_config:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_source_config: %s\n" % e) + print("Exception when calling SourcesApi->get_source_config: %s\n" % e) - path: /sources/{id}/entitlement-request-config method: GET xCodeSample: @@ -13309,16 +12476,15 @@ 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: - # Get Source Entitlement Request Configuration - - api_response = api_instance.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) - print("The response of SourcesApi->get_source_entitlement_request_config:\n") - pprint(api_response) + # Get Source Entitlement Request Configuration + + results = SourcesApi(api_client).get_source_entitlement_request_config(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling SourcesApi->get_source_entitlement_request_config: %s\n" % e) + print("Exception when calling SourcesApi->get_source_entitlement_request_config: %s\n" % e) - path: /sources/{sourceId}/source-health method: GET xCodeSample: @@ -13327,16 +12493,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_health(source_id) - print("The response of SourcesApi->get_source_health:\n") - pprint(api_response) + # Fetches source health by id + + results = SourcesApi(api_client).get_source_health(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_health(source_id) + print("The response of SourcesApi->get_source_health:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_source_health: %s\n" % e) + print("Exception when calling SourcesApi->get_source_health: %s\n" % e) - path: /sources/{sourceId}/schedules/{scheduleType} method: GET xCodeSample: @@ -13346,16 +12511,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_schedule(source_id, schedule_type) - print("The response of SourcesApi->get_source_schedule:\n") - pprint(api_response) + # Get Source Schedule by Type + + results = SourcesApi(api_client).get_source_schedule(source_id=source_id, schedule_type=schedule_type) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_schedule(source_id, schedule_type) + print("The response of SourcesApi->get_source_schedule:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_source_schedule: %s\n" % e) + print("Exception when calling SourcesApi->get_source_schedule: %s\n" % e) - path: /sources/{sourceId}/schedules method: GET xCodeSample: @@ -13364,16 +12528,15 @@ source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. try: - # List Schedules on Source - - api_response = api_instance.get_source_schedules(source_id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_schedules(source_id) - print("The response of SourcesApi->get_source_schedules:\n") - pprint(api_response) + # List Schedules on Source + + results = SourcesApi(api_client).get_source_schedules(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_schedules(source_id) + print("The response of SourcesApi->get_source_schedules:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_source_schedules: %s\n" % e) + print("Exception when calling SourcesApi->get_source_schedules: %s\n" % e) - path: /sources/{sourceId}/schemas/{schemaId} method: GET xCodeSample: @@ -13383,16 +12546,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_schema(source_id, schema_id) - print("The response of SourcesApi->get_source_schema:\n") - pprint(api_response) + # Get Source Schema by ID + + results = SourcesApi(api_client).get_source_schema(source_id=source_id, schema_id=schema_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_schema(source_id, schema_id) + print("The response of SourcesApi->get_source_schema:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) + print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) - path: /sources/{sourceId}/schemas method: GET xCodeSample: @@ -13403,16 +12565,15 @@ 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) try: - # List Schemas on Source - - api_response = api_instance.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) - print("The response of SourcesApi->get_source_schemas:\n") - pprint(api_response) + # List Schemas on Source + + results = SourcesApi(api_client).get_source_schemas(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) + print("The response of SourcesApi->get_source_schemas:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) + print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) - path: /sources/{id}/load-accounts method: POST xCodeSample: @@ -13424,16 +12585,15 @@ 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) try: - # Account Aggregation - - api_response = api_instance.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) - print("The response of SourcesApi->import_accounts:\n") - pprint(api_response) + # Account Aggregation + + results = SourcesApi(api_client).import_accounts(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_accounts(id, x_sail_point_experimental, file, disable_optimization) + print("The response of SourcesApi->import_accounts:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->import_accounts: %s\n" % e) + print("Exception when calling SourcesApi->import_accounts: %s\n" % e) - path: /sources/{id}/schemas/accounts method: POST xCodeSample: @@ -13443,16 +12603,15 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.import_accounts_schema(id, file) - print("The response of SourcesApi->import_accounts_schema:\n") - pprint(api_response) + # Uploads source accounts schema template + + results = SourcesApi(api_client).import_accounts_schema(id=id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_accounts_schema(id, file) + print("The response of SourcesApi->import_accounts_schema:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->import_accounts_schema: %s\n" % e) + print("Exception when calling SourcesApi->import_accounts_schema: %s\n" % e) - path: /sources/{sourceId}/upload-connector-file method: POST xCodeSample: @@ -13462,16 +12621,15 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.import_connector_file(source_id, file) - print("The response of SourcesApi->import_connector_file:\n") - pprint(api_response) + # Upload connector file to source + + results = SourcesApi(api_client).import_connector_file(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_connector_file(source_id, file) + print("The response of SourcesApi->import_connector_file:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->import_connector_file: %s\n" % e) + print("Exception when calling SourcesApi->import_connector_file: %s\n" % e) - path: /sources/{id}/schemas/entitlements method: POST xCodeSample: @@ -13482,16 +12640,15 @@ schema_name = '?schemaName=group' # str | Name of entitlement schema (optional) # str | Name of entitlement schema (optional) file = None # bytearray | (optional) # bytearray | (optional) try: - # Uploads source entitlements schema template - - api_response = api_instance.import_entitlements_schema(id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.import_entitlements_schema(id, schema_name, file) - print("The response of SourcesApi->import_entitlements_schema:\n") - pprint(api_response) + # Uploads source entitlements schema template + + results = SourcesApi(api_client).import_entitlements_schema(id=id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_entitlements_schema(id, schema_name, file) + print("The response of SourcesApi->import_entitlements_schema:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->import_entitlements_schema: %s\n" % e) + print("Exception when calling SourcesApi->import_entitlements_schema: %s\n" % e) - path: /sources/{id}/load-uncorrelated-accounts method: POST xCodeSample: @@ -13502,16 +12659,15 @@ x_sail_point_experimental = 'true' # 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) try: - # Process Uncorrelated Accounts - - api_response = api_instance.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) - print("The response of SourcesApi->import_uncorrelated_accounts:\n") - pprint(api_response) + # Process Uncorrelated Accounts + + results = SourcesApi(api_client).import_uncorrelated_accounts(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_uncorrelated_accounts(id, x_sail_point_experimental, file) + print("The response of SourcesApi->import_uncorrelated_accounts:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->import_uncorrelated_accounts: %s\n" % e) + print("Exception when calling SourcesApi->import_uncorrelated_accounts: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: GET xCodeSample: @@ -13520,16 +12676,15 @@ source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id try: - # Lists ProvisioningPolicies - - api_response = api_instance.list_provisioning_policies(source_id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_provisioning_policies(source_id) - print("The response of SourcesApi->list_provisioning_policies:\n") - pprint(api_response) + # Lists ProvisioningPolicies + + results = SourcesApi(api_client).list_provisioning_policies(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).list_provisioning_policies(source_id) + print("The response of SourcesApi->list_provisioning_policies:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) + print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) - path: /sources method: GET xCodeSample: @@ -13544,16 +12699,15 @@ for_subadmin = 'name' # str | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) # str | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) include_idn_source = False # bool | Include the IdentityNow source in the response. (optional) (default to False) # bool | Include the IdentityNow source in the response. (optional) (default to False) try: - # Lists all sources in IdentityNow. - - api_response = api_instance.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) - print("The response of SourcesApi->list_sources:\n") - pprint(api_response) + # Lists all sources in IdentityNow. + + results = SourcesApi(api_client).list_sources() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling SourcesApi->list_sources: %s\n" % e) + print("Exception when calling SourcesApi->list_sources: %s\n" % e) - path: /sources/{sourceId}/connector/peek-resource-objects method: POST xCodeSample: @@ -13562,21 +12716,20 @@ source: | 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 = { + resource_objects_request = '''{ "maxCount" : 100, "objectType" : "group" - } # ResourceObjectsRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.peek_resource_objects(source_id, x_sail_point_experimental, Result) - print("The response of SourcesApi->peek_resource_objects:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->peek_resource_objects: %s\n" % e) + }''' # ResourceObjectsRequest | + try: + # Peek source connector's resource objects + new_resource_objects_request = ResourceObjectsRequest.from_json(resource_objects_request) + results = SourcesApi(api_client).peek_resource_objects(source_id=source_id, x_sail_point_experimental=x_sail_point_experimental, resource_objects_request=new_resource_objects_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SourcesApi->peek_resource_objects: %s\n" % e) - path: /sources/{sourceId}/connector/ping-cluster method: POST xCodeSample: @@ -13586,16 +12739,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.ping_cluster(source_id, x_sail_point_experimental) - print("The response of SourcesApi->ping_cluster:\n") - pprint(api_response) + # Ping cluster for source connector + + results = SourcesApi(api_client).ping_cluster(source_id=source_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).ping_cluster(source_id, x_sail_point_experimental) + print("The response of SourcesApi->ping_cluster:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->ping_cluster: %s\n" % e) + print("Exception when calling SourcesApi->ping_cluster: %s\n" % e) - path: /sources/{id}/correlation-config method: PUT xCodeSample: @@ -13603,7 +12755,7 @@ label: SDK_tools/sdk/python/v2024/methods/sources#put-correlation-config source: | id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id - correlation_config = { + correlation_config = '''{ "attributeAssignments" : [ { "filterString" : "first_name == \"John\"", "ignoreCase" : false, @@ -13623,18 +12775,17 @@ } ], "name" : "Source [source] Account Correlation", "id" : "2c9180835d191a86015d28455b4a2329" - } # CorrelationConfig | - try: - # Update Source Correlation Configuration - Result = correlation_config.from_json(correlation_config) - api_response = api_instance.put_correlation_config(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_correlation_config(id, Result) - print("The response of SourcesApi->put_correlation_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->put_correlation_config: %s\n" % e) + }''' # CorrelationConfig | + try: + # Update Source Correlation Configuration + new_correlation_config = CorrelationConfig.from_json(correlation_config) + results = SourcesApi(api_client).put_correlation_config(id=id, correlation_config=new_correlation_config) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).put_correlation_config(id, new_correlation_config) + print("The response of SourcesApi->put_correlation_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_correlation_config: %s\n" % e) - path: /sources/{sourceId}/native-change-detection-config method: PUT xCodeSample: @@ -13643,25 +12794,24 @@ source: | 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 = { + native_change_detection_config = '''{ "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], "allNonEntitlementAttributes" : false, "allEntitlements" : false, "enabled" : true - } # NativeChangeDetectionConfig | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_native_change_detection_config(id, x_sail_point_experimental, Result) - print("The response of SourcesApi->put_native_change_detection_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->put_native_change_detection_config: %s\n" % e) + }''' # NativeChangeDetectionConfig | + try: + # Update Native Change Detection Configuration + new_native_change_detection_config = NativeChangeDetectionConfig.from_json(native_change_detection_config) + results = SourcesApi(api_client).put_native_change_detection_config(id=id, x_sail_point_experimental=x_sail_point_experimental, native_change_detection_config=new_native_change_detection_config) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SourcesApi->put_native_change_detection_config: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} method: PUT xCodeSample: @@ -13670,7 +12820,7 @@ source: | 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 = { + provisioning_policy_dto = '''{ "name" : "example provisioning policy for inactive identities", "description" : "this provisioning policy creates access based on an identity going inactive", "fields" : [ { @@ -13709,18 +12859,17 @@ "type" : "string" } ], "usageType" : "CREATE" - } # ProvisioningPolicyDto | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) - print("The response of SourcesApi->put_provisioning_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) + }''' # ProvisioningPolicyDto | + try: + # Update Provisioning Policy by UsageType + new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto) + results = SourcesApi(api_client).put_provisioning_policy(source_id=source_id, usage_type=usage_type, provisioning_policy_dto=new_provisioning_policy_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) - path: /sources/{id} method: PUT xCodeSample: @@ -13728,7 +12877,7 @@ label: SDK_tools/sdk/python/v2024/methods/sources#put-source source: | id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. - source = { + source = '''{ "cluster" : { "name" : "Corporate Cluster", "id" : "2c9180866166b5b0016167c32ef31a66", @@ -13810,18 +12959,17 @@ }, "status" : "SOURCE_STATE_HEALTHY", "since" : "2021-09-28T15:48:29.3801666300Z" - } # Source | - try: - # Update Source (Full) - Result = source.from_json(source) - api_response = api_instance.put_source(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_source(id, Result) - print("The response of SourcesApi->put_source:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->put_source: %s\n" % e) + }''' # Source | + try: + # Update Source (Full) + new_source = Source.from_json(source) + results = SourcesApi(api_client).put_source(id=id, source=new_source) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).put_source(id, new_source) + print("The response of SourcesApi->put_source:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_source: %s\n" % e) - path: /sources/{id}/attribute-sync-config method: PUT xCodeSample: @@ -13830,7 +12978,7 @@ source: | 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 = { + attr_sync_source_config = '''{ "attributes" : [ { "name" : "email", "displayName" : "Email", @@ -13847,18 +12995,17 @@ "id" : "2c9180835d191a86015d28455b4b232a", "type" : "SOURCE" } - } # AttrSyncSourceConfig | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_source_attr_sync_config(id, x_sail_point_experimental, Result) - print("The response of SourcesApi->put_source_attr_sync_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->put_source_attr_sync_config: %s\n" % e) + }''' # AttrSyncSourceConfig | + try: + # Update Attribute Sync Config + new_attr_sync_source_config = AttrSyncSourceConfig.from_json(attr_sync_source_config) + results = SourcesApi(api_client).put_source_attr_sync_config(id=id, x_sail_point_experimental=x_sail_point_experimental, attr_sync_source_config=new_attr_sync_source_config) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SourcesApi->put_source_attr_sync_config: %s\n" % e) - path: /sources/{sourceId}/schemas/{schemaId} method: PUT xCodeSample: @@ -13867,18 +13014,17 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_source_schema(source_id, schema_id, Result) - print("The response of SourcesApi->put_source_schema:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) + model_schema = '''sailpoint.v2024.ModelSchema()''' # ModelSchema | + try: + # Update Source Schema (Full) + new_model_schema = ModelSchema.from_json(model_schema) + results = SourcesApi(api_client).put_source_schema(source_id=source_id, schema_id=schema_id, model_schema=new_model_schema) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).put_source_schema(source_id, schema_id, new_model_schema) + print("The response of SourcesApi->put_source_schema:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) - path: /sources/{id}/synchronize-attributes method: POST xCodeSample: @@ -13888,16 +13034,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.sync_attributes_for_source(id, x_sail_point_experimental) - print("The response of SourcesApi->sync_attributes_for_source:\n") - pprint(api_response) + # Synchronize single source attributes. + + results = SourcesApi(api_client).sync_attributes_for_source(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).sync_attributes_for_source(id, x_sail_point_experimental) + print("The response of SourcesApi->sync_attributes_for_source:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->sync_attributes_for_source: %s\n" % e) + print("Exception when calling SourcesApi->sync_attributes_for_source: %s\n" % e) - path: /sources/{sourceId}/connector/test-configuration method: POST xCodeSample: @@ -13907,16 +13052,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.test_source_configuration(source_id, x_sail_point_experimental) - print("The response of SourcesApi->test_source_configuration:\n") - pprint(api_response) + # Test configuration for source connector + + results = SourcesApi(api_client).test_source_configuration(source_id=source_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).test_source_configuration(source_id, x_sail_point_experimental) + print("The response of SourcesApi->test_source_configuration:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->test_source_configuration: %s\n" % e) + print("Exception when calling SourcesApi->test_source_configuration: %s\n" % e) - path: /sources/{sourceId}/connector/check-connection method: POST xCodeSample: @@ -13926,16 +13070,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.test_source_connection(source_id, x_sail_point_experimental) - print("The response of SourcesApi->test_source_connection:\n") - pprint(api_response) + # Check connection for source connector. + + results = SourcesApi(api_client).test_source_connection(source_id=source_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).test_source_connection(source_id, x_sail_point_experimental) + print("The response of SourcesApi->test_source_connection:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->test_source_connection: %s\n" % e) + print("Exception when calling SourcesApi->test_source_connection: %s\n" % e) - path: /sources/{sourceId}/password-policies method: PATCH xCodeSample: @@ -13943,20 +13086,17 @@ label: SDK_tools/sdk/python/v2024/methods/sources#update-password-policy-holders source: | 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] | - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_password_policy_holders(source_id, Result) - print("The response of SourcesApi->update_password_policy_holders:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->update_password_policy_holders: %s\n" % e) + password_policy_holders_dto_inner = '''[sailpoint.v2024.PasswordPolicyHoldersDtoInner()]''' # List[PasswordPolicyHoldersDtoInner] | + try: + # Update Password Policy + new_password_policy_holders_dto_inner = PasswordPolicyHoldersDtoInner.from_json(password_policy_holders_dto_inner) + results = SourcesApi(api_client).update_password_policy_holders(source_id=source_id, password_policy_holders_dto_inner=new_password_policy_holders_dto_inner) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SourcesApi->update_password_policy_holders: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/bulk-update method: POST xCodeSample: @@ -13964,59 +13104,17 @@ label: SDK_tools/sdk/python/v2024/methods/sources#update-provisioning-policies-in-bulk source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - [sailpoint.v2024.ProvisioningPolicyDto()] # List[ProvisioningPolicyDto] | - provisioning_policy_dto = { - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - } # List[ProvisioningPolicyDto] | - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) - print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) + provisioning_policy_dto = '''[sailpoint.v2024.ProvisioningPolicyDto()]''' # List[ProvisioningPolicyDto] | + try: + # Bulk Update Provisioning Policies + new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto) + results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id=source_id, provisioning_policy_dto=new_provisioning_policy_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} method: PATCH xCodeSample: @@ -14025,24 +13123,17 @@ source: | 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. - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) - print("The response of SourcesApi->update_provisioning_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) + json_patch_operation = '''[{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. + try: + # Partial update of Provisioning Policy + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SourcesApi(api_client).update_provisioning_policy(source_id=source_id, usage_type=usage_type, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) - path: /sources/{id} method: PATCH xCodeSample: @@ -14050,24 +13141,17 @@ label: SDK_tools/sdk/python/v2024/methods/sources#update-source source: | 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 = { - "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). - - try: - # Update Source (Partial) - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_source(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_source(id, Result) - print("The response of SourcesApi->update_source:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->update_source: %s\n" % e) + json_patch_operation = '''[{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). + try: + # Update Source (Partial) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SourcesApi(api_client).update_source(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).update_source(id, new_json_patch_operation) + print("The response of SourcesApi->update_source:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->update_source: %s\n" % e) - path: /sources/{id}/entitlement-request-config method: PUT xCodeSample: @@ -14075,7 +13159,7 @@ label: SDK_tools/sdk/python/v2024/methods/sources#update-source-entitlement-request-config 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') - source_entitlement_request_config = { + source_entitlement_request_config = '''{ "accessRequestConfig" : { "denialCommentRequired" : false, "approvalSchemes" : [ { @@ -14087,18 +13171,17 @@ } ], "requestCommentRequired" : true } - } # SourceEntitlementRequestConfig | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_source_entitlement_request_config(x_sail_point_experimental, Result) - print("The response of SourcesApi->update_source_entitlement_request_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->update_source_entitlement_request_config: %s\n" % e) + }''' # SourceEntitlementRequestConfig | + try: + # Update Source Entitlement Request Configuration + new_source_entitlement_request_config = SourceEntitlementRequestConfig.from_json(source_entitlement_request_config) + results = SourcesApi(api_client).update_source_entitlement_request_config(x_sail_point_experimental=x_sail_point_experimental, source_entitlement_request_config=new_source_entitlement_request_config) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SourcesApi->update_source_entitlement_request_config: %s\n" % e) - path: /sources/{sourceId}/schedules/{scheduleType} method: PATCH xCodeSample: @@ -14107,24 +13190,17 @@ source: | 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. - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | The JSONPatch payload used to update the schedule. - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_source_schedule(source_id, schedule_type, Result) - print("The response of SourcesApi->update_source_schedule:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->update_source_schedule: %s\n" % e) + json_patch_operation = '''[{op=replace, path=/cronExpression, value=0 0 6 * * ?}]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the schedule. + try: + # Update Source Schedule (Partial) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SourcesApi(api_client).update_source_schedule(source_id=source_id, schedule_type=schedule_type, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SourcesApi->update_source_schedule: %s\n" % e) - path: /sources/{sourceId}/schemas/{schemaId} method: PATCH xCodeSample: @@ -14133,24 +13209,17 @@ source: | 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. - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_source_schema(source_id, schema_id, Result) - print("The response of SourcesApi->update_source_schema:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) + json_patch_operation = '''[{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. + try: + # Update Source Schema (Partial) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SourcesApi(api_client).update_source_schema(source_id=source_id, schema_id=schema_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) - path: /source-usages/{sourceId}/status method: GET xCodeSample: @@ -14159,16 +13228,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") - pprint(api_response) + # Finds status of source usage + + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + pprint(results) except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) - path: /source-usages/{sourceId}/summaries method: GET xCodeSample: @@ -14181,36 +13249,34 @@ 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) sorters = '-date' # 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: **date** (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: **date** (optional) try: - # Returns source usage insights - - api_response = api_instance.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) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - pprint(api_response) + # Returns source usage insights + + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sp-config/export method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sp-config#export-sp-config source: | - export_payload = { + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.export_sp_config(Result) - print("The response of SPConfigApi->export_sp_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) + }''' # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + new_export_payload = ExportPayload.from_json(export_payload) + results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).export_sp_config(new_export_payload) + print("The response of SPConfigApi->export_sp_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) - path: /sp-config/export/{id}/download method: GET xCodeSample: @@ -14219,16 +13285,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sp_config_export(id) - print("The response of SPConfigApi->get_sp_config_export:\n") - pprint(api_response) + # Download export job result. + + results = SPConfigApi(api_client).get_sp_config_export(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + pprint(results) except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) - path: /sp-config/export/{id} method: GET xCodeSample: @@ -14237,16 +13302,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sp_config_export_status(id) - print("The response of SPConfigApi->get_sp_config_export_status:\n") - pprint(api_response) + # Get export job status + + results = SPConfigApi(api_client).get_sp_config_export_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + pprint(results) except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) - path: /sp-config/import/{id}/download method: GET xCodeSample: @@ -14255,16 +13319,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sp_config_import(id) - print("The response of SPConfigApi->get_sp_config_import:\n") - pprint(api_response) + # Download import job result + + results = SPConfigApi(api_client).get_sp_config_import(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + pprint(results) except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) - path: /sp-config/import/{id} method: GET xCodeSample: @@ -14273,16 +13336,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sp_config_import_status(id) - print("The response of SPConfigApi->get_sp_config_import_status:\n") - pprint(api_response) + # Get import job status + + results = SPConfigApi(api_client).get_sp_config_import_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + pprint(results) except Exception as e: - print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) - path: /sp-config/import method: POST xCodeSample: @@ -14291,18 +13353,17 @@ source: | 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.v2024.ImportOptions() # ImportOptions | (optional) - try: - # Initiates configuration objects import job - - api_response = api_instance.import_sp_config(data, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.import_sp_config(data, preview, options) - print("The response of SPConfigApi->import_sp_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) + options = '''sailpoint.v2024.ImportOptions()''' # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + results = SPConfigApi(api_client).import_sp_config(data=data) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) - path: /sp-config/config-objects method: GET xCodeSample: @@ -14310,16 +13371,15 @@ label: SDK_tools/sdk/python/v2024/methods/sp-config#list-sp-config-objects source: | try: - # Get config object details - - api_response = api_instance.list_sp_config_objects() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_sp_config_objects() - print("The response of SPConfigApi->list_sp_config_objects:\n") - pprint(api_response) + # Get config object details + + results = SPConfigApi(api_client).list_sp_config_objects() + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + pprint(results) except Exception as e: - print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -14328,16 +13388,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sed_batch_stats(batch_id) - print("The response of SuggestedEntitlementDescriptionApi->get_sed_batch_stats:\n") - pprint(api_response) + # Submit Sed Batch Stats Request + + results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id=batch_id) + # Below is a request that includes all optional parameters + # results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id) + print("The response of SuggestedEntitlementDescriptionApi->get_sed_batch_stats:\n") + pprint(results) except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batch_stats: %s\n" % e) + print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batch_stats: %s\n" % e) - path: /suggested-entitlement-description-batches method: GET xCodeSample: @@ -14345,16 +13404,15 @@ label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#get-sed-batches source: | try: - # List Sed Batch Request - - api_response = api_instance.get_sed_batches() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sed_batches() - print("The response of SuggestedEntitlementDescriptionApi->get_sed_batches:\n") - pprint(api_response) + # List Sed Batch Request + + results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches() + # Below is a request that includes all optional parameters + # results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches() + print("The response of SuggestedEntitlementDescriptionApi->get_sed_batches:\n") + pprint(results) except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batches: %s\n" % e) + print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batches: %s\n" % e) - path: /suggested-entitlement-descriptions method: GET xCodeSample: @@ -14370,16 +13428,15 @@ requested_by_anyone = False # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to False) # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to False) show_pending_status_only = False # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) (default to False) # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) (default to False) try: - # List Suggested Entitlement Descriptions - - api_response = api_instance.list_seds() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_seds(limit, offset, count, filters, sorters, count_only, requested_by_anyone, show_pending_status_only) - print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") - pprint(api_response) + # List Suggested Entitlement Descriptions + + results = SuggestedEntitlementDescriptionApi(api_client).list_seds() + # Below is a request that includes all optional parameters + # results = SuggestedEntitlementDescriptionApi(api_client).list_seds(limit, offset, count, filters, sorters, count_only, requested_by_anyone, show_pending_status_only) + print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") + pprint(results) except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) + print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) - path: /suggested-entitlement-descriptions method: PATCH xCodeSample: @@ -14387,91 +13444,77 @@ label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#patch-sed source: | id = 'ebab396f-0af1-4050-89b7-dafc63ec70e7' # str | id is sed id # str | id is sed id - [sailpoint.v2024.SedPatch()] # List[SedPatch] | Sed Patch Request - sed_patch = { - "op" : "replace", - "path" : "status", - "value" : "approved" - } # List[SedPatch] | Sed Patch Request - - try: - # Patch Suggested Entitlement Description - Result = sed_patch.from_json(sed_patch) - api_response = api_instance.patch_sed(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_sed(id, Result) - print("The response of SuggestedEntitlementDescriptionApi->patch_sed:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->patch_sed: %s\n" % e) + sed_patch = '''[sailpoint.v2024.SedPatch()]''' # List[SedPatch] | Sed Patch Request + try: + # Patch Suggested Entitlement Description + new_sed_patch = SedPatch.from_json(sed_patch) + results = SuggestedEntitlementDescriptionApi(api_client).patch_sed(id=id, sed_patch=new_sed_patch) + # Below is a request that includes all optional parameters + # results = SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, new_sed_patch) + print("The response of SuggestedEntitlementDescriptionApi->patch_sed:\n") + pprint(results) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->patch_sed: %s\n" % e) - path: /suggested-entitlement-description-approvals method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#submit-sed-approval source: | - [sailpoint.v2024.SedApproval()] # List[SedApproval] | Sed Approval - sed_approval = { - "items" : "016629d1-1d25-463f-97f3-c6686846650" - } # List[SedApproval] | Sed Approval - - try: - # Submit Bulk Approval Request - Result = sed_approval.from_json(sed_approval) - api_response = api_instance.submit_sed_approval(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.submit_sed_approval(Result) - print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) + sed_approval = '''[sailpoint.v2024.SedApproval()]''' # List[SedApproval] | Sed Approval + try: + # Submit Bulk Approval Request + new_sed_approval = SedApproval.from_json(sed_approval) + results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(sed_approval=new_sed_approval) + # Below is a request that includes all optional parameters + # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") + pprint(results) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) - path: /suggested-entitlement-description-assignments method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#submit-sed-assignment source: | - sed_assignment = { + sed_assignment = '''{ "assignee" : { "type" : "SOURCE_OWNER", "value" : "016629d1-1d25-463f-97f3-c6686846650" }, "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] - } # SedAssignment | Sed Assignment Request - try: - # Submit Sed Assignment Request - Result = sed_assignment.from_json(sed_assignment) - api_response = api_instance.submit_sed_assignment(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.submit_sed_assignment(Result) - print("The response of SuggestedEntitlementDescriptionApi->submit_sed_assignment:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_assignment: %s\n" % e) + }''' # SedAssignment | Sed Assignment Request + try: + # Submit Sed Assignment Request + new_sed_assignment = SedAssignment.from_json(sed_assignment) + results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(sed_assignment=new_sed_assignment) + # Below is a request that includes all optional parameters + # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(new_sed_assignment) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_assignment:\n") + pprint(results) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_assignment: %s\n" % e) - path: /suggested-entitlement-description-batches method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#submit-sed-batch-request source: | - sed_batch_request = { + 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" ] - } # SedBatchRequest | Sed Batch Request (optional) - try: - # Submit Sed Batch Request - - api_response = api_instance.submit_sed_batch_request() - - # Below is a request that includes all optional parameters - # api_response = api_instance.submit_sed_batch_request(Result) - print("The response of SuggestedEntitlementDescriptionApi->submit_sed_batch_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_batch_request: %s\n" % e) + }''' # SedBatchRequest | Sed Batch Request (optional) + try: + # Submit Sed Batch Request + + results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request() + # Below is a request that includes all optional parameters + # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request(new_sed_batch_request) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_batch_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_batch_request: %s\n" % e) - path: /tagged-objects/{type}/{id} method: DELETE xCodeSample: @@ -14481,21 +13524,20 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_tagged_object(type, id) + # Delete Object Tags + + TaggedObjectsApi(api_client).delete_tagged_object(type=type, id=id) + # Below is a request that includes all optional parameters + # TaggedObjectsApi(api_client).delete_tagged_object(type, id) except Exception as e: - print("Exception when calling TaggedObjectsApi->delete_tagged_object: %s\n" % e) + print("Exception when calling TaggedObjectsApi->delete_tagged_object: %s\n" % e) - path: /tagged-objects/bulk-remove method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/tagged-objects#delete-tags-to-many-object source: | - bulk_remove_tagged_object = { + bulk_remove_tagged_object = '''{ "objectRefs" : [ { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", @@ -14506,16 +13548,15 @@ "type" : "IDENTITY" } ], "tags" : [ "BU_FINANCE", "PCI" ] - } # BulkRemoveTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + }''' # BulkRemoveTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_tags_to_many_object(Result) + # Remove Tags from Multiple Objects + new_bulk_remove_tagged_object = BulkRemoveTaggedObject.from_json(bulk_remove_tagged_object) + TaggedObjectsApi(api_client).delete_tags_to_many_object(bulk_remove_tagged_object=new_bulk_remove_tagged_object) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling TaggedObjectsApi->delete_tags_to_many_object: %s\n" % e) - path: /tagged-objects/{type}/{id} method: GET xCodeSample: @@ -14525,16 +13566,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_tagged_object(type, id) - print("The response of TaggedObjectsApi->get_tagged_object:\n") - pprint(api_response) + # Get Tagged Object + + results = TaggedObjectsApi(api_client).get_tagged_object(type=type, id=id) + # Below is a request that includes all optional parameters + # results = TaggedObjectsApi(api_client).get_tagged_object(type, id) + print("The response of TaggedObjectsApi->get_tagged_object:\n") + pprint(results) except Exception as e: - print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e) + print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e) - path: /tagged-objects method: GET xCodeSample: @@ -14546,16 +13586,15 @@ 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) filters = 'tagName eq \"BU_FINANCE\"' # 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) try: - # List Tagged Objects - - api_response = api_instance.list_tagged_objects() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_tagged_objects(limit, offset, count, filters) - print("The response of TaggedObjectsApi->list_tagged_objects:\n") - pprint(api_response) + # List Tagged Objects + + results = TaggedObjectsApi(api_client).list_tagged_objects() + # Below is a request that includes all optional parameters + # results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects:\n") + pprint(results) except Exception as e: - print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) + print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) - path: /tagged-objects/{type} method: GET xCodeSample: @@ -14568,16 +13607,15 @@ 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) filters = 'objectRef.id eq \"2c91808568c529c60168cca6f90c1313\"' # 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: **objectRef.id**: *eq* **objectRef.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: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) try: - # List Tagged Objects by Type - - api_response = api_instance.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) - print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") - pprint(api_response) + # List Tagged Objects by Type + + results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type=type) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) + print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) - path: /tagged-objects/{type}/{id} method: PUT xCodeSample: @@ -14586,55 +13624,53 @@ source: | 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 = { + tagged_object = '''{ "objectRef" : { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, "tags" : [ "BU_FINANCE", "PCI" ] - } # TaggedObject | - try: - # Update Tagged Object - Result = tagged_object.from_json(tagged_object) - api_response = api_instance.put_tagged_object(type, id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_tagged_object(type, id, Result) - print("The response of TaggedObjectsApi->put_tagged_object:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e) + }''' # TaggedObject | + try: + # Update Tagged Object + new_tagged_object = TaggedObject.from_json(tagged_object) + results = TaggedObjectsApi(api_client).put_tagged_object(type=type, id=id, tagged_object=new_tagged_object) + # Below is a request that includes all optional parameters + # results = TaggedObjectsApi(api_client).put_tagged_object(type, id, new_tagged_object) + print("The response of TaggedObjectsApi->put_tagged_object:\n") + pprint(results) + except Exception as e: + print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e) - path: /tagged-objects method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/tagged-objects#set-tag-to-object source: | - tagged_object = { + tagged_object = '''{ "objectRef" : { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, "tags" : [ "BU_FINANCE", "PCI" ] - } # TaggedObject | + }''' # TaggedObject | try: - # Add Tag to Object - Result = tagged_object.from_json(tagged_object) - api_instance.set_tag_to_object(Result) - - # Below is a request that includes all optional parameters - # api_instance.set_tag_to_object(Result) + # Add Tag to Object + new_tagged_object = TaggedObject.from_json(tagged_object) + TaggedObjectsApi(api_client).set_tag_to_object(tagged_object=new_tagged_object) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling TaggedObjectsApi->set_tag_to_object: %s\n" % e) - path: /tagged-objects/bulk-add method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/tagged-objects#set-tags-to-many-objects source: | - bulk_add_tagged_object = { + bulk_add_tagged_object = '''{ "objectRefs" : [ { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", @@ -14646,18 +13682,17 @@ } ], "operation" : "MERGE", "tags" : [ "BU_FINANCE", "PCI" ] - } # BulkAddTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_tags_to_many_objects(Result) - print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) + }''' # BulkAddTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + try: + # Tag Multiple Objects + new_bulk_add_tagged_object = BulkAddTaggedObject.from_json(bulk_add_tagged_object) + results = TaggedObjectsApi(api_client).set_tags_to_many_objects(bulk_add_tagged_object=new_bulk_add_tagged_object) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) - path: /task-status/pending-tasks method: HEAD xCodeSample: @@ -14669,14 +13704,13 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) try: - # Retrieve Pending Task List Headers - - api_instance.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) + # Retrieve Pending Task List Headers + + TaskManagementApi(api_client).get_pending_task_headers(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling TaskManagementApi->get_pending_task_headers: %s\n" % e) - path: /task-status/pending-tasks method: GET xCodeSample: @@ -14688,16 +13722,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) try: - # Retrieve Pending Task Status List - - api_response = api_instance.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) - print("The response of TaskManagementApi->get_pending_tasks:\n") - pprint(api_response) + # Retrieve Pending Task Status List + + results = TaskManagementApi(api_client).get_pending_tasks(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = TaskManagementApi(api_client).get_pending_tasks(x_sail_point_experimental, offset, limit, count) + print("The response of TaskManagementApi->get_pending_tasks:\n") + pprint(results) except Exception as e: - print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) + print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) - path: /task-status/{id} method: GET xCodeSample: @@ -14707,16 +13740,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_task_status(id, x_sail_point_experimental) - print("The response of TaskManagementApi->get_task_status:\n") - pprint(api_response) + # Get Task Status by ID + + results = TaskManagementApi(api_client).get_task_status(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = TaskManagementApi(api_client).get_task_status(id, x_sail_point_experimental) + print("The response of TaskManagementApi->get_task_status:\n") + pprint(results) except Exception as e: - print("Exception when calling TaskManagementApi->get_task_status: %s\n" % e) + print("Exception when calling TaskManagementApi->get_task_status: %s\n" % e) - path: /task-status method: GET xCodeSample: @@ -14730,16 +13762,15 @@ filters = 'completionStatus eq \"Success\"' # 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* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *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: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) sorters = '-created' # 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: **created** (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: **created** (optional) try: - # Retrieve Task Status List - - api_response = api_instance.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) - print("The response of TaskManagementApi->get_task_status_list:\n") - pprint(api_response) + # Retrieve Task Status List + + results = TaskManagementApi(api_client).get_task_status_list(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) + print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) - path: /task-status/{id} method: PATCH xCodeSample: @@ -14748,24 +13779,17 @@ source: | 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. - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | The JSONPatch payload used to update the object. - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_task_status(id, x_sail_point_experimental, Result) - print("The response of TaskManagementApi->update_task_status:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TaskManagementApi->update_task_status: %s\n" % e) + json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the object. + try: + # Update Task Status by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = TaskManagementApi(api_client).update_task_status(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling TaskManagementApi->update_task_status: %s\n" % e) - path: /tenant method: GET xCodeSample: @@ -14773,38 +13797,36 @@ label: SDK_tools/sdk/python/v2024/methods/tenant#get-tenant source: | try: - # Get Tenant Information. - - api_response = api_instance.get_tenant() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_tenant() - print("The response of TenantApi->get_tenant:\n") - pprint(api_response) + # Get Tenant Information. + + results = TenantApi(api_client).get_tenant() + # Below is a request that includes all optional parameters + # results = TenantApi(api_client).get_tenant() + print("The response of TenantApi->get_tenant:\n") + pprint(results) except Exception as e: - print("Exception when calling TenantApi->get_tenant: %s\n" % e) + print("Exception when calling TenantApi->get_tenant: %s\n" % e) - path: /transforms method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/transforms#create-transform source: | - transform = { + transform = '''{ "name" : "Timestamp To Date", "attributes" : "{}", "type" : "dateFormat" - } # Transform | The transform to be created. - try: - # Create transform - Result = transform.from_json(transform) - api_response = api_instance.create_transform(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_transform(Result) - print("The response of TransformsApi->create_transform:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TransformsApi->create_transform: %s\n" % e) + }''' # Transform | The transform to be created. + try: + # Create transform + new_transform = Transform.from_json(transform) + results = TransformsApi(api_client).create_transform(transform=new_transform) + # Below is a request that includes all optional parameters + # results = TransformsApi(api_client).create_transform(new_transform) + print("The response of TransformsApi->create_transform:\n") + pprint(results) + except Exception as e: + print("Exception when calling TransformsApi->create_transform: %s\n" % e) - path: /transforms/{id} method: DELETE xCodeSample: @@ -14813,14 +13835,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_transform(id) + # Delete a transform + + TransformsApi(api_client).delete_transform(id=id) + # Below is a request that includes all optional parameters + # TransformsApi(api_client).delete_transform(id) except Exception as e: - print("Exception when calling TransformsApi->delete_transform: %s\n" % e) + print("Exception when calling TransformsApi->delete_transform: %s\n" % e) - path: /transforms/{id} method: GET xCodeSample: @@ -14829,16 +13850,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_transform(id) - print("The response of TransformsApi->get_transform:\n") - pprint(api_response) + # Transform by ID + + results = TransformsApi(api_client).get_transform(id=id) + # Below is a request that includes all optional parameters + # results = TransformsApi(api_client).get_transform(id) + print("The response of TransformsApi->get_transform:\n") + pprint(results) except Exception as e: - print("Exception when calling TransformsApi->get_transform: %s\n" % e) + print("Exception when calling TransformsApi->get_transform: %s\n" % e) - path: /transforms method: GET xCodeSample: @@ -14851,16 +13871,15 @@ name = 'ExampleTransformName123' # str | Name of the transform to retrieve from the list. (optional) # str | Name of the transform to retrieve from the list. (optional) filters = 'name eq \"Uppercase\"' # 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: **internal**: *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: **internal**: *eq* **name**: *eq, sw* (optional) try: - # List transforms - - api_response = api_instance.list_transforms() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_transforms(offset, limit, count, name, filters) - print("The response of TransformsApi->list_transforms:\n") - pprint(api_response) + # List transforms + + results = TransformsApi(api_client).list_transforms() + # Below is a request that includes all optional parameters + # results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters) + print("The response of TransformsApi->list_transforms:\n") + pprint(results) except Exception as e: - print("Exception when calling TransformsApi->list_transforms: %s\n" % e) + print("Exception when calling TransformsApi->list_transforms: %s\n" % e) - path: /transforms/{id} method: PUT xCodeSample: @@ -14868,22 +13887,21 @@ label: SDK_tools/sdk/python/v2024/methods/transforms#update-transform source: | id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to update # str | ID of the transform to update - transform = { + transform = '''{ "name" : "Timestamp To Date", "attributes" : "{}", "type" : "dateFormat" - } # Transform | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional) - try: - # Update a transform - - api_response = api_instance.update_transform(id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_transform(id, Result) - print("The response of TransformsApi->update_transform:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TransformsApi->update_transform: %s\n" % e) + }''' # Transform | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional) + try: + # Update a transform + + results = TransformsApi(api_client).update_transform(id=id) + # Below is a request that includes all optional parameters + # results = TransformsApi(api_client).update_transform(id, new_transform) + print("The response of TransformsApi->update_transform:\n") + pprint(results) + except Exception as e: + print("Exception when calling TransformsApi->update_transform: %s\n" % e) - path: /trigger-invocations/{id}/complete method: POST xCodeSample: @@ -14892,22 +13910,21 @@ source: | 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 = { + complete_invocation = '''{ "output" : { "approved" : false }, "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", "error" : "Access request is denied." - } # CompleteInvocation | + }''' # CompleteInvocation | try: - # Complete Trigger Invocation - Result = complete_invocation.from_json(complete_invocation) - api_instance.complete_trigger_invocation(id, x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_instance.complete_trigger_invocation(id, x_sail_point_experimental, Result) + # Complete Trigger Invocation + new_complete_invocation = CompleteInvocation.from_json(complete_invocation) + TriggersApi(api_client).complete_trigger_invocation(id=id, x_sail_point_experimental=x_sail_point_experimental, complete_invocation=new_complete_invocation) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling TriggersApi->complete_trigger_invocation: %s\n" % e) - path: /trigger-subscriptions method: POST xCodeSample: @@ -14915,7 +13932,7 @@ label: SDK_tools/sdk/python/v2024/methods/triggers#create-subscription 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') - subscription_post_request = { + subscription_post_request = '''{ "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", "httpConfig" : { "bearerTokenAuthConfig" : { @@ -14939,18 +13956,17 @@ "responseDeadline" : "PT1H", "type" : "HTTP", "enabled" : true - } # SubscriptionPostRequest | - try: - # Create a Subscription - Result = subscription_post_request.from_json(subscription_post_request) - api_response = api_instance.create_subscription(x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_subscription(x_sail_point_experimental, Result) - print("The response of TriggersApi->create_subscription:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TriggersApi->create_subscription: %s\n" % e) + }''' # SubscriptionPostRequest | + try: + # Create a Subscription + new_subscription_post_request = SubscriptionPostRequest.from_json(subscription_post_request) + results = TriggersApi(api_client).create_subscription(x_sail_point_experimental=x_sail_point_experimental, subscription_post_request=new_subscription_post_request) + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).create_subscription(x_sail_point_experimental, new_subscription_post_request) + print("The response of TriggersApi->create_subscription:\n") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->create_subscription: %s\n" % e) - path: /trigger-subscriptions/{id} method: DELETE xCodeSample: @@ -14960,14 +13976,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_subscription(id, x_sail_point_experimental) + # Delete a Subscription + + TriggersApi(api_client).delete_subscription(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # TriggersApi(api_client).delete_subscription(id, x_sail_point_experimental) except Exception as e: - print("Exception when calling TriggersApi->delete_subscription: %s\n" % e) + print("Exception when calling TriggersApi->delete_subscription: %s\n" % e) - path: /trigger-subscriptions method: GET xCodeSample: @@ -14981,16 +13996,15 @@ filters = 'id eq \"12cff757-c0c0-413b-8ad7-2a47956d1e89\"' # 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* **triggerId**: *eq* **type**: *eq, le* (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* **triggerId**: *eq* **type**: *eq, le* (optional) sorters = 'triggerName' # 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: **triggerId, triggerName** (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: **triggerId, triggerName** (optional) try: - # List Subscriptions - - api_response = api_instance.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) - print("The response of TriggersApi->list_subscriptions:\n") - pprint(api_response) + # List Subscriptions + + results = TriggersApi(api_client).list_subscriptions(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).list_subscriptions(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_subscriptions:\n") + pprint(results) except Exception as e: - print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) + print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) - path: /trigger-invocations/status method: GET xCodeSample: @@ -15004,16 +14018,15 @@ filters = 'triggerId eq \"idn:access-request-dynamic-approver\"' # 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: **triggerId**: *eq* **subscriptionId**: *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: **triggerId**: *eq* **subscriptionId**: *eq* (optional) sorters = 'created' # 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: **triggerId, subscriptionName, created, completed** (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: **triggerId, subscriptionName, created, completed** (optional) try: - # List Latest Invocation Statuses - - api_response = api_instance.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) - print("The response of TriggersApi->list_trigger_invocation_status:\n") - pprint(api_response) + # List Latest Invocation Statuses + + results = TriggersApi(api_client).list_trigger_invocation_status(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) + print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) - path: /triggers method: GET xCodeSample: @@ -15027,16 +14040,15 @@ filters = 'id eq \"idn:access-request-post-approval\"' # 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, ge, le* (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, ge, le* (optional) 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: **id, 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: **id, name** (optional) try: - # List Triggers - - api_response = api_instance.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) - print("The response of TriggersApi->list_triggers:\n") - pprint(api_response) + # List Triggers + + results = TriggersApi(api_client).list_triggers(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).list_triggers(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_triggers:\n") + pprint(results) except Exception as e: - print("Exception when calling TriggersApi->list_triggers: %s\n" % e) + print("Exception when calling TriggersApi->list_triggers: %s\n" % e) - path: /trigger-subscriptions/{id} method: PATCH xCodeSample: @@ -15045,20 +14057,17 @@ source: | 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] | - subscription_patch_request_inner = [sailpoint.v2024.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] | - + subscription_patch_request_inner = '''[sailpoint.v2024.SubscriptionPatchRequestInner()]''' # List[SubscriptionPatchRequestInner] | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_subscription(id, x_sail_point_experimental, Result) - print("The response of TriggersApi->patch_subscription:\n") - pprint(api_response) + # Patch a Subscription + new_subscription_patch_request_inner = SubscriptionPatchRequestInner.from_json(subscription_patch_request_inner) + results = TriggersApi(api_client).patch_subscription(id=id, x_sail_point_experimental=x_sail_point_experimental, subscription_patch_request_inner=new_subscription_patch_request_inner) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling TriggersApi->patch_subscription: %s\n" % e) + print("Exception when calling TriggersApi->patch_subscription: %s\n" % e) - path: /trigger-invocations/test method: POST xCodeSample: @@ -15066,7 +14075,7 @@ label: SDK_tools/sdk/python/v2024/methods/triggers#start-test-trigger-invocation 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') - test_invocation = { + test_invocation = '''{ "input" : { "identityId" : "201327fda1c44704ac01181e963d463c" }, @@ -15075,18 +14084,17 @@ "contentJson" : { "workflowId" : 1234 } - } # TestInvocation | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_test_trigger_invocation(x_sail_point_experimental, Result) - print("The response of TriggersApi->start_test_trigger_invocation:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) + }''' # TestInvocation | + try: + # Start a Test Invocation + new_test_invocation = TestInvocation.from_json(test_invocation) + results = TriggersApi(api_client).start_test_trigger_invocation(x_sail_point_experimental=x_sail_point_experimental, test_invocation=new_test_invocation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) - path: /trigger-subscriptions/validate-filter method: POST xCodeSample: @@ -15094,23 +14102,22 @@ label: SDK_tools/sdk/python/v2024/methods/triggers#test-subscription-filter 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') - validate_filter_input_dto = { + validate_filter_input_dto = '''{ "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", "input" : { "identityId" : "201327fda1c44704ac01181e963d463c" } - } # ValidateFilterInputDto | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.test_subscription_filter(x_sail_point_experimental, Result) - print("The response of TriggersApi->test_subscription_filter:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TriggersApi->test_subscription_filter: %s\n" % e) + }''' # ValidateFilterInputDto | + try: + # Validate a Subscription Filter + new_validate_filter_input_dto = ValidateFilterInputDto.from_json(validate_filter_input_dto) + results = TriggersApi(api_client).test_subscription_filter(x_sail_point_experimental=x_sail_point_experimental, validate_filter_input_dto=new_validate_filter_input_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling TriggersApi->test_subscription_filter: %s\n" % e) - path: /trigger-subscriptions/{id} method: PUT xCodeSample: @@ -15119,7 +14126,7 @@ source: | 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 = { + subscription_put_request = '''{ "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", "httpConfig" : { "bearerTokenAuthConfig" : { @@ -15142,18 +14149,17 @@ "responseDeadline" : "PT1H", "type" : "HTTP", "enabled" : true - } # SubscriptionPutRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_subscription(id, x_sail_point_experimental, Result) - print("The response of TriggersApi->update_subscription:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TriggersApi->update_subscription: %s\n" % e) + }''' # SubscriptionPutRequest | + try: + # Update a Subscription + new_subscription_put_request = SubscriptionPutRequest.from_json(subscription_put_request) + results = TriggersApi(api_client).update_subscription(id=id, x_sail_point_experimental=x_sail_point_experimental, subscription_put_request=new_subscription_put_request) + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).update_subscription(id, x_sail_point_experimental, new_subscription_put_request) + print("The response of TriggersApi->update_subscription:\n") + pprint(results) + except Exception as e: + print("Exception when calling TriggersApi->update_subscription: %s\n" % e) - path: /ui-metadata/tenant method: GET xCodeSample: @@ -15162,16 +14168,15 @@ 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: - # Get a tenant UI metadata - - api_response = api_instance.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) - print("The response of UIMetadataApi->get_tenant_ui_metadata:\n") - pprint(api_response) + # Get a tenant UI metadata + + results = UIMetadataApi(api_client).get_tenant_ui_metadata(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = UIMetadataApi(api_client).get_tenant_ui_metadata(x_sail_point_experimental) + print("The response of UIMetadataApi->get_tenant_ui_metadata:\n") + pprint(results) except Exception as e: - print("Exception when calling UIMetadataApi->get_tenant_ui_metadata: %s\n" % e) + print("Exception when calling UIMetadataApi->get_tenant_ui_metadata: %s\n" % e) - path: /ui-metadata/tenant method: PUT xCodeSample: @@ -15179,29 +14184,28 @@ label: SDK_tools/sdk/python/v2024/methods/ui-metadata#set-tenant-ui-metadata 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') - tenant_ui_metadata_item_update_request = { + tenant_ui_metadata_item_update_request = '''{ "usernameEmptyText" : "Please provide your work email address...", "usernameLabel" : "Email", "iframeWhiteList" : "http://example.com http://example2.com" - } # TenantUiMetadataItemUpdateRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_tenant_ui_metadata(x_sail_point_experimental, Result) - print("The response of UIMetadataApi->set_tenant_ui_metadata:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling UIMetadataApi->set_tenant_ui_metadata: %s\n" % e) + }''' # TenantUiMetadataItemUpdateRequest | + try: + # Update tenant UI metadata + new_tenant_ui_metadata_item_update_request = TenantUiMetadataItemUpdateRequest.from_json(tenant_ui_metadata_item_update_request) + results = UIMetadataApi(api_client).set_tenant_ui_metadata(x_sail_point_experimental=x_sail_point_experimental, tenant_ui_metadata_item_update_request=new_tenant_ui_metadata_item_update_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling UIMetadataApi->set_tenant_ui_metadata: %s\n" % e) - path: /vendor-connector-mappings method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/vendor-connector-mappings#create-vendor-connector-mapping source: | - vendor_connector_mapping = { + vendor_connector_mapping = '''{ "createdAt" : "2024-03-13T12:56:19.391294Z", "deletedAt" : { "Valid" : false, @@ -15223,25 +14227,24 @@ "Valid" : true, "Time" : "2024-03-14T12:56:19.391294Z" } - } # VendorConnectorMapping | - try: - # Create Vendor Connector Mapping - Result = vendor_connector_mapping.from_json(vendor_connector_mapping) - api_response = api_instance.create_vendor_connector_mapping(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_vendor_connector_mapping(Result) - print("The response of VendorConnectorMappingsApi->create_vendor_connector_mapping:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e) + }''' # VendorConnectorMapping | + try: + # Create Vendor Connector Mapping + new_vendor_connector_mapping = VendorConnectorMapping.from_json(vendor_connector_mapping) + results = VendorConnectorMappingsApi(api_client).create_vendor_connector_mapping(vendor_connector_mapping=new_vendor_connector_mapping) + # Below is a request that includes all optional parameters + # results = VendorConnectorMappingsApi(api_client).create_vendor_connector_mapping(new_vendor_connector_mapping) + print("The response of VendorConnectorMappingsApi->create_vendor_connector_mapping:\n") + pprint(results) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e) - path: /vendor-connector-mappings method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/vendor-connector-mappings#delete-vendor-connector-mapping source: | - vendor_connector_mapping = { + vendor_connector_mapping = '''{ "createdAt" : "2024-03-13T12:56:19.391294Z", "deletedAt" : { "Valid" : false, @@ -15263,18 +14266,17 @@ "Valid" : true, "Time" : "2024-03-14T12:56:19.391294Z" } - } # VendorConnectorMapping | - try: - # Delete Vendor Connector Mapping - Result = vendor_connector_mapping.from_json(vendor_connector_mapping) - api_response = api_instance.delete_vendor_connector_mapping(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_vendor_connector_mapping(Result) - print("The response of VendorConnectorMappingsApi->delete_vendor_connector_mapping:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e) + }''' # VendorConnectorMapping | + try: + # Delete Vendor Connector Mapping + new_vendor_connector_mapping = VendorConnectorMapping.from_json(vendor_connector_mapping) + results = VendorConnectorMappingsApi(api_client).delete_vendor_connector_mapping(vendor_connector_mapping=new_vendor_connector_mapping) + # Below is a request that includes all optional parameters + # results = VendorConnectorMappingsApi(api_client).delete_vendor_connector_mapping(new_vendor_connector_mapping) + print("The response of VendorConnectorMappingsApi->delete_vendor_connector_mapping:\n") + pprint(results) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e) - path: /vendor-connector-mappings method: GET xCodeSample: @@ -15282,16 +14284,15 @@ label: SDK_tools/sdk/python/v2024/methods/vendor-connector-mappings#get-vendor-connector-mappings source: | try: - # List Vendor Connector Mappings - - api_response = api_instance.get_vendor_connector_mappings() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_vendor_connector_mappings() - print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") - pprint(api_response) + # List Vendor Connector Mappings + + results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() + # Below is a request that includes all optional parameters + # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() + print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") + pprint(results) except Exception as e: - print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) + print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) - path: /workflow-executions/{id}/cancel method: POST xCodeSample: @@ -15300,14 +14301,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.cancel_workflow_execution(id) + # Cancel Workflow Execution by ID + + WorkflowsApi(api_client).cancel_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).cancel_workflow_execution(id) except Exception as e: - print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) - path: /workflows/execute/external/{id} method: POST xCodeSample: @@ -15315,36 +14315,34 @@ label: SDK_tools/sdk/python/v2024/methods/workflows#create-external-execute-workflow source: | 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_external_execute_workflow(id, Result) - print("The response of WorkflowsApi->create_external_execute_workflow:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) + create_external_execute_workflow_request = '''sailpoint.v2024.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) - path: /workflows method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow source: | - 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 | + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_workflow(Result) - print("The response of WorkflowsApi->create_workflow:\n") - pprint(api_response) + # Create Workflow + new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) + results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) + print("The response of WorkflowsApi->create_workflow:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) - path: /workflows/{id}/external/oauth-clients method: POST xCodeSample: @@ -15353,16 +14351,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_workflow_external_trigger(id) - print("The response of WorkflowsApi->create_workflow_external_trigger:\n") - pprint(api_response) + # Generate External Trigger OAuth Client + + results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) + print("The response of WorkflowsApi->create_workflow_external_trigger:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) + print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) - path: /workflows/{id} method: DELETE xCodeSample: @@ -15371,14 +14368,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_workflow(id) + # Delete Workflow By Id + + WorkflowsApi(api_client).delete_workflow(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).delete_workflow(id) except Exception as e: - print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) - path: /workflows/{id} method: GET xCodeSample: @@ -15387,16 +14383,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_workflow(id) - print("The response of WorkflowsApi->get_workflow:\n") - pprint(api_response) + # Get Workflow By Id + + results = WorkflowsApi(api_client).get_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) - path: /workflow-executions/{id} method: GET xCodeSample: @@ -15405,16 +14400,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_workflow_execution(id) - print("The response of WorkflowsApi->get_workflow_execution:\n") - pprint(api_response) + # Get Workflow Execution + + results = WorkflowsApi(api_client).get_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) - path: /workflow-executions/{id}/history method: GET xCodeSample: @@ -15423,16 +14417,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_workflow_execution_history(id) - print("The response of WorkflowsApi->get_workflow_execution_history:\n") - pprint(api_response) + # Get Workflow Execution History + + results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) - path: /workflows/{id}/executions method: GET xCodeSample: @@ -15445,16 +14438,15 @@ 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) filters = 'status eq \"Failed\"' # 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: **start_time**: *eq, lt, le, gt, ge* **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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) try: - # List Workflow Executions - - api_response = api_instance.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) - print("The response of WorkflowsApi->get_workflow_executions:\n") - pprint(api_response) + # List Workflow Executions + + results = WorkflowsApi(api_client).get_workflow_executions(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) - path: /workflow-library method: GET xCodeSample: @@ -15464,16 +14456,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_complete_workflow_library(limit, offset) - print("The response of WorkflowsApi->list_complete_workflow_library:\n") - pprint(api_response) + # List Complete Workflow Library + + results = WorkflowsApi(api_client).list_complete_workflow_library() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) - path: /workflow-library/actions method: GET xCodeSample: @@ -15484,16 +14475,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) 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) try: - # List Workflow Library Actions - - api_response = api_instance.list_workflow_library_actions() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_workflow_library_actions(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_actions:\n") - pprint(api_response) + # List Workflow Library Actions + + results = WorkflowsApi(api_client).list_workflow_library_actions() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) - path: /workflow-library/operators method: GET xCodeSample: @@ -15501,16 +14491,15 @@ label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-operators source: | try: - # List Workflow Library Operators - - api_response = api_instance.list_workflow_library_operators() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_workflow_library_operators() - print("The response of WorkflowsApi->list_workflow_library_operators:\n") - pprint(api_response) + # List Workflow Library Operators + + results = WorkflowsApi(api_client).list_workflow_library_operators() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) - path: /workflow-library/triggers method: GET xCodeSample: @@ -15521,16 +14510,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) 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) try: - # List Workflow Library Triggers - - api_response = api_instance.list_workflow_library_triggers() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_workflow_library_triggers(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - pprint(api_response) + # List Workflow Library Triggers + + results = WorkflowsApi(api_client).list_workflow_library_triggers() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) - path: /workflows method: GET xCodeSample: @@ -15538,16 +14526,15 @@ label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflows source: | try: - # List Workflows - - api_response = api_instance.list_workflows() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_workflows() - print("The response of WorkflowsApi->list_workflows:\n") - pprint(api_response) + # List Workflows + + results = WorkflowsApi(api_client).list_workflows() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) - path: /workflows/{id} method: PATCH xCodeSample: @@ -15555,24 +14542,17 @@ label: SDK_tools/sdk/python/v2024/methods/workflows#patch-workflow source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | - - try: - # Patch Workflow - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_workflow(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_workflow(id, Result) - print("The response of WorkflowsApi->patch_workflow:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) + json_patch_operation = '''[{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] | + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) + print("The response of WorkflowsApi->patch_workflow:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) - path: /workflows/{id} method: PUT xCodeSample: @@ -15580,7 +14560,7 @@ label: SDK_tools/sdk/python/v2024/methods/workflows#put-workflow source: | id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = { + workflow_body = '''{ "owner" : { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", @@ -15618,18 +14598,17 @@ "type" : "EVENT" }, "enabled" : false - } # WorkflowBody | - try: - # Update Workflow - Result = workflow_body.from_json(workflow_body) - api_response = api_instance.put_workflow(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_workflow(id, Result) - print("The response of WorkflowsApi->put_workflow:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) + }''' # WorkflowBody | + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->put_workflow:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) - path: /workflows/execute/external/{id}/test method: POST xCodeSample: @@ -15637,18 +14616,17 @@ label: SDK_tools/sdk/python/v2024/methods/workflows#test-external-execute-workflow source: | 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.test_external_execute_workflow(id, Result) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) + test_external_execute_workflow_request = '''sailpoint.v2024.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) - path: /workflows/{id}/test method: POST xCodeSample: @@ -15656,18 +14634,17 @@ label: SDK_tools/sdk/python/v2024/methods/workflows#test-workflow source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.test_workflow(id, Result) - print("The response of WorkflowsApi->test_workflow:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) + 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 + new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) + results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) + print("The response of WorkflowsApi->test_workflow:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -15677,16 +14654,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.approve_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->approve_approval_item:\n") - pprint(api_response) + # Approve an Approval Item + + results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->approve_approval_item:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) - path: /work-items/bulk-approve/{id} method: POST xCodeSample: @@ -15695,16 +14671,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.approve_approval_items_in_bulk(id) - print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") - pprint(api_response) + # Bulk approve Approval Items + + results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id) + print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) + print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) - path: /work-items/{id} method: POST xCodeSample: @@ -15714,16 +14689,15 @@ id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) try: - # Complete a Work Item - - api_response = api_instance.complete_work_item(id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.complete_work_item(id, Result) - print("The response of WorkItemsApi->complete_work_item:\n") - pprint(api_response) + # Complete a Work Item + + results = WorkItemsApi(api_client).complete_work_item(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).complete_work_item(id, new_body) + print("The response of WorkItemsApi->complete_work_item:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) - path: /work-items/{id}/forward method: POST xCodeSample: @@ -15732,20 +14706,19 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - work_item_forward = { + work_item_forward = '''{ "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", "comment" : "I'm going on vacation.", "sendNotifications" : true - } # WorkItemForward | + }''' # WorkItemForward | try: - # Forward a Work Item - Result = work_item_forward.from_json(work_item_forward) - api_instance.forward_work_item(id, x_sail_point_experimental, Result) - - # Below is a request that includes all optional parameters - # api_instance.forward_work_item(id, x_sail_point_experimental, Result) + # Forward a Work Item + new_work_item_forward = WorkItemForward.from_json(work_item_forward) + WorkItemsApi(api_client).forward_work_item(id=id, x_sail_point_experimental=x_sail_point_experimental, work_item_forward=new_work_item_forward) + # Below is a request that includes all optional parameters + # WorkItemsApi(api_client).forward_work_item(id, x_sail_point_experimental, new_work_item_forward) except Exception as e: - print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e) + print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e) - path: /work-items/completed method: GET xCodeSample: @@ -15757,16 +14730,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) 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) try: - # Completed Work Items - - api_response = api_instance.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) - print("The response of WorkItemsApi->get_completed_work_items:\n") - pprint(api_response) + # Completed Work Items + + results = WorkItemsApi(api_client).get_completed_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) + print("The response of WorkItemsApi->get_completed_work_items:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) - path: /work-items/completed/count method: GET xCodeSample: @@ -15776,16 +14748,15 @@ x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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(x_sail_point_experimental, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_count_completed_work_items(x_sail_point_experimental, owner_id) - print("The response of WorkItemsApi->get_count_completed_work_items:\n") - pprint(api_response) + # Count Completed Work Items + + results = WorkItemsApi(api_client).get_count_completed_work_items(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_completed_work_items(x_sail_point_experimental, owner_id) + print("The response of WorkItemsApi->get_count_completed_work_items:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) - path: /work-items/count method: GET xCodeSample: @@ -15794,16 +14765,15 @@ source: | 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_count_work_items(owner_id) - print("The response of WorkItemsApi->get_count_work_items:\n") - pprint(api_response) + # Count Work Items + + results = WorkItemsApi(api_client).get_count_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_work_items(owner_id) + print("The response of WorkItemsApi->get_count_work_items:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) - path: /work-items/{id} method: GET xCodeSample: @@ -15812,16 +14782,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_work_item(id) - print("The response of WorkItemsApi->get_work_item:\n") - pprint(api_response) + # Get a Work Item + + results = WorkItemsApi(api_client).get_work_item(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_item(id) + print("The response of WorkItemsApi->get_work_item:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) - path: /work-items/summary method: GET xCodeSample: @@ -15830,16 +14799,15 @@ source: | 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_work_items_summary(owner_id) - print("The response of WorkItemsApi->get_work_items_summary:\n") - pprint(api_response) + # Work Items Summary + + results = WorkItemsApi(api_client).get_work_items_summary() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_items_summary(owner_id) + print("The response of WorkItemsApi->get_work_items_summary:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) - path: /work-items method: GET xCodeSample: @@ -15851,16 +14819,15 @@ 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) owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) try: - # List Work Items - - api_response = api_instance.list_work_items() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_work_items(limit, offset, count, owner_id) - print("The response of WorkItemsApi->list_work_items:\n") - pprint(api_response) + # List Work Items + + results = WorkItemsApi(api_client).list_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) + print("The response of WorkItemsApi->list_work_items:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) - path: /work-items/{id}/reject/{approvalItemId} method: POST xCodeSample: @@ -15870,16 +14837,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.reject_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->reject_approval_item:\n") - pprint(api_response) + # Reject an Approval Item + + results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->reject_approval_item:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) - path: /work-items/bulk-reject/{id} method: POST xCodeSample: @@ -15888,16 +14854,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.reject_approval_items_in_bulk(id) - print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") - pprint(api_response) + # Bulk reject Approval Items + + results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id) + print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) + print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) - path: /work-items/{id}/submit-account-selection method: POST xCodeSample: @@ -15907,16 +14872,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.submit_account_selection(id, Result) - print("The response of WorkItemsApi->submit_account_selection:\n") - pprint(api_response) + # Submit Account Selections + new_request_body = RequestBody.from_json(request_body) + results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body) + print("The response of WorkItemsApi->submit_account_selection:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) - path: /reassignment-configurations method: POST xCodeSample: @@ -15924,24 +14888,23 @@ label: SDK_tools/sdk/python/v2024/methods/work-reassignment#create-reassignment-configuration 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') - configuration_item_request = { + configuration_item_request = '''{ "endDate" : "2022-07-30T17:00:00Z", "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", "configType" : "ACCESS_REQUESTS", "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", "startDate" : "2022-07-21T11:13:12.345Z" - } # ConfigurationItemRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_reassignment_configuration(x_sail_point_experimental, Result) - print("The response of WorkReassignmentApi->create_reassignment_configuration:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling WorkReassignmentApi->create_reassignment_configuration: %s\n" % e) + }''' # ConfigurationItemRequest | + try: + # Create a Reassignment Configuration + new_configuration_item_request = ConfigurationItemRequest.from_json(configuration_item_request) + results = WorkReassignmentApi(api_client).create_reassignment_configuration(x_sail_point_experimental=x_sail_point_experimental, configuration_item_request=new_configuration_item_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->create_reassignment_configuration: %s\n" % e) - path: /reassignment-configurations/{identityId}/{configType} method: DELETE xCodeSample: @@ -15952,14 +14915,13 @@ 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') try: - # Delete Reassignment Configuration - - api_instance.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) + # Delete Reassignment Configuration + + WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id=identity_id, config_type=config_type, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling WorkReassignmentApi->delete_reassignment_configuration: %s\n" % e) - path: /reassignment-configurations/{identityId}/evaluate/{configType} method: GET xCodeSample: @@ -15969,20 +14931,17 @@ 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') - 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) - - 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) + 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) try: - # Evaluate Reassignment Configuration - - api_response = api_instance.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) - print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") - pprint(api_response) + # Evaluate Reassignment Configuration + + results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id=identity_id, config_type=config_type, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) + print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) - path: /reassignment-configurations/types method: GET xCodeSample: @@ -15991,16 +14950,15 @@ 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: - # List Reassignment Config Types - - api_response = api_instance.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) - print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") - pprint(api_response) + # List Reassignment Config Types + + results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental) + print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) + print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) - path: /reassignment-configurations/{identityId} method: GET xCodeSample: @@ -16010,16 +14968,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_reassignment_configuration(identity_id, x_sail_point_experimental) - print("The response of WorkReassignmentApi->get_reassignment_configuration:\n") - pprint(api_response) + # Get Reassignment Configuration + + results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id, x_sail_point_experimental) + print("The response of WorkReassignmentApi->get_reassignment_configuration:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkReassignmentApi->get_reassignment_configuration: %s\n" % e) + print("Exception when calling WorkReassignmentApi->get_reassignment_configuration: %s\n" % e) - path: /reassignment-configurations/tenant-config method: GET xCodeSample: @@ -16028,16 +14985,15 @@ 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: - # Get Tenant-wide Reassignment Configuration settings - - api_response = api_instance.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) - print("The response of WorkReassignmentApi->get_tenant_config_configuration:\n") - pprint(api_response) + # Get Tenant-wide Reassignment Configuration settings + + results = WorkReassignmentApi(api_client).get_tenant_config_configuration(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).get_tenant_config_configuration(x_sail_point_experimental) + print("The response of WorkReassignmentApi->get_tenant_config_configuration:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkReassignmentApi->get_tenant_config_configuration: %s\n" % e) + print("Exception when calling WorkReassignmentApi->get_tenant_config_configuration: %s\n" % e) - path: /reassignment-configurations method: GET xCodeSample: @@ -16046,16 +15002,15 @@ 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: - # List Reassignment Configurations - - api_response = api_instance.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) - print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") - pprint(api_response) + # List Reassignment Configurations + + results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental) + print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) + print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) - path: /reassignment-configurations/{identityId} method: PUT xCodeSample: @@ -16064,24 +15019,23 @@ source: | 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 = { + configuration_item_request = '''{ "endDate" : "2022-07-30T17:00:00Z", "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", "configType" : "ACCESS_REQUESTS", "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", "startDate" : "2022-07-21T11:13:12.345Z" - } # ConfigurationItemRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_reassignment_config(identity_id, x_sail_point_experimental, Result) - print("The response of WorkReassignmentApi->put_reassignment_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling WorkReassignmentApi->put_reassignment_config: %s\n" % e) + }''' # ConfigurationItemRequest | + try: + # Update Reassignment Configuration + new_configuration_item_request = ConfigurationItemRequest.from_json(configuration_item_request) + results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental, configuration_item_request=new_configuration_item_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_reassignment_config: %s\n" % e) - path: /reassignment-configurations/tenant-config method: PUT xCodeSample: @@ -16089,19 +15043,18 @@ label: SDK_tools/sdk/python/v2024/methods/work-reassignment#put-tenant-configuration 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') - tenant_configuration_request = { + tenant_configuration_request = '''{ "configDetails" : { "disabled" : true } - } # TenantConfigurationRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_tenant_configuration(x_sail_point_experimental, Result) - print("The response of WorkReassignmentApi->put_tenant_configuration:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) + }''' # TenantConfigurationRequest | + try: + # Update Tenant-wide Reassignment Configuration settings + new_tenant_configuration_request = TenantConfigurationRequest.from_json(tenant_configuration_request) + results = WorkReassignmentApi(api_client).put_tenant_configuration(x_sail_point_experimental=x_sail_point_experimental, tenant_configuration_request=new_tenant_configuration_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) diff --git a/sailpoint/v3/docs/Examples/python_code_examples_overlay.yaml b/sailpoint/v3/docs/Examples/python_code_examples_overlay.yaml index 94ae01357..51da6e33e 100644 --- a/sailpoint/v3/docs/Examples/python_code_examples_overlay.yaml +++ b/sailpoint/v3/docs/Examples/python_code_examples_overlay.yaml @@ -4,7 +4,7 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/access-profiles#create-access-profile source: | - access_profile = { + access_profile = '''{ "owner" : { "name" : "support", "id" : "2c9180a46faadee4016fb4e018c20639", @@ -88,18 +88,17 @@ "modified" : "2021-03-02T20:22:28.104Z", "id" : "2c91808a7190d06e01719938fcd20792", "requestable" : true - } # AccessProfile | - try: - # Create Access Profile - Result = access_profile.from_json(access_profile) - api_response = api_instance.create_access_profile(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_access_profile(Result) - print("The response of AccessProfilesApi->create_access_profile:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessProfilesApi->create_access_profile: %s\n" % e) + }''' # AccessProfile | + try: + # Create Access Profile + new_access_profile = AccessProfile.from_json(access_profile) + results = AccessProfilesApi(api_client).create_access_profile(access_profile=new_access_profile) + # Below is a request that includes all optional parameters + # results = AccessProfilesApi(api_client).create_access_profile(new_access_profile) + print("The response of AccessProfilesApi->create_access_profile:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->create_access_profile: %s\n" % e) - path: /access-profiles/{id} method: DELETE xCodeSample: @@ -108,35 +107,33 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_access_profile(id) + # Delete the specified Access Profile + + AccessProfilesApi(api_client).delete_access_profile(id=id) + # Below is a request that includes all optional parameters + # AccessProfilesApi(api_client).delete_access_profile(id) except Exception as e: - print("Exception when calling AccessProfilesApi->delete_access_profile: %s\n" % e) + print("Exception when calling AccessProfilesApi->delete_access_profile: %s\n" % e) - path: /access-profiles/bulk-delete method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/access-profiles#delete-access-profiles-in-bulk source: | - access_profile_bulk_delete_request = { + access_profile_bulk_delete_request = '''{ "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], "bestEffortOnly" : true - } # AccessProfileBulkDeleteRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_access_profiles_in_bulk(Result) - print("The response of AccessProfilesApi->delete_access_profiles_in_bulk:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessProfilesApi->delete_access_profiles_in_bulk: %s\n" % e) + }''' # AccessProfileBulkDeleteRequest | + try: + # Delete Access Profile(s) + new_access_profile_bulk_delete_request = AccessProfileBulkDeleteRequest.from_json(access_profile_bulk_delete_request) + results = AccessProfilesApi(api_client).delete_access_profiles_in_bulk(access_profile_bulk_delete_request=new_access_profile_bulk_delete_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->delete_access_profiles_in_bulk: %s\n" % e) - path: /access-profiles/{id} method: GET xCodeSample: @@ -145,16 +142,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_access_profile(id) - print("The response of AccessProfilesApi->get_access_profile:\n") - pprint(api_response) + # Get an Access Profile + + results = AccessProfilesApi(api_client).get_access_profile(id=id) + # Below is a request that includes all optional parameters + # results = AccessProfilesApi(api_client).get_access_profile(id) + print("The response of AccessProfilesApi->get_access_profile:\n") + pprint(results) except Exception as e: - print("Exception when calling AccessProfilesApi->get_access_profile: %s\n" % e) + print("Exception when calling AccessProfilesApi->get_access_profile: %s\n" % e) - path: /access-profiles/{id}/entitlements method: GET xCodeSample: @@ -168,16 +164,15 @@ filters = 'attribute eq \"memberOf\"' # 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) sorters = 'name,-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-results) Sorting is supported for the following fields: **name, attribute, value, created, 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-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) try: - # List Access Profile's Entitlements - - api_response = api_instance.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) - print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") - pprint(api_response) + # List Access Profile's Entitlements + + results = AccessProfilesApi(api_client).get_access_profile_entitlements(id=id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) + print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) - path: /access-profiles method: GET xCodeSample: @@ -193,16 +188,15 @@ for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) try: - # List Access Profiles - - api_response = api_instance.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) - print("The response of AccessProfilesApi->list_access_profiles:\n") - pprint(api_response) + # List Access Profiles + + results = AccessProfilesApi(api_client).list_access_profiles() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) + print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) - path: /access-profiles/{id} method: PATCH xCodeSample: @@ -210,24 +204,17 @@ label: SDK_tools/sdk/python/v3/methods/access-profiles#patch-access-profile source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | - - try: - # Patch a specified Access Profile - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_access_profile(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_access_profile(id, Result) - print("The response of AccessProfilesApi->patch_access_profile:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e) + json_patch_operation = '''[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}]''' # List[JsonPatchOperation] | + try: + # Patch a specified Access Profile + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = AccessProfilesApi(api_client).patch_access_profile(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = AccessProfilesApi(api_client).patch_access_profile(id, new_json_patch_operation) + print("The response of AccessProfilesApi->patch_access_profile:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e) - path: /access-request-approvals/{approvalId}/approve method: POST xCodeSample: @@ -235,7 +222,7 @@ label: SDK_tools/sdk/python/v3/methods/access-request-approvals#approve-access-request source: | approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. - comment_dto = { + comment_dto = '''{ "created" : "2017-07-11T18:45:37.098Z", "author" : { "name" : "john.doe", @@ -243,18 +230,17 @@ "type" : "IDENTITY" }, "comment" : "This is a comment." - } # CommentDto | Reviewer's comment. (optional) - try: - # Approve Access Request Approval - - api_response = api_instance.approve_access_request(approval_id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.approve_access_request(approval_id, Result) - print("The response of AccessRequestApprovalsApi->approve_access_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->approve_access_request: %s\n" % e) + }''' # CommentDto | Reviewer's comment. (optional) + try: + # Approve Access Request Approval + + results = AccessRequestApprovalsApi(api_client).approve_access_request(approval_id=approval_id) + # Below is a request that includes all optional parameters + # results = AccessRequestApprovalsApi(api_client).approve_access_request(approval_id, new_comment_dto) + print("The response of AccessRequestApprovalsApi->approve_access_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->approve_access_request: %s\n" % e) - path: /access-request-approvals/{approvalId}/forward method: POST xCodeSample: @@ -262,21 +248,20 @@ label: SDK_tools/sdk/python/v3/methods/access-request-approvals#forward-access-request source: | approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. - forward_approval_dto = { + forward_approval_dto = '''{ "newOwnerId" : "2c91808568c529c60168cca6f90c1314", "comment" : "2c91808568c529c60168cca6f90c1313" - } # ForwardApprovalDto | Information about the forwarded approval. - try: - # Forward Access Request Approval - Result = forward_approval_dto.from_json(forward_approval_dto) - api_response = api_instance.forward_access_request(approval_id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.forward_access_request(approval_id, Result) - print("The response of AccessRequestApprovalsApi->forward_access_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->forward_access_request: %s\n" % e) + }''' # ForwardApprovalDto | Information about the forwarded approval. + try: + # Forward Access Request Approval + new_forward_approval_dto = ForwardApprovalDto.from_json(forward_approval_dto) + results = AccessRequestApprovalsApi(api_client).forward_access_request(approval_id=approval_id, forward_approval_dto=new_forward_approval_dto) + # Below is a request that includes all optional parameters + # results = AccessRequestApprovalsApi(api_client).forward_access_request(approval_id, new_forward_approval_dto) + print("The response of AccessRequestApprovalsApi->forward_access_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->forward_access_request: %s\n" % e) - path: /access-request-approvals/approval-summary method: GET xCodeSample: @@ -286,16 +271,15 @@ 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_access_request_approval_summary(owner_id, from_date) - print("The response of AccessRequestApprovalsApi->get_access_request_approval_summary:\n") - pprint(api_response) + # Get Access Requests Approvals Number + + results = AccessRequestApprovalsApi(api_client).get_access_request_approval_summary() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->get_access_request_approval_summary: %s\n" % e) + print("Exception when calling AccessRequestApprovalsApi->get_access_request_approval_summary: %s\n" % e) - path: /access-request-approvals/completed method: GET xCodeSample: @@ -309,16 +293,15 @@ filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # 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, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, 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: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) 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-results) Sorting is supported for the following fields: **created, 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-results) Sorting is supported for the following fields: **created, modified** (optional) try: - # Completed Access Request Approvals List - - api_response = api_instance.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) - print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") - pprint(api_response) + # Completed Access Request Approvals List + + results = AccessRequestApprovalsApi(api_client).list_completed_approvals() + # Below is a request that includes all optional parameters + # results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") + pprint(results) except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) + print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) - path: /access-request-approvals/pending method: GET xCodeSample: @@ -332,16 +315,15 @@ filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *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: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) 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-results) Sorting is supported for the following fields: **created, 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-results) Sorting is supported for the following fields: **created, modified** (optional) try: - # Pending Access Request Approvals List - - api_response = api_instance.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) - print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") - pprint(api_response) + # Pending Access Request Approvals List + + results = AccessRequestApprovalsApi(api_client).list_pending_approvals() + # Below is a request that includes all optional parameters + # results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") + pprint(results) except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) + print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) - path: /access-request-approvals/{approvalId}/reject method: POST xCodeSample: @@ -349,7 +331,7 @@ label: SDK_tools/sdk/python/v3/methods/access-request-approvals#reject-access-request source: | approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. - comment_dto = { + comment_dto = '''{ "created" : "2017-07-11T18:45:37.098Z", "author" : { "name" : "john.doe", @@ -357,46 +339,44 @@ "type" : "IDENTITY" }, "comment" : "This is a comment." - } # CommentDto | Reviewer's comment. - try: - # Reject Access Request Approval - Result = comment_dto.from_json(comment_dto) - api_response = api_instance.reject_access_request(approval_id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.reject_access_request(approval_id, Result) - print("The response of AccessRequestApprovalsApi->reject_access_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e) + }''' # CommentDto | Reviewer's comment. + try: + # Reject Access Request Approval + new_comment_dto = CommentDto.from_json(comment_dto) + results = AccessRequestApprovalsApi(api_client).reject_access_request(approval_id=approval_id, comment_dto=new_comment_dto) + # Below is a request that includes all optional parameters + # results = AccessRequestApprovalsApi(api_client).reject_access_request(approval_id, new_comment_dto) + print("The response of AccessRequestApprovalsApi->reject_access_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e) - path: /access-requests/cancel method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/access-requests#cancel-access-request source: | - cancel_access_request = { + cancel_access_request = '''{ "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", "comment" : "I requested this role by mistake." - } # CancelAccessRequest | - try: - # Cancel Access Request - Result = cancel_access_request.from_json(cancel_access_request) - api_response = api_instance.cancel_access_request(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.cancel_access_request(Result) - print("The response of AccessRequestsApi->cancel_access_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e) + }''' # CancelAccessRequest | + try: + # Cancel Access Request + new_cancel_access_request = CancelAccessRequest.from_json(cancel_access_request) + results = AccessRequestsApi(api_client).cancel_access_request(cancel_access_request=new_cancel_access_request) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).cancel_access_request(new_cancel_access_request) + print("The response of AccessRequestsApi->cancel_access_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e) - path: /access-requests method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/access-requests#create-access-request source: | - access_request = { + access_request = '''{ "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", @@ -449,18 +429,17 @@ "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" } ] - } # AccessRequest | - try: - # Submit Access Request - Result = access_request.from_json(access_request) - api_response = api_instance.create_access_request(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_access_request(Result) - print("The response of AccessRequestsApi->create_access_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessRequestsApi->create_access_request: %s\n" % e) + }''' # AccessRequest | + try: + # Submit Access Request + new_access_request = AccessRequest.from_json(access_request) + results = AccessRequestsApi(api_client).create_access_request(access_request=new_access_request) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).create_access_request(new_access_request) + print("The response of AccessRequestsApi->create_access_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->create_access_request: %s\n" % e) - path: /access-request-config method: GET xCodeSample: @@ -468,16 +447,15 @@ label: SDK_tools/sdk/python/v3/methods/access-requests#get-access-request-config source: | try: - # Get Access Request Configuration - - api_response = api_instance.get_access_request_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_access_request_config() - print("The response of AccessRequestsApi->get_access_request_config:\n") - pprint(api_response) + # Get Access Request Configuration + + results = AccessRequestsApi(api_client).get_access_request_config() + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).get_access_request_config() + print("The response of AccessRequestsApi->get_access_request_config:\n") + pprint(results) except Exception as e: - print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e) + print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e) - path: /access-request-status method: GET xCodeSample: @@ -495,23 +473,22 @@ sorters = 'created' # 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: **created, modified, accountActivityItemId, 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: **created, modified, accountActivityItemId, name** (optional) request_state = 'request-state=EXECUTING' # str | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) # str | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) try: - # Access Request Status - - api_response = api_instance.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) - print("The response of AccessRequestsApi->list_access_request_status:\n") - pprint(api_response) + # Access Request Status + + results = AccessRequestsApi(api_client).list_access_request_status() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) + print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) - path: /access-request-config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/access-requests#set-access-request-config source: | - access_request_config = { + access_request_config = '''{ "requestOnBehalfOfConfig" : { "allowRequestOnBehalfOfEmployeeByManager" : true, "allowRequestOnBehalfOfAnyoneByAnyone" : true @@ -536,18 +513,17 @@ }, "reauthorizationEnabled" : true, "approvalsMustBeExternal" : true - } # AccessRequestConfig | - try: - # Update Access Request Configuration - Result = access_request_config.from_json(access_request_config) - api_response = api_instance.set_access_request_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_access_request_config(Result) - print("The response of AccessRequestsApi->set_access_request_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccessRequestsApi->set_access_request_config: %s\n" % e) + }''' # AccessRequestConfig | + try: + # Update Access Request Configuration + new_access_request_config = AccessRequestConfig.from_json(access_request_config) + results = AccessRequestsApi(api_client).set_access_request_config(access_request_config=new_access_request_config) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).set_access_request_config(new_access_request_config) + print("The response of AccessRequestsApi->set_access_request_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccessRequestsApi->set_access_request_config: %s\n" % e) - path: /account-activities/{id} method: GET xCodeSample: @@ -556,16 +532,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_account_activity(id) - print("The response of AccountActivitiesApi->get_account_activity:\n") - pprint(api_response) + # Get an Account Activity + + results = AccountActivitiesApi(api_client).get_account_activity(id=id) + # Below is a request that includes all optional parameters + # results = AccountActivitiesApi(api_client).get_account_activity(id) + print("The response of AccountActivitiesApi->get_account_activity:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountActivitiesApi->get_account_activity: %s\n" % e) + print("Exception when calling AccountActivitiesApi->get_account_activity: %s\n" % e) - path: /account-activities method: GET xCodeSample: @@ -581,23 +556,22 @@ filters = 'type eq \"Identity Refresh\"' # 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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, 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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) sorters = 'created' # 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: **type, created, 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-results) Sorting is supported for the following fields: **type, created, modified** (optional) try: - # List Account Activities - - api_response = api_instance.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) - print("The response of AccountActivitiesApi->list_account_activities:\n") - pprint(api_response) + # List Account Activities + + results = AccountActivitiesApi(api_client).list_account_activities() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) + print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) - path: /accounts method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/accounts#create-account source: | - account_attributes_create = { + account_attributes_create = '''{ "attributes" : { "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", "city" : "Austin", @@ -606,18 +580,17 @@ "sAMAccountName" : "jDoe", "mail" : "john.doe@sailpoint.com" } - } # AccountAttributesCreate | - try: - # Create Account - Result = account_attributes_create.from_json(account_attributes_create) - api_response = api_instance.create_account(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_account(Result) - print("The response of AccountsApi->create_account:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccountsApi->create_account: %s\n" % e) + }''' # AccountAttributesCreate | + try: + # Create Account + new_account_attributes_create = AccountAttributesCreate.from_json(account_attributes_create) + results = AccountsApi(api_client).create_account(account_attributes_create=new_account_attributes_create) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).create_account(new_account_attributes_create) + print("The response of AccountsApi->create_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->create_account: %s\n" % e) - path: /accounts/{id} method: DELETE xCodeSample: @@ -626,16 +599,15 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. try: - # Delete Account - - api_response = api_instance.delete_account(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_account(id) - print("The response of AccountsApi->delete_account:\n") - pprint(api_response) + # Delete Account + + results = AccountsApi(api_client).delete_account(id=id) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).delete_account(id) + print("The response of AccountsApi->delete_account:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountsApi->delete_account: %s\n" % e) + print("Exception when calling AccountsApi->delete_account: %s\n" % e) - path: /accounts/{id}/disable method: POST xCodeSample: @@ -643,21 +615,20 @@ label: SDK_tools/sdk/python/v3/methods/accounts#disable-account source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id - account_toggle_request = { + account_toggle_request = '''{ "forceProvisioning" : false, "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" - } # AccountToggleRequest | - try: - # Disable Account - Result = account_toggle_request.from_json(account_toggle_request) - api_response = api_instance.disable_account(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.disable_account(id, Result) - print("The response of AccountsApi->disable_account:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccountsApi->disable_account: %s\n" % e) + }''' # AccountToggleRequest | + try: + # Disable Account + new_account_toggle_request = AccountToggleRequest.from_json(account_toggle_request) + results = AccountsApi(api_client).disable_account(id=id, account_toggle_request=new_account_toggle_request) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).disable_account(id, new_account_toggle_request) + print("The response of AccountsApi->disable_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->disable_account: %s\n" % e) - path: /accounts/{id}/enable method: POST xCodeSample: @@ -665,21 +636,20 @@ label: SDK_tools/sdk/python/v3/methods/accounts#enable-account source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id - account_toggle_request = { + account_toggle_request = '''{ "forceProvisioning" : false, "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" - } # AccountToggleRequest | - try: - # Enable Account - Result = account_toggle_request.from_json(account_toggle_request) - api_response = api_instance.enable_account(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.enable_account(id, Result) - print("The response of AccountsApi->enable_account:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccountsApi->enable_account: %s\n" % e) + }''' # AccountToggleRequest | + try: + # Enable Account + new_account_toggle_request = AccountToggleRequest.from_json(account_toggle_request) + results = AccountsApi(api_client).enable_account(id=id, account_toggle_request=new_account_toggle_request) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).enable_account(id, new_account_toggle_request) + print("The response of AccountsApi->enable_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->enable_account: %s\n" % e) - path: /accounts/{id} method: GET xCodeSample: @@ -688,16 +658,15 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. try: - # Account Details - - api_response = api_instance.get_account(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_account(id) - print("The response of AccountsApi->get_account:\n") - pprint(api_response) + # Account Details + + results = AccountsApi(api_client).get_account(id=id) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).get_account(id) + print("The response of AccountsApi->get_account:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountsApi->get_account: %s\n" % e) + print("Exception when calling AccountsApi->get_account: %s\n" % e) - path: /accounts/{id}/entitlements method: GET xCodeSample: @@ -709,16 +678,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) 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) try: - # Account Entitlements - - api_response = api_instance.get_account_entitlements(id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_account_entitlements(id, limit, offset, count) - print("The response of AccountsApi->get_account_entitlements:\n") - pprint(api_response) + # Account Entitlements + + results = AccountsApi(api_client).get_account_entitlements(id=id) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).get_account_entitlements(id, limit, offset, count) + print("The response of AccountsApi->get_account_entitlements:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) + print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) - path: /accounts method: GET xCodeSample: @@ -732,16 +700,15 @@ filters = 'identityId eq \"2c9180858082150f0180893dbaf44201\"' # 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) sorters = 'id,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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) try: - # Accounts List - - api_response = api_instance.list_accounts() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_accounts(limit, offset, count, detail_level, filters, sorters) - print("The response of AccountsApi->list_accounts:\n") - pprint(api_response) + # Accounts List + + results = AccountsApi(api_client).list_accounts() + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).list_accounts(limit, offset, count, detail_level, filters, sorters) + print("The response of AccountsApi->list_accounts:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountsApi->list_accounts: %s\n" % e) + print("Exception when calling AccountsApi->list_accounts: %s\n" % e) - path: /accounts/{id} method: PUT xCodeSample: @@ -749,7 +716,7 @@ label: SDK_tools/sdk/python/v3/methods/accounts#put-account source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. - account_attributes = { + account_attributes = '''{ "attributes" : { "city" : "Austin", "displayName" : "John Doe", @@ -757,18 +724,17 @@ "sAMAccountName" : "jDoe", "mail" : "john.doe@sailpoint.com" } - } # AccountAttributes | - try: - # Update Account - Result = account_attributes.from_json(account_attributes) - api_response = api_instance.put_account(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_account(id, Result) - print("The response of AccountsApi->put_account:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccountsApi->put_account: %s\n" % e) + }''' # AccountAttributes | + try: + # Update Account + new_account_attributes = AccountAttributes.from_json(account_attributes) + results = AccountsApi(api_client).put_account(id=id, account_attributes=new_account_attributes) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).put_account(id, new_account_attributes) + print("The response of AccountsApi->put_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->put_account: %s\n" % e) - path: /accounts/{id}/reload method: POST xCodeSample: @@ -777,16 +743,15 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id try: - # Reload Account - - api_response = api_instance.submit_reload_account(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.submit_reload_account(id) - print("The response of AccountsApi->submit_reload_account:\n") - pprint(api_response) + # Reload Account + + results = AccountsApi(api_client).submit_reload_account(id=id) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).submit_reload_account(id) + print("The response of AccountsApi->submit_reload_account:\n") + pprint(results) except Exception as e: - print("Exception when calling AccountsApi->submit_reload_account: %s\n" % e) + print("Exception when calling AccountsApi->submit_reload_account: %s\n" % e) - path: /accounts/{id}/unlock method: POST xCodeSample: @@ -794,22 +759,21 @@ label: SDK_tools/sdk/python/v3/methods/accounts#unlock-account source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. # str | The account ID. - account_unlock_request = { + account_unlock_request = '''{ "forceProvisioning" : false, "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", "unlockIDNAccount" : false - } # AccountUnlockRequest | - try: - # Unlock Account - Result = account_unlock_request.from_json(account_unlock_request) - api_response = api_instance.unlock_account(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.unlock_account(id, Result) - print("The response of AccountsApi->unlock_account:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccountsApi->unlock_account: %s\n" % e) + }''' # AccountUnlockRequest | + try: + # Unlock Account + new_account_unlock_request = AccountUnlockRequest.from_json(account_unlock_request) + results = AccountsApi(api_client).unlock_account(id=id, account_unlock_request=new_account_unlock_request) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).unlock_account(id, new_account_unlock_request) + print("The response of AccountsApi->unlock_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->unlock_account: %s\n" % e) - path: /accounts/{id} method: PATCH xCodeSample: @@ -817,20 +781,17 @@ label: SDK_tools/sdk/python/v3/methods/accounts#update-account source: | 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. - - try: - # Update Account - Result = request_body.from_json(request_body) - api_response = api_instance.update_account(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_account(id, Result) - print("The response of AccountsApi->update_account:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AccountsApi->update_account: %s\n" % e) + 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. + try: + # Update Account + new_request_body = RequestBody.from_json(request_body) + results = AccountsApi(api_client).update_account(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).update_account(id, new_request_body) + print("The response of AccountsApi->update_account:\n") + pprint(results) + except Exception as e: + print("Exception when calling AccountsApi->update_account: %s\n" % e) - path: /account-usages/{accountId}/summaries method: GET xCodeSample: @@ -843,16 +804,15 @@ 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) sorters = '-date' # 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: **date** (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: **date** (optional) try: - # Returns account usage insights - - api_response = api_instance.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) - print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - pprint(api_response) + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: @@ -865,16 +825,15 @@ filter = 'name eq \"Okta\" and description co \"Okta\" and discoverySource in (\"csv\", \"Okta Saas\")' # 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, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) 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, description, discoveredAt, discoverySource** (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, description, discoveredAt, discoverySource** (optional) try: - # Get Discovered Applications for Tenant - - api_response = api_instance.get_discovered_applications() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_discovered_applications(limit, offset, detail, filter, sorters) - print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") - pprint(api_response) + # Get Discovered Applications for Tenant + + results = ApplicationDiscoveryApi(api_client).get_discovered_applications() + # Below is a request that includes all optional parameters + # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) + print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") + pprint(results) except Exception as e: - print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) + print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) - path: /manual-discover-applications-template method: GET xCodeSample: @@ -882,16 +841,15 @@ label: SDK_tools/sdk/python/v3/methods/application-discovery#get-manual-discover-applications-csv-template source: | try: - # Download CSV Template for Discovery - - api_response = api_instance.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() - print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n") - pprint(api_response) + # Download CSV Template for Discovery + + results = ApplicationDiscoveryApi(api_client).get_manual_discover_applications_csv_template() + # Below is a request that includes all optional parameters + # results = ApplicationDiscoveryApi(api_client).get_manual_discover_applications_csv_template() + print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n") + pprint(results) except Exception as e: - print("Exception when calling ApplicationDiscoveryApi->get_manual_discover_applications_csv_template: %s\n" % e) + print("Exception when calling ApplicationDiscoveryApi->get_manual_discover_applications_csv_template: %s\n" % e) - path: /manual-discover-applications method: POST xCodeSample: @@ -900,14 +858,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.send_manual_discover_applications_csv_template(file) + # Upload CSV to Discover Applications + + ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file=file) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling ApplicationDiscoveryApi->send_manual_discover_applications_csv_template: %s\n" % e) - path: /auth-users/{id} method: GET xCodeSample: @@ -916,16 +873,15 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID try: - # Auth User Details - - api_response = api_instance.get_auth_user(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_auth_user(id) - print("The response of AuthUsersApi->get_auth_user:\n") - pprint(api_response) + # Auth User Details + + results = AuthUsersApi(api_client).get_auth_user(id=id) + # Below is a request that includes all optional parameters + # results = AuthUsersApi(api_client).get_auth_user(id) + print("The response of AuthUsersApi->get_auth_user:\n") + pprint(results) except Exception as e: - print("Exception when calling AuthUsersApi->get_auth_user: %s\n" % e) + print("Exception when calling AuthUsersApi->get_auth_user: %s\n" % e) - path: /auth-users/{id} method: PATCH xCodeSample: @@ -933,24 +889,17 @@ label: SDK_tools/sdk/python/v3/methods/auth-users#patch-auth-user source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - try: - # Auth User Update - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_auth_user(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_auth_user(id, Result) - print("The response of AuthUsersApi->patch_auth_user:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling AuthUsersApi->patch_auth_user: %s\n" % e) + json_patch_operation = '''[{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. + try: + # Auth User Update + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = AuthUsersApi(api_client).patch_auth_user(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = AuthUsersApi(api_client).patch_auth_user(id, new_json_patch_operation) + print("The response of AuthUsersApi->patch_auth_user:\n") + pprint(results) + except Exception as e: + print("Exception when calling AuthUsersApi->patch_auth_user: %s\n" % e) - path: /brandings method: POST xCodeSample: @@ -966,16 +915,15 @@ login_informational_message = 'login_informational_message_example' # str | login information message (optional) # str | login information message (optional) file_standard = None # bytearray | png file with logo (optional) # bytearray | png file with logo (optional) try: - # Create a branding item - - api_response = api_instance.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) - print("The response of BrandingApi->create_branding_item:\n") - pprint(api_response) + # Create a branding item + + results = BrandingApi(api_client).create_branding_item(name=name, product_name=product_name) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling BrandingApi->create_branding_item: %s\n" % e) + print("Exception when calling BrandingApi->create_branding_item: %s\n" % e) - path: /brandings/{name} method: DELETE xCodeSample: @@ -984,14 +932,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_branding(name) + # Delete a branding item + + BrandingApi(api_client).delete_branding(name=name) + # Below is a request that includes all optional parameters + # BrandingApi(api_client).delete_branding(name) except Exception as e: - print("Exception when calling BrandingApi->delete_branding: %s\n" % e) + print("Exception when calling BrandingApi->delete_branding: %s\n" % e) - path: /brandings/{name} method: GET xCodeSample: @@ -1000,16 +947,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_branding(name) - print("The response of BrandingApi->get_branding:\n") - pprint(api_response) + # Get a branding item + + results = BrandingApi(api_client).get_branding(name=name) + # Below is a request that includes all optional parameters + # results = BrandingApi(api_client).get_branding(name) + print("The response of BrandingApi->get_branding:\n") + pprint(results) except Exception as e: - print("Exception when calling BrandingApi->get_branding: %s\n" % e) + print("Exception when calling BrandingApi->get_branding: %s\n" % e) - path: /brandings method: GET xCodeSample: @@ -1017,16 +963,15 @@ label: SDK_tools/sdk/python/v3/methods/branding#get-branding-list source: | try: - # List of branding items - - api_response = api_instance.get_branding_list() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_branding_list() - print("The response of BrandingApi->get_branding_list:\n") - pprint(api_response) + # List of branding items + + results = BrandingApi(api_client).get_branding_list() + # Below is a request that includes all optional parameters + # results = BrandingApi(api_client).get_branding_list() + print("The response of BrandingApi->get_branding_list:\n") + pprint(results) except Exception as e: - print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) + print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) - path: /brandings/{name} method: PUT xCodeSample: @@ -1043,23 +988,22 @@ login_informational_message = 'login_informational_message_example' # str | login information message (optional) # str | login information message (optional) file_standard = None # bytearray | png file with logo (optional) # bytearray | png file with logo (optional) try: - # Update a branding item - - api_response = api_instance.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) - print("The response of BrandingApi->set_branding_item:\n") - pprint(api_response) + # Update a branding item + + results = BrandingApi(api_client).set_branding_item(name=name, name2=name2, product_name=product_name) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling BrandingApi->set_branding_item: %s\n" % e) + print("Exception when calling BrandingApi->set_branding_item: %s\n" % e) - path: /campaign-filters method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#create-campaign-filter source: | - campaign_filter_details = { + campaign_filter_details = '''{ "owner" : "SailPoint Support", "mode" : "INCLUSION", "isSystemFilter" : false, @@ -1076,36 +1020,32 @@ "recordChildMatches" : false, "suppressMatchedItems" : false } ] - } # CampaignFilterDetails | - try: - # Create Campaign Filter - Result = campaign_filter_details.from_json(campaign_filter_details) - api_response = api_instance.create_campaign_filter(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_campaign_filter(Result) - print("The response of CertificationCampaignFiltersApi->create_campaign_filter:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignFiltersApi->create_campaign_filter: %s\n" % e) + }''' # CampaignFilterDetails | + try: + # Create Campaign Filter + new_campaign_filter_details = CampaignFilterDetails.from_json(campaign_filter_details) + results = CertificationCampaignFiltersApi(api_client).create_campaign_filter(campaign_filter_details=new_campaign_filter_details) + # Below is a request that includes all optional parameters + # results = CertificationCampaignFiltersApi(api_client).create_campaign_filter(new_campaign_filter_details) + print("The response of CertificationCampaignFiltersApi->create_campaign_filter:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->create_campaign_filter: %s\n" % e) - path: /campaign-filters/delete method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#delete-campaign-filters source: | - 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. - + 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_campaign_filters(Result) + # Deletes Campaign Filters + new_request_body = RequestBody.from_json(request_body) + CertificationCampaignFiltersApi(api_client).delete_campaign_filters(request_body=new_request_body) + # Below is a request that includes all optional parameters + # CertificationCampaignFiltersApi(api_client).delete_campaign_filters(new_request_body) except Exception as e: - print("Exception when calling CertificationCampaignFiltersApi->delete_campaign_filters: %s\n" % e) + print("Exception when calling CertificationCampaignFiltersApi->delete_campaign_filters: %s\n" % e) - path: /campaign-filters/{id} method: GET xCodeSample: @@ -1114,16 +1054,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_campaign_filter_by_id(id) - print("The response of CertificationCampaignFiltersApi->get_campaign_filter_by_id:\n") - pprint(api_response) + # Get Campaign Filter by ID + + results = CertificationCampaignFiltersApi(api_client).get_campaign_filter_by_id(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignFiltersApi(api_client).get_campaign_filter_by_id(id) + print("The response of CertificationCampaignFiltersApi->get_campaign_filter_by_id:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignFiltersApi->get_campaign_filter_by_id: %s\n" % e) + print("Exception when calling CertificationCampaignFiltersApi->get_campaign_filter_by_id: %s\n" % e) - path: /campaign-filters method: GET xCodeSample: @@ -1134,16 +1073,15 @@ 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) try: - # List Campaign Filters - - api_response = api_instance.list_campaign_filters() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_campaign_filters(limit, start, include_system_filters) - print("The response of CertificationCampaignFiltersApi->list_campaign_filters:\n") - pprint(api_response) + # List Campaign Filters + + results = CertificationCampaignFiltersApi(api_client).list_campaign_filters() + # Below is a request that includes all optional parameters + # results = CertificationCampaignFiltersApi(api_client).list_campaign_filters(limit, start, include_system_filters) + print("The response of CertificationCampaignFiltersApi->list_campaign_filters:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignFiltersApi->list_campaign_filters: %s\n" % e) + print("Exception when calling CertificationCampaignFiltersApi->list_campaign_filters: %s\n" % e) - path: /campaign-filters/{id} method: POST xCodeSample: @@ -1151,7 +1089,7 @@ label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#update-campaign-filter source: | filter_id = 'e9f9a1397b842fd5a65842087040d3ac' # str | The ID of the campaign filter being modified. # str | The ID of the campaign filter being modified. - campaign_filter_details = { + campaign_filter_details = '''{ "owner" : "SailPoint Support", "mode" : "INCLUSION", "isSystemFilter" : false, @@ -1168,18 +1106,17 @@ "recordChildMatches" : false, "suppressMatchedItems" : false } ] - } # CampaignFilterDetails | A campaign filter details with updated field values. - try: - # Updates a Campaign Filter - Result = campaign_filter_details.from_json(campaign_filter_details) - api_response = api_instance.update_campaign_filter(filter_id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_campaign_filter(filter_id, Result) - print("The response of CertificationCampaignFiltersApi->update_campaign_filter:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignFiltersApi->update_campaign_filter: %s\n" % e) + }''' # CampaignFilterDetails | A campaign filter details with updated field values. + try: + # Updates a Campaign Filter + new_campaign_filter_details = CampaignFilterDetails.from_json(campaign_filter_details) + results = CertificationCampaignFiltersApi(api_client).update_campaign_filter(filter_id=filter_id, campaign_filter_details=new_campaign_filter_details) + # Below is a request that includes all optional parameters + # results = CertificationCampaignFiltersApi(api_client).update_campaign_filter(filter_id, new_campaign_filter_details) + print("The response of CertificationCampaignFiltersApi->update_campaign_filter:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->update_campaign_filter: %s\n" % e) - path: /campaigns/{id}/complete method: POST xCodeSample: @@ -1187,27 +1124,26 @@ label: SDK_tools/sdk/python/v3/methods/certification-campaigns#complete-campaign source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID. - campaign_complete_options = { + campaign_complete_options = '''{ "autoCompleteAction" : "REVOKE" - } # CampaignCompleteOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) - try: - # Complete a Campaign - - api_response = api_instance.complete_campaign(id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.complete_campaign(id, Result) - print("The response of CertificationCampaignsApi->complete_campaign:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e) + }''' # CampaignCompleteOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) + try: + # Complete a Campaign + + results = CertificationCampaignsApi(api_client).complete_campaign(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).complete_campaign(id, new_campaign_complete_options) + print("The response of CertificationCampaignsApi->complete_campaign:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e) - path: /campaigns method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#create-campaign source: | - campaign = { + campaign = '''{ "totalCertifications" : 100, "sourcesWithOrphanEntitlements" : [ { "name" : "Source with orphan entitlements", @@ -1315,25 +1251,24 @@ "deadline" : "2020-03-15T10:00:01.456Z", "status" : "ACTIVE", "correlatedStatus" : "CORRELATED" - } # Campaign | - try: - # Create a campaign - Result = campaign.from_json(campaign) - api_response = api_instance.create_campaign(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_campaign(Result) - print("The response of CertificationCampaignsApi->create_campaign:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->create_campaign: %s\n" % e) + }''' # Campaign | + try: + # Create a campaign + new_campaign = Campaign.from_json(campaign) + results = CertificationCampaignsApi(api_client).create_campaign(campaign=new_campaign) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).create_campaign(new_campaign) + print("The response of CertificationCampaignsApi->create_campaign:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign: %s\n" % e) - path: /campaign-templates method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#create-campaign-template source: | - campaign_template = { + campaign_template = '''{ "ownerRef" : { "name" : "Mister Manager", "id" : "2c918086676d3e0601677611dbde220f", @@ -1456,18 +1391,17 @@ "correlatedStatus" : "CORRELATED" }, "id" : "2c9079b270a266a60170a277bb960008" - } # CampaignTemplate | - try: - # Create a Campaign Template - Result = campaign_template.from_json(campaign_template) - api_response = api_instance.create_campaign_template(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_campaign_template(Result) - print("The response of CertificationCampaignsApi->create_campaign_template:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->create_campaign_template: %s\n" % e) + }''' # CampaignTemplate | + try: + # Create a Campaign Template + new_campaign_template = CampaignTemplate.from_json(campaign_template) + results = CertificationCampaignsApi(api_client).create_campaign_template(campaign_template=new_campaign_template) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).create_campaign_template(new_campaign_template) + print("The response of CertificationCampaignsApi->create_campaign_template:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign_template: %s\n" % e) - path: /campaign-templates/{id} method: DELETE xCodeSample: @@ -1476,14 +1410,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_campaign_template(id) + # Delete a Campaign Template + + CertificationCampaignsApi(api_client).delete_campaign_template(id=id) + # Below is a request that includes all optional parameters + # CertificationCampaignsApi(api_client).delete_campaign_template(id) except Exception as e: - print("Exception when calling CertificationCampaignsApi->delete_campaign_template: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->delete_campaign_template: %s\n" % e) - path: /campaign-templates/{id}/schedule method: DELETE xCodeSample: @@ -1492,34 +1425,32 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_campaign_template_schedule(id) + # Delete Campaign Template Schedule + + CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id=id) + # Below is a request that includes all optional parameters + # CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id) except Exception as e: - print("Exception when calling CertificationCampaignsApi->delete_campaign_template_schedule: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->delete_campaign_template_schedule: %s\n" % e) - path: /campaigns/delete method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#delete-campaigns source: | - campaigns_delete_request = { + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_campaigns(Result) - print("The response of CertificationCampaignsApi->delete_campaigns:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e) + }''' # CampaignsDeleteRequest | IDs of the campaigns to delete. + try: + # Delete Campaigns + new_campaigns_delete_request = CampaignsDeleteRequest.from_json(campaigns_delete_request) + results = CertificationCampaignsApi(api_client).delete_campaigns(campaigns_delete_request=new_campaigns_delete_request) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).delete_campaigns(new_campaigns_delete_request) + print("The response of CertificationCampaignsApi->delete_campaigns:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e) - path: /campaigns method: GET xCodeSample: @@ -1533,16 +1464,15 @@ filters = 'name eq \"Manager 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, in* **name**: *eq, sw* **status**: *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: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) 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, created** (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, created** (optional) try: - # List Campaigns - - api_response = api_instance.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) - print("The response of CertificationCampaignsApi->get_active_campaigns:\n") - pprint(api_response) + # List Campaigns + + results = CertificationCampaignsApi(api_client).get_active_campaigns() + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters) + print("The response of CertificationCampaignsApi->get_active_campaigns:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) - path: /campaigns/{id} method: GET xCodeSample: @@ -1552,16 +1482,15 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_campaign(id, detail) - print("The response of CertificationCampaignsApi->get_campaign:\n") - pprint(api_response) + # Get Campaign + + results = CertificationCampaignsApi(api_client).get_campaign(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign(id, detail) + print("The response of CertificationCampaignsApi->get_campaign:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e) - path: /campaigns/{id}/reports method: GET xCodeSample: @@ -1570,16 +1499,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_campaign_reports(id) - print("The response of CertificationCampaignsApi->get_campaign_reports:\n") - pprint(api_response) + # Get Campaign Reports + + results = CertificationCampaignsApi(api_client).get_campaign_reports(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign_reports(id) + print("The response of CertificationCampaignsApi->get_campaign_reports:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) - path: /campaigns/reports-configuration method: GET xCodeSample: @@ -1587,16 +1515,15 @@ label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign-reports-config source: | try: - # Get Campaign Reports Configuration - - api_response = api_instance.get_campaign_reports_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_campaign_reports_config() - print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n") - pprint(api_response) + # Get Campaign Reports Configuration + + results = CertificationCampaignsApi(api_client).get_campaign_reports_config() + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign_reports_config() + print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e) - path: /campaign-templates/{id} method: GET xCodeSample: @@ -1605,16 +1532,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_campaign_template(id) - print("The response of CertificationCampaignsApi->get_campaign_template:\n") - pprint(api_response) + # Get a Campaign Template + + results = CertificationCampaignsApi(api_client).get_campaign_template(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign_template(id) + print("The response of CertificationCampaignsApi->get_campaign_template:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e) - path: /campaign-templates/{id}/schedule method: GET xCodeSample: @@ -1623,16 +1549,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_campaign_template_schedule(id) - print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n") - pprint(api_response) + # Get Campaign Template Schedule + + results = CertificationCampaignsApi(api_client).get_campaign_template_schedule(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign_template_schedule(id) + print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e) - path: /campaign-templates method: GET xCodeSample: @@ -1645,16 +1570,15 @@ 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, created, 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-results) Sorting is supported for the following fields: **name, created, modified** (optional) filters = 'name eq \"manager template\"' # 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, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, 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**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) try: - # List Campaign Templates - - api_response = api_instance.get_campaign_templates() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_campaign_templates(limit, offset, count, sorters, filters) - print("The response of CertificationCampaignsApi->get_campaign_templates:\n") - pprint(api_response) + # List Campaign Templates + + results = CertificationCampaignsApi(api_client).get_campaign_templates() + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters) + print("The response of CertificationCampaignsApi->get_campaign_templates:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) - path: /campaigns/{id}/reassign method: POST xCodeSample: @@ -1662,25 +1586,24 @@ label: SDK_tools/sdk/python/v3/methods/certification-campaigns#move source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification campaign ID # str | The certification campaign ID - admin_review_reassign = { + admin_review_reassign = '''{ "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], "reason" : "reassigned for some reason", "reassignTo" : { "id" : "ef38f94347e94562b5bb8424a56397d8", "type" : "IDENTITY" } - } # AdminReviewReassign | - try: - # Reassign Certifications - Result = admin_review_reassign.from_json(admin_review_reassign) - api_response = api_instance.move(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.move(id, Result) - print("The response of CertificationCampaignsApi->move:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->move: %s\n" % e) + }''' # AdminReviewReassign | + try: + # Reassign Certifications + new_admin_review_reassign = AdminReviewReassign.from_json(admin_review_reassign) + results = CertificationCampaignsApi(api_client).move(id=id, admin_review_reassign=new_admin_review_reassign) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).move(id, new_admin_review_reassign) + print("The response of CertificationCampaignsApi->move:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->move: %s\n" % e) - path: /campaign-templates/{id} method: PATCH xCodeSample: @@ -1688,44 +1611,36 @@ label: SDK_tools/sdk/python/v3/methods/certification-campaigns#patch-campaign-template source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # 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) - - try: - # Update a Campaign Template - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_campaign_template(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_campaign_template(id, Result) - print("The response of CertificationCampaignsApi->patch_campaign_template:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e) + json_patch_operation = '''[{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) + try: + # Update a Campaign Template + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = CertificationCampaignsApi(api_client).patch_campaign_template(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).patch_campaign_template(id, new_json_patch_operation) + print("The response of CertificationCampaignsApi->patch_campaign_template:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e) - path: /campaigns/reports-configuration method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#set-campaign-reports-config source: | - campaign_reports_config = { + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_campaign_reports_config(Result) - print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->set_campaign_reports_config: %s\n" % e) + }''' # CampaignReportsConfig | Campaign report configuration. + try: + # Set Campaign Reports Configuration + new_campaign_reports_config = CampaignReportsConfig.from_json(campaign_reports_config) + results = CertificationCampaignsApi(api_client).set_campaign_reports_config(campaign_reports_config=new_campaign_reports_config) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).set_campaign_reports_config(new_campaign_reports_config) + print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->set_campaign_reports_config: %s\n" % e) - path: /campaign-templates/{id}/schedule method: PUT xCodeSample: @@ -1733,7 +1648,7 @@ label: SDK_tools/sdk/python/v3/methods/certification-campaigns#set-campaign-template-schedule source: | id = '04bedce387bd47b2ae1f86eb0bb36dee' # str | ID of the campaign template being scheduled. # str | ID of the campaign template being scheduled. - schedule = { + schedule = '''{ "hours" : { "values" : [ "1" ], "interval" : 2, @@ -1752,16 +1667,15 @@ }, "expiration" : "2000-01-23T04:56:07.000+00:00", "type" : "WEEKLY" - } # Schedule | (optional) + }''' # Schedule | (optional) try: - # Set Campaign Template Schedule - - api_instance.set_campaign_template_schedule(id, ) - - # Below is a request that includes all optional parameters - # api_instance.set_campaign_template_schedule(id, Result) + # Set Campaign Template Schedule + + CertificationCampaignsApi(api_client).set_campaign_template_schedule(id=id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling CertificationCampaignsApi->set_campaign_template_schedule: %s\n" % e) - path: /campaigns/{id}/activate method: POST xCodeSample: @@ -1769,20 +1683,19 @@ label: SDK_tools/sdk/python/v3/methods/certification-campaigns#start-campaign source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID. - activate_campaign_options = { + activate_campaign_options = '''{ "timeZone" : "-05:00" - } # ActivateCampaignOptions | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional) - try: - # Activate a Campaign - - api_response = api_instance.start_campaign(id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_campaign(id, Result) - print("The response of CertificationCampaignsApi->start_campaign:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->start_campaign: %s\n" % e) + }''' # ActivateCampaignOptions | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional) + try: + # Activate a Campaign + + results = CertificationCampaignsApi(api_client).start_campaign(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).start_campaign(id, new_activate_campaign_options) + print("The response of CertificationCampaignsApi->start_campaign:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign: %s\n" % e) - path: /campaigns/{id}/run-remediation-scan method: POST xCodeSample: @@ -1791,16 +1704,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_campaign_remediation_scan(id) - print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n") - pprint(api_response) + # Run Campaign Remediation Scan + + results = CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id) + print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->start_campaign_remediation_scan: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->start_campaign_remediation_scan: %s\n" % e) - path: /campaigns/{id}/run-report/{type} method: POST xCodeSample: @@ -1810,16 +1722,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_campaign_report(id, type) - print("The response of CertificationCampaignsApi->start_campaign_report:\n") - pprint(api_response) + # Run Campaign Report + + results = CertificationCampaignsApi(api_client).start_campaign_report(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).start_campaign_report(id, type) + print("The response of CertificationCampaignsApi->start_campaign_report:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e) - path: /campaign-templates/{id}/generate method: POST xCodeSample: @@ -1828,16 +1739,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_generate_campaign_template(id) - print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n") - pprint(api_response) + # Generate a Campaign from Template + + results = CertificationCampaignsApi(api_client).start_generate_campaign_template(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).start_generate_campaign_template(id) + print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e) + print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e) - path: /campaigns/{id} method: PATCH xCodeSample: @@ -1845,24 +1755,17 @@ label: SDK_tools/sdk/python/v3/methods/certification-campaigns#update-campaign source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New 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 - - try: - # Update a Campaign - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_campaign(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_campaign(id, Result) - print("The response of CertificationCampaignsApi->update_campaign:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) + json_patch_operation = '''[{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 + try: + # Update a Campaign + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = CertificationCampaignsApi(api_client).update_campaign(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).update_campaign(id, new_json_patch_operation) + print("The response of CertificationCampaignsApi->update_campaign:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) - path: /certification-tasks/{id} method: GET xCodeSample: @@ -1871,16 +1774,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_certification_task(id) - print("The response of CertificationsApi->get_certification_task:\n") - pprint(api_response) + # Certification Task by ID + + results = CertificationsApi(api_client).get_certification_task(id=id) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).get_certification_task(id) + print("The response of CertificationsApi->get_certification_task:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationsApi->get_certification_task: %s\n" % e) + print("Exception when calling CertificationsApi->get_certification_task: %s\n" % e) - path: /certifications/{id} method: GET xCodeSample: @@ -1889,16 +1791,15 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification id # str | The certification id try: - # Identity Certification by ID - - api_response = api_instance.get_identity_certification(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_certification(id) - print("The response of CertificationsApi->get_identity_certification:\n") - pprint(api_response) + # Identity Certification by ID + + results = CertificationsApi(api_client).get_identity_certification(id=id) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).get_identity_certification(id) + print("The response of CertificationsApi->get_identity_certification:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationsApi->get_identity_certification: %s\n" % e) + print("Exception when calling CertificationsApi->get_identity_certification: %s\n" % e) - path: /certifications/{certificationId}/access-review-items/{itemId}/permissions method: GET xCodeSample: @@ -1912,16 +1813,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) 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) try: - # Permissions for Entitlement Certification Item - - api_response = api_instance.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) - print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") - pprint(api_response) + # Permissions for Entitlement Certification Item + + results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id=certification_id, item_id=item_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) + print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) - path: /certification-tasks method: GET xCodeSample: @@ -1934,16 +1834,15 @@ 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) filters = 'type eq \"ADMIN_REASSIGN\"' # 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* **targetId**: *eq, in* **type**: *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: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) try: - # List of Pending Certification Tasks - - api_response = api_instance.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) - print("The response of CertificationsApi->get_pending_certification_tasks:\n") - pprint(api_response) + # List of Pending Certification Tasks + + results = CertificationsApi(api_client).get_pending_certification_tasks() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) + print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) - path: /certifications/{id}/reviewers method: GET xCodeSample: @@ -1957,16 +1856,15 @@ filters = 'name eq \"Bob\"' # 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* **email**: *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: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) 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, email** (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, email** (optional) try: - # List of Reviewers for certification - - api_response = api_instance.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) - print("The response of CertificationsApi->list_certification_reviewers:\n") - pprint(api_response) + # List of Reviewers for certification + + results = CertificationsApi(api_client).list_certification_reviewers(id=id) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_certification_reviewers:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) + print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) - path: /certifications/{id}/access-review-items method: GET xCodeSample: @@ -1983,16 +1881,15 @@ access_profiles = 'accessProfile1' # str | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) # str | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) roles = 'userRole' # str | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) # str | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) try: - # List of Access Review Items - - api_response = api_instance.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) - print("The response of CertificationsApi->list_identity_access_review_items:\n") - pprint(api_response) + # List of Access Review Items + + results = CertificationsApi(api_client).list_identity_access_review_items(id=id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) + print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) - path: /certifications method: GET xCodeSample: @@ -2006,16 +1903,15 @@ filters = '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: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *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* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) sorters = 'name,due' # 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, due, signed** (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, due, signed** (optional) try: - # List Identity Campaign Certifications - - api_response = api_instance.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) - print("The response of CertificationsApi->list_identity_certifications:\n") - pprint(api_response) + # List Identity Campaign Certifications + + results = CertificationsApi(api_client).list_identity_certifications() + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_identity_certifications:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) + print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) - path: /certifications/{id}/decide method: POST xCodeSample: @@ -2023,31 +1919,17 @@ label: SDK_tools/sdk/python/v3/methods/certifications#make-identity-decision source: | 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 = { - "comments" : "This user no longer needs access to this source", - "decision" : "APPROVE", - "proposedEndDate" : "2017-07-11T18:45:37.098Z", - "recommendation" : { - "reasons" : [ "Reason 1", "Reason 2" ], - "recommendation" : "recommendation", - "timestamp" : "2020-06-01T13:49:37.385Z" - }, - "id" : "ef38f94347e94562b5bb8424a56397d8", - "bulk" : true - } # List[ReviewDecision] | A non-empty array of decisions to be made. - - try: - # Decide on a Certification Item - Result = review_decision.from_json(review_decision) - api_response = api_instance.make_identity_decision(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.make_identity_decision(id, Result) - print("The response of CertificationsApi->make_identity_decision:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationsApi->make_identity_decision: %s\n" % e) + review_decision = '''[{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. + try: + # Decide on a Certification Item + new_review_decision = ReviewDecision.from_json(review_decision) + results = CertificationsApi(api_client).make_identity_decision(id=id, review_decision=new_review_decision) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).make_identity_decision(id, new_review_decision) + print("The response of CertificationsApi->make_identity_decision:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->make_identity_decision: %s\n" % e) - path: /certifications/{id}/reassign method: POST xCodeSample: @@ -2055,7 +1937,7 @@ label: SDK_tools/sdk/python/v3/methods/certifications#reassign-identity-certifications source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - review_reassign = { + review_reassign = '''{ "reason" : "reassigned for some reason", "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", "reassign" : [ { @@ -2065,18 +1947,17 @@ "id" : "ef38f94347e94562b5bb8424a56397d8", "type" : "ITEM" } ] - } # ReviewReassign | - try: - # Reassign Identities or Items - Result = review_reassign.from_json(review_reassign) - api_response = api_instance.reassign_identity_certifications(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.reassign_identity_certifications(id, Result) - print("The response of CertificationsApi->reassign_identity_certifications:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationsApi->reassign_identity_certifications: %s\n" % e) + }''' # ReviewReassign | + try: + # Reassign Identities or Items + new_review_reassign = ReviewReassign.from_json(review_reassign) + results = CertificationsApi(api_client).reassign_identity_certifications(id=id, review_reassign=new_review_reassign) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).reassign_identity_certifications(id, new_review_reassign) + print("The response of CertificationsApi->reassign_identity_certifications:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->reassign_identity_certifications: %s\n" % e) - path: /certifications/{id}/sign-off method: POST xCodeSample: @@ -2085,16 +1966,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.sign_off_identity_certification(id) - print("The response of CertificationsApi->sign_off_identity_certification:\n") - pprint(api_response) + # Finalize Identity Certification Decisions + + results = CertificationsApi(api_client).sign_off_identity_certification(id=id) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).sign_off_identity_certification(id) + print("The response of CertificationsApi->sign_off_identity_certification:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationsApi->sign_off_identity_certification: %s\n" % e) + print("Exception when calling CertificationsApi->sign_off_identity_certification: %s\n" % e) - path: /certifications/{id}/reassign-async method: POST xCodeSample: @@ -2102,7 +1982,7 @@ label: SDK_tools/sdk/python/v3/methods/certifications#submit-reassign-certs-async source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID - review_reassign = { + review_reassign = '''{ "reason" : "reassigned for some reason", "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", "reassign" : [ { @@ -2112,18 +1992,17 @@ "id" : "ef38f94347e94562b5bb8424a56397d8", "type" : "ITEM" } ] - } # ReviewReassign | - try: - # Reassign Certifications Asynchronously - Result = review_reassign.from_json(review_reassign) - api_response = api_instance.submit_reassign_certs_async(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.submit_reassign_certs_async(id, Result) - print("The response of CertificationsApi->submit_reassign_certs_async:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) + }''' # ReviewReassign | + try: + # Reassign Certifications Asynchronously + new_review_reassign = ReviewReassign.from_json(review_reassign) + results = CertificationsApi(api_client).submit_reassign_certs_async(id=id, review_reassign=new_review_reassign) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).submit_reassign_certs_async(id, new_review_reassign) + print("The response of CertificationsApi->submit_reassign_certs_async:\n") + pprint(results) + except Exception as e: + print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) - path: /certifications/{id}/access-summaries/{type} method: GET xCodeSample: @@ -2138,16 +2017,15 @@ filters = 'access.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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) sorters = 'access.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: **access.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: **access.name** (optional) try: - # Access Summaries - - api_response = api_instance.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) - print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - pprint(api_response) + # Access Summaries + + results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) - path: /certifications/{id}/decision-summary method: GET xCodeSample: @@ -2157,16 +2035,15 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_decision_summary(id, filters) - print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") - pprint(api_response) + # Summary of Certification Decisions + + results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) - path: /certifications/{id}/identity-summaries method: GET xCodeSample: @@ -2180,16 +2057,15 @@ filters = '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: **id**: *eq, in* **completed**: *eq, ne* **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: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) 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) try: - # Identity Summaries for Campaign Certification - - api_response = api_instance.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) - print("The response of CertificationSummariesApi->get_identity_summaries:\n") - pprint(api_response) + # Identity Summaries for Campaign Certification + + results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) - path: /certifications/{id}/identity-summaries/{identitySummaryId} method: GET xCodeSample: @@ -2199,16 +2075,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_identity_summary(id, identity_summary_id) - print("The response of CertificationSummariesApi->get_identity_summary:\n") - pprint(api_response) + # Summary for Identity + + results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + pprint(results) except Exception as e: - print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg} method: POST xCodeSample: @@ -2216,24 +2091,23 @@ label: SDK_tools/sdk/python/v3/methods/configuration-hub#create-object-mapping source: | source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. - object_mapping_request = { + object_mapping_request = '''{ "targetValue" : "My New Governance Group Name", "jsonPath" : "$.name", "sourceValue" : "My Governance Group Name", "enabled" : false, "objectType" : "IDENTITY" - } # ObjectMappingRequest | The object mapping request body. - try: - # Creates an object mapping - Result = object_mapping_request.from_json(object_mapping_request) - api_response = api_instance.create_object_mapping(source_org, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_object_mapping(source_org, Result) - print("The response of ConfigurationHubApi->create_object_mapping:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ConfigurationHubApi->create_object_mapping: %s\n" % e) + }''' # ObjectMappingRequest | The object mapping request body. + try: + # Creates an object mapping + new_object_mapping_request = ObjectMappingRequest.from_json(object_mapping_request) + results = ConfigurationHubApi(api_client).create_object_mapping(source_org=source_org, object_mapping_request=new_object_mapping_request) + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).create_object_mapping(source_org, new_object_mapping_request) + print("The response of ConfigurationHubApi->create_object_mapping:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_object_mapping: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg}/bulk-create method: POST xCodeSample: @@ -2241,7 +2115,7 @@ label: SDK_tools/sdk/python/v3/methods/configuration-hub#create-object-mappings source: | source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. - object_mapping_bulk_create_request = { + object_mapping_bulk_create_request = '''{ "newObjectsMappings" : [ { "targetValue" : "My New Governance Group Name", "jsonPath" : "$.name", @@ -2255,18 +2129,17 @@ "enabled" : false, "objectType" : "IDENTITY" } ] - } # ObjectMappingBulkCreateRequest | The bulk create object mapping request body. - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_object_mappings(source_org, Result) - print("The response of ConfigurationHubApi->create_object_mappings:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ConfigurationHubApi->create_object_mappings: %s\n" % e) + }''' # ObjectMappingBulkCreateRequest | The bulk create object mapping request body. + try: + # Bulk creates object mappings + new_object_mapping_bulk_create_request = ObjectMappingBulkCreateRequest.from_json(object_mapping_bulk_create_request) + results = ConfigurationHubApi(api_client).create_object_mappings(source_org=source_org, object_mapping_bulk_create_request=new_object_mapping_bulk_create_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_object_mappings: %s\n" % e) - path: /configuration-hub/backups/uploads method: POST xCodeSample: @@ -2276,16 +2149,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_uploaded_configuration(data, name) - print("The response of ConfigurationHubApi->create_uploaded_configuration:\n") - pprint(api_response) + # Upload a Configuration + + results = ConfigurationHubApi(api_client).create_uploaded_configuration(data=data, name=name) + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).create_uploaded_configuration(data, name) + print("The response of ConfigurationHubApi->create_uploaded_configuration:\n") + pprint(results) except Exception as e: - print("Exception when calling ConfigurationHubApi->create_uploaded_configuration: %s\n" % e) + print("Exception when calling ConfigurationHubApi->create_uploaded_configuration: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId} method: DELETE xCodeSample: @@ -2295,14 +2167,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_object_mapping(source_org, object_mapping_id) + # Deletes an object mapping + + ConfigurationHubApi(api_client).delete_object_mapping(source_org=source_org, object_mapping_id=object_mapping_id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling ConfigurationHubApi->delete_object_mapping: %s\n" % e) - path: /configuration-hub/backups/uploads/{id} method: DELETE xCodeSample: @@ -2311,14 +2182,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_uploaded_configuration(id) + # Delete an Uploaded Configuration + + ConfigurationHubApi(api_client).delete_uploaded_configuration(id=id) + # Below is a request that includes all optional parameters + # ConfigurationHubApi(api_client).delete_uploaded_configuration(id) except Exception as e: - print("Exception when calling ConfigurationHubApi->delete_uploaded_configuration: %s\n" % e) + print("Exception when calling ConfigurationHubApi->delete_uploaded_configuration: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg} method: GET xCodeSample: @@ -2327,16 +2197,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_object_mappings(source_org) - print("The response of ConfigurationHubApi->get_object_mappings:\n") - pprint(api_response) + # Gets list of object mappings + + results = ConfigurationHubApi(api_client).get_object_mappings(source_org=source_org) + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).get_object_mappings(source_org) + print("The response of ConfigurationHubApi->get_object_mappings:\n") + pprint(results) except Exception as e: - print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) + print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) - path: /configuration-hub/backups/uploads/{id} method: GET xCodeSample: @@ -2345,16 +2214,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_uploaded_configuration(id) - print("The response of ConfigurationHubApi->get_uploaded_configuration:\n") - pprint(api_response) + # Get an Uploaded Configuration + + results = ConfigurationHubApi(api_client).get_uploaded_configuration(id=id) + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).get_uploaded_configuration(id) + print("The response of ConfigurationHubApi->get_uploaded_configuration:\n") + pprint(results) except Exception as e: - print("Exception when calling ConfigurationHubApi->get_uploaded_configuration: %s\n" % e) + print("Exception when calling ConfigurationHubApi->get_uploaded_configuration: %s\n" % e) - path: /configuration-hub/backups/uploads method: GET xCodeSample: @@ -2363,16 +2231,15 @@ source: | 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_uploaded_configurations(filters) - print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") - pprint(api_response) + # List Uploaded Configurations + + results = ConfigurationHubApi(api_client).list_uploaded_configurations() + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).list_uploaded_configurations(filters) + print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") + pprint(results) except Exception as e: - print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) + print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch method: POST xCodeSample: @@ -2380,7 +2247,7 @@ label: SDK_tools/sdk/python/v3/methods/configuration-hub#update-object-mappings source: | source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. - object_mapping_bulk_patch_request = { + object_mapping_bulk_patch_request = '''{ "patches" : { "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { "op" : "replace", @@ -2393,42 +2260,40 @@ "value" : "New Target Value" } ] } - } # ObjectMappingBulkPatchRequest | The object mapping request body. - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_object_mappings(source_org, Result) - print("The response of ConfigurationHubApi->update_object_mappings:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ConfigurationHubApi->update_object_mappings: %s\n" % e) + }''' # ObjectMappingBulkPatchRequest | The object mapping request body. + try: + # Bulk updates object mappings + new_object_mapping_bulk_patch_request = ObjectMappingBulkPatchRequest.from_json(object_mapping_bulk_patch_request) + results = ConfigurationHubApi(api_client).update_object_mappings(source_org=source_org, object_mapping_bulk_patch_request=new_object_mapping_bulk_patch_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling ConfigurationHubApi->update_object_mappings: %s\n" % e) - path: /connectors method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/connectors#create-custom-connector source: | - v3_create_connector_dto = { + v3_create_connector_dto = '''{ "name" : "custom connector", "directConnect" : true, "className" : "sailpoint.connector.OpenConnectorAdapter", "type" : "custom connector type", "status" : "RELEASED" - } # V3CreateConnectorDto | - try: - # Create Custom Connector - Result = v3_create_connector_dto.from_json(v3_create_connector_dto) - api_response = api_instance.create_custom_connector(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_custom_connector(Result) - print("The response of ConnectorsApi->create_custom_connector:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ConnectorsApi->create_custom_connector: %s\n" % e) + }''' # V3CreateConnectorDto | + try: + # Create Custom Connector + new_v3_create_connector_dto = V3CreateConnectorDto.from_json(v3_create_connector_dto) + results = ConnectorsApi(api_client).create_custom_connector(v3_create_connector_dto=new_v3_create_connector_dto) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).create_custom_connector(new_v3_create_connector_dto) + print("The response of ConnectorsApi->create_custom_connector:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->create_custom_connector: %s\n" % e) - path: /connectors/{scriptName} method: DELETE xCodeSample: @@ -2437,14 +2302,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_custom_connector(script_name) + # Delete Connector by Script Name + + ConnectorsApi(api_client).delete_custom_connector(script_name=script_name) + # Below is a request that includes all optional parameters + # ConnectorsApi(api_client).delete_custom_connector(script_name) except Exception as e: - print("Exception when calling ConnectorsApi->delete_custom_connector: %s\n" % e) + print("Exception when calling ConnectorsApi->delete_custom_connector: %s\n" % e) - path: /connectors/{scriptName} method: GET xCodeSample: @@ -2454,16 +2318,15 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_connector(script_name, locale) - print("The response of ConnectorsApi->get_connector:\n") - pprint(api_response) + # Get Connector by Script Name + + results = ConnectorsApi(api_client).get_connector(script_name=script_name) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).get_connector(script_name, locale) + print("The response of ConnectorsApi->get_connector:\n") + pprint(results) except Exception as e: - print("Exception when calling ConnectorsApi->get_connector: %s\n" % e) + print("Exception when calling ConnectorsApi->get_connector: %s\n" % e) - path: /connectors method: GET xCodeSample: @@ -2476,16 +2339,15 @@ 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) 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 List - - api_response = api_instance.get_connector_list() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_connector_list(filters, limit, offset, count, locale) - print("The response of ConnectorsApi->get_connector_list:\n") - pprint(api_response) + # Get Connector List + + results = ConnectorsApi(api_client).get_connector_list() + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale) + print("The response of ConnectorsApi->get_connector_list:\n") + pprint(results) except Exception as e: - print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) + print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) - path: /connectors/{scriptName}/source-config method: GET xCodeSample: @@ -2494,16 +2356,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_connector_source_config(script_name) - print("The response of ConnectorsApi->get_connector_source_config:\n") - pprint(api_response) + # Get Connector Source Configuration + + results = ConnectorsApi(api_client).get_connector_source_config(script_name=script_name) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).get_connector_source_config(script_name) + print("The response of ConnectorsApi->get_connector_source_config:\n") + pprint(results) except Exception as e: - print("Exception when calling ConnectorsApi->get_connector_source_config: %s\n" % e) + print("Exception when calling ConnectorsApi->get_connector_source_config: %s\n" % e) - path: /connectors/{scriptName}/source-template method: GET xCodeSample: @@ -2512,16 +2373,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_connector_source_template(script_name) - print("The response of ConnectorsApi->get_connector_source_template:\n") - pprint(api_response) + # Get Connector Source Template + + results = ConnectorsApi(api_client).get_connector_source_template(script_name=script_name) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).get_connector_source_template(script_name) + print("The response of ConnectorsApi->get_connector_source_template:\n") + pprint(results) except Exception as e: - print("Exception when calling ConnectorsApi->get_connector_source_template: %s\n" % e) + print("Exception when calling ConnectorsApi->get_connector_source_template: %s\n" % e) - path: /connectors/{scriptName}/translations/{locale} method: GET xCodeSample: @@ -2531,16 +2391,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_connector_translations(script_name, locale) - print("The response of ConnectorsApi->get_connector_translations:\n") - pprint(api_response) + # Get Connector Translations + + results = ConnectorsApi(api_client).get_connector_translations(script_name=script_name, locale=locale) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).get_connector_translations(script_name, locale) + print("The response of ConnectorsApi->get_connector_translations:\n") + pprint(results) except Exception as e: - print("Exception when calling ConnectorsApi->get_connector_translations: %s\n" % e) + print("Exception when calling ConnectorsApi->get_connector_translations: %s\n" % e) - path: /connectors/{scriptName}/source-config method: PUT xCodeSample: @@ -2550,16 +2409,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_connector_source_config(script_name, file) - print("The response of ConnectorsApi->put_connector_source_config:\n") - pprint(api_response) + # Update Connector Source Configuration + + results = ConnectorsApi(api_client).put_connector_source_config(script_name=script_name, file=file) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).put_connector_source_config(script_name, file) + print("The response of ConnectorsApi->put_connector_source_config:\n") + pprint(results) except Exception as e: - print("Exception when calling ConnectorsApi->put_connector_source_config: %s\n" % e) + print("Exception when calling ConnectorsApi->put_connector_source_config: %s\n" % e) - path: /connectors/{scriptName}/source-template method: PUT xCodeSample: @@ -2569,16 +2427,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_connector_source_template(script_name, file) - print("The response of ConnectorsApi->put_connector_source_template:\n") - pprint(api_response) + # Update Connector Source Template + + results = ConnectorsApi(api_client).put_connector_source_template(script_name=script_name, file=file) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).put_connector_source_template(script_name, file) + print("The response of ConnectorsApi->put_connector_source_template:\n") + pprint(results) except Exception as e: - print("Exception when calling ConnectorsApi->put_connector_source_template: %s\n" % e) + print("Exception when calling ConnectorsApi->put_connector_source_template: %s\n" % e) - path: /connectors/{scriptName}/translations/{locale} method: PUT xCodeSample: @@ -2588,16 +2445,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_connector_translations(script_name, locale) - print("The response of ConnectorsApi->put_connector_translations:\n") - pprint(api_response) + # Update Connector Translations + + results = ConnectorsApi(api_client).put_connector_translations(script_name=script_name, locale=locale) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).put_connector_translations(script_name, locale) + print("The response of ConnectorsApi->put_connector_translations:\n") + pprint(results) except Exception as e: - print("Exception when calling ConnectorsApi->put_connector_translations: %s\n" % e) + print("Exception when calling ConnectorsApi->put_connector_translations: %s\n" % e) - path: /connectors/{scriptName} method: PATCH xCodeSample: @@ -2605,46 +2461,38 @@ label: SDK_tools/sdk/python/v3/methods/connectors#update-connector source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | A list of connector detail update operations - - try: - # Update Connector by Script Name - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_connector(script_name, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_connector(script_name, Result) - print("The response of ConnectorsApi->update_connector:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ConnectorsApi->update_connector: %s\n" % e) + json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of connector detail update operations + try: + # Update Connector by Script Name + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ConnectorsApi(api_client).update_connector(script_name=script_name, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).update_connector(script_name, new_json_patch_operation) + print("The response of ConnectorsApi->update_connector:\n") + pprint(results) + except Exception as e: + print("Exception when calling ConnectorsApi->update_connector: %s\n" % e) - path: /auth-org/network-config method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#create-auth-org-network-config source: | - network_configuration = { + network_configuration = '''{ "range" : [ "1.3.7.2", "255.255.255.252/30" ], "whitelisted" : true, "geolocation" : [ "CA", "FR", "HT" ] - } # NetworkConfiguration | Network configuration creation request body. The following constraints ensure the request body 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. - try: - # Create security network configuration. - Result = network_configuration.from_json(network_configuration) - api_response = api_instance.create_auth_org_network_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_auth_org_network_config(Result) - print("The response of GlobalTenantSecuritySettingsApi->create_auth_org_network_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling GlobalTenantSecuritySettingsApi->create_auth_org_network_config: %s\n" % e) + }''' # NetworkConfiguration | Network configuration creation request body. The following constraints ensure the request body 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. + try: + # Create security network configuration. + new_network_configuration = NetworkConfiguration.from_json(network_configuration) + results = GlobalTenantSecuritySettingsApi(api_client).create_auth_org_network_config(network_configuration=new_network_configuration) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).create_auth_org_network_config(new_network_configuration) + print("The response of GlobalTenantSecuritySettingsApi->create_auth_org_network_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->create_auth_org_network_config: %s\n" % e) - path: /auth-org/lockout-config method: GET xCodeSample: @@ -2652,16 +2500,15 @@ label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#get-auth-org-lockout-config source: | try: - # Get Auth Org Lockout Configuration. - - api_response = api_instance.get_auth_org_lockout_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_auth_org_lockout_config() - print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config:\n") - pprint(api_response) + # Get Auth Org Lockout Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config:\n") + pprint(results) except Exception as e: - print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config: %s\n" % e) + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config: %s\n" % e) - path: /auth-org/network-config method: GET xCodeSample: @@ -2669,16 +2516,15 @@ label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#get-auth-org-network-config source: | try: - # Get security network configuration. - - api_response = api_instance.get_auth_org_network_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_auth_org_network_config() - print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_network_config:\n") - pprint(api_response) + # Get security network configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_network_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_network_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_network_config:\n") + pprint(results) except Exception as e: - print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_network_config: %s\n" % e) + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_network_config: %s\n" % e) - path: /auth-org/service-provider-config method: GET xCodeSample: @@ -2686,16 +2532,15 @@ label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#get-auth-org-service-provider-config source: | try: - # Get Service Provider Configuration. - - api_response = api_instance.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() - print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config:\n") - pprint(api_response) + # Get Service Provider Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config:\n") + pprint(results) except Exception as e: - print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config: %s\n" % e) + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config: %s\n" % e) - path: /auth-org/session-config method: GET xCodeSample: @@ -2703,119 +2548,90 @@ label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#get-auth-org-session-config source: | try: - # Get Auth Org Session Configuration. - - api_response = api_instance.get_auth_org_session_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_auth_org_session_config() - print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_session_config:\n") - pprint(api_response) + # Get Auth Org Session Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_session_config:\n") + pprint(results) except Exception as e: - print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_session_config: %s\n" % e) + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_session_config: %s\n" % e) - path: /auth-org/lockout-config method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#patch-auth-org-lockout-config source: | - [{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", - "path" : "/description", - "value" : "New description" - } # 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` - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_auth_org_lockout_config(Result) - print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config: %s\n" % e) + json_patch_operation = '''[{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` + try: + # Update Auth Org Lockout Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config: %s\n" % e) - path: /auth-org/network-config method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#patch-auth-org-network-config source: | - [{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", - "path" : "/description", - "value" : "New description" - } # 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. - - try: - # Update security network configuration. - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_auth_org_network_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_auth_org_network_config(Result) - print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_network_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_network_config: %s\n" % e) + json_patch_operation = '''[{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. + try: + # Update security network configuration. + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_network_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_network_config: %s\n" % e) - path: /auth-org/service-provider-config method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#patch-auth-org-service-provider-config source: | - [{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", - "path" : "/description", - "value" : "New description" - } # 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) - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_auth_org_service_provider_config(Result) - print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config: %s\n" % e) + json_patch_operation = '''[{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) + try: + # Update Service Provider Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config: %s\n" % e) - path: /auth-org/session-config method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#patch-auth-org-session-config source: | - [{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", - "path" : "/description", - "value" : "New description" - } # 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.` - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_auth_org_session_config(Result) - print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_session_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_session_config: %s\n" % e) + json_patch_operation = '''[{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.` + try: + # Update Auth Org Session Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_session_config: %s\n" % e) - path: /identity-profiles method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/identity-profiles#create-identity-profile source: | - identity_profile = { + identity_profile = '''{ "owner" : { "name" : "William Wilson", "id" : "2c9180835d191a86015d28455b4b232a", @@ -2863,18 +2679,17 @@ "name" : "aName", "modified" : "2015-05-28T14:07:17Z", "id" : "id12345" - } # IdentityProfile | - try: - # Create Identity Profile - Result = identity_profile.from_json(identity_profile) - api_response = api_instance.create_identity_profile(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_identity_profile(Result) - print("The response of IdentityProfilesApi->create_identity_profile:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IdentityProfilesApi->create_identity_profile: %s\n" % e) + }''' # IdentityProfile | + try: + # Create Identity Profile + new_identity_profile = IdentityProfile.from_json(identity_profile) + results = IdentityProfilesApi(api_client).create_identity_profile(identity_profile=new_identity_profile) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).create_identity_profile(new_identity_profile) + print("The response of IdentityProfilesApi->create_identity_profile:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->create_identity_profile: %s\n" % e) - path: /identity-profiles/{identity-profile-id} method: DELETE xCodeSample: @@ -2883,36 +2698,32 @@ source: | identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. try: - # Delete Identity Profile - - api_response = api_instance.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) - print("The response of IdentityProfilesApi->delete_identity_profile:\n") - pprint(api_response) + # Delete Identity Profile + + results = IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id=identity_profile_id) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->delete_identity_profile:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityProfilesApi->delete_identity_profile: %s\n" % e) + print("Exception when calling IdentityProfilesApi->delete_identity_profile: %s\n" % e) - path: /identity-profiles/bulk-delete method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/identity-profiles#delete-identity-profiles source: | - 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. - + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_identity_profiles(Result) - print("The response of IdentityProfilesApi->delete_identity_profiles:\n") - pprint(api_response) + # Delete Identity Profiles + new_request_body = RequestBody.from_json(request_body) + results = IdentityProfilesApi(api_client).delete_identity_profiles(request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).delete_identity_profiles(new_request_body) + print("The response of IdentityProfilesApi->delete_identity_profiles:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityProfilesApi->delete_identity_profiles: %s\n" % e) + print("Exception when calling IdentityProfilesApi->delete_identity_profiles: %s\n" % e) - path: /identity-profiles/export method: GET xCodeSample: @@ -2925,16 +2736,15 @@ filters = '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: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (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, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) sorters = 'id,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: **id, name, priority** (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: **id, name, priority** (optional) try: - # Export Identity Profiles - - api_response = api_instance.export_identity_profiles() - - # Below is a request that includes all optional parameters - # api_response = api_instance.export_identity_profiles(limit, offset, count, filters, sorters) - print("The response of IdentityProfilesApi->export_identity_profiles:\n") - pprint(api_response) + # Export Identity Profiles + + results = IdentityProfilesApi(api_client).export_identity_profiles() + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->export_identity_profiles:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) + print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config method: GET xCodeSample: @@ -2943,16 +2753,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) - print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n") - pprint(api_response) + # Get default Identity Attribute Config + + results = IdentityProfilesApi(api_client).get_default_identity_attribute_config(identity_profile_id=identity_profile_id) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).get_default_identity_attribute_config(identity_profile_id) + print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e) + print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e) - path: /identity-profiles/{identity-profile-id} method: GET xCodeSample: @@ -2961,92 +2770,32 @@ source: | identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. try: - # Get Identity Profile - - api_response = api_instance.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) - print("The response of IdentityProfilesApi->get_identity_profile:\n") - pprint(api_response) + # Get Identity Profile + + results = IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id=identity_profile_id) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->get_identity_profile:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityProfilesApi->get_identity_profile: %s\n" % e) + print("Exception when calling IdentityProfilesApi->get_identity_profile: %s\n" % e) - path: /identity-profiles/import method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/identity-profiles#import-identity-profiles source: | - [sailpoint.v3.IdentityProfileExportedObject()] # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. - identity_profile_exported_object = { - "self" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "version" : 1, - "object" : { - "owner" : { - "name" : "William Wilson", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "IDENTITY" - }, - "identityExceptionReportReference" : { - "reportName" : "My annual report", - "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" - }, - "authoritativeSource" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "hasTimeBasedAttr" : true, - "created" : "2015-05-28T14:07:17Z", - "description" : "My custom flat file profile", - "identityRefreshRequired" : true, - "identityCount" : 8, - "priority" : 10, - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - }, - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "id" : "id12345" - } - } # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. - - try: - # Import Identity Profiles - Result = identity_profile_exported_object.from_json(identity_profile_exported_object) - api_response = api_instance.import_identity_profiles(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.import_identity_profiles(Result) - print("The response of IdentityProfilesApi->import_identity_profiles:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IdentityProfilesApi->import_identity_profiles: %s\n" % e) + identity_profile_exported_object = '''[sailpoint.v3.IdentityProfileExportedObject()]''' # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + try: + # Import Identity Profiles + new_identity_profile_exported_object = IdentityProfileExportedObject.from_json(identity_profile_exported_object) + results = IdentityProfilesApi(api_client).import_identity_profiles(identity_profile_exported_object=new_identity_profile_exported_object) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).import_identity_profiles(new_identity_profile_exported_object) + print("The response of IdentityProfilesApi->import_identity_profiles:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->import_identity_profiles: %s\n" % e) - path: /identity-profiles method: GET xCodeSample: @@ -3059,23 +2808,22 @@ filters = '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: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) sorters = 'id,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: **id, name, priority, created, modified, owner.id, owner.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: **id, name, priority, created, modified, owner.id, owner.name** (optional) try: - # List Identity Profiles - - api_response = api_instance.list_identity_profiles() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_identity_profiles(limit, offset, count, filters, sorters) - print("The response of IdentityProfilesApi->list_identity_profiles:\n") - pprint(api_response) + # List Identity Profiles + + results = IdentityProfilesApi(api_client).list_identity_profiles() + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->list_identity_profiles:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) + print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) - path: /identity-profiles/identity-preview method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/identity-profiles#show-identity-preview source: | - identity_preview_request = { + identity_preview_request = '''{ "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "identityAttributeConfig" : { "attributeTransforms" : [ { @@ -3101,18 +2849,17 @@ } ], "enabled" : true } - } # IdentityPreviewRequest | Identity Preview request body. - try: - # Generate Identity Profile Preview - Result = identity_preview_request.from_json(identity_preview_request) - api_response = api_instance.show_identity_preview(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.show_identity_preview(Result) - print("The response of IdentityProfilesApi->show_identity_preview:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IdentityProfilesApi->show_identity_preview: %s\n" % e) + }''' # IdentityPreviewRequest | Identity Preview request body. + try: + # Generate Identity Profile Preview + new_identity_preview_request = IdentityPreviewRequest.from_json(identity_preview_request) + results = IdentityProfilesApi(api_client).show_identity_preview(identity_preview_request=new_identity_preview_request) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).show_identity_preview(new_identity_preview_request) + print("The response of IdentityProfilesApi->show_identity_preview:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->show_identity_preview: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/process-identities method: POST xCodeSample: @@ -3121,16 +2868,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.sync_identity_profile(identity_profile_id) - print("The response of IdentityProfilesApi->sync_identity_profile:\n") - pprint(api_response) + # Process identities under profile + + results = IdentityProfilesApi(api_client).sync_identity_profile(identity_profile_id=identity_profile_id) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).sync_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->sync_identity_profile:\n") + pprint(results) except Exception as e: - print("Exception when calling IdentityProfilesApi->sync_identity_profile: %s\n" % e) + print("Exception when calling IdentityProfilesApi->sync_identity_profile: %s\n" % e) - path: /identity-profiles/{identity-profile-id} method: PATCH xCodeSample: @@ -3138,24 +2884,17 @@ label: SDK_tools/sdk/python/v3/methods/identity-profiles#update-identity-profile source: | identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. - [{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}] # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - try: - # Update Identity Profile - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_identity_profile(identity_profile_id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_identity_profile(identity_profile_id, Result) - print("The response of IdentityProfilesApi->update_identity_profile:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e) + json_patch_operation = '''[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}]''' # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + try: + # Update Identity Profile + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id=identity_profile_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id, new_json_patch_operation) + print("The response of IdentityProfilesApi->update_identity_profile:\n") + pprint(results) + except Exception as e: + print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/lifecycle-states method: POST xCodeSample: @@ -3163,7 +2902,7 @@ label: SDK_tools/sdk/python/v3/methods/lifecycle-states#create-lifecycle-state source: | identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. - lifecycle_state = { + lifecycle_state = '''{ "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], "emailNotificationOption" : { "notifyManagers" : true, @@ -3187,18 +2926,17 @@ "technicalName" : "Technical Name", "identityState" : "identityState", "enabled" : true - } # LifecycleState | Lifecycle state to be created. - try: - # Create Lifecycle State - Result = lifecycle_state.from_json(lifecycle_state) - api_response = api_instance.create_lifecycle_state(identity_profile_id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_lifecycle_state(identity_profile_id, Result) - print("The response of LifecycleStatesApi->create_lifecycle_state:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling LifecycleStatesApi->create_lifecycle_state: %s\n" % e) + }''' # LifecycleState | Lifecycle state to be created. + try: + # Create Lifecycle State + new_lifecycle_state = LifecycleState.from_json(lifecycle_state) + results = LifecycleStatesApi(api_client).create_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state=new_lifecycle_state) + # Below is a request that includes all optional parameters + # results = LifecycleStatesApi(api_client).create_lifecycle_state(identity_profile_id, new_lifecycle_state) + print("The response of LifecycleStatesApi->create_lifecycle_state:\n") + pprint(results) + except Exception as e: + print("Exception when calling LifecycleStatesApi->create_lifecycle_state: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} method: DELETE xCodeSample: @@ -3208,16 +2946,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_lifecycle_state(identity_profile_id, lifecycle_state_id) - print("The response of LifecycleStatesApi->delete_lifecycle_state:\n") - pprint(api_response) + # Delete Lifecycle State + + results = LifecycleStatesApi(api_client).delete_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id) + # Below is a request that includes all optional parameters + # results = LifecycleStatesApi(api_client).delete_lifecycle_state(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->delete_lifecycle_state:\n") + pprint(results) except Exception as e: - print("Exception when calling LifecycleStatesApi->delete_lifecycle_state: %s\n" % e) + print("Exception when calling LifecycleStatesApi->delete_lifecycle_state: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} method: GET xCodeSample: @@ -3227,16 +2964,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_lifecycle_state(identity_profile_id, lifecycle_state_id) - print("The response of LifecycleStatesApi->get_lifecycle_state:\n") - pprint(api_response) + # Get Lifecycle State + + results = LifecycleStatesApi(api_client).get_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id) + # Below is a request that includes all optional parameters + # results = LifecycleStatesApi(api_client).get_lifecycle_state(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->get_lifecycle_state:\n") + pprint(results) except Exception as e: - print("Exception when calling LifecycleStatesApi->get_lifecycle_state: %s\n" % e) + print("Exception when calling LifecycleStatesApi->get_lifecycle_state: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/lifecycle-states method: GET xCodeSample: @@ -3249,16 +2985,15 @@ 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) sorters = 'created,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-results) Sorting is supported for the following fields: **created, 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-results) Sorting is supported for the following fields: **created, modified** (optional) try: - # Lists LifecycleStates - - api_response = api_instance.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) - print("The response of LifecycleStatesApi->get_lifecycle_states:\n") - pprint(api_response) + # Lists LifecycleStates + + results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id=identity_profile_id) + # Below is a request that includes all optional parameters + # results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) + print("The response of LifecycleStatesApi->get_lifecycle_states:\n") + pprint(results) except Exception as e: - print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) + print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) - path: /identities/{identity-id}/set-lifecycle-state method: POST xCodeSample: @@ -3266,18 +3001,17 @@ label: SDK_tools/sdk/python/v3/methods/lifecycle-states#set-lifecycle-state source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_lifecycle_state(identity_id, Result) - print("The response of LifecycleStatesApi->set_lifecycle_state:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling LifecycleStatesApi->set_lifecycle_state: %s\n" % e) + set_lifecycle_state_request = '''sailpoint.v3.SetLifecycleStateRequest()''' # SetLifecycleStateRequest | + try: + # Set Lifecycle State + new_set_lifecycle_state_request = SetLifecycleStateRequest.from_json(set_lifecycle_state_request) + results = LifecycleStatesApi(api_client).set_lifecycle_state(identity_id=identity_id, set_lifecycle_state_request=new_set_lifecycle_state_request) + # Below is a request that includes all optional parameters + # results = LifecycleStatesApi(api_client).set_lifecycle_state(identity_id, new_set_lifecycle_state_request) + print("The response of LifecycleStatesApi->set_lifecycle_state:\n") + pprint(results) + except Exception as e: + print("Exception when calling LifecycleStatesApi->set_lifecycle_state: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} method: PATCH xCodeSample: @@ -3286,47 +3020,39 @@ source: | 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 - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # 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 - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result) - print("The response of LifecycleStatesApi->update_lifecycle_states:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) + json_patch_operation = '''[{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 + try: + # Update Lifecycle State + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = LifecycleStatesApi(api_client).update_lifecycle_states(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) - path: /managed-clients method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/managed-clients#create-managed-client source: | - managed_client_request = { + managed_client_request = '''{ "name" : "aName", "description" : "A short description of the ManagedClient", "clusterId" : "aClusterId", "type" : "VA" - } # ManagedClientRequest | - try: - # Create Managed Client - Result = managed_client_request.from_json(managed_client_request) - api_response = api_instance.create_managed_client(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_managed_client(Result) - print("The response of ManagedClientsApi->create_managed_client:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) + }''' # ManagedClientRequest | + try: + # Create Managed Client + new_managed_client_request = ManagedClientRequest.from_json(managed_client_request) + results = ManagedClientsApi(api_client).create_managed_client(managed_client_request=new_managed_client_request) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).create_managed_client(new_managed_client_request) + print("The response of ManagedClientsApi->create_managed_client:\n") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) - path: /managed-clients/{id} method: DELETE xCodeSample: @@ -3335,14 +3061,13 @@ source: | id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. try: - # Delete Managed Client - - api_instance.delete_managed_client(id) - - # Below is a request that includes all optional parameters - # api_instance.delete_managed_client(id) + # Delete Managed Client + + ManagedClientsApi(api_client).delete_managed_client(id=id) + # Below is a request that includes all optional parameters + # ManagedClientsApi(api_client).delete_managed_client(id) except Exception as e: - print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e) + print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e) - path: /managed-clients/{id} method: GET xCodeSample: @@ -3351,16 +3076,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_managed_client(id) - print("The response of ManagedClientsApi->get_managed_client:\n") - pprint(api_response) + # Get Managed Client + + results = ManagedClientsApi(api_client).get_managed_client(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client(id) + print("The response of ManagedClientsApi->get_managed_client:\n") + pprint(results) except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) + print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) - path: /managed-clients/{id}/status method: GET xCodeSample: @@ -3370,16 +3094,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_managed_client_status(id, type) - print("The response of ManagedClientsApi->get_managed_client_status:\n") - pprint(api_response) + # Get Managed Client Status + + results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + pprint(results) except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) - path: /managed-clients method: GET xCodeSample: @@ -3391,16 +3114,15 @@ 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) filters = 'name eq \"client 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* **name**: *eq* **clientId**: *eq* **clusterId**: *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* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) try: - # Get Managed Clients - - api_response = api_instance.get_managed_clients() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_managed_clients(offset, limit, count, filters) - print("The response of ManagedClientsApi->get_managed_clients:\n") - pprint(api_response) + # Get Managed Clients + + results = ManagedClientsApi(api_client).get_managed_clients() + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) + print("The response of ManagedClientsApi->get_managed_clients:\n") + pprint(results) except Exception as e: - print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) + print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) - path: /managed-clients/{id} method: PATCH xCodeSample: @@ -3408,31 +3130,24 @@ label: SDK_tools/sdk/python/v3/methods/managed-clients#update-managed-client source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | JSONPatch payload used to update the object. - - try: - # Update Managed Client - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_managed_client(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_managed_client(id, Result) - print("The response of ManagedClientsApi->update_managed_client:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) + json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. + try: + # Update Managed Client + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ManagedClientsApi(api_client).update_managed_client(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation) + print("The response of ManagedClientsApi->update_managed_client:\n") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) - path: /managed-clusters method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/managed-clusters#create-managed-cluster source: | - managed_cluster_request = { + managed_cluster_request = '''{ "configuration" : { "clusterExternalId" : "externalId", "ccgVersion" : "77.0.0" @@ -3440,18 +3155,17 @@ "name" : "Managed Cluster Name", "description" : "A short description of the managed cluster.", "type" : "idn" - } # ManagedClusterRequest | - try: - # Create Create Managed Cluster - Result = managed_cluster_request.from_json(managed_cluster_request) - api_response = api_instance.create_managed_cluster(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_managed_cluster(Result) - print("The response of ManagedClustersApi->create_managed_cluster:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) + }''' # ManagedClusterRequest | + try: + # Create Create Managed Cluster + new_managed_cluster_request = ManagedClusterRequest.from_json(managed_cluster_request) + results = ManagedClustersApi(api_client).create_managed_cluster(managed_cluster_request=new_managed_cluster_request) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request) + print("The response of ManagedClustersApi->create_managed_cluster:\n") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) - path: /managed-clusters/{id} method: DELETE xCodeSample: @@ -3461,14 +3175,13 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_instance.delete_managed_cluster(id, remove_clients) + # Delete Managed Cluster + + ManagedClustersApi(api_client).delete_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # ManagedClustersApi(api_client).delete_managed_cluster(id, remove_clients) except Exception as e: - print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) + print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) - path: /managed-clusters/{id}/log-config method: GET xCodeSample: @@ -3477,16 +3190,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_client_log_configuration(id) - print("The response of ManagedClustersApi->get_client_log_configuration:\n") - pprint(api_response) + # Get Managed Cluster Log Configuration + + results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + pprint(results) except Exception as e: - print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) - path: /managed-clusters/{id} method: GET xCodeSample: @@ -3495,16 +3207,15 @@ source: | id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. try: - # Get Managed Cluster - - api_response = api_instance.get_managed_cluster(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_managed_cluster(id) - print("The response of ManagedClustersApi->get_managed_cluster:\n") - pprint(api_response) + # Get Managed Cluster + + results = ManagedClustersApi(api_client).get_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + pprint(results) except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) - path: /managed-clusters method: GET xCodeSample: @@ -3516,16 +3227,15 @@ 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) filters = 'operational eq \"operation\"' # 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: **operational**: *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: **operational**: *eq* (optional) try: - # Get Managed Clusters - - api_response = api_instance.get_managed_clusters() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_managed_clusters(offset, limit, count, filters) - print("The response of ManagedClustersApi->get_managed_clusters:\n") - pprint(api_response) + # Get Managed Clusters + + results = ManagedClustersApi(api_client).get_managed_clusters() + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + pprint(results) except Exception as e: - print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) - path: /managed-clusters/{id}/log-config method: PUT xCodeSample: @@ -3533,18 +3243,17 @@ label: SDK_tools/sdk/python/v3/methods/managed-clusters#put-client-log-configuration source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_client_log_configuration(id, Result) - print("The response of ManagedClustersApi->put_client_log_configuration:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) + put_client_log_configuration_request = '''sailpoint.v3.PutClientLogConfigurationRequest()''' # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. + try: + # Update Managed Cluster Log Configuration + new_put_client_log_configuration_request = PutClientLogConfigurationRequest.from_json(put_client_log_configuration_request) + results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, put_client_log_configuration_request=new_put_client_log_configuration_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) - path: /managed-clusters/{id} method: PATCH xCodeSample: @@ -3552,24 +3261,17 @@ label: SDK_tools/sdk/python/v3/methods/managed-clusters#update-managed-cluster source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | JSONPatch payload used to update the object. - - try: - # Update Managed Cluster - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_managed_cluster(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_managed_cluster(id, Result) - print("The response of ManagedClustersApi->update_managed_cluster:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) + json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. + try: + # Update Managed Cluster + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ManagedClustersApi(api_client).update_managed_cluster(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation) + print("The response of ManagedClustersApi->update_managed_cluster:\n") + pprint(results) + except Exception as e: + print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -3578,16 +3280,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_mfa_config(method) - print("The response of MFAConfigurationApi->delete_mfa_config:\n") - pprint(api_response) + # Delete MFA method configuration + + results = MFAConfigurationApi(api_client).delete_mfa_config(method=method) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).delete_mfa_config(method) + print("The response of MFAConfigurationApi->delete_mfa_config:\n") + pprint(results) except Exception as e: - print("Exception when calling MFAConfigurationApi->delete_mfa_config: %s\n" % e) + print("Exception when calling MFAConfigurationApi->delete_mfa_config: %s\n" % e) - path: /mfa/duo-web/config method: GET xCodeSample: @@ -3595,16 +3296,15 @@ label: SDK_tools/sdk/python/v3/methods/mfa-configuration#get-mfa-duo-config source: | try: - # Configuration of Duo MFA method - - api_response = api_instance.get_mfa_duo_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_mfa_duo_config() - print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") - pprint(api_response) + # Configuration of Duo MFA method + + results = MFAConfigurationApi(api_client).get_mfa_duo_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + pprint(results) except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) - path: /mfa/kba/config method: GET xCodeSample: @@ -3613,16 +3313,15 @@ source: | 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_mfa_kba_config(all_languages) - print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - pprint(api_response) + # Configuration of KBA MFA method + + results = MFAConfigurationApi(api_client).get_mfa_kba_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + pprint(results) except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) + print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) - path: /mfa/okta-verify/config method: GET xCodeSample: @@ -3630,23 +3329,22 @@ label: SDK_tools/sdk/python/v3/methods/mfa-configuration#get-mfa-okta-config source: | try: - # Configuration of Okta MFA method - - api_response = api_instance.get_mfa_okta_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_mfa_okta_config() - print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") - pprint(api_response) + # Configuration of Okta MFA method + + results = MFAConfigurationApi(api_client).get_mfa_okta_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + pprint(results) except Exception as e: - print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) - path: /mfa/duo-web/config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/mfa-configuration#set-mfa-duo-config source: | - mfa_duo_config = { + mfa_duo_config = '''{ "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", "host" : "example.com", "configProperties" : { @@ -3656,65 +3354,57 @@ "mfaMethod" : "duo-web", "enabled" : true, "identityAttribute" : "email" - } # MfaDuoConfig | - try: - # Set Duo MFA configuration - Result = mfa_duo_config.from_json(mfa_duo_config) - api_response = api_instance.set_mfa_duo_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_mfa_duo_config(Result) - print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) + }''' # MfaDuoConfig | + try: + # Set Duo MFA configuration + new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) + results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) - path: /mfa/okta-verify/config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/mfa-configuration#set-mfa-okta-config source: | - mfa_okta_config = { + mfa_okta_config = '''{ "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", "host" : "example.com", "mfaMethod" : "okta-verify", "enabled" : true, "identityAttribute" : "email" - } # MfaOktaConfig | - try: - # Set Okta MFA configuration - Result = mfa_okta_config.from_json(mfa_okta_config) - api_response = api_instance.set_mfa_okta_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_mfa_okta_config(Result) - print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) + }''' # MfaOktaConfig | + try: + # Set Okta MFA configuration + new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) + results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) - path: /mfa/kba/config/answers method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/mfa-configuration#set-mfakba-config source: | - [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | - kba_answer_request_item = { - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - } # List[KbaAnswerRequestItem] | - - try: - # Set MFA KBA configuration - Result = kba_answer_request_item.from_json(kba_answer_request_item) - api_response = api_instance.set_mfakba_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_mfakba_config(Result) - print("The response of MFAConfigurationApi->set_mfakba_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) + kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | + try: + # Set MFA KBA configuration + new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) + results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) - path: /mfa/{method}/test method: GET xCodeSample: @@ -3723,37 +3413,35 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.test_mfa_config(method) - print("The response of MFAConfigurationApi->test_mfa_config:\n") - pprint(api_response) + # MFA method's test configuration + + results = MFAConfigurationApi(api_client).test_mfa_config(method=method) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + pprint(results) except Exception as e: - print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /mfa/token/send method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/mfa-controller#create-send-token source: | - send_token_request = { + send_token_request = '''{ "userAlias" : "will.albin", "deliveryType" : "EMAIL_WORK" - } # SendTokenRequest | - try: - # Create and send user token - Result = send_token_request.from_json(send_token_request) - api_response = api_instance.create_send_token(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_send_token(Result) - print("The response of MFAControllerApi->create_send_token:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MFAControllerApi->create_send_token: %s\n" % e) + }''' # SendTokenRequest | + try: + # Create and send user token + new_send_token_request = SendTokenRequest.from_json(send_token_request) + results = MFAControllerApi(api_client).create_send_token(send_token_request=new_send_token_request) + # Below is a request that includes all optional parameters + # results = MFAControllerApi(api_client).create_send_token(new_send_token_request) + print("The response of MFAControllerApi->create_send_token:\n") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->create_send_token: %s\n" % e) - path: /mfa/{method}/poll method: POST xCodeSample: @@ -3761,106 +3449,96 @@ label: SDK_tools/sdk/python/v3/methods/mfa-controller#ping-verification-status source: | 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 = { + verification_poll_request = '''{ "requestId" : "089899f13a8f4da7824996191587bab9" - } # VerificationPollRequest | - try: - # Polling MFA method by VerificationPollRequest - Result = verification_poll_request.from_json(verification_poll_request) - api_response = api_instance.ping_verification_status(method, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.ping_verification_status(method, Result) - print("The response of MFAControllerApi->ping_verification_status:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MFAControllerApi->ping_verification_status: %s\n" % e) + }''' # VerificationPollRequest | + try: + # Polling MFA method by VerificationPollRequest + new_verification_poll_request = VerificationPollRequest.from_json(verification_poll_request) + results = MFAControllerApi(api_client).ping_verification_status(method=method, verification_poll_request=new_verification_poll_request) + # Below is a request that includes all optional parameters + # results = MFAControllerApi(api_client).ping_verification_status(method, new_verification_poll_request) + print("The response of MFAControllerApi->ping_verification_status:\n") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->ping_verification_status: %s\n" % e) - path: /mfa/duo-web/verify method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/mfa-controller#send-duo-verify-request source: | - duo_verification_request = { + duo_verification_request = '''{ "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", "userId" : "2c9180947f0ef465017f215cbcfd004b" - } # DuoVerificationRequest | - try: - # Verifying authentication via Duo method - Result = duo_verification_request.from_json(duo_verification_request) - api_response = api_instance.send_duo_verify_request(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.send_duo_verify_request(Result) - print("The response of MFAControllerApi->send_duo_verify_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MFAControllerApi->send_duo_verify_request: %s\n" % e) + }''' # DuoVerificationRequest | + try: + # Verifying authentication via Duo method + new_duo_verification_request = DuoVerificationRequest.from_json(duo_verification_request) + results = MFAControllerApi(api_client).send_duo_verify_request(duo_verification_request=new_duo_verification_request) + # Below is a request that includes all optional parameters + # results = MFAControllerApi(api_client).send_duo_verify_request(new_duo_verification_request) + print("The response of MFAControllerApi->send_duo_verify_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->send_duo_verify_request: %s\n" % e) - path: /mfa/kba/authenticate method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/mfa-controller#send-kba-answers source: | - [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | - kba_answer_request_item = { - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - } # List[KbaAnswerRequestItem] | - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.send_kba_answers(Result) - print("The response of MFAControllerApi->send_kba_answers:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MFAControllerApi->send_kba_answers: %s\n" % e) + kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | + try: + # Authenticate KBA provided MFA method + new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) + results = MFAControllerApi(api_client).send_kba_answers(kba_answer_request_item=new_kba_answer_request_item) + # Below is a request that includes all optional parameters + # results = MFAControllerApi(api_client).send_kba_answers(new_kba_answer_request_item) + print("The response of MFAControllerApi->send_kba_answers:\n") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->send_kba_answers: %s\n" % e) - path: /mfa/okta-verify/verify method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/mfa-controller#send-okta-verify-request source: | - okta_verification_request = { + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.send_okta_verify_request(Result) - print("The response of MFAControllerApi->send_okta_verify_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MFAControllerApi->send_okta_verify_request: %s\n" % e) + }''' # OktaVerificationRequest | + try: + # Verifying authentication via Okta method + new_okta_verification_request = OktaVerificationRequest.from_json(okta_verification_request) + results = MFAControllerApi(api_client).send_okta_verify_request(okta_verification_request=new_okta_verification_request) + # Below is a request that includes all optional parameters + # results = MFAControllerApi(api_client).send_okta_verify_request(new_okta_verification_request) + print("The response of MFAControllerApi->send_okta_verify_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->send_okta_verify_request: %s\n" % e) - path: /mfa/token/authenticate method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/mfa-controller#send-token-auth-request source: | - token_auth_request = { + token_auth_request = '''{ "userAlias" : "will.albin", "deliveryType" : "EMAIL_WORK", "token" : "12345" - } # TokenAuthRequest | - try: - # Authenticate Token provided MFA method - Result = token_auth_request.from_json(token_auth_request) - api_response = api_instance.send_token_auth_request(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.send_token_auth_request(Result) - print("The response of MFAControllerApi->send_token_auth_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) + }''' # TokenAuthRequest | + try: + # Authenticate Token provided MFA method + new_token_auth_request = TokenAuthRequest.from_json(token_auth_request) + results = MFAControllerApi(api_client).send_token_auth_request(token_auth_request=new_token_auth_request) + # Below is a request that includes all optional parameters + # results = MFAControllerApi(api_client).send_token_auth_request(new_token_auth_request) + print("The response of MFAControllerApi->send_token_auth_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) - path: /non-employee-approvals/{id}/approve method: POST xCodeSample: @@ -3868,27 +3546,26 @@ label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#approve-non-employee-request source: | id = 'e136567de87e4d029e60b3c3c55db56d' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) - non_employee_approval_decision = { + non_employee_approval_decision = '''{ "comment" : "Approved by manager" - } # NonEmployeeApprovalDecision | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.approve_non_employee_request(id, Result) - print("The response of NonEmployeeLifecycleManagementApi->approve_non_employee_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->approve_non_employee_request: %s\n" % e) + }''' # NonEmployeeApprovalDecision | + try: + # Approve a Non-Employee Request + new_non_employee_approval_decision = NonEmployeeApprovalDecision.from_json(non_employee_approval_decision) + results = NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id=id, non_employee_approval_decision=new_non_employee_approval_decision) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->approve_non_employee_request: %s\n" % e) - path: /non-employee-records method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#create-non-employee-record source: | - non_employee_request_body = { + non_employee_request_body = '''{ "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", "lastName" : "Smith", @@ -3901,25 +3578,24 @@ "endDate" : "2021-03-25T00:00:00-05:00", "email" : "william.smith@example.com", "startDate" : "2020-03-24T00:00:00-05:00" - } # NonEmployeeRequestBody | Non-Employee record creation request body. - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_record(Result) - print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_record:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_record: %s\n" % e) + }''' # NonEmployeeRequestBody | Non-Employee record creation request body. + try: + # Create Non-Employee Record + new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body) + results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(non_employee_request_body=new_non_employee_request_body) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(new_non_employee_request_body) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_record:\n") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_record: %s\n" % e) - path: /non-employee-requests method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#create-non-employee-request source: | - non_employee_request_body = { + non_employee_request_body = '''{ "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", "lastName" : "Smith", @@ -3932,25 +3608,24 @@ "endDate" : "2021-03-25T00:00:00-05:00", "email" : "william.smith@example.com", "startDate" : "2020-03-24T00:00:00-05:00" - } # NonEmployeeRequestBody | Non-Employee creation request body - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_request(Result) - print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_request: %s\n" % e) + }''' # NonEmployeeRequestBody | Non-Employee creation request body + try: + # Create Non-Employee Request + new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body) + results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(non_employee_request_body=new_non_employee_request_body) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(new_non_employee_request_body) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_request:\n") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_request: %s\n" % e) - path: /non-employee-sources method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#create-non-employee-source source: | - non_employee_source_request_body = { + non_employee_source_request_body = '''{ "owner" : { "id" : "2c91808570313110017040b06f344ec9" }, @@ -3975,18 +3650,17 @@ }, { "id" : "2c91808570313110017040b06f344ec9" } ] - } # NonEmployeeSourceRequestBody | Non-Employee source creation request body. - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_source(Result) - print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source: %s\n" % e) + }''' # NonEmployeeSourceRequestBody | Non-Employee source creation request body. + try: + # Create Non-Employee Source + new_non_employee_source_request_body = NonEmployeeSourceRequestBody.from_json(non_employee_source_request_body) + results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(non_employee_source_request_body=new_non_employee_source_request_body) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes method: POST xCodeSample: @@ -3994,25 +3668,24 @@ label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes source: | source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id - non_employee_schema_attribute_body = { + non_employee_schema_attribute_body = '''{ "helpText" : "The unique identifier for the account", "label" : "Account Name", "placeholder" : "Enter a unique user name for this account.", "type" : "TEXT", "technicalName" : "account.name", "required" : true - } # NonEmployeeSchemaAttributeBody | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) - print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes: %s\n" % e) + }''' # NonEmployeeSchemaAttributeBody | + try: + # Create a new Schema Attribute for Non-Employee Source + new_non_employee_schema_attribute_body = NonEmployeeSchemaAttributeBody.from_json(non_employee_schema_attribute_body) + results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id=source_id, non_employee_schema_attribute_body=new_non_employee_schema_attribute_body) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes: %s\n" % e) - path: /non-employee-records/{id} method: DELETE xCodeSample: @@ -4021,30 +3694,28 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_record(id) + # Delete Non-Employee Record + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id=id) + # Below is a request that includes all optional parameters + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record: %s\n" % e) - path: /non-employee-records/bulk-delete method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk source: | - delete_non_employee_records_in_bulk_request = sailpoint.v3.DeleteNonEmployeeRecordsInBulkRequest() # DeleteNonEmployeeRecordsInBulkRequest | Non-Employee bulk delete request body. + 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_records_in_bulk(Result) + # Delete Multiple Non-Employee Records + new_delete_non_employee_records_in_bulk_request = DeleteNonEmployeeRecordsInBulkRequest.from_json(delete_non_employee_records_in_bulk_request) + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_records_in_bulk(delete_non_employee_records_in_bulk_request=new_delete_non_employee_records_in_bulk_request) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_records_in_bulk: %s\n" % e) - path: /non-employee-requests/{id} method: DELETE xCodeSample: @@ -4053,14 +3724,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_request(id) + # Delete Non-Employee Request + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id=id) + # Below is a request that includes all optional parameters + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_request: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_request: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} method: DELETE xCodeSample: @@ -4070,14 +3740,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_schema_attribute(attribute_id, source_id) + # Delete a Schema Attribute for Non-Employee Source + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_schema_attribute: %s\n" % e) - path: /non-employee-sources/{sourceId} method: DELETE xCodeSample: @@ -4086,14 +3755,13 @@ source: | source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id try: - # Delete Non-Employee Source - - api_instance.delete_non_employee_source(source_id) - - # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_source(source_id) + # Delete Non-Employee Source + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source(source_id=source_id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes method: DELETE xCodeSample: @@ -4102,14 +3770,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_non_employee_source_schema_attributes(source_id) + # Delete all custom schema attributes for Non-Employee Source + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source_schema_attributes(source_id=source_id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source_schema_attributes: %s\n" % e) - path: /non-employee-sources/{id}/non-employees/download method: GET xCodeSample: @@ -4118,14 +3785,13 @@ source: | id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) try: - # Exports Non-Employee Records to CSV - - api_instance.export_non_employee_records(id) - - # Below is a request that includes all optional parameters - # api_instance.export_non_employee_records(id) + # Exports Non-Employee Records to CSV + + NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id=id) + # Below is a request that includes all optional parameters + # NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_records: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_records: %s\n" % e) - path: /non-employee-sources/{id}/schema-attributes-template/download method: GET xCodeSample: @@ -4134,14 +3800,13 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id (UUID) # str | Source Id (UUID) try: - # Exports Source Schema Template - - api_instance.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) + # Exports Source Schema Template + + NonEmployeeLifecycleManagementApi(api_client).export_non_employee_source_schema_template(id=id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_source_schema_template: %s\n" % e) - path: /non-employee-approvals/{id} method: GET xCodeSample: @@ -4151,16 +3816,15 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_approval(id, include_detail) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n") - pprint(api_response) + # Get a non-employee approval item detail + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval(id=id) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval(id, include_detail) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval: %s\n" % e) - path: /non-employee-approvals/summary/{requested-for} method: GET xCodeSample: @@ -4169,16 +3833,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_approval_summary(requested_for) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n") - pprint(api_response) + # Get Summary of Non-Employee Approval Requests + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for=requested_for) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary: %s\n" % e) - path: /non-employee-sources/{id}/non-employee-bulk-upload/status method: GET xCodeSample: @@ -4187,16 +3850,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_bulk_upload_status(id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n") - pprint(api_response) + # Obtain the status of bulk upload on the source + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_bulk_upload_status(id=id) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_bulk_upload_status(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) - path: /non-employee-records/{id} method: GET xCodeSample: @@ -4205,16 +3867,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_record(id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n") - pprint(api_response) + # Get a Non-Employee Record + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id=id) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) - path: /non-employee-requests/{id} method: GET xCodeSample: @@ -4223,16 +3884,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_request(id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n") - pprint(api_response) + # Get a Non-Employee Request + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id=id) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) - path: /non-employee-requests/summary/{requested-for} method: GET xCodeSample: @@ -4241,16 +3901,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_request_summary(requested_for) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n") - pprint(api_response) + # Get Summary of Non-Employee Requests + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for=requested_for) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request_summary: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request_summary: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} method: GET xCodeSample: @@ -4260,16 +3919,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute:\n") - pprint(api_response) + # Get Schema Attribute Non-Employee Source + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) - path: /non-employee-sources/{sourceId} method: GET xCodeSample: @@ -4278,16 +3936,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_source(source_id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source:\n") - pprint(api_response) + # Get a Non-Employee Source + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id=source_id) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes method: GET xCodeSample: @@ -4296,16 +3953,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_non_employee_source_schema_attributes(source_id) - print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - pprint(api_response) + # List Schema Attributes Non-Employee Source + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id=source_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) - path: /non-employee-sources/{id}/non-employee-bulk-upload method: POST xCodeSample: @@ -4315,16 +3971,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.import_non_employee_records_in_bulk(id, data) - print("The response of NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk:\n") - pprint(api_response) + # Imports, or Updates, Non-Employee Records + + results = NonEmployeeLifecycleManagementApi(api_client).import_non_employee_records_in_bulk(id=id, data=data) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk: %s\n" % e) - path: /non-employee-approvals method: GET xCodeSample: @@ -4338,16 +3993,15 @@ filters = 'approvalStatus 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: **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: **approvalStatus**: *eq* (optional) sorters = 'created' # 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: **created, 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-results) Sorting is supported for the following fields: **created, modified** (optional) try: - # Get List of Non-Employee Approval Requests - - api_response = api_instance.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) - print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") - pprint(api_response) + # Get List of Non-Employee Approval Requests + + results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) - path: /non-employee-records method: GET xCodeSample: @@ -4360,16 +4014,15 @@ sorters = 'accountName,sourceId' # 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: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, 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-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) filters = 'sourceId eq \"2c91808568c529c60168cca6f90c1313\"' # 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: **sourceId**: *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: **sourceId**: *eq* (optional) try: - # List Non-Employee Records - - api_response = api_instance.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) - print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - pprint(api_response) + # List Non-Employee Records + + results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records() + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) - path: /non-employee-requests method: GET xCodeSample: @@ -4383,16 +4036,15 @@ sorters = 'created,approvalStatus' # 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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) filters = 'sourceId eq \"2c91808568c529c60168cca6f90c1313\"' # 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: **sourceId**: *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: **sourceId**: *eq* (optional) try: - # List Non-Employee Requests - - api_response = api_instance.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) - print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - pprint(api_response) + # List Non-Employee Requests + + results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for=requested_for) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) - path: /non-employee-sources method: GET xCodeSample: @@ -4406,16 +4058,15 @@ non_employee_count = False # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to False) # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to False) sorters = 'name,created' # 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, created, sourceId** (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, created, sourceId** (optional) try: - # List Non-Employee Sources - - api_response = api_instance.list_non_employee_sources() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) - print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - pprint(api_response) + # List Non-Employee Sources + + results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources() + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") + pprint(results) except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) - path: /non-employee-records/{id} method: PATCH xCodeSample: @@ -4423,24 +4074,17 @@ label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#patch-non-employee-record source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # 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. - - try: - # Patch Non-Employee Record - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_non_employee_record(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_non_employee_record(id, Result) - print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_record: %s\n" % e) + json_patch_operation = '''[{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. + try: + # Patch Non-Employee Record + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id, new_json_patch_operation) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n") + pprint(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_record: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} method: PATCH xCodeSample: @@ -4449,24 +4093,17 @@ source: | 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'. - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # 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'. - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) - print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute: %s\n" % e) + json_patch_operation = '''[{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'. + try: + # Patch a Schema Attribute for Non-Employee Source + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute: %s\n" % e) - path: /non-employee-sources/{sourceId} method: PATCH xCodeSample: @@ -4474,24 +4111,17 @@ label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#patch-non-employee-source source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_non_employee_source(source_id, Result) - print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_source:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_source: %s\n" % e) + json_patch_operation = '''[{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. + try: + # Patch a Non-Employee Source + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id=source_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_source: %s\n" % e) - path: /non-employee-approvals/{id}/reject method: POST xCodeSample: @@ -4499,20 +4129,19 @@ label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#reject-non-employee-request source: | id = 'e136567de87e4d029e60b3c3c55db56d' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) - non_employee_reject_approval_decision = { + non_employee_reject_approval_decision = '''{ "comment" : "approved" - } # NonEmployeeRejectApprovalDecision | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.reject_non_employee_request(id, Result) - print("The response of NonEmployeeLifecycleManagementApi->reject_non_employee_request:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->reject_non_employee_request: %s\n" % e) + }''' # NonEmployeeRejectApprovalDecision | + try: + # Reject a Non-Employee Request + new_non_employee_reject_approval_decision = NonEmployeeRejectApprovalDecision.from_json(non_employee_reject_approval_decision) + results = NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id=id, non_employee_reject_approval_decision=new_non_employee_reject_approval_decision) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->reject_non_employee_request: %s\n" % e) - path: /non-employee-records/{id} method: PUT xCodeSample: @@ -4520,7 +4149,7 @@ label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#update-non-employee-record source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) - non_employee_request_body = { + non_employee_request_body = '''{ "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", "lastName" : "Smith", @@ -4533,25 +4162,24 @@ "endDate" : "2021-03-25T00:00:00-05:00", "email" : "william.smith@example.com", "startDate" : "2020-03-24T00:00:00-05:00" - } # NonEmployeeRequestBody | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_non_employee_record(id, Result) - print("The response of NonEmployeeLifecycleManagementApi->update_non_employee_record:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling NonEmployeeLifecycleManagementApi->update_non_employee_record: %s\n" % e) + }''' # NonEmployeeRequestBody | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + try: + # Update Non-Employee Record + new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body) + results = NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id=id, non_employee_request_body=new_non_employee_request_body) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->update_non_employee_record: %s\n" % e) - path: /oauth-clients method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/o-auth-clients#create-oauth-client source: | - create_o_auth_client_request = { + create_o_auth_client_request = '''{ "internal" : false, "businessName" : "Acme-Solar", "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", @@ -4567,18 +4195,17 @@ "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], "name" : "Demo API Client", "claimsSupported" : false - } # CreateOAuthClientRequest | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_oauth_client(Result) - print("The response of OAuthClientsApi->create_oauth_client:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling OAuthClientsApi->create_oauth_client: %s\n" % e) + }''' # CreateOAuthClientRequest | + try: + # Create OAuth Client + new_create_o_auth_client_request = CreateOAuthClientRequest.from_json(create_o_auth_client_request) + results = OAuthClientsApi(api_client).create_oauth_client(create_o_auth_client_request=new_create_o_auth_client_request) + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).create_oauth_client(new_create_o_auth_client_request) + print("The response of OAuthClientsApi->create_oauth_client:\n") + pprint(results) + except Exception as e: + print("Exception when calling OAuthClientsApi->create_oauth_client: %s\n" % e) - path: /oauth-clients/{id} method: DELETE xCodeSample: @@ -4587,14 +4214,13 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id try: - # Delete OAuth Client - - api_instance.delete_oauth_client(id) - - # Below is a request that includes all optional parameters - # api_instance.delete_oauth_client(id) + # Delete OAuth Client + + OAuthClientsApi(api_client).delete_oauth_client(id=id) + # Below is a request that includes all optional parameters + # OAuthClientsApi(api_client).delete_oauth_client(id) except Exception as e: - print("Exception when calling OAuthClientsApi->delete_oauth_client: %s\n" % e) + print("Exception when calling OAuthClientsApi->delete_oauth_client: %s\n" % e) - path: /oauth-clients/{id} method: GET xCodeSample: @@ -4603,16 +4229,15 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id try: - # Get OAuth Client - - api_response = api_instance.get_oauth_client(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_oauth_client(id) - print("The response of OAuthClientsApi->get_oauth_client:\n") - pprint(api_response) + # Get OAuth Client + + results = OAuthClientsApi(api_client).get_oauth_client(id=id) + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).get_oauth_client(id) + print("The response of OAuthClientsApi->get_oauth_client:\n") + pprint(results) except Exception as e: - print("Exception when calling OAuthClientsApi->get_oauth_client: %s\n" % e) + print("Exception when calling OAuthClientsApi->get_oauth_client: %s\n" % e) - path: /oauth-clients method: GET xCodeSample: @@ -4621,16 +4246,15 @@ source: | 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_oauth_clients(filters) - print("The response of OAuthClientsApi->list_oauth_clients:\n") - pprint(api_response) + # List OAuth Clients + + results = OAuthClientsApi(api_client).list_oauth_clients() + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).list_oauth_clients(filters) + print("The response of OAuthClientsApi->list_oauth_clients:\n") + pprint(results) except Exception as e: - print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) + print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) - path: /oauth-clients/{id} method: PATCH xCodeSample: @@ -4638,47 +4262,39 @@ label: SDK_tools/sdk/python/v3/methods/o-auth-clients#patch-oauth-client source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # 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 - - try: - # Patch OAuth Client - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_oauth_client(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_oauth_client(id, Result) - print("The response of OAuthClientsApi->patch_oauth_client:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e) + json_patch_operation = '''[{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 + try: + # Patch OAuth Client + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = OAuthClientsApi(api_client).patch_oauth_client(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).patch_oauth_client(id, new_json_patch_operation) + print("The response of OAuthClientsApi->patch_oauth_client:\n") + pprint(results) + except Exception as e: + print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e) - path: /password-org-config method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/password-configuration#create-password-org-config source: | - password_org_config = { + password_org_config = '''{ "digitTokenLength" : 9, "digitTokenEnabled" : true, "digitTokenDurationMinutes" : 10, "customInstructionsEnabled" : true - } # PasswordOrgConfig | - try: - # Create Password Org Config - Result = password_org_config.from_json(password_org_config) - api_response = api_instance.create_password_org_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_password_org_config(Result) - print("The response of PasswordConfigurationApi->create_password_org_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordConfigurationApi->create_password_org_config: %s\n" % e) + }''' # PasswordOrgConfig | + try: + # Create Password Org Config + new_password_org_config = PasswordOrgConfig.from_json(password_org_config) + results = PasswordConfigurationApi(api_client).create_password_org_config(password_org_config=new_password_org_config) + # Below is a request that includes all optional parameters + # results = PasswordConfigurationApi(api_client).create_password_org_config(new_password_org_config) + print("The response of PasswordConfigurationApi->create_password_org_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->create_password_org_config: %s\n" % e) - path: /password-org-config method: GET xCodeSample: @@ -4686,39 +4302,37 @@ label: SDK_tools/sdk/python/v3/methods/password-configuration#get-password-org-config source: | try: - # Get Password Org Config - - api_response = api_instance.get_password_org_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_password_org_config() - print("The response of PasswordConfigurationApi->get_password_org_config:\n") - pprint(api_response) + # Get Password Org Config + + results = PasswordConfigurationApi(api_client).get_password_org_config() + # Below is a request that includes all optional parameters + # results = PasswordConfigurationApi(api_client).get_password_org_config() + print("The response of PasswordConfigurationApi->get_password_org_config:\n") + pprint(results) except Exception as e: - print("Exception when calling PasswordConfigurationApi->get_password_org_config: %s\n" % e) + print("Exception when calling PasswordConfigurationApi->get_password_org_config: %s\n" % e) - path: /password-org-config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/password-configuration#put-password-org-config source: | - password_org_config = { + password_org_config = '''{ "digitTokenLength" : 9, "digitTokenEnabled" : true, "digitTokenDurationMinutes" : 10, "customInstructionsEnabled" : true - } # PasswordOrgConfig | - try: - # Update Password Org Config - Result = password_org_config.from_json(password_org_config) - api_response = api_instance.put_password_org_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_password_org_config(Result) - print("The response of PasswordConfigurationApi->put_password_org_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordConfigurationApi->put_password_org_config: %s\n" % e) + }''' # PasswordOrgConfig | + try: + # Update Password Org Config + new_password_org_config = PasswordOrgConfig.from_json(password_org_config) + results = PasswordConfigurationApi(api_client).put_password_org_config(password_org_config=new_password_org_config) + # Below is a request that includes all optional parameters + # results = PasswordConfigurationApi(api_client).put_password_org_config(new_password_org_config) + print("The response of PasswordConfigurationApi->put_password_org_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->put_password_org_config: %s\n" % e) - path: /password-dictionary method: GET xCodeSample: @@ -4726,16 +4340,15 @@ label: SDK_tools/sdk/python/v3/methods/password-dictionary#get-password-dictionary source: | try: - # Get Password Dictionary - - api_response = api_instance.get_password_dictionary() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_password_dictionary() - print("The response of PasswordDictionaryApi->get_password_dictionary:\n") - pprint(api_response) + # Get Password Dictionary + + results = PasswordDictionaryApi(api_client).get_password_dictionary() + # Below is a request that includes all optional parameters + # results = PasswordDictionaryApi(api_client).get_password_dictionary() + print("The response of PasswordDictionaryApi->get_password_dictionary:\n") + pprint(results) except Exception as e: - print("Exception when calling PasswordDictionaryApi->get_password_dictionary: %s\n" % e) + print("Exception when calling PasswordDictionaryApi->get_password_dictionary: %s\n" % e) - path: /password-dictionary method: PUT xCodeSample: @@ -4744,14 +4357,13 @@ source: | file = None # bytearray | (optional) # bytearray | (optional) try: - # Update Password Dictionary - - api_instance.put_password_dictionary() - - # Below is a request that includes all optional parameters - # api_instance.put_password_dictionary(file) + # Update Password Dictionary + + PasswordDictionaryApi(api_client).put_password_dictionary() + # Below is a request that includes all optional parameters + # PasswordDictionaryApi(api_client).put_password_dictionary(file) except Exception as e: - print("Exception when calling PasswordDictionaryApi->put_password_dictionary: %s\n" % e) + print("Exception when calling PasswordDictionaryApi->put_password_dictionary: %s\n" % e) - path: /password-change-status/{id} method: GET xCodeSample: @@ -4760,68 +4372,65 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_password_change_status(id) - print("The response of PasswordManagementApi->get_password_change_status:\n") - pprint(api_response) + # Get Password Change Request Status + + results = PasswordManagementApi(api_client).get_password_change_status(id=id) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).get_password_change_status(id) + print("The response of PasswordManagementApi->get_password_change_status:\n") + pprint(results) except Exception as e: - print("Exception when calling PasswordManagementApi->get_password_change_status: %s\n" % e) + print("Exception when calling PasswordManagementApi->get_password_change_status: %s\n" % e) - path: /query-password-info method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/password-management#query-password-info source: | - password_info_query_dto = { + password_info_query_dto = '''{ "sourceName" : "My-AD", "userName" : "Abby.Smith" - } # PasswordInfoQueryDTO | - try: - # Query Password Info - Result = password_info_query_dto.from_json(password_info_query_dto) - api_response = api_instance.query_password_info(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.query_password_info(Result) - print("The response of PasswordManagementApi->query_password_info:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordManagementApi->query_password_info: %s\n" % e) + }''' # PasswordInfoQueryDTO | + try: + # Query Password Info + new_password_info_query_dto = PasswordInfoQueryDto.from_json(password_info_query_dto) + results = PasswordManagementApi(api_client).query_password_info(password_info_query_dto=new_password_info_query_dto) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).query_password_info(new_password_info_query_dto) + print("The response of PasswordManagementApi->query_password_info:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordManagementApi->query_password_info: %s\n" % e) - path: /set-password method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/password-management#set-password source: | - password_change_request = { + password_change_request = '''{ "sourceId" : "8a807d4c73c545510173c545d4b60246", "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", "identityId" : "8a807d4c73c545510173c545f0a002ff", "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" - } # PasswordChangeRequest | - try: - # Set Identity's Password - Result = password_change_request.from_json(password_change_request) - api_response = api_instance.set_password(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_password(Result) - print("The response of PasswordManagementApi->set_password:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordManagementApi->set_password: %s\n" % e) + }''' # PasswordChangeRequest | + try: + # Set Identity's Password + new_password_change_request = PasswordChangeRequest.from_json(password_change_request) + results = PasswordManagementApi(api_client).set_password(password_change_request=new_password_change_request) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).set_password(new_password_change_request) + print("The response of PasswordManagementApi->set_password:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordManagementApi->set_password: %s\n" % e) - path: /password-policies method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/password-policies#create-password-policy source: | - password_policy_v3_dto = { + password_policy_v3_dto = '''{ "validateAgainstAccountName" : true, "minLength" : 8, "description" : "Information about the Password Policy", @@ -4853,18 +4462,17 @@ "requireStrongAuthOffNetwork" : true, "name" : "PasswordPolicy Example", "maxLength" : 25 - } # PasswordPolicyV3Dto | - try: - # Create Password Policy - Result = password_policy_v3_dto.from_json(password_policy_v3_dto) - api_response = api_instance.create_password_policy(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_password_policy(Result) - print("The response of PasswordPoliciesApi->create_password_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordPoliciesApi->create_password_policy: %s\n" % e) + }''' # PasswordPolicyV3Dto | + try: + # Create Password Policy + new_password_policy_v3_dto = PasswordPolicyV3Dto.from_json(password_policy_v3_dto) + results = PasswordPoliciesApi(api_client).create_password_policy(password_policy_v3_dto=new_password_policy_v3_dto) + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).create_password_policy(new_password_policy_v3_dto) + print("The response of PasswordPoliciesApi->create_password_policy:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->create_password_policy: %s\n" % e) - path: /password-policies/{id} method: DELETE xCodeSample: @@ -4873,14 +4481,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_password_policy(id) + # Delete Password Policy by ID + + PasswordPoliciesApi(api_client).delete_password_policy(id=id) + # Below is a request that includes all optional parameters + # PasswordPoliciesApi(api_client).delete_password_policy(id) except Exception as e: - print("Exception when calling PasswordPoliciesApi->delete_password_policy: %s\n" % e) + print("Exception when calling PasswordPoliciesApi->delete_password_policy: %s\n" % e) - path: /password-policies/{id} method: GET xCodeSample: @@ -4889,16 +4496,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_password_policy_by_id(id) - print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n") - pprint(api_response) + # Get Password Policy by ID + + results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id=id) + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id) + print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n") + pprint(results) except Exception as e: - print("Exception when calling PasswordPoliciesApi->get_password_policy_by_id: %s\n" % e) + print("Exception when calling PasswordPoliciesApi->get_password_policy_by_id: %s\n" % e) - path: /password-policies method: GET xCodeSample: @@ -4909,16 +4515,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) 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) try: - # List Password Policies - - api_response = api_instance.list_password_policies() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_password_policies(limit, offset, count) - print("The response of PasswordPoliciesApi->list_password_policies:\n") - pprint(api_response) + # List Password Policies + + results = PasswordPoliciesApi(api_client).list_password_policies() + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) + print("The response of PasswordPoliciesApi->list_password_policies:\n") + pprint(results) except Exception as e: - print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) + print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) - path: /password-policies/{id} method: PUT xCodeSample: @@ -4926,7 +4531,7 @@ label: SDK_tools/sdk/python/v3/methods/password-policies#set-password-policy source: | id = 'ff808081838d9e9d01838da6a03e0007' # str | The ID of password policy to update. # str | The ID of password policy to update. - password_policy_v3_dto = { + password_policy_v3_dto = '''{ "validateAgainstAccountName" : true, "minLength" : 8, "description" : "Information about the Password Policy", @@ -4958,43 +4563,41 @@ "requireStrongAuthOffNetwork" : true, "name" : "PasswordPolicy Example", "maxLength" : 25 - } # PasswordPolicyV3Dto | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_password_policy(id, Result) - print("The response of PasswordPoliciesApi->set_password_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordPoliciesApi->set_password_policy: %s\n" % e) + }''' # PasswordPolicyV3Dto | + try: + # Update Password Policy by ID + new_password_policy_v3_dto = PasswordPolicyV3Dto.from_json(password_policy_v3_dto) + results = PasswordPoliciesApi(api_client).set_password_policy(id=id, password_policy_v3_dto=new_password_policy_v3_dto) + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).set_password_policy(id, new_password_policy_v3_dto) + print("The response of PasswordPoliciesApi->set_password_policy:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->set_password_policy: %s\n" % e) - path: /password-sync-groups method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/password-sync-groups#create-password-sync-group source: | - password_sync_group = { + password_sync_group = '''{ "created" : "2023-03-16T04:00:00Z", "name" : "Password Sync Group 1", "modified" : "2023-03-16T04:00:00Z", "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } # PasswordSyncGroup | - try: - # Create Password Sync Group - Result = password_sync_group.from_json(password_sync_group) - api_response = api_instance.create_password_sync_group(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_password_sync_group(Result) - print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->create_password_sync_group: %s\n" % e) + }''' # PasswordSyncGroup | + try: + # Create Password Sync Group + new_password_sync_group = PasswordSyncGroup.from_json(password_sync_group) + results = PasswordSyncGroupsApi(api_client).create_password_sync_group(password_sync_group=new_password_sync_group) + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).create_password_sync_group(new_password_sync_group) + print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->create_password_sync_group: %s\n" % e) - path: /password-sync-groups/{id} method: DELETE xCodeSample: @@ -5003,14 +4606,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_password_sync_group(id) + # Delete Password Sync Group by ID + + PasswordSyncGroupsApi(api_client).delete_password_sync_group(id=id) + # Below is a request that includes all optional parameters + # PasswordSyncGroupsApi(api_client).delete_password_sync_group(id) except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->delete_password_sync_group: %s\n" % e) + print("Exception when calling PasswordSyncGroupsApi->delete_password_sync_group: %s\n" % e) - path: /password-sync-groups/{id} method: GET xCodeSample: @@ -5019,16 +4621,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_password_sync_group(id) - print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n") - pprint(api_response) + # Get Password Sync Group by ID + + results = PasswordSyncGroupsApi(api_client).get_password_sync_group(id=id) + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).get_password_sync_group(id) + print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n") + pprint(results) except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->get_password_sync_group: %s\n" % e) + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_group: %s\n" % e) - path: /password-sync-groups method: GET xCodeSample: @@ -5039,16 +4640,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) 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) try: - # Get Password Sync Group List - - api_response = api_instance.get_password_sync_groups() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_password_sync_groups(limit, offset, count) - print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") - pprint(api_response) + # Get Password Sync Group List + + results = PasswordSyncGroupsApi(api_client).get_password_sync_groups() + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) + print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") + pprint(results) except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) - path: /password-sync-groups/{id} method: PUT xCodeSample: @@ -5056,47 +4656,45 @@ label: SDK_tools/sdk/python/v3/methods/password-sync-groups#update-password-sync-group source: | 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 = { + password_sync_group = '''{ "created" : "2023-03-16T04:00:00Z", "name" : "Password Sync Group 1", "modified" : "2023-03-16T04:00:00Z", "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } # PasswordSyncGroup | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_password_sync_group(id, Result) - print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PasswordSyncGroupsApi->update_password_sync_group: %s\n" % e) + }''' # PasswordSyncGroup | + try: + # Update Password Sync Group by ID + new_password_sync_group = PasswordSyncGroup.from_json(password_sync_group) + results = PasswordSyncGroupsApi(api_client).update_password_sync_group(id=id, password_sync_group=new_password_sync_group) + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).update_password_sync_group(id, new_password_sync_group) + print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n") + pprint(results) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->update_password_sync_group: %s\n" % e) - path: /personal-access-tokens method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/personal-access-tokens#create-personal-access-token source: | - create_personal_access_token_request = { + create_personal_access_token_request = '''{ "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], "accessTokenValiditySeconds" : 36900, "name" : "NodeJS Integration" - } # CreatePersonalAccessTokenRequest | Name and scope of personal access token. - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_personal_access_token(Result) - print("The response of PersonalAccessTokensApi->create_personal_access_token:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PersonalAccessTokensApi->create_personal_access_token: %s\n" % e) + }''' # CreatePersonalAccessTokenRequest | Name and scope of personal access token. + try: + # Create Personal Access Token + new_create_personal_access_token_request = CreatePersonalAccessTokenRequest.from_json(create_personal_access_token_request) + results = PersonalAccessTokensApi(api_client).create_personal_access_token(create_personal_access_token_request=new_create_personal_access_token_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->create_personal_access_token: %s\n" % e) - path: /personal-access-tokens/{id} method: DELETE xCodeSample: @@ -5105,14 +4703,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_personal_access_token(id) + # Delete Personal Access Token + + PersonalAccessTokensApi(api_client).delete_personal_access_token(id=id) + # Below is a request that includes all optional parameters + # PersonalAccessTokensApi(api_client).delete_personal_access_token(id) except Exception as e: - print("Exception when calling PersonalAccessTokensApi->delete_personal_access_token: %s\n" % e) + print("Exception when calling PersonalAccessTokensApi->delete_personal_access_token: %s\n" % e) - path: /personal-access-tokens method: GET xCodeSample: @@ -5122,16 +4719,15 @@ 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_personal_access_tokens(owner_id, filters) - print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") - pprint(api_response) + # List Personal Access Tokens + + results = PersonalAccessTokensApi(api_client).list_personal_access_tokens() + # Below is a request that includes all optional parameters + # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) + print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") + pprint(results) except Exception as e: - print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) + print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) - path: /personal-access-tokens/{id} method: PATCH xCodeSample: @@ -5139,24 +4735,17 @@ label: SDK_tools/sdk/python/v3/methods/personal-access-tokens#patch-personal-access-token source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # 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 - - try: - # Patch Personal Access Token - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_personal_access_token(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_personal_access_token(id, Result) - print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PersonalAccessTokensApi->patch_personal_access_token: %s\n" % e) + json_patch_operation = '''[{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 + try: + # Patch Personal Access Token + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = PersonalAccessTokensApi(api_client).patch_personal_access_token(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = PersonalAccessTokensApi(api_client).patch_personal_access_token(id, new_json_patch_operation) + print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n") + pprint(results) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->patch_personal_access_token: %s\n" % e) - path: /public-identities method: GET xCodeSample: @@ -5170,16 +4759,15 @@ add_core_filters = False # bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to False) # bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to False) 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) try: - # Get list of public identities - - api_response = api_instance.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) - print("The response of PublicIdentitiesApi->get_public_identities:\n") - pprint(api_response) + # Get list of public identities + + results = PublicIdentitiesApi(api_client).get_public_identities() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) + print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) - path: /public-identities-config method: GET xCodeSample: @@ -5187,23 +4775,22 @@ label: SDK_tools/sdk/python/v3/methods/public-identities-config#get-public-identity-config source: | try: - # Get the Public Identities Configuration - - api_response = api_instance.get_public_identity_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_public_identity_config() - print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n") - pprint(api_response) + # Get the Public Identities Configuration + + results = PublicIdentitiesConfigApi(api_client).get_public_identity_config() + # Below is a request that includes all optional parameters + # results = PublicIdentitiesConfigApi(api_client).get_public_identity_config() + print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n") + pprint(results) except Exception as e: - print("Exception when calling PublicIdentitiesConfigApi->get_public_identity_config: %s\n" % e) + print("Exception when calling PublicIdentitiesConfigApi->get_public_identity_config: %s\n" % e) - path: /public-identities-config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/public-identities-config#update-public-identity-config source: | - public_identity_config = { + public_identity_config = '''{ "modified" : "2018-06-25T20:22:28.104Z", "attributes" : [ { "name" : "Country", @@ -5217,18 +4804,17 @@ "id" : "2c9180a46faadee4016fb4e018c20639", "type" : "IDENTITY" } - } # PublicIdentityConfig | - try: - # Update the Public Identities Configuration - Result = public_identity_config.from_json(public_identity_config) - api_response = api_instance.update_public_identity_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_public_identity_config(Result) - print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PublicIdentitiesConfigApi->update_public_identity_config: %s\n" % e) + }''' # PublicIdentityConfig | + try: + # Update the Public Identities Configuration + new_public_identity_config = PublicIdentityConfig.from_json(public_identity_config) + results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(public_identity_config=new_public_identity_config) + # Below is a request that includes all optional parameters + # results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(new_public_identity_config) + print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->update_public_identity_config: %s\n" % e) - path: /reports/{id}/cancel method: POST xCodeSample: @@ -5237,14 +4823,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.cancel_report(id) + # Cancel Report + + ReportsDataExtractionApi(api_client).cancel_report(id=id) + # Below is a request that includes all optional parameters + # ReportsDataExtractionApi(api_client).cancel_report(id) except Exception as e: - print("Exception when calling ReportsDataExtractionApi->cancel_report: %s\n" % e) + print("Exception when calling ReportsDataExtractionApi->cancel_report: %s\n" % e) - path: /reports/{taskResultId} method: GET xCodeSample: @@ -5256,16 +4841,15 @@ 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) auditable = False # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to False) # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to False) try: - # Get Report File - - api_response = api_instance.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) - print("The response of ReportsDataExtractionApi->get_report:\n") - pprint(api_response) + # Get Report File + + results = ReportsDataExtractionApi(api_client).get_report(task_result_id=task_result_id, file_format=file_format) + # Below is a request that includes all optional parameters + # results = ReportsDataExtractionApi(api_client).get_report(task_result_id, file_format, name, auditable) + print("The response of ReportsDataExtractionApi->get_report:\n") + pprint(results) except Exception as e: - print("Exception when calling ReportsDataExtractionApi->get_report: %s\n" % e) + print("Exception when calling ReportsDataExtractionApi->get_report: %s\n" % e) - path: /reports/{taskResultId}/result method: GET xCodeSample: @@ -5275,40 +4859,38 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_report_result(task_result_id, completed) - print("The response of ReportsDataExtractionApi->get_report_result:\n") - pprint(api_response) + # Get Report Result + + results = ReportsDataExtractionApi(api_client).get_report_result(task_result_id=task_result_id) + # Below is a request that includes all optional parameters + # results = ReportsDataExtractionApi(api_client).get_report_result(task_result_id, completed) + print("The response of ReportsDataExtractionApi->get_report_result:\n") + pprint(results) except Exception as e: - print("Exception when calling ReportsDataExtractionApi->get_report_result: %s\n" % e) + print("Exception when calling ReportsDataExtractionApi->get_report_result: %s\n" % e) - path: /reports/run method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/reports-data-extraction#start-report source: | - report_details = { + report_details = '''{ "reportType" : "ACCOUNTS", "arguments" : { "application" : "2c9180897e7742b2017e781782f705b9", "sourceName" : "Active Directory" } - } # ReportDetails | - try: - # Run Report - Result = report_details.from_json(report_details) - api_response = api_instance.start_report(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_report(Result) - print("The response of ReportsDataExtractionApi->start_report:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ReportsDataExtractionApi->start_report: %s\n" % e) + }''' # ReportDetails | + try: + # Run Report + new_report_details = ReportDetails.from_json(report_details) + results = ReportsDataExtractionApi(api_client).start_report(report_details=new_report_details) + # Below is a request that includes all optional parameters + # results = ReportsDataExtractionApi(api_client).start_report(new_report_details) + print("The response of ReportsDataExtractionApi->start_report:\n") + pprint(results) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->start_report: %s\n" % e) - path: /requestable-objects method: GET xCodeSample: @@ -5316,36 +4898,31 @@ label: SDK_tools/sdk/python/v3/methods/requestable-objects#list-requestable-objects source: | 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) - - 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) + 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) term = 'Finance Role' # str | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) # str | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) - statuses = [sailpoint.v3.RequestableObjectRequestStatus()] # List[RequestableObjectRequestStatus] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) - - statuses = [sailpoint.v3.RequestableObjectRequestStatus()] # List[RequestableObjectRequestStatus] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) + statuses = '''[sailpoint.v3.RequestableObjectRequestStatus()]''' # List[RequestableObjectRequestStatus] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (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) 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) filters = 'name sw \"bob\"' # 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, in, 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: **id**: *eq, in* **name**: *eq, in, sw* (optional) 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) try: - # Requestable Objects List - - api_response = api_instance.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) - print("The response of RequestableObjectsApi->list_requestable_objects:\n") - pprint(api_response) + # Requestable Objects List + + results = RequestableObjectsApi(api_client).list_requestable_objects() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) + print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) - path: /roles method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/roles#create-role source: | - role = { + role = '''{ "owner" : { "name" : "support", "id" : "2c9180a46faadee4016fb4e018c20639", @@ -5502,38 +5079,36 @@ }, "id" : "2c918086749d78830174a1a40e121518", "requestable" : true - } # Role | - try: - # Create a Role - Result = role.from_json(role) - api_response = api_instance.create_role(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_role(Result) - print("The response of RolesApi->create_role:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling RolesApi->create_role: %s\n" % e) + }''' # Role | + try: + # Create a Role + new_role = Role.from_json(role) + results = RolesApi(api_client).create_role(role=new_role) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).create_role(new_role) + print("The response of RolesApi->create_role:\n") + pprint(results) + except Exception as e: + print("Exception when calling RolesApi->create_role: %s\n" % e) - path: /roles/bulk-delete method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/roles#delete-bulk-roles source: | - role_bulk_delete_request = { + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_bulk_roles(Result) - print("The response of RolesApi->delete_bulk_roles:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling RolesApi->delete_bulk_roles: %s\n" % e) + }''' # RoleBulkDeleteRequest | + try: + # Delete Role(s) + new_role_bulk_delete_request = RoleBulkDeleteRequest.from_json(role_bulk_delete_request) + results = RolesApi(api_client).delete_bulk_roles(role_bulk_delete_request=new_role_bulk_delete_request) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).delete_bulk_roles(new_role_bulk_delete_request) + print("The response of RolesApi->delete_bulk_roles:\n") + pprint(results) + except Exception as e: + print("Exception when calling RolesApi->delete_bulk_roles: %s\n" % e) - path: /roles/{id} method: DELETE xCodeSample: @@ -5542,14 +5117,13 @@ source: | id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role try: - # Delete a Role - - api_instance.delete_role(id) - - # Below is a request that includes all optional parameters - # api_instance.delete_role(id) + # Delete a Role + + RolesApi(api_client).delete_role(id=id) + # Below is a request that includes all optional parameters + # RolesApi(api_client).delete_role(id) except Exception as e: - print("Exception when calling RolesApi->delete_role: %s\n" % e) + print("Exception when calling RolesApi->delete_role: %s\n" % e) - path: /roles/{id} method: GET xCodeSample: @@ -5558,16 +5132,15 @@ source: | id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role try: - # Get a Role - - api_response = api_instance.get_role(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_role(id) - print("The response of RolesApi->get_role:\n") - pprint(api_response) + # Get a Role + + results = RolesApi(api_client).get_role(id=id) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).get_role(id) + print("The response of RolesApi->get_role:\n") + pprint(results) except Exception as e: - print("Exception when calling RolesApi->get_role: %s\n" % e) + print("Exception when calling RolesApi->get_role: %s\n" % e) - path: /roles/{id}/assigned-identities method: GET xCodeSample: @@ -5581,16 +5154,15 @@ filters = 'name sw Joe' # 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* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, 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: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) sorters = 'aliasName,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: **id, name, aliasName, email** (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: **id, name, aliasName, email** (optional) try: - # List Identities assigned a Role - - api_response = api_instance.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) - print("The response of RolesApi->get_role_assigned_identities:\n") - pprint(api_response) + # List Identities assigned a Role + + results = RolesApi(api_client).get_role_assigned_identities(id=id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) + print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) - path: /roles method: GET xCodeSample: @@ -5606,16 +5178,15 @@ for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) try: - # List Roles - - api_response = api_instance.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) - print("The response of RolesApi->list_roles:\n") - pprint(api_response) + # List Roles + + results = RolesApi(api_client).list_roles() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling RolesApi->list_roles: %s\n" % e) + print("Exception when calling RolesApi->list_roles: %s\n" % e) - path: /roles/{id} method: PATCH xCodeSample: @@ -5623,42 +5194,34 @@ label: SDK_tools/sdk/python/v3/methods/roles#patch-role source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | - - try: - # Patch a specified Role - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_role(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_role(id, Result) - print("The response of RolesApi->patch_role:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling RolesApi->patch_role: %s\n" % e) + json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]''' # List[JsonPatchOperation] | + try: + # Patch a specified Role + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = RolesApi(api_client).patch_role(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).patch_role(id, new_json_patch_operation) + print("The response of RolesApi->patch_role:\n") + pprint(results) + except Exception as e: + print("Exception when calling RolesApi->patch_role: %s\n" % e) - path: /saved-searches method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/saved-search#create-saved-search source: | - create_saved_search_request = sailpoint.v3.CreateSavedSearchRequest() # CreateSavedSearchRequest | The saved search to persist. + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_saved_search(Result) - print("The response of SavedSearchApi->create_saved_search:\n") - pprint(api_response) + # Create a saved search + new_create_saved_search_request = CreateSavedSearchRequest.from_json(create_saved_search_request) + results = SavedSearchApi(api_client).create_saved_search(create_saved_search_request=new_create_saved_search_request) + # Below is a request that includes all optional parameters + # results = SavedSearchApi(api_client).create_saved_search(new_create_saved_search_request) + print("The response of SavedSearchApi->create_saved_search:\n") + pprint(results) except Exception as e: - print("Exception when calling SavedSearchApi->create_saved_search: %s\n" % e) + print("Exception when calling SavedSearchApi->create_saved_search: %s\n" % e) - path: /saved-searches/{id} method: DELETE xCodeSample: @@ -5667,14 +5230,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_saved_search(id) + # Delete document by ID + + SavedSearchApi(api_client).delete_saved_search(id=id) + # Below is a request that includes all optional parameters + # SavedSearchApi(api_client).delete_saved_search(id) except Exception as e: - print("Exception when calling SavedSearchApi->delete_saved_search: %s\n" % e) + print("Exception when calling SavedSearchApi->delete_saved_search: %s\n" % e) - path: /saved-searches/{id}/execute method: POST xCodeSample: @@ -5682,7 +5244,7 @@ label: SDK_tools/sdk/python/v3/methods/saved-search#execute-saved-search source: | id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - search_arguments = { + search_arguments = '''{ "owner" : "", "recipients" : [ { "id" : "2c91808568c529c60168cca6f90c1313", @@ -5692,16 +5254,15 @@ "type" : "IDENTITY" } ], "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" - } # SearchArguments | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. + }''' # SearchArguments | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. try: - # Execute a saved search by ID - Result = search_arguments.from_json(search_arguments) - api_instance.execute_saved_search(id, Result) - - # Below is a request that includes all optional parameters - # api_instance.execute_saved_search(id, Result) + # Execute a saved search by ID + new_search_arguments = SearchArguments.from_json(search_arguments) + SavedSearchApi(api_client).execute_saved_search(id=id, search_arguments=new_search_arguments) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling SavedSearchApi->execute_saved_search: %s\n" % e) - path: /saved-searches/{id} method: GET xCodeSample: @@ -5710,16 +5271,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_saved_search(id) - print("The response of SavedSearchApi->get_saved_search:\n") - pprint(api_response) + # Return saved search by ID + + results = SavedSearchApi(api_client).get_saved_search(id=id) + # Below is a request that includes all optional parameters + # results = SavedSearchApi(api_client).get_saved_search(id) + print("The response of SavedSearchApi->get_saved_search:\n") + pprint(results) except Exception as e: - print("Exception when calling SavedSearchApi->get_saved_search: %s\n" % e) + print("Exception when calling SavedSearchApi->get_saved_search: %s\n" % e) - path: /saved-searches method: GET xCodeSample: @@ -5731,16 +5291,15 @@ 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) filters = 'owner.id eq \"7a724640-0c17-4ce9-a8c3-4a89738459c8\"' # 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: **owner.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: **owner.id**: *eq* (optional) try: - # A list of Saved Searches - - api_response = api_instance.list_saved_searches() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_saved_searches(offset, limit, count, filters) - print("The response of SavedSearchApi->list_saved_searches:\n") - pprint(api_response) + # A list of Saved Searches + + results = SavedSearchApi(api_client).list_saved_searches() + # Below is a request that includes all optional parameters + # results = SavedSearchApi(api_client).list_saved_searches(offset, limit, count, filters) + print("The response of SavedSearchApi->list_saved_searches:\n") + pprint(results) except Exception as e: - print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) + print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) - path: /saved-searches/{id} method: PUT xCodeSample: @@ -5748,7 +5307,7 @@ label: SDK_tools/sdk/python/v3/methods/saved-search#put-saved-search source: | id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - saved_search = { + saved_search = '''{ "owner" : { "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" @@ -5792,36 +5351,34 @@ "modified" : "2018-06-25T20:22:28.104Z", "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", "fields" : [ "disabled" ] - } # SavedSearch | The saved search to persist. - try: - # Updates an existing saved search - Result = saved_search.from_json(saved_search) - api_response = api_instance.put_saved_search(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_saved_search(id, Result) - print("The response of SavedSearchApi->put_saved_search:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SavedSearchApi->put_saved_search: %s\n" % e) + }''' # SavedSearch | The saved search to persist. + try: + # Updates an existing saved search + new_saved_search = SavedSearch.from_json(saved_search) + results = SavedSearchApi(api_client).put_saved_search(id=id, saved_search=new_saved_search) + # Below is a request that includes all optional parameters + # results = SavedSearchApi(api_client).put_saved_search(id, new_saved_search) + print("The response of SavedSearchApi->put_saved_search:\n") + pprint(results) + except Exception as e: + print("Exception when calling SavedSearchApi->put_saved_search: %s\n" % e) - path: /scheduled-searches method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/scheduled-search#create-scheduled-search source: | - 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. + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_scheduled_search(Result) - print("The response of ScheduledSearchApi->create_scheduled_search:\n") - pprint(api_response) + # Create a new scheduled search + new_create_scheduled_search_request = CreateScheduledSearchRequest.from_json(create_scheduled_search_request) + results = ScheduledSearchApi(api_client).create_scheduled_search(create_scheduled_search_request=new_create_scheduled_search_request) + # Below is a request that includes all optional parameters + # results = ScheduledSearchApi(api_client).create_scheduled_search(new_create_scheduled_search_request) + print("The response of ScheduledSearchApi->create_scheduled_search:\n") + pprint(results) except Exception as e: - print("Exception when calling ScheduledSearchApi->create_scheduled_search: %s\n" % e) + print("Exception when calling ScheduledSearchApi->create_scheduled_search: %s\n" % e) - path: /scheduled-searches/{id} method: DELETE xCodeSample: @@ -5830,14 +5387,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_scheduled_search(id) + # Delete a Scheduled Search + + ScheduledSearchApi(api_client).delete_scheduled_search(id=id) + # Below is a request that includes all optional parameters + # ScheduledSearchApi(api_client).delete_scheduled_search(id) except Exception as e: - print("Exception when calling ScheduledSearchApi->delete_scheduled_search: %s\n" % e) + print("Exception when calling ScheduledSearchApi->delete_scheduled_search: %s\n" % e) - path: /scheduled-searches/{id} method: GET xCodeSample: @@ -5846,16 +5402,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_scheduled_search(id) - print("The response of ScheduledSearchApi->get_scheduled_search:\n") - pprint(api_response) + # Get a Scheduled Search + + results = ScheduledSearchApi(api_client).get_scheduled_search(id=id) + # Below is a request that includes all optional parameters + # results = ScheduledSearchApi(api_client).get_scheduled_search(id) + print("The response of ScheduledSearchApi->get_scheduled_search:\n") + pprint(results) except Exception as e: - print("Exception when calling ScheduledSearchApi->get_scheduled_search: %s\n" % e) + print("Exception when calling ScheduledSearchApi->get_scheduled_search: %s\n" % e) - path: /scheduled-searches method: GET xCodeSample: @@ -5867,16 +5422,15 @@ 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) filters = 'savedSearchId eq \"6cc0945d-9eeb-4948-9033-72d066e1153e\"' # 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: **owner.id**: *eq* **savedSearchId**: *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: **owner.id**: *eq* **savedSearchId**: *eq* (optional) try: - # List scheduled searches - - api_response = api_instance.list_scheduled_search() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_scheduled_search(offset, limit, count, filters) - print("The response of ScheduledSearchApi->list_scheduled_search:\n") - pprint(api_response) + # List scheduled searches + + results = ScheduledSearchApi(api_client).list_scheduled_search() + # Below is a request that includes all optional parameters + # results = ScheduledSearchApi(api_client).list_scheduled_search(offset, limit, count, filters) + print("The response of ScheduledSearchApi->list_scheduled_search:\n") + pprint(results) except Exception as e: - print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) + print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) - path: /scheduled-searches/{id}/unsubscribe method: POST xCodeSample: @@ -5884,19 +5438,18 @@ label: SDK_tools/sdk/python/v3/methods/scheduled-search#unsubscribe-scheduled-search source: | id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - typed_reference = { + typed_reference = '''{ "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" - } # TypedReference | The recipient to be removed from the scheduled search. + }''' # TypedReference | The recipient to be removed from the scheduled search. try: - # Unsubscribe a recipient from Scheduled Search - Result = typed_reference.from_json(typed_reference) - api_instance.unsubscribe_scheduled_search(id, Result) - - # Below is a request that includes all optional parameters - # api_instance.unsubscribe_scheduled_search(id, Result) + # Unsubscribe a recipient from Scheduled Search + new_typed_reference = TypedReference.from_json(typed_reference) + ScheduledSearchApi(api_client).unsubscribe_scheduled_search(id=id, typed_reference=new_typed_reference) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling ScheduledSearchApi->unsubscribe_scheduled_search: %s\n" % e) - path: /scheduled-searches/{id} method: PUT xCodeSample: @@ -5904,7 +5457,7 @@ label: SDK_tools/sdk/python/v3/methods/scheduled-search#update-scheduled-search source: | id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. - scheduled_search = { + scheduled_search = '''{ "owner" : { "id" : "2c9180867624cbd7017642d8c8c81f67", "type" : "IDENTITY" @@ -5946,25 +5499,24 @@ "modified" : "", "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", "emailEmptyResults" : false - } # ScheduledSearch | The scheduled search to persist. - try: - # Update an existing Scheduled Search - Result = scheduled_search.from_json(scheduled_search) - api_response = api_instance.update_scheduled_search(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_scheduled_search(id, Result) - print("The response of ScheduledSearchApi->update_scheduled_search:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ScheduledSearchApi->update_scheduled_search: %s\n" % e) + }''' # ScheduledSearch | The scheduled search to persist. + try: + # Update an existing Scheduled Search + new_scheduled_search = ScheduledSearch.from_json(scheduled_search) + results = ScheduledSearchApi(api_client).update_scheduled_search(id=id, scheduled_search=new_scheduled_search) + # Below is a request that includes all optional parameters + # results = ScheduledSearchApi(api_client).update_scheduled_search(id, new_scheduled_search) + print("The response of ScheduledSearchApi->update_scheduled_search:\n") + pprint(results) + except Exception as e: + print("Exception when calling ScheduledSearchApi->update_scheduled_search: %s\n" % e) - path: /search/aggregate method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/search#search-aggregate source: | - search = { + search = '''{ "queryDsl" : { "match" : { "name" : "john.doe" @@ -6080,28 +5632,27 @@ "type" : "access" } } - } # Search | + }''' # Search | 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) try: - # Perform a Search Query Aggregation - Result = search.from_json(search) - api_response = api_instance.search_aggregate(Result, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.search_aggregate(Result, offset, limit, count) - print("The response of SearchApi->search_aggregate:\n") - pprint(api_response) + # Perform a Search Query Aggregation + new_search = Search.from_json(search) + results = SearchApi(api_client).search_aggregate(search=new_search) + # Below is a request that includes all optional parameters + # results = SearchApi(api_client).search_aggregate(new_search, offset, limit, count) + print("The response of SearchApi->search_aggregate:\n") + pprint(results) except Exception as e: - print("Exception when calling SearchApi->search_aggregate: %s\n" % e) + print("Exception when calling SearchApi->search_aggregate: %s\n" % e) - path: /search/count method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/search#search-count source: | - search = { + search = '''{ "queryDsl" : { "match" : { "name" : "john.doe" @@ -6217,16 +5768,15 @@ "type" : "access" } } - } # Search | + }''' # Search | try: - # Count Documents Satisfying a Query - Result = search.from_json(search) - api_instance.search_count(Result) - - # Below is a request that includes all optional parameters - # api_instance.search_count(Result) + # Count Documents Satisfying a Query + new_search = Search.from_json(search) + SearchApi(api_client).search_count(search=new_search) + # Below is a request that includes all optional parameters + # SearchApi(api_client).search_count(new_search) except Exception as e: - print("Exception when calling SearchApi->search_count: %s\n" % e) + print("Exception when calling SearchApi->search_count: %s\n" % e) - path: /search/{index}/{id} method: GET xCodeSample: @@ -6236,23 +5786,22 @@ index = 'identities' # 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.search_get(index, id) - print("The response of SearchApi->search_get:\n") - pprint(api_response) + # Get a Document by ID + + results = SearchApi(api_client).search_get(index=index, id=id) + # Below is a request that includes all optional parameters + # results = SearchApi(api_client).search_get(index, id) + print("The response of SearchApi->search_get:\n") + pprint(results) except Exception as e: - print("Exception when calling SearchApi->search_get: %s\n" % e) + print("Exception when calling SearchApi->search_get: %s\n" % e) - path: /search method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/search#search-post source: | - search = { + search = '''{ "queryDsl" : { "match" : { "name" : "john.doe" @@ -6368,46 +5917,44 @@ "type" : "access" } } - } # Search | + }''' # Search | 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) try: - # Perform Search - Result = search.from_json(search) - api_response = api_instance.search_post(Result, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.search_post(Result, offset, limit, count) - print("The response of SearchApi->search_post:\n") - pprint(api_response) + # Perform Search + new_search = Search.from_json(search) + results = SearchApi(api_client).search_post(search=new_search) + # Below is a request that includes all optional parameters + # results = SearchApi(api_client).search_post(new_search, offset, limit, count) + print("The response of SearchApi->search_post:\n") + pprint(results) except Exception as e: - print("Exception when calling SearchApi->search_post: %s\n" % e) + print("Exception when calling SearchApi->search_post: %s\n" % e) - path: /accounts/search-attribute-config method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#create-search-attribute-config source: | - search_attribute_config = { + search_attribute_config = '''{ "displayName" : "New Mail Attribute", "name" : "newMailAttribute", "applicationAttributes" : { "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" } - } # SearchAttributeConfig | - try: - # Create Extended Search Attributes - Result = search_attribute_config.from_json(search_attribute_config) - api_response = api_instance.create_search_attribute_config(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_search_attribute_config(Result) - print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) + }''' # SearchAttributeConfig | + try: + # Create Extended Search Attributes + new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config) + results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(search_attribute_config=new_search_attribute_config) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config) + print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} method: DELETE xCodeSample: @@ -6416,14 +5963,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_search_attribute_config(name) + # Delete Extended Search Attribute + + SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name) + # Below is a request that includes all optional parameters + # SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name) except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) + print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config method: GET xCodeSample: @@ -6431,16 +5977,15 @@ label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#get-search-attribute-config source: | try: - # List Extended Search Attributes - - api_response = api_instance.get_search_attribute_config() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_search_attribute_config() - print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - pprint(api_response) + # List Extended Search Attributes + + results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config() + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config() + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + pprint(results) except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) + print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} method: GET xCodeSample: @@ -6449,16 +5994,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_single_search_attribute_config(name) - print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") - pprint(api_response) + # Get Extended Search Attribute + + results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) + print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") + pprint(results) except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) + print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} method: PATCH xCodeSample: @@ -6466,31 +6010,24 @@ label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#patch-search-attribute-config source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | - - try: - # Update Extended Search Attribute - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_search_attribute_config(name, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_search_attribute_config(name, Result) - print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) + json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | + try: + # Update Extended Search Attribute + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation) + print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") + pprint(results) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) - path: /segments method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/segments#create-segment source: | - segment = { + segment = '''{ "owner" : { "name" : "support", "id" : "2c9180a46faadee4016fb4e018c20639", @@ -6513,18 +6050,17 @@ "description" : "This segment represents xyz", "active" : true, "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - } # Segment | - try: - # Create Segment - Result = segment.from_json(segment) - api_response = api_instance.create_segment(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_segment(Result) - print("The response of SegmentsApi->create_segment:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SegmentsApi->create_segment: %s\n" % e) + }''' # Segment | + try: + # Create Segment + new_segment = Segment.from_json(segment) + results = SegmentsApi(api_client).create_segment(segment=new_segment) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).create_segment(new_segment) + print("The response of SegmentsApi->create_segment:\n") + pprint(results) + except Exception as e: + print("Exception when calling SegmentsApi->create_segment: %s\n" % e) - path: /segments/{id} method: DELETE xCodeSample: @@ -6533,14 +6069,13 @@ source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. try: - # Delete Segment by ID - - api_instance.delete_segment(id) - - # Below is a request that includes all optional parameters - # api_instance.delete_segment(id) + # Delete Segment by ID + + SegmentsApi(api_client).delete_segment(id=id) + # Below is a request that includes all optional parameters + # SegmentsApi(api_client).delete_segment(id) except Exception as e: - print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) + print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) - path: /segments/{id} method: GET xCodeSample: @@ -6549,16 +6084,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_segment(id) - print("The response of SegmentsApi->get_segment:\n") - pprint(api_response) + # Get Segment by ID + + results = SegmentsApi(api_client).get_segment(id=id) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + pprint(results) except Exception as e: - print("Exception when calling SegmentsApi->get_segment: %s\n" % e) + print("Exception when calling SegmentsApi->get_segment: %s\n" % e) - path: /segments method: GET xCodeSample: @@ -6569,16 +6103,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) 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) try: - # List Segments - - api_response = api_instance.list_segments() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_segments(limit, offset, count) - print("The response of SegmentsApi->list_segments:\n") - pprint(api_response) + # List Segments + + results = SegmentsApi(api_client).list_segments() + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).list_segments(limit, offset, count) + print("The response of SegmentsApi->list_segments:\n") + pprint(results) except Exception as e: - print("Exception when calling SegmentsApi->list_segments: %s\n" % e) + print("Exception when calling SegmentsApi->list_segments: %s\n" % e) - path: /segments/{id} method: PATCH xCodeSample: @@ -6586,27 +6119,24 @@ label: SDK_tools/sdk/python/v3/methods/segments#patch-segment source: | 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 - - try: - # Update Segment - Result = request_body.from_json(request_body) - api_response = api_instance.patch_segment(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_segment(id, Result) - print("The response of SegmentsApi->patch_segment:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) + 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 + try: + # Update Segment + new_request_body = RequestBody.from_json(request_body) + results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).patch_segment(id, new_request_body) + print("The response of SegmentsApi->patch_segment:\n") + pprint(results) + except Exception as e: + print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) - path: /service-desk-integrations method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/service-desk-integration#create-service-desk-integration source: | - service_desk_integration_dto = { + service_desk_integration_dto = '''{ "ownerRef" : "", "cluster" : "xyzzy999", "created" : "2024-01-17T18:45:25.994Z", @@ -6639,18 +6169,17 @@ }, "id" : "62945a496ef440189b1f03e3623411c8", "beforeProvisioningRule" : "" - } # ServiceDeskIntegrationDto | The specifics of a new integration to create - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_service_desk_integration(Result) - print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) + }''' # ServiceDeskIntegrationDto | The specifics of a new integration to create + try: + # Create new Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) + results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(service_desk_integration_dto=new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto) + print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) - path: /service-desk-integrations/{id} method: DELETE xCodeSample: @@ -6659,14 +6188,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_service_desk_integration(id) + # Delete a Service Desk integration + + ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id=id) + # Below is a request that includes all optional parameters + # ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id) except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) + print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) - path: /service-desk-integrations/{id} method: GET xCodeSample: @@ -6675,16 +6203,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_service_desk_integration(id) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") - pprint(api_response) + # Get a Service Desk integration + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id=id) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n") + pprint(results) except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) - path: /service-desk-integrations/templates/{scriptName} method: GET xCodeSample: @@ -6693,16 +6220,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_service_desk_integration_template(script_name) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") - pprint(api_response) + # Service Desk integration template by scriptName + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name=script_name) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n") + pprint(results) except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) - path: /service-desk-integrations/types method: GET xCodeSample: @@ -6710,16 +6236,15 @@ label: SDK_tools/sdk/python/v3/methods/service-desk-integration#get-service-desk-integration-types source: | try: - # List Service Desk integration types - - api_response = api_instance.get_service_desk_integration_types() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_service_desk_integration_types() - print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - pprint(api_response) + # List Service Desk integration types + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() + print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") + pprint(results) except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) - path: /service-desk-integrations method: GET xCodeSample: @@ -6732,16 +6257,15 @@ filters = 'name eq \"John Doe\"' # 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* **type**: *eq, in* **cluster**: *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: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) 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) try: - # List existing Service Desk integrations - - api_response = api_instance.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) - print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") - pprint(api_response) + # List existing Service Desk integrations + + results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations(offset, limit, sorters, filters, count) + print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") + pprint(results) except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) + print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) - path: /service-desk-integrations/status-check-configuration method: GET xCodeSample: @@ -6749,16 +6273,15 @@ label: SDK_tools/sdk/python/v3/methods/service-desk-integration#get-status-check-details source: | try: - # Get the time check configuration - - api_response = api_instance.get_status_check_details() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_status_check_details() - print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") - pprint(api_response) + # Get the time check configuration + + results = ServiceDeskIntegrationApi(api_client).get_status_check_details() + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).get_status_check_details() + print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") + pprint(results) except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) + print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) - path: /service-desk-integrations/{id} method: PATCH xCodeSample: @@ -6766,18 +6289,17 @@ label: SDK_tools/sdk/python/v3/methods/service-desk-integration#patch-service-desk-integration source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_service_desk_integration(id, Result) - print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) + 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 + new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) - path: /service-desk-integrations/{id} method: PUT xCodeSample: @@ -6785,7 +6307,7 @@ label: SDK_tools/sdk/python/v3/methods/service-desk-integration#put-service-desk-integration source: | id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - service_desk_integration_dto = { + service_desk_integration_dto = '''{ "ownerRef" : "", "cluster" : "xyzzy999", "created" : "2024-01-17T18:45:25.994Z", @@ -6818,46 +6340,44 @@ }, "id" : "62945a496ef440189b1f03e3623411c8", "beforeProvisioningRule" : "" - } # ServiceDeskIntegrationDto | The specifics of the integration to update - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_service_desk_integration(id, Result) - print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) + }''' # ServiceDeskIntegrationDto | The specifics of the integration to update + try: + # Update a Service Desk integration + new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto) + results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id=id, service_desk_integration_dto=new_service_desk_integration_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) - path: /service-desk-integrations/status-check-configuration method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/service-desk-integration#update-status-check-details source: | - queued_check_config_details = { + queued_check_config_details = '''{ "provisioningStatusCheckIntervalMinutes" : "30", "provisioningMaxStatusCheckDays" : "2" - } # QueuedCheckConfigDetails | The modified time check configuration - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_status_check_details(Result) - print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) + }''' # QueuedCheckConfigDetails | The modified time check configuration + try: + # Update the time check configuration + new_queued_check_config_details = QueuedCheckConfigDetails.from_json(queued_check_config_details) + results = ServiceDeskIntegrationApi(api_client).update_status_check_details(queued_check_config_details=new_queued_check_config_details) + # Below is a request that includes all optional parameters + # results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details) + print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n") + pprint(results) + except Exception as e: + print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e) - path: /sod-policies method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-policies#create-sod-policy source: | - sod_policy = { + sod_policy = '''{ "conflictingAccessCriteria" : { "leftCriteria" : { "name" : "money-in", @@ -6912,18 +6432,17 @@ "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", "state" : "ENFORCED", "externalPolicyReference" : "XYZ policy" - } # SodPolicy | - try: - # Create SOD policy - Result = sod_policy.from_json(sod_policy) - api_response = api_instance.create_sod_policy(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_sod_policy(Result) - print("The response of SODPoliciesApi->create_sod_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) + }''' # SodPolicy | + try: + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") + pprint(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) - path: /sod-policies/{id} method: DELETE xCodeSample: @@ -6933,14 +6452,13 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_instance.delete_sod_policy(id, logical) + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) - path: /sod-policies/{id}/schedule method: DELETE xCodeSample: @@ -6949,14 +6467,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_sod_policy_schedule(id) + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) except Exception as e: - print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) - path: /sod-violation-report/{reportResultId}/download/{fileName} method: GET xCodeSample: @@ -6966,16 +6483,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_custom_violation_report(report_result_id, file_name) - print("The response of SODPoliciesApi->get_custom_violation_report:\n") - pprint(api_response) + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) - path: /sod-violation-report/{reportResultId}/download method: GET xCodeSample: @@ -6984,16 +6500,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_default_violation_report(report_result_id) - print("The response of SODPoliciesApi->get_default_violation_report:\n") - pprint(api_response) + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) - path: /sod-violation-report method: GET xCodeSample: @@ -7001,16 +6516,15 @@ label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-all-report-run-status source: | try: - # Get multi-report run task status - - api_response = api_instance.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() - print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") - pprint(api_response) + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) - path: /sod-policies/{id} method: GET xCodeSample: @@ -7019,16 +6533,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sod_policy(id) - print("The response of SODPoliciesApi->get_sod_policy:\n") - pprint(api_response) + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) - path: /sod-policies/{id}/schedule method: GET xCodeSample: @@ -7037,16 +6550,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sod_policy_schedule(id) - print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") - pprint(api_response) + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) - path: /sod-policies/sod-violation-report-status/{reportResultId} method: GET xCodeSample: @@ -7055,16 +6567,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sod_violation_report_run_status(report_result_id) - print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") - pprint(api_response) + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) - path: /sod-policies/{id}/violation-report method: GET xCodeSample: @@ -7073,16 +6584,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_sod_violation_report_status(id) - print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") - pprint(api_response) + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) - path: /sod-policies method: GET xCodeSample: @@ -7095,16 +6605,15 @@ filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # 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, in* **state**: *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: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) sorters = 'id,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: **id, name, created, modified, description** (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: **id, name, created, modified, description** (optional) try: - # List SOD policies - - api_response = api_instance.list_sod_policies() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_sod_policies(limit, offset, count, filters, sorters) - print("The response of SODPoliciesApi->list_sod_policies:\n") - pprint(api_response) + # List SOD policies + + results = SODPoliciesApi(api_client).list_sod_policies() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) - path: /sod-policies/{id} method: PATCH xCodeSample: @@ -7112,24 +6621,17 @@ label: SDK_tools/sdk/python/v3/methods/sod-policies#patch-sod-policy source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # 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 - - try: - # Patch SOD policy by ID - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_sod_policy(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_sod_policy(id, Result) - print("The response of SODPoliciesApi->patch_sod_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) + json_patch_operation = '''[{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 + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + pprint(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) - path: /sod-policies/{id}/schedule method: PUT xCodeSample: @@ -7137,7 +6639,7 @@ label: SDK_tools/sdk/python/v3/methods/sod-policies#put-policy-schedule source: | 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 = { + sod_policy_schedule = '''{ "schedule" : { "hours" : { "values" : [ "MON", "WED" ], @@ -7174,18 +6676,17 @@ "modified" : "2020-01-01T00:00:00Z", "description" : "Schedule for policy xyz", "emailEmptyResults" : false - } # SodPolicySchedule | - try: - # Update SOD Policy schedule - Result = sod_policy_schedule.from_json(sod_policy_schedule) - api_response = api_instance.put_policy_schedule(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_policy_schedule(id, Result) - print("The response of SODPoliciesApi->put_policy_schedule:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + pprint(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) - path: /sod-policies/{id} method: PUT xCodeSample: @@ -7193,7 +6694,7 @@ label: SDK_tools/sdk/python/v3/methods/sod-policies#put-sod-policy source: | 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 = { + sod_policy = '''{ "conflictingAccessCriteria" : { "leftCriteria" : { "name" : "money-in", @@ -7248,18 +6749,17 @@ "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", "state" : "ENFORCED", "externalPolicyReference" : "XYZ policy" - } # SodPolicy | - try: - # Update SOD policy by ID - Result = sod_policy.from_json(sod_policy) - api_response = api_instance.put_sod_policy(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_sod_policy(id, Result) - print("The response of SODPoliciesApi->put_sod_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + pprint(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) - path: /sod-policies/{id}/evaluate method: POST xCodeSample: @@ -7268,36 +6768,34 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_evaluate_sod_policy(id) - print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") - pprint(api_response) + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) - path: /sod-violation-report/run method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-all-policies-for-org source: | - multi_policy_request = { + 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) - try: - # Runs all policies for org - - api_response = api_instance.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) - print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) - path: /sod-policies/{id}/violation-report/run method: POST xCodeSample: @@ -7306,23 +6804,22 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_sod_policy(id) - print("The response of SODPoliciesApi->start_sod_policy:\n") - pprint(api_response) + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + pprint(results) except Exception as e: - print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) - path: /sod-violations/predict method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-violations#start-predict-sod-violations source: | - identity_with_new_access = { + identity_with_new_access = '''{ "identityId" : "2c91808568c529c60168cca6f90c1313", "accessRefs" : [ { "type" : "ENTITLEMENT", @@ -7333,36 +6830,34 @@ "id" : "2c918087682f9a86016839c0509c1ab2", "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" } ] - } # IdentityWithNewAccess | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_predict_sod_violations(Result) - print("The response of SODViolationsApi->start_predict_sod_violations:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + pprint(results) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) - path: /sod-violations/check method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-violations#start-violation-check source: | - 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 | + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.start_violation_check(Result) - print("The response of SODViolationsApi->start_violation_check:\n") - pprint(api_response) + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + pprint(results) except Exception as e: - print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -7370,7 +6865,7 @@ label: SDK_tools/sdk/python/v3/methods/sources#create-provisioning-policy source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id - provisioning_policy_dto = { + provisioning_policy_dto = '''{ "name" : "example provisioning policy for inactive identities", "description" : "this provisioning policy creates access based on an identity going inactive", "fields" : [ { @@ -7409,25 +6904,24 @@ "type" : "string" } ], "usageType" : "CREATE" - } # ProvisioningPolicyDto | - try: - # Create Provisioning Policy - Result = provisioning_policy_dto.from_json(provisioning_policy_dto) - api_response = api_instance.create_provisioning_policy(source_id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_provisioning_policy(source_id, Result) - print("The response of SourcesApi->create_provisioning_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) + }''' # ProvisioningPolicyDto | + try: + # Create Provisioning Policy + new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto) + results = SourcesApi(api_client).create_provisioning_policy(source_id=source_id, provisioning_policy_dto=new_provisioning_policy_dto) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).create_provisioning_policy(source_id, new_provisioning_policy_dto) + print("The response of SourcesApi->create_provisioning_policy:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) - path: /sources method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#create-source source: | - source = { + source = '''{ "cluster" : { "name" : "Corporate Cluster", "id" : "2c9180866166b5b0016167c32ef31a66", @@ -7509,19 +7003,18 @@ }, "status" : "SOURCE_STATE_HEALTHY", "since" : "2021-09-28T15:48:29.3801666300Z" - } # Source | + }''' # Source | provision_as_csv = false # bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) # bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) try: - # Creates a source in IdentityNow. - Result = source.from_json(source) - api_response = api_instance.create_source(Result, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_source(Result, provision_as_csv) - print("The response of SourcesApi->create_source:\n") - pprint(api_response) + # Creates a source in IdentityNow. + new_source = Source.from_json(source) + results = SourcesApi(api_client).create_source(source=new_source) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).create_source(new_source, provision_as_csv) + print("The response of SourcesApi->create_source:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->create_source: %s\n" % e) + print("Exception when calling SourcesApi->create_source: %s\n" % e) - path: /sources/{sourceId}/schemas method: POST xCodeSample: @@ -7529,18 +7022,17 @@ label: SDK_tools/sdk/python/v3/methods/sources#create-source-schema source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_source_schema(source_id, Result) - print("The response of SourcesApi->create_source_schema:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) + model_schema = '''sailpoint.v3.ModelSchema()''' # ModelSchema | + try: + # Create Schema on Source + new_model_schema = ModelSchema.from_json(model_schema) + results = SourcesApi(api_client).create_source_schema(source_id=source_id, model_schema=new_model_schema) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).create_source_schema(source_id, new_model_schema) + print("The response of SourcesApi->create_source_schema:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} method: DELETE xCodeSample: @@ -7550,14 +7042,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_provisioning_policy(source_id, usage_type) + # Delete Provisioning Policy by UsageType + + SourcesApi(api_client).delete_provisioning_policy(source_id=source_id, usage_type=usage_type) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling SourcesApi->delete_provisioning_policy: %s\n" % e) - path: /sources/{id} method: DELETE xCodeSample: @@ -7566,16 +7057,15 @@ source: | id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. try: - # Delete Source by ID - - api_response = api_instance.delete_source(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_source(id) - print("The response of SourcesApi->delete_source:\n") - pprint(api_response) + # Delete Source by ID + + results = SourcesApi(api_client).delete_source(id=id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).delete_source(id) + print("The response of SourcesApi->delete_source:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->delete_source: %s\n" % e) + print("Exception when calling SourcesApi->delete_source: %s\n" % e) - path: /sources/{sourceId}/schemas/{schemaId} method: DELETE xCodeSample: @@ -7585,14 +7075,13 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_source_schema(source_id, schema_id) + # Delete Source Schema by ID + + SourcesApi(api_client).delete_source_schema(source_id=source_id, schema_id=schema_id) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling SourcesApi->delete_source_schema: %s\n" % e) - path: /sources/{id}/schemas/accounts method: GET xCodeSample: @@ -7601,14 +7090,13 @@ source: | id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id try: - # Downloads source accounts schema template - - api_instance.get_accounts_schema(id) - - # Below is a request that includes all optional parameters - # api_instance.get_accounts_schema(id) + # Downloads source accounts schema template + + SourcesApi(api_client).get_accounts_schema(id=id) + # Below is a request that includes all optional parameters + # SourcesApi(api_client).get_accounts_schema(id) except Exception as e: - print("Exception when calling SourcesApi->get_accounts_schema: %s\n" % e) + print("Exception when calling SourcesApi->get_accounts_schema: %s\n" % e) - path: /sources/{id}/schemas/entitlements method: GET xCodeSample: @@ -7618,14 +7106,13 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_instance.get_entitlements_schema(id, schema_name) + # Downloads source entitlements schema template + + SourcesApi(api_client).get_entitlements_schema(id=id) + # Below is a request that includes all optional parameters + # SourcesApi(api_client).get_entitlements_schema(id, schema_name) except Exception as e: - print("Exception when calling SourcesApi->get_entitlements_schema: %s\n" % e) + print("Exception when calling SourcesApi->get_entitlements_schema: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} method: GET xCodeSample: @@ -7635,16 +7122,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_provisioning_policy(source_id, usage_type) - print("The response of SourcesApi->get_provisioning_policy:\n") - pprint(api_response) + # Get Provisioning Policy by UsageType + + results = SourcesApi(api_client).get_provisioning_policy(source_id=source_id, usage_type=usage_type) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_provisioning_policy(source_id, usage_type) + print("The response of SourcesApi->get_provisioning_policy:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) + print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) - path: /sources/{id} method: GET xCodeSample: @@ -7653,16 +7139,15 @@ source: | id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. try: - # Get Source by ID - - api_response = api_instance.get_source(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_source(id) - print("The response of SourcesApi->get_source:\n") - pprint(api_response) + # Get Source by ID + + results = SourcesApi(api_client).get_source(id=id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source(id) + print("The response of SourcesApi->get_source:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_source: %s\n" % e) + print("Exception when calling SourcesApi->get_source: %s\n" % e) - path: /sources/{sourceId}/connections method: GET xCodeSample: @@ -7671,16 +7156,15 @@ source: | id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. try: - # Get Source Connections by ID - - api_response = api_instance.get_source_connections(id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_connections(id) - print("The response of SourcesApi->get_source_connections:\n") - pprint(api_response) + # Get Source Connections by ID + + results = SourcesApi(api_client).get_source_connections(id=id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_connections(id) + print("The response of SourcesApi->get_source_connections:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_source_connections: %s\n" % e) + print("Exception when calling SourcesApi->get_source_connections: %s\n" % e) - path: /sources/{sourceId}/source-health method: GET xCodeSample: @@ -7689,16 +7173,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_health(source_id) - print("The response of SourcesApi->get_source_health:\n") - pprint(api_response) + # Fetches source health by id + + results = SourcesApi(api_client).get_source_health(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_health(source_id) + print("The response of SourcesApi->get_source_health:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_source_health: %s\n" % e) + print("Exception when calling SourcesApi->get_source_health: %s\n" % e) - path: /sources/{sourceId}/schemas/{schemaId} method: GET xCodeSample: @@ -7708,16 +7191,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_source_schema(source_id, schema_id) - print("The response of SourcesApi->get_source_schema:\n") - pprint(api_response) + # Get Source Schema by ID + + results = SourcesApi(api_client).get_source_schema(source_id=source_id, schema_id=schema_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_schema(source_id, schema_id) + print("The response of SourcesApi->get_source_schema:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) + print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) - path: /sources/{sourceId}/schemas method: GET xCodeSample: @@ -7728,16 +7210,15 @@ 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) try: - # List Schemas on Source - - api_response = api_instance.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) - print("The response of SourcesApi->get_source_schemas:\n") - pprint(api_response) + # List Schemas on Source + + results = SourcesApi(api_client).get_source_schemas(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) + print("The response of SourcesApi->get_source_schemas:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) + print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) - path: /sources/{id}/schemas/accounts method: POST xCodeSample: @@ -7747,16 +7228,15 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.import_accounts_schema(id, file) - print("The response of SourcesApi->import_accounts_schema:\n") - pprint(api_response) + # Uploads source accounts schema template + + results = SourcesApi(api_client).import_accounts_schema(id=id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_accounts_schema(id, file) + print("The response of SourcesApi->import_accounts_schema:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->import_accounts_schema: %s\n" % e) + print("Exception when calling SourcesApi->import_accounts_schema: %s\n" % e) - path: /sources/{sourceId}/upload-connector-file method: POST xCodeSample: @@ -7766,16 +7246,15 @@ 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.import_connector_file(source_id, file) - print("The response of SourcesApi->import_connector_file:\n") - pprint(api_response) + # Upload connector file to source + + results = SourcesApi(api_client).import_connector_file(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_connector_file(source_id, file) + print("The response of SourcesApi->import_connector_file:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->import_connector_file: %s\n" % e) + print("Exception when calling SourcesApi->import_connector_file: %s\n" % e) - path: /sources/{id}/schemas/entitlements method: POST xCodeSample: @@ -7786,16 +7265,15 @@ schema_name = '?schemaName=group' # str | Name of entitlement schema (optional) # str | Name of entitlement schema (optional) file = None # bytearray | (optional) # bytearray | (optional) try: - # Uploads source entitlements schema template - - api_response = api_instance.import_entitlements_schema(id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.import_entitlements_schema(id, schema_name, file) - print("The response of SourcesApi->import_entitlements_schema:\n") - pprint(api_response) + # Uploads source entitlements schema template + + results = SourcesApi(api_client).import_entitlements_schema(id=id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_entitlements_schema(id, schema_name, file) + print("The response of SourcesApi->import_entitlements_schema:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->import_entitlements_schema: %s\n" % e) + print("Exception when calling SourcesApi->import_entitlements_schema: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: GET xCodeSample: @@ -7804,16 +7282,15 @@ source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id try: - # Lists ProvisioningPolicies - - api_response = api_instance.list_provisioning_policies(source_id) - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_provisioning_policies(source_id) - print("The response of SourcesApi->list_provisioning_policies:\n") - pprint(api_response) + # Lists ProvisioningPolicies + + results = SourcesApi(api_client).list_provisioning_policies(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).list_provisioning_policies(source_id) + print("The response of SourcesApi->list_provisioning_policies:\n") + pprint(results) except Exception as e: - print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) + print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) - path: /sources method: GET xCodeSample: @@ -7828,16 +7305,15 @@ for_subadmin = 'name' # str | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) # str | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) include_idn_source = False # bool | Include the IdentityNow source in the response. (optional) (default to False) # bool | Include the IdentityNow source in the response. (optional) (default to False) try: - # Lists all sources in IdentityNow. - - api_response = api_instance.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) - print("The response of SourcesApi->list_sources:\n") - pprint(api_response) + # Lists all sources in IdentityNow. + + results = SourcesApi(api_client).list_sources() + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling SourcesApi->list_sources: %s\n" % e) + print("Exception when calling SourcesApi->list_sources: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} method: PUT xCodeSample: @@ -7846,7 +7322,7 @@ source: | 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 = { + provisioning_policy_dto = '''{ "name" : "example provisioning policy for inactive identities", "description" : "this provisioning policy creates access based on an identity going inactive", "fields" : [ { @@ -7885,18 +7361,17 @@ "type" : "string" } ], "usageType" : "CREATE" - } # ProvisioningPolicyDto | - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result) - print("The response of SourcesApi->put_provisioning_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) + }''' # ProvisioningPolicyDto | + try: + # Update Provisioning Policy by UsageType + new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto) + results = SourcesApi(api_client).put_provisioning_policy(source_id=source_id, usage_type=usage_type, provisioning_policy_dto=new_provisioning_policy_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) - path: /sources/{id} method: PUT xCodeSample: @@ -7904,7 +7379,7 @@ label: SDK_tools/sdk/python/v3/methods/sources#put-source source: | id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. - source = { + source = '''{ "cluster" : { "name" : "Corporate Cluster", "id" : "2c9180866166b5b0016167c32ef31a66", @@ -7986,18 +7461,17 @@ }, "status" : "SOURCE_STATE_HEALTHY", "since" : "2021-09-28T15:48:29.3801666300Z" - } # Source | - try: - # Update Source (Full) - Result = source.from_json(source) - api_response = api_instance.put_source(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_source(id, Result) - print("The response of SourcesApi->put_source:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->put_source: %s\n" % e) + }''' # Source | + try: + # Update Source (Full) + new_source = Source.from_json(source) + results = SourcesApi(api_client).put_source(id=id, source=new_source) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).put_source(id, new_source) + print("The response of SourcesApi->put_source:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_source: %s\n" % e) - path: /sources/{sourceId}/schemas/{schemaId} method: PUT xCodeSample: @@ -8006,18 +7480,17 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_source_schema(source_id, schema_id, Result) - print("The response of SourcesApi->put_source_schema:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) + model_schema = '''sailpoint.v3.ModelSchema()''' # ModelSchema | + try: + # Update Source Schema (Full) + new_model_schema = ModelSchema.from_json(model_schema) + results = SourcesApi(api_client).put_source_schema(source_id=source_id, schema_id=schema_id, model_schema=new_model_schema) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).put_source_schema(source_id, schema_id, new_model_schema) + print("The response of SourcesApi->put_source_schema:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/bulk-update method: POST xCodeSample: @@ -8025,59 +7498,17 @@ label: SDK_tools/sdk/python/v3/methods/sources#update-provisioning-policies-in-bulk source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. - [sailpoint.v3.ProvisioningPolicyDto()] # List[ProvisioningPolicyDto] | - provisioning_policy_dto = { - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" - } # List[ProvisioningPolicyDto] | - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) - print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) + provisioning_policy_dto = '''[sailpoint.v3.ProvisioningPolicyDto()]''' # List[ProvisioningPolicyDto] | + try: + # Bulk Update Provisioning Policies + new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto) + results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id=source_id, provisioning_policy_dto=new_provisioning_policy_dto) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} method: PATCH xCodeSample: @@ -8086,24 +7517,17 @@ source: | 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. - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) - print("The response of SourcesApi->update_provisioning_policy:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) + json_patch_operation = '''[{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. + try: + # Partial update of Provisioning Policy + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SourcesApi(api_client).update_provisioning_policy(source_id=source_id, usage_type=usage_type, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) - path: /sources/{id} method: PATCH xCodeSample: @@ -8111,24 +7535,17 @@ label: SDK_tools/sdk/python/v3/methods/sources#update-source source: | 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 = { - "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). - - try: - # Update Source (Partial) - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.update_source(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_source(id, Result) - print("The response of SourcesApi->update_source:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->update_source: %s\n" % e) + json_patch_operation = '''[{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). + try: + # Update Source (Partial) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SourcesApi(api_client).update_source(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).update_source(id, new_json_patch_operation) + print("The response of SourcesApi->update_source:\n") + pprint(results) + except Exception as e: + print("Exception when calling SourcesApi->update_source: %s\n" % e) - path: /sources/{sourceId}/schemas/{schemaId} method: PATCH xCodeSample: @@ -8137,24 +7554,17 @@ source: | 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. - json_patch_operation = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. - - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_source_schema(source_id, schema_id, Result) - print("The response of SourcesApi->update_source_schema:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) + json_patch_operation = '''[{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. + try: + # Update Source Schema (Partial) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SourcesApi(api_client).update_source_schema(source_id=source_id, schema_id=schema_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) - path: /source-usages/{sourceId}/status method: GET xCodeSample: @@ -8163,16 +7573,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_status_by_source_id(source_id) - print("The response of SourceUsagesApi->get_status_by_source_id:\n") - pprint(api_response) + # Finds status of source usage + + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + pprint(results) except Exception as e: - print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) - path: /source-usages/{sourceId}/summaries method: GET xCodeSample: @@ -8185,16 +7594,15 @@ 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) sorters = '-date' # 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: **date** (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: **date** (optional) try: - # Returns source usage insights - - api_response = api_instance.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) - print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - pprint(api_response) + # Returns source usage insights + + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /tagged-objects/{type}/{id} method: DELETE xCodeSample: @@ -8204,21 +7612,20 @@ 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_tagged_object(type, id) + # Delete Object Tags + + TaggedObjectsApi(api_client).delete_tagged_object(type=type, id=id) + # Below is a request that includes all optional parameters + # TaggedObjectsApi(api_client).delete_tagged_object(type, id) except Exception as e: - print("Exception when calling TaggedObjectsApi->delete_tagged_object: %s\n" % e) + print("Exception when calling TaggedObjectsApi->delete_tagged_object: %s\n" % e) - path: /tagged-objects/bulk-remove method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/tagged-objects#delete-tags-to-many-object source: | - bulk_remove_tagged_object = { + bulk_remove_tagged_object = '''{ "objectRefs" : [ { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", @@ -8229,16 +7636,15 @@ "type" : "IDENTITY" } ], "tags" : [ "BU_FINANCE", "PCI" ] - } # BulkRemoveTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + }''' # BulkRemoveTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_tags_to_many_object(Result) + # Remove Tags from Multiple Objects + new_bulk_remove_tagged_object = BulkRemoveTaggedObject.from_json(bulk_remove_tagged_object) + TaggedObjectsApi(api_client).delete_tags_to_many_object(bulk_remove_tagged_object=new_bulk_remove_tagged_object) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling TaggedObjectsApi->delete_tags_to_many_object: %s\n" % e) - path: /tagged-objects/{type}/{id} method: GET xCodeSample: @@ -8248,16 +7654,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_tagged_object(type, id) - print("The response of TaggedObjectsApi->get_tagged_object:\n") - pprint(api_response) + # Get Tagged Object + + results = TaggedObjectsApi(api_client).get_tagged_object(type=type, id=id) + # Below is a request that includes all optional parameters + # results = TaggedObjectsApi(api_client).get_tagged_object(type, id) + print("The response of TaggedObjectsApi->get_tagged_object:\n") + pprint(results) except Exception as e: - print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e) + print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e) - path: /tagged-objects method: GET xCodeSample: @@ -8269,16 +7674,15 @@ 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) filters = 'tagName eq \"BU_FINANCE\"' # 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) try: - # List Tagged Objects - - api_response = api_instance.list_tagged_objects() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_tagged_objects(limit, offset, count, filters) - print("The response of TaggedObjectsApi->list_tagged_objects:\n") - pprint(api_response) + # List Tagged Objects + + results = TaggedObjectsApi(api_client).list_tagged_objects() + # Below is a request that includes all optional parameters + # results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects:\n") + pprint(results) except Exception as e: - print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) + print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) - path: /tagged-objects/{type} method: GET xCodeSample: @@ -8291,16 +7695,15 @@ 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) filters = 'objectRef.id eq \"2c91808568c529c60168cca6f90c1313\"' # 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: **objectRef.id**: *eq* **objectRef.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: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) try: - # List Tagged Objects by Type - - api_response = api_instance.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) - print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") - pprint(api_response) + # List Tagged Objects by Type + + results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type=type) + # Below is a request that includes all optional parameters + # 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(results) except Exception as e: - print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) + print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) - path: /tagged-objects/{type}/{id} method: PUT xCodeSample: @@ -8309,55 +7712,53 @@ source: | 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 = { + tagged_object = '''{ "objectRef" : { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, "tags" : [ "BU_FINANCE", "PCI" ] - } # TaggedObject | - try: - # Update Tagged Object - Result = tagged_object.from_json(tagged_object) - api_response = api_instance.put_tagged_object(type, id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_tagged_object(type, id, Result) - print("The response of TaggedObjectsApi->put_tagged_object:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e) + }''' # TaggedObject | + try: + # Update Tagged Object + new_tagged_object = TaggedObject.from_json(tagged_object) + results = TaggedObjectsApi(api_client).put_tagged_object(type=type, id=id, tagged_object=new_tagged_object) + # Below is a request that includes all optional parameters + # results = TaggedObjectsApi(api_client).put_tagged_object(type, id, new_tagged_object) + print("The response of TaggedObjectsApi->put_tagged_object:\n") + pprint(results) + except Exception as e: + print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e) - path: /tagged-objects method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/tagged-objects#set-tag-to-object source: | - tagged_object = { + tagged_object = '''{ "objectRef" : { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, "tags" : [ "BU_FINANCE", "PCI" ] - } # TaggedObject | + }''' # TaggedObject | try: - # Add Tag to Object - Result = tagged_object.from_json(tagged_object) - api_instance.set_tag_to_object(Result) - - # Below is a request that includes all optional parameters - # api_instance.set_tag_to_object(Result) + # Add Tag to Object + new_tagged_object = TaggedObject.from_json(tagged_object) + TaggedObjectsApi(api_client).set_tag_to_object(tagged_object=new_tagged_object) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling TaggedObjectsApi->set_tag_to_object: %s\n" % e) - path: /tagged-objects/bulk-add method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/tagged-objects#set-tags-to-many-objects source: | - bulk_add_tagged_object = { + bulk_add_tagged_object = '''{ "objectRefs" : [ { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", @@ -8369,40 +7770,38 @@ } ], "operation" : "MERGE", "tags" : [ "BU_FINANCE", "PCI" ] - } # BulkAddTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.set_tags_to_many_objects(Result) - print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) + }''' # BulkAddTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + try: + # Tag Multiple Objects + new_bulk_add_tagged_object = BulkAddTaggedObject.from_json(bulk_add_tagged_object) + results = TaggedObjectsApi(api_client).set_tags_to_many_objects(bulk_add_tagged_object=new_bulk_add_tagged_object) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) - path: /transforms method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/transforms#create-transform source: | - transform = { + transform = '''{ "name" : "Timestamp To Date", "attributes" : "{}", "type" : "dateFormat" - } # Transform | The transform to be created. - try: - # Create transform - Result = transform.from_json(transform) - api_response = api_instance.create_transform(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_transform(Result) - print("The response of TransformsApi->create_transform:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TransformsApi->create_transform: %s\n" % e) + }''' # Transform | The transform to be created. + try: + # Create transform + new_transform = Transform.from_json(transform) + results = TransformsApi(api_client).create_transform(transform=new_transform) + # Below is a request that includes all optional parameters + # results = TransformsApi(api_client).create_transform(new_transform) + print("The response of TransformsApi->create_transform:\n") + pprint(results) + except Exception as e: + print("Exception when calling TransformsApi->create_transform: %s\n" % e) - path: /transforms/{id} method: DELETE xCodeSample: @@ -8411,14 +7810,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_transform(id) + # Delete a transform + + TransformsApi(api_client).delete_transform(id=id) + # Below is a request that includes all optional parameters + # TransformsApi(api_client).delete_transform(id) except Exception as e: - print("Exception when calling TransformsApi->delete_transform: %s\n" % e) + print("Exception when calling TransformsApi->delete_transform: %s\n" % e) - path: /transforms/{id} method: GET xCodeSample: @@ -8427,16 +7825,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_transform(id) - print("The response of TransformsApi->get_transform:\n") - pprint(api_response) + # Transform by ID + + results = TransformsApi(api_client).get_transform(id=id) + # Below is a request that includes all optional parameters + # results = TransformsApi(api_client).get_transform(id) + print("The response of TransformsApi->get_transform:\n") + pprint(results) except Exception as e: - print("Exception when calling TransformsApi->get_transform: %s\n" % e) + print("Exception when calling TransformsApi->get_transform: %s\n" % e) - path: /transforms method: GET xCodeSample: @@ -8449,16 +7846,15 @@ name = 'ExampleTransformName123' # str | Name of the transform to retrieve from the list. (optional) # str | Name of the transform to retrieve from the list. (optional) filters = 'name eq \"Uppercase\"' # 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: **internal**: *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: **internal**: *eq* **name**: *eq, sw* (optional) try: - # List transforms - - api_response = api_instance.list_transforms() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_transforms(offset, limit, count, name, filters) - print("The response of TransformsApi->list_transforms:\n") - pprint(api_response) + # List transforms + + results = TransformsApi(api_client).list_transforms() + # Below is a request that includes all optional parameters + # results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters) + print("The response of TransformsApi->list_transforms:\n") + pprint(results) except Exception as e: - print("Exception when calling TransformsApi->list_transforms: %s\n" % e) + print("Exception when calling TransformsApi->list_transforms: %s\n" % e) - path: /transforms/{id} method: PUT xCodeSample: @@ -8466,29 +7862,28 @@ label: SDK_tools/sdk/python/v3/methods/transforms#update-transform source: | id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to update # str | ID of the transform to update - transform = { + transform = '''{ "name" : "Timestamp To Date", "attributes" : "{}", "type" : "dateFormat" - } # Transform | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional) - try: - # Update a transform - - api_response = api_instance.update_transform(id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.update_transform(id, Result) - print("The response of TransformsApi->update_transform:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling TransformsApi->update_transform: %s\n" % e) + }''' # Transform | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional) + try: + # Update a transform + + results = TransformsApi(api_client).update_transform(id=id) + # Below is a request that includes all optional parameters + # results = TransformsApi(api_client).update_transform(id, new_transform) + print("The response of TransformsApi->update_transform:\n") + pprint(results) + except Exception as e: + print("Exception when calling TransformsApi->update_transform: %s\n" % e) - path: /vendor-connector-mappings method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/vendor-connector-mappings#create-vendor-connector-mapping source: | - vendor_connector_mapping = { + vendor_connector_mapping = '''{ "createdAt" : "2024-03-13T12:56:19.391294Z", "deletedAt" : { "Valid" : false, @@ -8510,25 +7905,24 @@ "Valid" : true, "Time" : "2024-03-14T12:56:19.391294Z" } - } # VendorConnectorMapping | - try: - # Create Vendor Connector Mapping - Result = vendor_connector_mapping.from_json(vendor_connector_mapping) - api_response = api_instance.create_vendor_connector_mapping(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_vendor_connector_mapping(Result) - print("The response of VendorConnectorMappingsApi->create_vendor_connector_mapping:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e) + }''' # VendorConnectorMapping | + try: + # Create Vendor Connector Mapping + new_vendor_connector_mapping = VendorConnectorMapping.from_json(vendor_connector_mapping) + results = VendorConnectorMappingsApi(api_client).create_vendor_connector_mapping(vendor_connector_mapping=new_vendor_connector_mapping) + # Below is a request that includes all optional parameters + # results = VendorConnectorMappingsApi(api_client).create_vendor_connector_mapping(new_vendor_connector_mapping) + print("The response of VendorConnectorMappingsApi->create_vendor_connector_mapping:\n") + pprint(results) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e) - path: /vendor-connector-mappings method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/vendor-connector-mappings#delete-vendor-connector-mapping source: | - vendor_connector_mapping = { + vendor_connector_mapping = '''{ "createdAt" : "2024-03-13T12:56:19.391294Z", "deletedAt" : { "Valid" : false, @@ -8550,18 +7944,17 @@ "Valid" : true, "Time" : "2024-03-14T12:56:19.391294Z" } - } # VendorConnectorMapping | - try: - # Delete Vendor Connector Mapping - Result = vendor_connector_mapping.from_json(vendor_connector_mapping) - api_response = api_instance.delete_vendor_connector_mapping(Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.delete_vendor_connector_mapping(Result) - print("The response of VendorConnectorMappingsApi->delete_vendor_connector_mapping:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e) + }''' # VendorConnectorMapping | + try: + # Delete Vendor Connector Mapping + new_vendor_connector_mapping = VendorConnectorMapping.from_json(vendor_connector_mapping) + results = VendorConnectorMappingsApi(api_client).delete_vendor_connector_mapping(vendor_connector_mapping=new_vendor_connector_mapping) + # Below is a request that includes all optional parameters + # results = VendorConnectorMappingsApi(api_client).delete_vendor_connector_mapping(new_vendor_connector_mapping) + print("The response of VendorConnectorMappingsApi->delete_vendor_connector_mapping:\n") + pprint(results) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e) - path: /vendor-connector-mappings method: GET xCodeSample: @@ -8569,16 +7962,15 @@ label: SDK_tools/sdk/python/v3/methods/vendor-connector-mappings#get-vendor-connector-mappings source: | try: - # List Vendor Connector Mappings - - api_response = api_instance.get_vendor_connector_mappings() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_vendor_connector_mappings() - print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") - pprint(api_response) + # List Vendor Connector Mappings + + results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() + # Below is a request that includes all optional parameters + # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() + print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") + pprint(results) except Exception as e: - print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) + print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) - path: /workflow-executions/{id}/cancel method: POST xCodeSample: @@ -8587,14 +7979,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.cancel_workflow_execution(id) + # Cancel Workflow Execution by ID + + WorkflowsApi(api_client).cancel_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).cancel_workflow_execution(id) except Exception as e: - print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) - path: /workflows/execute/external/{id} method: POST xCodeSample: @@ -8602,36 +7993,34 @@ label: SDK_tools/sdk/python/v3/methods/workflows#create-external-execute-workflow source: | 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_external_execute_workflow(id, Result) - print("The response of WorkflowsApi->create_external_execute_workflow:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) + create_external_execute_workflow_request = '''sailpoint.v3.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) - path: /workflows method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v3/methods/workflows#create-workflow source: | - 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 | + 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_workflow(Result) - print("The response of WorkflowsApi->create_workflow:\n") - pprint(api_response) + # Create Workflow + new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) + results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) + print("The response of WorkflowsApi->create_workflow:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) - path: /workflows/{id}/external/oauth-clients method: POST xCodeSample: @@ -8640,16 +8029,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.create_workflow_external_trigger(id) - print("The response of WorkflowsApi->create_workflow_external_trigger:\n") - pprint(api_response) + # Generate External Trigger OAuth Client + + results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) + print("The response of WorkflowsApi->create_workflow_external_trigger:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) + print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) - path: /workflows/{id} method: DELETE xCodeSample: @@ -8658,14 +8046,13 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_instance.delete_workflow(id) + # Delete Workflow By Id + + WorkflowsApi(api_client).delete_workflow(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).delete_workflow(id) except Exception as e: - print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) - path: /workflows/{id} method: GET xCodeSample: @@ -8674,16 +8061,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_workflow(id) - print("The response of WorkflowsApi->get_workflow:\n") - pprint(api_response) + # Get Workflow By Id + + results = WorkflowsApi(api_client).get_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) - path: /workflow-executions/{id} method: GET xCodeSample: @@ -8692,16 +8078,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_workflow_execution(id) - print("The response of WorkflowsApi->get_workflow_execution:\n") - pprint(api_response) + # Get Workflow Execution + + results = WorkflowsApi(api_client).get_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) - path: /workflow-executions/{id}/history method: GET xCodeSample: @@ -8710,16 +8095,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_workflow_execution_history(id) - print("The response of WorkflowsApi->get_workflow_execution_history:\n") - pprint(api_response) + # Get Workflow Execution History + + results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) - path: /workflows/{id}/executions method: GET xCodeSample: @@ -8732,16 +8116,15 @@ 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) filters = 'status eq \"Failed\"' # 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: **start_time**: *eq, lt, le, gt, ge* **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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) try: - # List Workflow Executions - - api_response = api_instance.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) - print("The response of WorkflowsApi->get_workflow_executions:\n") - pprint(api_response) + # List Workflow Executions + + results = WorkflowsApi(api_client).get_workflow_executions(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) - path: /workflow-library method: GET xCodeSample: @@ -8751,16 +8134,15 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_complete_workflow_library(limit, offset) - print("The response of WorkflowsApi->list_complete_workflow_library:\n") - pprint(api_response) + # List Complete Workflow Library + + results = WorkflowsApi(api_client).list_complete_workflow_library() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) - path: /workflow-library/actions method: GET xCodeSample: @@ -8771,16 +8153,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) 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) try: - # List Workflow Library Actions - - api_response = api_instance.list_workflow_library_actions() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_workflow_library_actions(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_actions:\n") - pprint(api_response) + # List Workflow Library Actions + + results = WorkflowsApi(api_client).list_workflow_library_actions() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) - path: /workflow-library/operators method: GET xCodeSample: @@ -8788,16 +8169,15 @@ label: SDK_tools/sdk/python/v3/methods/workflows#list-workflow-library-operators source: | try: - # List Workflow Library Operators - - api_response = api_instance.list_workflow_library_operators() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_workflow_library_operators() - print("The response of WorkflowsApi->list_workflow_library_operators:\n") - pprint(api_response) + # List Workflow Library Operators + + results = WorkflowsApi(api_client).list_workflow_library_operators() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) - path: /workflow-library/triggers method: GET xCodeSample: @@ -8808,16 +8188,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) 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) try: - # List Workflow Library Triggers - - api_response = api_instance.list_workflow_library_triggers() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_workflow_library_triggers(limit, offset, filters) - print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - pprint(api_response) + # List Workflow Library Triggers + + results = WorkflowsApi(api_client).list_workflow_library_triggers() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) - path: /workflows method: GET xCodeSample: @@ -8825,16 +8204,15 @@ label: SDK_tools/sdk/python/v3/methods/workflows#list-workflows source: | try: - # List Workflows - - api_response = api_instance.list_workflows() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_workflows() - print("The response of WorkflowsApi->list_workflows:\n") - pprint(api_response) + # List Workflows + + results = WorkflowsApi(api_client).list_workflows() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) - path: /workflows/{id} method: PATCH xCodeSample: @@ -8842,24 +8220,17 @@ label: SDK_tools/sdk/python/v3/methods/workflows#patch-workflow source: | 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 = { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } # List[JsonPatchOperation] | - - try: - # Patch Workflow - Result = json_patch_operation.from_json(json_patch_operation) - api_response = api_instance.patch_workflow(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.patch_workflow(id, Result) - print("The response of WorkflowsApi->patch_workflow:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) + json_patch_operation = '''[{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] | + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) + print("The response of WorkflowsApi->patch_workflow:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) - path: /workflows/{id} method: PUT xCodeSample: @@ -8867,7 +8238,7 @@ label: SDK_tools/sdk/python/v3/methods/workflows#put-workflow source: | id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = { + workflow_body = '''{ "owner" : { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", @@ -8905,18 +8276,17 @@ "type" : "EVENT" }, "enabled" : false - } # WorkflowBody | - try: - # Update Workflow - Result = workflow_body.from_json(workflow_body) - api_response = api_instance.put_workflow(id, Result) - - # Below is a request that includes all optional parameters - # api_response = api_instance.put_workflow(id, Result) - print("The response of WorkflowsApi->put_workflow:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) + }''' # WorkflowBody | + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->put_workflow:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) - path: /workflows/execute/external/{id}/test method: POST xCodeSample: @@ -8924,18 +8294,17 @@ label: SDK_tools/sdk/python/v3/methods/workflows#test-external-execute-workflow source: | 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, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.test_external_execute_workflow(id, Result) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) + test_external_execute_workflow_request = '''sailpoint.v3.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # 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(results) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) - path: /workflows/{id}/test method: POST xCodeSample: @@ -8943,18 +8312,17 @@ label: SDK_tools/sdk/python/v3/methods/workflows#test-workflow source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.test_workflow(id, Result) - print("The response of WorkflowsApi->test_workflow:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) + 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 + new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) + results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) + print("The response of WorkflowsApi->test_workflow:\n") + pprint(results) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -8964,16 +8332,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.approve_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->approve_approval_item:\n") - pprint(api_response) + # Approve an Approval Item + + results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->approve_approval_item:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) - path: /work-items/bulk-approve/{id} method: POST xCodeSample: @@ -8982,16 +8349,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.approve_approval_items_in_bulk(id) - print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") - pprint(api_response) + # Bulk approve Approval Items + + results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id) + print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) + print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) - path: /work-items/{id} method: POST xCodeSample: @@ -9001,16 +8367,15 @@ id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) try: - # Complete a Work Item - - api_response = api_instance.complete_work_item(id, ) - - # Below is a request that includes all optional parameters - # api_response = api_instance.complete_work_item(id, Result) - print("The response of WorkItemsApi->complete_work_item:\n") - pprint(api_response) + # Complete a Work Item + + results = WorkItemsApi(api_client).complete_work_item(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).complete_work_item(id, new_body) + print("The response of WorkItemsApi->complete_work_item:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) - path: /work-items/completed method: GET xCodeSample: @@ -9022,16 +8387,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) 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) try: - # Completed Work Items - - api_response = api_instance.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) - print("The response of WorkItemsApi->get_completed_work_items:\n") - pprint(api_response) + # Completed Work Items + + results = WorkItemsApi(api_client).get_completed_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) + print("The response of WorkItemsApi->get_completed_work_items:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) - path: /work-items/completed/count method: GET xCodeSample: @@ -9040,16 +8404,15 @@ source: | 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_count_completed_work_items(owner_id) - print("The response of WorkItemsApi->get_count_completed_work_items:\n") - pprint(api_response) + # Count Completed Work Items + + results = WorkItemsApi(api_client).get_count_completed_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id) + print("The response of WorkItemsApi->get_count_completed_work_items:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) - path: /work-items/count method: GET xCodeSample: @@ -9058,16 +8421,15 @@ source: | 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_count_work_items(owner_id) - print("The response of WorkItemsApi->get_count_work_items:\n") - pprint(api_response) + # Count Work Items + + results = WorkItemsApi(api_client).get_count_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_work_items(owner_id) + print("The response of WorkItemsApi->get_count_work_items:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) - path: /work-items/{id} method: GET xCodeSample: @@ -9076,16 +8438,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_work_item(id) - print("The response of WorkItemsApi->get_work_item:\n") - pprint(api_response) + # Get a Work Item + + results = WorkItemsApi(api_client).get_work_item(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_item(id) + print("The response of WorkItemsApi->get_work_item:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) - path: /work-items/summary method: GET xCodeSample: @@ -9094,16 +8455,15 @@ source: | 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() - - # Below is a request that includes all optional parameters - # api_response = api_instance.get_work_items_summary(owner_id) - print("The response of WorkItemsApi->get_work_items_summary:\n") - pprint(api_response) + # Work Items Summary + + results = WorkItemsApi(api_client).get_work_items_summary() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_items_summary(owner_id) + print("The response of WorkItemsApi->get_work_items_summary:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) - path: /work-items method: GET xCodeSample: @@ -9115,16 +8475,15 @@ 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) owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) try: - # List Work Items - - api_response = api_instance.list_work_items() - - # Below is a request that includes all optional parameters - # api_response = api_instance.list_work_items(limit, offset, count, owner_id) - print("The response of WorkItemsApi->list_work_items:\n") - pprint(api_response) + # List Work Items + + results = WorkItemsApi(api_client).list_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) + print("The response of WorkItemsApi->list_work_items:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) - path: /work-items/{id}/reject/{approvalItemId} method: POST xCodeSample: @@ -9134,16 +8493,15 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.reject_approval_item(id, approval_item_id) - print("The response of WorkItemsApi->reject_approval_item:\n") - pprint(api_response) + # Reject an Approval Item + + results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->reject_approval_item:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) - path: /work-items/bulk-reject/{id} method: POST xCodeSample: @@ -9152,16 +8510,15 @@ source: | 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.reject_approval_items_in_bulk(id) - print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") - pprint(api_response) + # Bulk reject Approval Items + + results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id) + print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) + print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) - path: /work-items/{id}/forward method: POST xCodeSample: @@ -9169,20 +8526,19 @@ label: SDK_tools/sdk/python/v3/methods/work-items#send-work-item-forward source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item - work_item_forward = { + work_item_forward = '''{ "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", "comment" : "I'm going on vacation.", "sendNotifications" : true - } # WorkItemForward | + }''' # WorkItemForward | try: - # Forward a Work Item - Result = work_item_forward.from_json(work_item_forward) - api_instance.send_work_item_forward(id, Result) - - # Below is a request that includes all optional parameters - # api_instance.send_work_item_forward(id, Result) + # Forward a Work Item + new_work_item_forward = WorkItemForward.from_json(work_item_forward) + WorkItemsApi(api_client).send_work_item_forward(id=id, work_item_forward=new_work_item_forward) + # Below is a request that includes all optional parameters + # 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) + print("Exception when calling WorkItemsApi->send_work_item_forward: %s\n" % e) - path: /work-items/{id}/submit-account-selection method: POST xCodeSample: @@ -9192,13 +8548,12 @@ 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) - - # Below is a request that includes all optional parameters - # api_response = api_instance.submit_account_selection(id, Result) - print("The response of WorkItemsApi->submit_account_selection:\n") - pprint(api_response) + # Submit Account Selections + new_request_body = RequestBody.from_json(request_body) + results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body) + print("The response of WorkItemsApi->submit_account_selection:\n") + pprint(results) except Exception as e: - print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) diff --git a/sdk-resources/resources/developerSite_code_examples.mustache b/sdk-resources/resources/developerSite_code_examples.mustache index 20021f4ec..01b226d5a 100644 --- a/sdk-resources/resources/developerSite_code_examples.mustache +++ b/sdk-resources/resources/developerSite_code_examples.mustache @@ -9,7 +9,7 @@ {{#allParams}} {{^isArray}} {{#isModel}} - {{paramName}} = {{#lambda.indented_8}}{{#requestBodyExamples}}{{{example}}}{{/requestBodyExamples}}{{^requestBodyExamples}}{{#example}}{{{example}}}{{/example}}{{/requestBodyExamples}} # {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}{{/lambda.indented_8}} + {{paramName}} = '''{{#lambda.indented_8}}{{#requestBodyExamples}}{{{example}}}{{/requestBodyExamples}}{{^requestBodyExamples}}{{#example}}{{{example}}}{{/example}}{{/requestBodyExamples}}''' # {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}{{/lambda.indented_8}} {{/isModel}} {{^isModel}} {{paramName}} = {{{example}}} # {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} # {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} @@ -17,29 +17,26 @@ {{/isArray}} {{#isArray}} {{#items.isModel}} - {{{example}}} # {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} + {{paramName}} = '''{{{example}}}''' # {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} {{/items.isModel}} {{^items.isModel}} - {{paramName}} = {{{example}}} # {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} + {{paramName}} = '''{{{example}}}''' # {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} {{/items.isModel}} - {{#requestBodyExamples}} {{paramName}} = {{#lambda.indented_8}}{{{example}}} # {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}{{/lambda.indented_8}}{{/requestBodyExamples}} - {{^requestBodyExamples}}{{#example}}{{paramName}} = {{#lambda.indented_8}}{{{example}}} # {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}{{/lambda.indented_8}}{{/example}}{{/requestBodyExamples}} {{/isArray}} {{/allParams}} try: - {{#summary}} - # {{{.}}} - {{/summary}} - {{#requiredAndNotNullableParams}}{{#isBodyParam}}Result = {{paramName}}.from_json({{paramName}}){{/isBodyParam}}{{/requiredAndNotNullableParams}} - {{#returnType}}api_response = {{/returnType}}{{#asyncio}}await {{/asyncio}}api_instance.{{{operationId}}}({{#allParams}}{{#required}}{{^isBodyParam}}{{paramName}}{{/isBodyParam}}{{#isBodyParam}}Result{{/isBodyParam}}{{^-last}}, {{/-last}}{{/required}}{{/allParams}}) - - # Below is a request that includes all optional parameters - # {{#returnType}}api_response = {{/returnType}}{{#asyncio}}await {{/asyncio}}api_instance.{{{operationId}}}({{#allParams}}{{^isBodyParam}}{{paramName}}{{/isBodyParam}}{{#isBodyParam}}Result{{/isBodyParam}}{{^-last}}, {{/-last}}{{/allParams}}) - {{#returnType}} - print("The response of {{classname}}->{{operationId}}:\n") - pprint(api_response) - {{/returnType}} + {{#summary}} + # {{{.}}} + {{/summary}} + {{#requiredAndNotNullableParams}}{{#isBodyParam}}new_{{paramName}} = {{#lambda.titlecase}}{{#lambda.camelcase}}{{paramName}}{{/lambda.camelcase}}{{/lambda.titlecase}}.from_json({{paramName}}){{/isBodyParam}}{{/requiredAndNotNullableParams}} + {{#returnType}}results = {{/returnType}}{{#lambda.titlecase}}{{classname}}{{/lambda.titlecase}}(api_client).{{{operationId}}}({{#requiredParams}}{{#isBodyParam}}{{paramName}}=new_{{paramName}}{{^-last}}, {{/-last}}{{/isBodyParam}}{{^isBodyParam}}{{paramName}}={{paramName}}{{^-last}}, {{/-last}}{{/isBodyParam}}{{/requiredParams}}) + # Below is a request that includes all optional parameters + # {{#returnType}}results = {{/returnType}}{{#lambda.titlecase}}{{classname}}{{/lambda.titlecase}}(api_client).{{{operationId}}}({{#allParams}}{{^isBodyParam}}{{paramName}}{{/isBodyParam}}{{#isBodyParam}}new_{{paramName}}{{/isBodyParam}}{{^-last}}, {{/-last}}{{/allParams}}) + {{#returnType}} + print("The response of {{classname}}->{{operationId}}:\n") + pprint(results) + {{/returnType}} except Exception as e: - print("Exception when calling {{classname}}->{{operationId}}: %s\n" % e) + print("Exception when calling {{classname}}->{{operationId}}: %s\n" % e) {{/operation}} {{/operations}} From a6012967aebd3c7f550fb1ea29e589b145e24c45 Mon Sep 17 00:00:00 2001 From: darrell-thobe-sp Date: Wed, 12 Mar 2025 16:02:46 -0400 Subject: [PATCH 2/2] fix for code example overlay --- .../python_code_examples_overlay.yaml | 5086 ++++++++++++++ .../python_code_examples_overlay.yaml | 6212 +++++++++++++++++ .../python_code_examples_overlay.yaml | 3286 +++++++++ .../developerSite_code_examples.mustache | 14 + 4 files changed, 14598 insertions(+) diff --git a/sailpoint/beta/docs/Examples/python_code_examples_overlay.yaml b/sailpoint/beta/docs/Examples/python_code_examples_overlay.yaml index 6c496b387..1ce99f819 100644 --- a/sailpoint/beta/docs/Examples/python_code_examples_overlay.yaml +++ b/sailpoint/beta/docs/Examples/python_code_examples_overlay.yaml @@ -4,6 +4,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-model-metadata#get-access-model-metadata-attribute source: | + 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 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 @@ -21,6 +30,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-model-metadata#get-access-model-metadata-attribute-value source: | + 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 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: @@ -39,6 +57,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-model-metadata#list-access-model-metadata-attribute source: | + 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 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 @@ -56,6 +83,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-model-metadata#list-access-model-metadata-attribute-value source: | + 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 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 @@ -73,6 +109,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-profiles#create-access-profile source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: access_profile = '''{ "owner" : { "name" : "support", @@ -174,6 +219,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-profiles#delete-access-profile source: | + 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 @@ -189,6 +242,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-profiles#delete-access-profiles-in-bulk source: | + 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 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 @@ -209,6 +272,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-profiles#get-access-profile source: | + 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 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 @@ -226,6 +298,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-profiles#get-access-profile-entitlements source: | + from sailpoint.beta.api.access_profiles_api import AccessProfilesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.entitlement import Entitlement + 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) @@ -248,6 +329,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-profiles#list-access-profiles source: | + 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 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) @@ -272,6 +362,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-profiles#patch-access-profile source: | + 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 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 json_patch_operation = '''[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}]''' # List[JsonPatchOperation] | try: @@ -290,6 +390,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-profiles#update-access-profiles-in-bulk source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: access_profile_bulk_update_request_inner = '''[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]''' # List[AccessProfileBulkUpdateRequestInner] | try: # Update Access Profile(s) requestable field. @@ -307,6 +417,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-request-approvals#approve-access-request source: | + 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 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" : { @@ -333,6 +452,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-request-approvals#forward-access-request source: | + 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 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", @@ -354,6 +482,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-request-approvals#get-access-request-approval-summary source: | + 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 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: @@ -372,6 +509,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-request-approvals#list-completed-approvals source: | + 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 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) @@ -394,6 +540,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-request-approvals#list-pending-approvals source: | + 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 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) @@ -416,6 +571,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-request-approvals#reject-access-request source: | + 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 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" : { @@ -442,6 +606,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-request-identity-metrics#get-access-request-identity-metrics source: | + 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. @@ -461,6 +633,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-requests#cancel-access-request source: | + 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 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." @@ -481,6 +662,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-requests#close-access-request source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: close_access_request = '''{ "executionStatus" : "Terminated", "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], @@ -503,6 +693,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-requests#create-access-request source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: access_request = '''{ "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], "clientMetadata" : { @@ -573,6 +773,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-requests#get-access-request-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get Access Request Configuration @@ -589,6 +798,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-requests#list-access-request-status source: | + 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 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) @@ -615,6 +833,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/access-requests#set-access-request-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: access_request_config = '''{ "requestOnBehalfOfConfig" : { "allowRequestOnBehalfOfEmployeeByManager" : true, @@ -657,6 +884,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/account-activities#get-account-activity source: | + 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 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 @@ -674,6 +910,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/account-activities#list-account-activities source: | + 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 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) @@ -699,6 +944,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/account-aggregations#get-account-aggregation-status source: | + 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 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 @@ -716,6 +970,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#create-account source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: account_attributes_create = '''{ "attributes" : { "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", @@ -742,6 +1006,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#delete-account source: | + 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 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 @@ -759,6 +1032,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#delete-account-async source: | + 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 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 @@ -776,6 +1058,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#disable-account source: | + 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 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, @@ -797,6 +1089,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#disable-account-for-identity source: | + 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 @@ -814,6 +1114,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#disable-accounts-for-identities source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: identities_accounts_bulk_request = '''{ "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] }''' # IdentitiesAccountsBulkRequest | @@ -833,6 +1143,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#enable-account source: | + 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 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, @@ -854,6 +1174,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#enable-account-for-identity source: | + 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 @@ -871,6 +1199,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#enable-accounts-for-identities source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: identities_accounts_bulk_request = '''{ "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] }''' # IdentitiesAccountsBulkRequest | @@ -890,6 +1228,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#get-account source: | + from sailpoint.beta.api.accounts_api import AccountsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.account import Account + 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 @@ -907,6 +1254,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#get-account-entitlements source: | + from sailpoint.beta.api.accounts_api import AccountsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.entitlement import Entitlement + 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) @@ -927,6 +1283,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#list-accounts source: | + from sailpoint.beta.api.accounts_api import AccountsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.account import Account + 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) @@ -949,6 +1314,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#put-account source: | + 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 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" : { @@ -975,6 +1350,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#submit-reload-account source: | + 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 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 @@ -992,6 +1376,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#unlock-account source: | + 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 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, @@ -1014,6 +1408,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#update-account source: | + 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. try: @@ -1032,6 +1434,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/account-usages#get-usages-by-account-id source: | + 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 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) @@ -1053,6 +1464,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/application-discovery#get-discovered-application-by-id source: | + 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 @@ -1068,6 +1487,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/application-discovery#get-discovered-applications source: | + 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 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) @@ -1089,6 +1517,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/application-discovery#get-manual-discover-applications-csv-template source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Download CSV Template for Discovery @@ -1105,6 +1542,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/application-discovery#patch-discovered-application-by-id source: | + 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 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. json_patch_operations = '''[{op=replace, path=/dismissed, value=true}]''' # List[JsonPatchOperations] | (optional) try: @@ -1121,6 +1567,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/application-discovery#send-manual-discover-applications-csv-template source: | + 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 @@ -1136,6 +1590,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/approvals#get-approval source: | + from sailpoint.beta.api.approvals_api import ApprovalsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.approval import Approval + 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 @@ -1153,6 +1616,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/approvals#get-approvals source: | + from sailpoint.beta.api.approvals_api import ApprovalsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.approval import Approval + 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) @@ -1172,6 +1644,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#create-source-app source: | + 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 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", @@ -1198,6 +1680,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#delete-access-profiles-from-source-app-by-bulk source: | + 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 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] | limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) @@ -1217,6 +1708,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#delete-source-app source: | + from sailpoint.beta.api.apps_api import AppsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.source_app import SourceApp + 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 @@ -1234,6 +1734,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#get-source-app source: | + from sailpoint.beta.api.apps_api import AppsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.source_app import SourceApp + 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 @@ -1251,6 +1760,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#list-access-profiles-for-source-app source: | + 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 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) @@ -1271,6 +1789,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#list-all-source-app source: | + from sailpoint.beta.api.apps_api import AppsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.source_app import SourceApp + 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) @@ -1292,6 +1819,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#list-all-user-apps source: | + from sailpoint.beta.api.apps_api import AppsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.user_app import UserApp + 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) @@ -1312,6 +1848,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#list-assigned-source-app source: | + from sailpoint.beta.api.apps_api import AppsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.source_app import SourceApp + 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) @@ -1333,6 +1878,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#list-available-accounts-for-user-app source: | + 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 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) @@ -1353,6 +1907,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#list-available-source-apps source: | + from sailpoint.beta.api.apps_api import AppsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.source_app import SourceApp + 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) @@ -1374,6 +1937,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#list-owned-user-apps source: | + from sailpoint.beta.api.apps_api import AppsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.user_app import UserApp + 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) @@ -1394,6 +1966,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#patch-source-app source: | + 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 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 json_patch_operation = '''[{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}]''' # List[JsonPatchOperation] | (optional) try: @@ -1412,6 +1994,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#patch-user-app source: | + 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 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 json_patch_operation = '''[sailpoint.beta.JsonPatchOperation()]''' # List[JsonPatchOperation] | (optional) try: @@ -1430,6 +2022,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#update-source-apps-in-bulk source: | + 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 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" : [ { @@ -1456,6 +2057,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/auth-profile#get-profile-config source: | + 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 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. @@ -1473,6 +2083,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/auth-profile#get-profile-config-list source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get list of Auth Profiles. @@ -1489,6 +2108,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/auth-profile#patch-profile-config source: | + 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 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. json_patch_operation = '''[sailpoint.beta.JsonPatchOperation()]''' # List[JsonPatchOperation] | try: @@ -1507,6 +2136,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#complete-campaign source: | + 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 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" @@ -1527,6 +2165,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#create-campaign source: | + from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.campaign import Campaign + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: campaign = '''{ "totalCertifications" : 100, "sourcesWithOrphanEntitlements" : [ { @@ -1652,6 +2299,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#create-campaign-template source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: campaign_template = '''{ "ownerRef" : { "name" : "Mister Manager", @@ -1792,6 +2448,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#delete-campaign-template source: | + 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 @@ -1807,6 +2471,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#delete-campaign-template-schedule source: | + 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 @@ -1822,6 +2494,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#delete-campaigns source: | + 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 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. @@ -1841,6 +2522,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-active-campaigns source: | + 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 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) @@ -1863,6 +2553,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-campaign source: | + from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.slimcampaign import Slimcampaign + 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 @@ -1880,6 +2579,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-campaign-reports source: | + 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 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 @@ -1897,6 +2605,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-campaign-reports-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get Campaign Reports Configuration @@ -1913,6 +2630,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-campaign-template source: | + 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 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 @@ -1930,6 +2656,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-campaign-template-schedule source: | + from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.schedule import Schedule + 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 @@ -1947,6 +2682,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-campaign-templates source: | + 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 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) @@ -1968,6 +2712,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#move source: | + 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 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" ], @@ -1993,6 +2747,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#patch-campaign-template source: | + 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 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. json_patch_operation = '''[{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) try: @@ -2011,6 +2775,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#set-campaign-reports-config source: | + 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 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. @@ -2030,6 +2803,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#set-campaign-template-schedule source: | + from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.schedule import Schedule + 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" : { @@ -2065,6 +2847,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#start-campaign source: | + 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 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" @@ -2085,6 +2876,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#start-campaign-remediation-scan source: | + 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 @@ -2102,6 +2901,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#start-campaign-report source: | + 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 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: @@ -2120,6 +2928,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#start-generate-campaign-template source: | + 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 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 @@ -2137,6 +2954,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#update-campaign source: | + from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.slimcampaign import Slimcampaign + 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 try: @@ -2155,6 +2981,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certifications#get-identity-certification-item-permissions source: | + from sailpoint.beta.api.certifications_api import CertificationsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.permission_dto import PermissionDto + 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) @@ -2177,6 +3012,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certifications#get-identity-certification-pending-tasks source: | + 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 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 @@ -2194,6 +3038,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certifications#get-identity-certification-task-status source: | + 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 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: @@ -2212,6 +3065,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certifications#list-certification-reviewers source: | + 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 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) @@ -2234,6 +3096,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certifications#list-certifications source: | + from sailpoint.beta.api.certifications_api import CertificationsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.certification_dto import CertificationDto + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: reviewer_identitiy = 'reviewer_identitiy_example' # 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) @@ -2256,6 +3127,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/certifications#submit-reassign-certs-async source: | + 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 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", @@ -2284,6 +3165,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/connector-rule-management#create-connector-rule source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: connector_rule_create_request = '''{ "sourceCode" : { "version" : "1.0", @@ -2326,6 +3217,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/connector-rule-management#delete-connector-rule source: | + 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 @@ -2341,6 +3240,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/connector-rule-management#get-connector-rule source: | + 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 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 @@ -2358,6 +3266,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/connector-rule-management#get-connector-rule-list source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List Connector Rules @@ -2374,6 +3291,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/connector-rule-management#update-connector-rule source: | + 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 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" : { @@ -2418,6 +3345,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/connector-rule-management#validate-connector-rule source: | + 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 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;" @@ -2438,6 +3375,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/connectors#get-connector-list source: | + 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 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) @@ -2459,6 +3405,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-definition source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: create_form_definition_request = '''{ "owner" : { "name" : "Grant Smith", @@ -2586,6 +3542,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-definition-by-template source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: create_form_definition_request = '''{ "owner" : { "name" : "Grant Smith", @@ -2713,6 +3679,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-definition-dynamic-schema source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: body = '''{ "description" : "A description", "attributes" : { @@ -2738,6 +3714,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-definition-file-request source: | + 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 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: @@ -2756,6 +3741,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-instance source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: body = '''{ "formInput" : { "input1" : "Sales" @@ -2793,6 +3788,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#delete-form-definition source: | + 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. @@ -2810,6 +3813,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#export-form-definitions-by-tenant source: | + 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 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) @@ -2830,6 +3842,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#get-file-from-s3 source: | + 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: @@ -2848,6 +3868,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#get-form-definition-by-key source: | + 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 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. @@ -2865,6 +3894,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#get-form-instance-by-key source: | + 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 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. @@ -2882,6 +3920,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#get-form-instance-file source: | + 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: @@ -2900,6 +3946,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#import-form-definitions source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: 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) try: # Import form definitions from export. @@ -2917,6 +3973,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#patch-form-definition source: | + 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 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) try: @@ -2935,6 +4000,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#patch-form-instance source: | + 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 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) try: @@ -2953,6 +4027,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#search-form-definitions-by-tenant source: | + 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 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) @@ -2973,6 +4056,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#search-form-element-data-by-element-id source: | + 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 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) @@ -2994,6 +4086,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#search-form-instances-by-tenant source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List form instances by tenant. @@ -3010,6 +4111,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#search-pre-defined-select-options source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List predefined select options. @@ -3026,6 +4136,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#show-preview-data-source source: | + 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 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) @@ -3057,6 +4177,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-password-instructions#create-custom-password-instructions source: | + 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 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", @@ -3078,6 +4207,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-password-instructions#delete-custom-password-instructions source: | + 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: @@ -3094,6 +4231,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-password-instructions#get-custom-password-instructions source: | + 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 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: @@ -3112,6 +4258,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#create-access-model-metadata-for-entitlement source: | + from sailpoint.beta.api.entitlements_api import EntitlementsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.entitlement import Entitlement + 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. @@ -3131,6 +4286,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#delete-access-model-metadata-from-entitlement source: | + 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. @@ -3148,6 +4311,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#get-entitlement source: | + from sailpoint.beta.api.entitlements_api import EntitlementsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.entitlement import Entitlement + 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 @@ -3165,6 +4337,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#get-entitlement-request-config source: | + 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 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 @@ -3182,6 +4363,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#import-entitlements-by-source source: | + 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 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: @@ -3200,6 +4390,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#list-entitlement-children source: | + from sailpoint.beta.api.entitlements_api import EntitlementsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.entitlement import Entitlement + 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) @@ -3222,6 +4421,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#list-entitlement-parents source: | + from sailpoint.beta.api.entitlements_api import EntitlementsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.entitlement import Entitlement + 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) @@ -3244,6 +4452,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#list-entitlements source: | + from sailpoint.beta.api.entitlements_api import EntitlementsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.entitlement import Entitlement + 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) @@ -3269,6 +4486,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#patch-entitlement source: | + 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 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 json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}]''' # List[JsonPatchOperation] | (optional) try: @@ -3287,6 +4514,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#put-entitlement-request-config source: | + 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 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" : { @@ -3317,6 +4553,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#reset-source-entitlements source: | + 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 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 @@ -3334,6 +4579,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#update-entitlements-in-bulk source: | + 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 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" : [ { @@ -3360,6 +4614,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/governance-groups#create-workgroup source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: workgroup_dto = '''{ "owner" : { "emailAddress" : "support@sailpoint.com", @@ -3392,6 +4655,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/governance-groups#delete-workgroup source: | + 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 @@ -3407,6 +4678,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/governance-groups#delete-workgroup-members source: | + 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 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. bulk_workgroup_members_request_inner = '''[sailpoint.beta.BulkWorkgroupMembersRequestInner()]''' # List[BulkWorkgroupMembersRequestInner] | List of identities to be removed from a Governance Group members list. try: @@ -3425,6 +4706,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/governance-groups#delete-workgroups-in-bulk source: | + 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 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 | @@ -3444,6 +4735,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/governance-groups#get-workgroup source: | + 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 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 @@ -3461,6 +4761,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/governance-groups#list-connections source: | + 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 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) @@ -3482,6 +4791,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/governance-groups#list-workgroup-members source: | + 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 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) @@ -3503,6 +4821,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/governance-groups#list-workgroups source: | + 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 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) @@ -3524,6 +4851,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/governance-groups#patch-workgroup source: | + 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 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 json_patch_operation = '''[{op=replace, path=/description, value=Governance Group new description.}]''' # List[JsonPatchOperation] | (optional) try: @@ -3542,6 +4879,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/governance-groups#update-workgroup-members source: | + 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 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. bulk_workgroup_members_request_inner = '''[sailpoint.beta.BulkWorkgroupMembersRequestInner()]''' # List[BulkWorkgroupMembersRequestInner] | List of identities to be added to a Governance Group members list. try: @@ -3560,6 +4907,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item source: | + 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 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", @@ -3583,6 +4940,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item source: | + 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 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", @@ -3606,6 +4973,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item source: | + 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 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", @@ -3629,6 +5006,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: access_request_recommendation_action_item_dto = '''[sailpoint.beta.AccessRequestRecommendationActionItemDto()]''' # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. try: # Bulk Mark Viewed Access Request Recommendations @@ -3646,6 +5033,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#get-access-request-recommendations source: | + 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 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) @@ -3669,6 +5065,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items source: | + 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 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) @@ -3690,6 +5095,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items source: | + 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 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) @@ -3711,6 +5125,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items source: | + 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 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) @@ -3732,6 +5155,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-common-access#create-common-access source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: common_access_item_request = '''{ "access" : { "ownerName" : "ownerName", @@ -3759,6 +5192,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-common-access#get-common-access source: | + 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 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) @@ -3780,6 +5222,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-common-access#update-common-access-status-in-bulk source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: common_access_id_status = '''[sailpoint.beta.CommonAccessIDStatus()]''' # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access try: # Bulk update common access status @@ -3797,6 +5248,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-message-catalogs#get-message-catalogs source: | + 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 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 @@ -3814,6 +5274,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-outliers#export-outliers-zip source: | + 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 @@ -3831,6 +5299,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-identity-outlier-snapshots source: | + 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 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) @@ -3852,6 +5329,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-identity-outliers source: | + from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.outlier import Outlier + 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) @@ -3874,6 +5360,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-latest-identity-outlier-snapshots source: | + 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 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 @@ -3891,6 +5386,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-outlier-contributing-feature-summary source: | + 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 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 @@ -3908,6 +5412,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-peer-group-outliers-contributing-features source: | + 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 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) @@ -3930,6 +5443,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-outliers#ignore-identity-outliers source: | + 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] | try: # IAI Identity Outliers Ignore @@ -3945,6 +5466,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-outliers#list-outliers-contributing-feature-access-items source: | + 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 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) @@ -3968,6 +5498,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-outliers#un-ignore-identity-outliers source: | + 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] | try: # IAI Identity Outliers Unignore @@ -3983,6 +5521,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-peer-group-strategies#get-peer-group-outliers source: | + 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 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) @@ -4003,6 +5550,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-recommendations#get-recommendations source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: recommendation_request_dto = '''{ "prescribeMode" : false, "excludeInterpretations" : false, @@ -4038,6 +5595,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-recommendations#get-recommendations-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get certification recommendation config values @@ -4054,6 +5620,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-recommendations#update-recommendations-config source: | + 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 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, @@ -4076,6 +5651,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#create-potential-role-provision-request source: | + from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role_mining_potential_role_provision_request import RoleMiningPotentialRoleProvisionRequest + from sailpoint.beta.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + 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) @@ -4103,6 +5688,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#create-role-mining-sessions source: | + from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role_mining_session_dto import RoleMiningSessionDto + from sailpoint.beta.models.role_mining_session_response import RoleMiningSessionResponse + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: role_mining_session_dto = '''{ "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", "prescribedPruneThreshold" : 10, @@ -4151,6 +5746,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#download-role-mining-potential-role-zip source: | + 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 @@ -4170,6 +5773,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#export-role-mining-potential-role source: | + 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: @@ -4188,6 +5799,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#export-role-mining-potential-role-async source: | + from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role_mining_potential_role_export_request import RoleMiningPotentialRoleExportRequest + from sailpoint.beta.models.role_mining_potential_role_export_response import RoleMiningPotentialRoleExportResponse + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + 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 = '''{ @@ -4210,6 +5831,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#export-role-mining-potential-role-status source: | + from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role_mining_potential_role_export_response import RoleMiningPotentialRoleExportResponse + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + 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 @@ -4229,6 +5859,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-all-potential-role-summaries source: | + from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + 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) @@ -4250,6 +5889,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-entitlement-distribution-potential-role source: | + 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) @@ -4269,6 +5916,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-entitlements-potential-role source: | + from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role_mining_entitlement import RoleMiningEntitlement + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + 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) @@ -4293,6 +5949,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-excluded-entitlements-potential-role source: | + from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role_mining_entitlement import RoleMiningEntitlement + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + 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) @@ -4316,6 +5981,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-identities-potential-role source: | + from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role_mining_identity import RoleMiningIdentity + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + 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) @@ -4339,6 +6013,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-potential-role source: | + from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role_mining_potential_role import RoleMiningPotentialRole + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + 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: @@ -4357,6 +6040,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-potential-role-applications source: | + from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role_mining_potential_role_application import RoleMiningPotentialRoleApplication + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + 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) @@ -4379,6 +6071,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-potential-role-entitlements source: | + from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role_mining_potential_role_entitlements import RoleMiningPotentialRoleEntitlements + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + 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) @@ -4401,6 +6102,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-potential-role-source-identity-usage source: | + from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role_mining_potential_role_source_usage import RoleMiningPotentialRoleSourceUsage + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + 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) @@ -4423,6 +6133,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-potential-role-summaries source: | + from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + 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) @@ -4445,6 +6164,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-role-mining-potential-role source: | + from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role_mining_potential_role import RoleMiningPotentialRole + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + 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 @@ -4462,6 +6190,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-role-mining-session source: | + from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role_mining_session_response import RoleMiningSessionResponse + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + 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 @@ -4479,6 +6216,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-role-mining-session-status source: | + from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role_mining_session_status import RoleMiningSessionStatus + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + 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 @@ -4496,6 +6242,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-role-mining-sessions source: | + from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role_mining_session_response import RoleMiningSessionResponse + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + 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) @@ -4517,6 +6272,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-saved-potential-roles source: | + from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role_mining_session_draft_role_dto import RoleMiningSessionDraftRoleDto + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + 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) @@ -4537,6 +6301,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#patch-potential-role source: | + from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.patch_potential_role_request_inner import PatchPotentialRoleRequestInner + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + 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 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] | @@ -4556,6 +6329,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#patch-role-mining-potential-role source: | + from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.patch_potential_role_request_inner import PatchPotentialRoleRequestInner + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + 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 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] | try: @@ -4574,6 +6356,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#patch-role-mining-session source: | + from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.json_patch_operation import JsonPatchOperation + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + 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 json_patch_operation = '''[{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. try: @@ -4592,6 +6383,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#update-entitlements-potential-role source: | + from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role_mining_potential_role import RoleMiningPotentialRole + from sailpoint.beta.models.role_mining_potential_role_edit_entitlements import RoleMiningPotentialRoleEditEntitlements + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + 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 = '''{ @@ -4614,6 +6415,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/icons#delete-icon source: | + 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: @@ -4630,6 +6439,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/icons#set-icon source: | + 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 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'] @@ -4649,6 +6467,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#delete-identity source: | + 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 @@ -4664,6 +6490,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#get-identity source: | + from sailpoint.beta.api.identities_api import IdentitiesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.identity import Identity + 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 @@ -4681,6 +6516,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#get-identity-ownership-details source: | + 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 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 @@ -4698,6 +6542,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#get-role-assignment source: | + 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 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: @@ -4716,6 +6569,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#get-role-assignments source: | + 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 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) @@ -4735,6 +6597,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#list-identities source: | + from sailpoint.beta.api.identities_api import IdentitiesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.identity import Identity + 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) @@ -4757,6 +6628,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#reset-identity source: | + 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 @@ -4772,6 +6651,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#send-identity-verification-account-token source: | + 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 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", @@ -4791,6 +6679,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#start-identities-invite source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: invite_identities_request = '''{ "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], "uninvited" : false @@ -4811,6 +6709,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#start-identity-processing source: | + 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 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 | @@ -4830,6 +6738,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#synchronize-attributes-for-identity source: | + 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 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. @@ -4847,6 +6764,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-attributes#create-identity-attribute source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: identity_attribute = '''{ "standard" : false, "system" : false, @@ -4885,6 +6811,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-attributes#delete-identity-attribute source: | + 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 @@ -4900,6 +6834,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-attributes#delete-identity-attributes-in-bulk source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: identity_attribute_names = '''{ "ids" : [ "name", "displayName" ] }''' # IdentityAttributeNames | @@ -4917,6 +6860,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-attributes#get-identity-attribute source: | + 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 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 @@ -4934,6 +6886,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-attributes#list-identity-attributes source: | + 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 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) @@ -4954,6 +6915,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-attributes#put-identity-attribute source: | + 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 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, @@ -4993,6 +6963,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-history#compare-identity-snapshots source: | + 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 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) @@ -5016,6 +6995,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-history#compare-identity-snapshots-access-type source: | + 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 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) @@ -5040,6 +7028,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-history#get-historical-identity source: | + 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 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 @@ -5057,6 +7054,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-history#get-historical-identity-events source: | + 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 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) @@ -5080,6 +7086,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-history#get-identity-snapshot source: | + 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 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: @@ -5098,6 +7113,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-history#get-identity-snapshot-summary source: | + 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 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) @@ -5121,6 +7145,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-history#get-identity-start-date source: | + 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 @@ -5138,6 +7170,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-history#list-historical-identities source: | + 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 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) @@ -5159,6 +7200,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-history#list-identity-access-items source: | + 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 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) @@ -5183,6 +7233,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-history#list-identity-snapshot-access-items source: | + 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 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) @@ -5202,6 +7261,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-history#list-identity-snapshots source: | + 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 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) @@ -5224,6 +7292,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-profiles#create-identity-profile source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: identity_profile = '''{ "owner" : { "name" : "William Wilson", @@ -5289,6 +7366,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-profiles#delete-identity-profile source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. try: # Delete Identity Profile @@ -5306,6 +7392,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-profiles#delete-identity-profiles source: | + 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 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. try: # Delete Identity Profiles @@ -5323,6 +7418,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-profiles#export-identity-profiles source: | + 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 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) @@ -5344,6 +7448,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-profiles#get-default-identity-attribute-config source: | + 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 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 @@ -5361,6 +7474,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-profiles#get-identity-profile source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. try: # Get Identity Profile @@ -5378,6 +7500,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-profiles#import-identity-profiles source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: identity_profile_exported_object = '''[sailpoint.beta.IdentityProfileExportedObject()]''' # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. try: # Import Identity Profiles @@ -5395,6 +7527,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-profiles#list-identity-profiles source: | + 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 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) @@ -5416,6 +7557,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-profiles#show-generate-identity-preview source: | + 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 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" : { @@ -5459,6 +7610,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-profiles#sync-identity-profile source: | + 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 @@ -5476,6 +7635,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-profiles#update-identity-profile source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. json_patch_operation = '''[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}]''' # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. try: @@ -5494,6 +7663,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/launchers#create-launcher source: | + 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 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", @@ -5521,6 +7700,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/launchers#delete-launcher source: | + 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 @@ -5536,6 +7723,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/launchers#get-launcher source: | + from sailpoint.beta.api.launchers_api import LaunchersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.launcher import Launcher + 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 @@ -5553,6 +7749,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/launchers#get-launchers source: | + 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 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) @@ -5572,6 +7777,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/launchers#put-launcher source: | + 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 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" : { @@ -5600,6 +7815,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/launchers#start-launcher source: | + 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 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 @@ -5617,6 +7841,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/lifecycle-states#get-lifecycle-states source: | + 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 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: @@ -5635,6 +7868,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/lifecycle-states#update-lifecycle-states source: | + 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 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. json_patch_operation = '''[{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 @@ -5654,6 +7897,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/managed-clients#get-managed-client-status source: | + 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 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: @@ -5672,6 +7925,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/managed-clients#update-managed-client-status source: | + 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 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" : { @@ -5715,6 +7978,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-client-log-configuration source: | + 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 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 @@ -5732,6 +8004,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-cluster source: | + 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 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. @@ -5749,6 +8030,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-clusters source: | + 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 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) @@ -5769,6 +8059,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/managed-clusters#put-client-log-configuration source: | + 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 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, @@ -5793,6 +8092,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-configuration#delete-mfa-config source: | + 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 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 @@ -5810,6 +8118,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-configuration#get-mfa-duo-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Configuration of Duo MFA method @@ -5826,6 +8143,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-configuration#get-mfa-kba-config source: | + 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 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 @@ -5843,6 +8169,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-configuration#get-mfa-okta-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Configuration of Okta MFA method @@ -5859,6 +8194,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-configuration#set-mfa-duo-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: mfa_duo_config = '''{ "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", "host" : "example.com", @@ -5886,6 +8230,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-configuration#set-mfa-okta-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: mfa_okta_config = '''{ "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", "host" : "example.com", @@ -5909,6 +8262,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-configuration#set-mfakba-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | try: # Set MFA KBA configuration @@ -5926,6 +8289,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-configuration#test-mfa-config source: | + 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 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 @@ -5943,6 +8315,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-controller#create-send-token source: | + 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 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" @@ -5963,6 +8345,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-controller#ping-verification-status source: | + 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 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" @@ -5983,6 +8375,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-controller#send-duo-verify-request source: | + 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 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" @@ -6003,6 +8405,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-controller#send-kba-answers source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | try: # Authenticate KBA provided MFA method @@ -6020,6 +8432,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-controller#send-okta-verify-request source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: okta_verification_request = '''{ "userId" : "example@mail.com" }''' # OktaVerificationRequest | @@ -6039,6 +8461,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-controller#send-token-auth-request source: | + 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 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", @@ -6060,6 +8492,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#create-multi-host-integration source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: multi_host_integrations_create = '''{ "owner" : { "name" : "MyName", @@ -6102,6 +8544,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#create-sources-within-multi-host source: | + 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 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. multi_host_integrations_create_sources = '''[sailpoint.beta.MultiHostIntegrationsCreateSources()]''' # List[MultiHostIntegrationsCreateSources] | The specifics of the sources to create within Multi-Host Integration. try: @@ -6118,6 +8569,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#delete-multi-host source: | + 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 @@ -6133,6 +8592,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-acct-aggregation-groups source: | + 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 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 @@ -6150,6 +8618,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-entitlement-aggregation-groups source: | + 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 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 @@ -6167,6 +8644,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-multi-host-integrations source: | + 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 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 @@ -6184,6 +8670,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-multi-host-integrations-list source: | + 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 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) @@ -6206,6 +8701,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-multi-host-source-creation-errors source: | + 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 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 @@ -6223,6 +8727,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-multihost-integration-types source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List Multi-Host Integration Types @@ -6239,6 +8752,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-sources-within-multi-host source: | + 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 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) @@ -6261,6 +8783,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#test-connection-multi-host-sources source: | + 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 @@ -6276,6 +8806,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#test-source-connection-multihost source: | + 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 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: @@ -6294,6 +8833,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#update-multi-host-sources source: | + 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 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. 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. try: @@ -6310,6 +8858,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#approve-non-employee-request source: | + 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 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" @@ -6330,6 +8888,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#create-non-employee-record source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: non_employee_request_body = '''{ "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", @@ -6360,6 +8928,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#create-non-employee-request source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: non_employee_request_body = '''{ "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", @@ -6390,6 +8968,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#create-non-employee-source source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: non_employee_source_request_body = '''{ "owner" : { "id" : "2c91808570313110017040b06f344ec9" @@ -6432,6 +9020,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes source: | + 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 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", @@ -6457,6 +9055,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-record source: | + 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 @@ -6472,6 +9078,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-record-in-bulk source: | + 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 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 @@ -6487,6 +9102,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-request source: | + 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 @@ -6502,6 +9125,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute source: | + 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: @@ -6518,6 +9149,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-source source: | + 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 @@ -6533,6 +9172,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes source: | + 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 @@ -6548,6 +9195,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#export-non-employee-records source: | + 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 @@ -6563,6 +9218,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template source: | + 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 @@ -6578,6 +9241,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-approval source: | + 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 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: @@ -6596,6 +9268,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-approval-summary source: | + 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 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 @@ -6613,6 +9294,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status source: | + 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 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 @@ -6630,6 +9320,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-record source: | + 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 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 @@ -6647,6 +9346,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-request source: | + 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 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 @@ -6664,6 +9372,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-request-summary source: | + 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 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 @@ -6681,6 +9398,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute source: | + 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 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: @@ -6699,6 +9425,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-source source: | + 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 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 @@ -6716,6 +9451,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes source: | + 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 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 @@ -6733,6 +9477,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk source: | + 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 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: @@ -6751,6 +9504,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#list-non-employee-approval source: | + 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 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) @@ -6773,6 +9535,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#list-non-employee-records source: | + 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 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) @@ -6794,6 +9565,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#list-non-employee-requests source: | + 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 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) @@ -6816,6 +9596,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#list-non-employee-sources source: | + 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 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) @@ -6838,6 +9627,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#patch-non-employee-record source: | + 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 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) json_patch_operation = '''[{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. try: @@ -6856,6 +9655,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute source: | + 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 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 json_patch_operation = '''[{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'. @@ -6875,6 +9684,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#patch-non-employee-source source: | + 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 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 json_patch_operation = '''[{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. try: @@ -6893,6 +9712,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#reject-non-employee-request source: | + 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 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" @@ -6913,6 +9742,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#update-non-employee-record source: | + 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 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", @@ -6944,6 +9783,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#create-domain-dkim source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: domain_address = '''{ "domain" : "sailpoint.com" }''' # DomainAddress | @@ -6963,6 +9812,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#create-notification-template source: | + from sailpoint.beta.api.notifications_api import NotificationsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.template_dto import TemplateDto + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: template_dto = '''{ "slackTemplate" : "slackTemplate", "footer" : "footer", @@ -6997,6 +9855,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#create-verified-from-address source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: email_status_dto = '''{ "isVerifiedByDomain" : false, "verificationStatus" : "PENDING", @@ -7019,6 +9886,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#delete-notification-templates-in-bulk source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: template_bulk_delete_dto = '''[sailpoint.beta.TemplateBulkDeleteDto()]''' # List[TemplateBulkDeleteDto] | try: # Bulk Delete Notification Templates @@ -7034,6 +9910,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#delete-verified-from-address source: | + 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 @@ -7049,6 +9933,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#get-dkim-attributes source: | + from sailpoint.beta.api.notifications_api import NotificationsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.dkim_attributes import DkimAttributes + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get DKIM Attributes @@ -7065,6 +9958,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#get-mail-from-attributes source: | + 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 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 @@ -7082,6 +9984,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#get-notification-template source: | + from sailpoint.beta.api.notifications_api import NotificationsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.template_dto import TemplateDto + 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 @@ -7099,6 +10010,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#get-notifications-template-context source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get Notification Template Context @@ -7115,6 +10035,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#list-from-addresses source: | + 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 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) @@ -7136,6 +10065,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#list-notification-preferences source: | + from sailpoint.beta.api.notifications_api import NotificationsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.preferences_dto import PreferencesDto + 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. @@ -7153,6 +10091,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#list-notification-template-defaults source: | + 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 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) @@ -7172,6 +10119,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#list-notification-templates source: | + from sailpoint.beta.api.notifications_api import NotificationsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.template_dto import TemplateDto + 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) @@ -7191,6 +10147,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#put-mail-from-attributes source: | + 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 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" @@ -7211,6 +10177,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#send-test-notification source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: send_test_notification_request_dto = '''{ "context" : "{}", "medium" : "EMAIL", @@ -7230,6 +10205,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/o-auth-clients#create-oauth-client source: | + 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 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", @@ -7263,6 +10248,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/o-auth-clients#delete-oauth-client source: | + 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 @@ -7278,6 +10271,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/o-auth-clients#get-oauth-client source: | + 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 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 @@ -7295,6 +10297,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/o-auth-clients#list-oauth-clients source: | + 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 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 @@ -7312,6 +10323,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/o-auth-clients#patch-oauth-client source: | + 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 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 json_patch_operation = '''[{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 try: @@ -7330,6 +10351,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/org-config#get-org-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get Org configuration settings @@ -7346,6 +10376,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/org-config#get-valid-time-zones source: | + 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 @@ -7362,6 +10400,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/org-config#patch-org-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: json_patch_operation = '''[{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. try: # Patch an Org configuration property @@ -7379,6 +10427,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/password-configuration#create-password-org-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: password_org_config = '''{ "digitTokenLength" : 9, "digitTokenEnabled" : true, @@ -7401,6 +10458,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/password-configuration#get-password-org-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get Password Org Config @@ -7417,6 +10483,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/password-configuration#put-password-org-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: password_org_config = '''{ "digitTokenLength" : 9, "digitTokenEnabled" : true, @@ -7439,6 +10514,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/password-dictionary#get-password-dictionary source: | + 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 @@ -7455,6 +10538,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/password-dictionary#put-password-dictionary source: | + 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 @@ -7470,6 +10561,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/password-management#create-digit-token source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: password_digit_token_reset = '''{ "durationMinutes" : 5, "length" : 8, @@ -7491,6 +10592,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/password-management#get-identity-password-change-status source: | + 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 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 @@ -7508,6 +10618,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/password-management#query-password-info source: | + 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 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" @@ -7528,6 +10648,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/password-management#set-identity-password source: | + 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 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", @@ -7551,6 +10681,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/password-policies#create-password-policy source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: password_policy_v3_dto = '''{ "validateAgainstAccountName" : true, "minLength" : 8, @@ -7600,6 +10739,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/password-policies#delete-password-policy source: | + 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 @@ -7615,6 +10762,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/password-policies#get-password-policy-by-id source: | + 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 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 @@ -7632,6 +10788,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/password-policies#list-password-policies source: | + 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 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) @@ -7651,6 +10816,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/password-policies#set-password-policy source: | + 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 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, @@ -7701,6 +10875,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/password-sync-groups#create-password-sync-group source: | + 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 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", @@ -7725,6 +10908,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/password-sync-groups#delete-password-sync-group source: | + 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 @@ -7740,6 +10931,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/password-sync-groups#get-password-sync-group source: | + 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 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 @@ -7757,6 +10957,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/password-sync-groups#get-password-sync-groups source: | + 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 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) @@ -7776,6 +10985,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/password-sync-groups#update-password-sync-group source: | + 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 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", @@ -7801,6 +11019,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/personal-access-tokens#create-personal-access-token source: | + 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 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, @@ -7822,6 +11050,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/personal-access-tokens#delete-personal-access-token source: | + 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 @@ -7837,6 +11073,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/personal-access-tokens#list-personal-access-tokens source: | + 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 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: @@ -7855,6 +11100,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/personal-access-tokens#patch-personal-access-token source: | + 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 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 json_patch_operation = '''[{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 try: @@ -7873,6 +11128,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/public-identities-config#get-public-identity-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get Public Identity Config @@ -7889,6 +11153,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/public-identities-config#update-public-identity-config source: | + 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 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" : [ { @@ -7920,6 +11193,17 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/requestable-objects#list-requestable-objects source: | + 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 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) term = 'Finance Role' # str | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) # str | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) @@ -7945,6 +11229,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/role-insights#create-role-insight-requests source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Generate insights for roles @@ -7961,6 +11254,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/role-insights#download-role-insights-entitlements-changes source: | + 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) @@ -7980,6 +11281,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/role-insights#get-entitlement-changes-identities source: | + 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 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) @@ -8004,6 +11314,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insight source: | + 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 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 @@ -8021,6 +11340,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights source: | + 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 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) @@ -8042,6 +11370,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights-current-entitlements source: | + 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 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: @@ -8060,6 +11397,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights-entitlements-changes source: | + 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 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) @@ -8079,6 +11425,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights-requests source: | + 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 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. @@ -8096,6 +11451,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights-summary source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get role insights summary information @@ -8112,6 +11476,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/roles#create-role source: | + from sailpoint.beta.api.roles_api import RolesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role import Role + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: role = '''{ "owner" : { "name" : "support", @@ -8286,6 +11659,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/roles#delete-bulk-roles source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: role_bulk_delete_request = '''{ "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] }''' # RoleBulkDeleteRequest | @@ -8305,6 +11688,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/roles#delete-role source: | + 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 @@ -8320,6 +11711,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/roles#get-role source: | + from sailpoint.beta.api.roles_api import RolesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role import Role + 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 @@ -8337,6 +11737,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/roles#get-role-assigned-identities source: | + from sailpoint.beta.api.roles_api import RolesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role_identity import RoleIdentity + 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) @@ -8359,6 +11768,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/roles#get-role-entitlements source: | + from sailpoint.beta.api.roles_api import RolesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.entitlement import Entitlement + 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) @@ -8381,6 +11799,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/roles#list-roles source: | + from sailpoint.beta.api.roles_api import RolesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.role import Role + 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) @@ -8405,6 +11832,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/roles#patch-role source: | + 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 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 json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]''' # List[JsonPatchOperation] | try: @@ -8423,6 +11860,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#create-search-attribute-config source: | + 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 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", @@ -8447,6 +11893,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#delete-search-attribute-config source: | + 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 @@ -8462,6 +11916,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-search-attribute-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List Extended Search Attributes @@ -8478,6 +11941,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-single-search-attribute-config source: | + 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 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 @@ -8495,6 +11967,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#patch-search-attribute-config source: | + 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 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. json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | try: @@ -8513,6 +11995,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/segments#create-segment source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: segment = '''{ "owner" : { "name" : "support", @@ -8553,6 +12044,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/segments#delete-segment source: | + 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 @@ -8568,6 +12067,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/segments#get-segment source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + 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 @@ -8585,6 +12093,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/segments#list-segments source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + 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) @@ -8604,6 +12121,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/segments#patch-segment source: | + from sailpoint.beta.api.segments_api import SegmentsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.segment import Segment + 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 try: @@ -8622,6 +12148,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/service-desk-integration#create-service-desk-integration source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: service_desk_integration_dto = '''{ "ownerRef" : "", "cluster" : "xyzzy999", @@ -8669,6 +12204,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/service-desk-integration#delete-service-desk-integration source: | + 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 @@ -8684,6 +12227,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration source: | + 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 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 @@ -8701,6 +12253,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-list source: | + 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 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) @@ -8722,6 +12283,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-template source: | + 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 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 @@ -8739,6 +12309,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-types source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List Service Desk integration types @@ -8755,6 +12334,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-status-check-details source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get the time check configuration @@ -8771,6 +12359,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/service-desk-integration#patch-service-desk-integration source: | + 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 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: @@ -8789,6 +12387,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/service-desk-integration#put-service-desk-integration source: | + 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 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" : "", @@ -8837,6 +12444,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/service-desk-integration#update-status-check-details source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: queued_check_config_details = '''{ "provisioningStatusCheckIntervalMinutes" : "30", "provisioningMaxStatusCheckDays" : "2" @@ -8857,6 +12473,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sim-integrations#create-sim-integration source: | + 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 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}", @@ -8891,6 +12517,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sim-integrations#delete-sim-integration source: | + 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 @@ -8906,6 +12540,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sim-integrations#get-sim-integration source: | + 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 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. @@ -8923,6 +12566,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sim-integrations#get-sim-integrations source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List the existing SIM integrations. @@ -8939,6 +12591,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sim-integrations#patch-before-provisioning-rule source: | + 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 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: @@ -8957,6 +12619,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sim-integrations#patch-sim-attributes source: | + 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 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: @@ -8975,6 +12647,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sim-integrations#put-sim-integration source: | + 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 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", @@ -9010,6 +12692,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#create-sod-policy source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: sod_policy = '''{ "conflictingAccessCriteria" : { "leftCriteria" : { @@ -9082,6 +12773,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#delete-sod-policy source: | + 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: @@ -9098,6 +12797,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#delete-sod-policy-schedule source: | + 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 @@ -9113,6 +12820,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#get-custom-violation-report source: | + 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: @@ -9131,6 +12846,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#get-default-violation-report source: | + 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 @@ -9148,6 +12871,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#get-sod-all-report-run-status source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get multi-report run task status @@ -9164,6 +12896,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#get-sod-policy source: | + 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 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 @@ -9181,6 +12922,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#get-sod-policy-schedule source: | + 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 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 @@ -9198,6 +12948,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#get-sod-violation-report-run-status source: | + 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 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 @@ -9215,6 +12974,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#get-sod-violation-report-status source: | + 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 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 @@ -9232,6 +13000,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#list-sod-policies source: | + 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 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) @@ -9253,6 +13030,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#patch-sod-policy source: | + 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 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 try: @@ -9271,6 +13057,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#put-policy-schedule source: | + 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 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" : { @@ -9374,6 +13169,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#put-sod-policy source: | + 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 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" : { @@ -9447,6 +13251,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#start-sod-all-policies-for-org source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: multi_policy_request = '''{ "filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ] }''' # MultiPolicyRequest | (optional) @@ -9466,6 +13280,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#start-sod-policy source: | + 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 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 @@ -9483,6 +13306,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-violations#start-predict-sod-violations source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: identity_with_new_access = '''{ "identityId" : "2c91808568c529c60168cca6f90c1313", "accessRefs" : [ { @@ -9511,6 +13344,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#create-provisioning-policy source: | + 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 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", @@ -9568,6 +13410,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#create-source source: | + from sailpoint.beta.api.sources_api import SourcesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.source import Source + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: source = '''{ "cluster" : { "name" : "Corporate Cluster", @@ -9668,6 +13519,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#create-source-schema source: | + from sailpoint.beta.api.sources_api import SourcesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.model_schema import ModelSchema + 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: @@ -9686,6 +13546,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#delete source: | + from sailpoint.beta.api.sources_api import SourcesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.delete202_response import Delete202Response + 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 @@ -9703,6 +13572,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#delete-accounts-async source: | + 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 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 @@ -9720,6 +13598,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#delete-native-change-detection-config source: | + 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 @@ -9735,6 +13621,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#delete-provisioning-policy source: | + from sailpoint.beta.api.sources_api import SourcesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.usage_type import UsageType + 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: @@ -9751,6 +13646,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#delete-source-schema source: | + 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: @@ -9767,6 +13670,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#get-correlation-config source: | + from sailpoint.beta.api.sources_api import SourcesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.correlation_config import CorrelationConfig + 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 @@ -9784,6 +13696,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#get-native-change-detection-config source: | + 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 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 @@ -9801,6 +13722,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#get-provisioning-policy source: | + 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 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: @@ -9819,6 +13750,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#get-source source: | + from sailpoint.beta.api.sources_api import SourcesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.source import Source + 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 @@ -9836,6 +13776,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#get-source-accounts-schema source: | + 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 @@ -9851,6 +13799,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#get-source-attr-sync-config source: | + 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 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 @@ -9868,6 +13825,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#get-source-config source: | + from sailpoint.beta.api.sources_api import SourcesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.connector_detail import ConnectorDetail + 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: @@ -9886,6 +13852,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#get-source-entitlement-request-config source: | + 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 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 @@ -9903,6 +13878,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#get-source-entitlements-schema source: | + 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: @@ -9919,6 +13902,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#get-source-schema source: | + from sailpoint.beta.api.sources_api import SourcesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.model_schema import ModelSchema + 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: @@ -9937,6 +13929,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#get-source-schemas source: | + from sailpoint.beta.api.sources_api import SourcesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.model_schema import ModelSchema + 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) @@ -9956,6 +13957,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#import-accounts source: | + 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 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) @@ -9975,6 +13985,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#import-entitlements source: | + 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 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: @@ -9993,6 +14012,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#import-source-accounts-schema source: | + from sailpoint.beta.api.sources_api import SourcesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.model_schema import ModelSchema + 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: @@ -10011,6 +14039,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#import-source-connector-file source: | + from sailpoint.beta.api.sources_api import SourcesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.source import Source + 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: @@ -10029,6 +14066,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#import-source-entitlements-schema source: | + from sailpoint.beta.api.sources_api import SourcesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.model_schema import ModelSchema + 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) @@ -10048,6 +14094,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#import-uncorrelated-accounts source: | + 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 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: @@ -10066,6 +14121,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#list-provisioning-policies source: | + 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 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 @@ -10083,6 +14147,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#list-sources source: | + from sailpoint.beta.api.sources_api import SourcesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.source import Source + 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) @@ -10106,6 +14179,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#peek-resource-objects source: | + 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 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, @@ -10127,6 +14210,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#ping-cluster source: | + from sailpoint.beta.api.sources_api import SourcesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.status_response import StatusResponse + 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 @@ -10144,6 +14236,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#put-correlation-config source: | + from sailpoint.beta.api.sources_api import SourcesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.correlation_config import CorrelationConfig + 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" : [ { @@ -10182,6 +14283,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#put-native-change-detection-config source: | + 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 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" ], @@ -10207,6 +14317,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#put-provisioning-policy source: | + 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 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 = '''{ @@ -10265,6 +14385,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#put-source source: | + from sailpoint.beta.api.sources_api import SourcesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.source import Source + 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" : { @@ -10365,6 +14494,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#put-source-attr-sync-config source: | + 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 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" : [ { @@ -10400,6 +14538,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#put-source-schema source: | + from sailpoint.beta.api.sources_api import SourcesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.model_schema import ModelSchema + 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 | @@ -10419,6 +14566,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#sync-attributes-for-source source: | + 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 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. @@ -10436,6 +14592,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#test-source-configuration source: | + from sailpoint.beta.api.sources_api import SourcesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.status_response import StatusResponse + 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 @@ -10453,6 +14618,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#test-source-connection source: | + from sailpoint.beta.api.sources_api import SourcesApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.status_response import StatusResponse + 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. @@ -10470,6 +14644,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#update-provisioning-policies-in-bulk source: | + 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 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 = '''[sailpoint.beta.ProvisioningPolicyDto()]''' # List[ProvisioningPolicyDto] | try: @@ -10488,6 +14671,17 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#update-provisioning-policy source: | + 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 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. json_patch_operation = '''[{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. @@ -10507,6 +14701,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#update-source source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. json_patch_operation = '''[{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). try: @@ -10525,6 +14729,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#update-source-entitlement-request-config source: | + 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 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" : { @@ -10555,6 +14768,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#update-source-schema source: | + 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 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. json_patch_operation = '''[{op=replace, path=/displayAttribute, value={new-display-attribute=null}}]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. @@ -10574,6 +14797,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/source-usages#get-status-by-source-id source: | + 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 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 @@ -10591,6 +14823,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/source-usages#get-usages-by-source-id source: | + 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 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) @@ -10612,6 +14853,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sp-config#export-sp-config source: | + 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 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. @@ -10631,6 +14882,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export source: | + 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 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. @@ -10648,6 +14908,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-export-status source: | + 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 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 @@ -10665,6 +14934,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import source: | + 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 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 @@ -10682,6 +14960,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sp-config#get-sp-config-import-status source: | + 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 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 @@ -10699,6 +14986,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sp-config#import-sp-config source: | + 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 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) @@ -10718,6 +15015,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/sp-config#list-sp-config-objects source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get config object details @@ -10734,6 +15040,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#get-sed-batch-stats source: | + 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 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 @@ -10751,6 +15066,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#get-sed-batches source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List Sed Batch Request @@ -10767,6 +15091,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#list-seds source: | + 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 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) @@ -10790,6 +15123,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#patch-sed source: | + 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 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 sed_patch = '''[sailpoint.beta.SedPatch()]''' # List[SedPatch] | Sed Patch Request try: @@ -10808,6 +15151,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#submit-sed-approval source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: sed_approval = '''[sailpoint.beta.SedApproval()]''' # List[SedApproval] | Sed Approval try: # Submit Bulk Approval Request @@ -10825,6 +15178,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#submit-sed-assignment source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: sed_assignment = '''{ "assignee" : { "type" : "SOURCE_OWNER", @@ -10848,6 +15211,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#submit-sed-batch-request source: | + 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 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" ] @@ -10868,6 +15241,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/tagged-objects#delete-tagged-object source: | + 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: @@ -10884,6 +15265,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/tagged-objects#delete-tags-to-many-object source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: bulk_tagged_object = '''{ "objectRefs" : [ { "name" : "William Wilson", @@ -10911,6 +15301,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/tagged-objects#get-tagged-object source: | + 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 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: @@ -10929,6 +15328,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/tagged-objects#list-tagged-objects source: | + 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 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) @@ -10949,6 +15357,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/tagged-objects#list-tagged-objects-by-type source: | + 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 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) @@ -10970,6 +15387,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/tagged-objects#put-tagged-object source: | + 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 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 = '''{ @@ -10996,6 +15422,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/tagged-objects#set-tag-to-object source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: tagged_object = '''{ "objectRef" : { "name" : "William Wilson", @@ -11018,6 +15453,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/tagged-objects#set-tags-to-many-objects source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: bulk_tagged_object = '''{ "objectRefs" : [ { "name" : "William Wilson", @@ -11047,6 +15491,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/tags#create-tag source: | + from sailpoint.beta.api.tags_api import TagsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.tag import Tag + 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" : [ { @@ -11078,6 +15531,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/tags#delete-tag-by-id source: | + 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 @@ -11093,6 +15554,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/tags#get-tag-by-id source: | + from sailpoint.beta.api.tags_api import TagsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.tag import Tag + 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 @@ -11110,6 +15580,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/tags#list-tags source: | + from sailpoint.beta.api.tags_api import TagsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.tag import Tag + 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) @@ -11131,6 +15610,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/task-management#get-pending-task-headers source: | + 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) @@ -11148,6 +15635,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/task-management#get-pending-tasks source: | + 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 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) @@ -11167,6 +15663,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/task-management#get-task-status source: | + 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 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 @@ -11184,6 +15689,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/task-management#get-task-status-list source: | + 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 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) @@ -11205,6 +15719,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/task-management#update-task-status source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. json_patch_operation = '''[sailpoint.beta.JsonPatchOperation()]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the object. try: @@ -11223,6 +15747,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/tenant#get-tenant source: | + from sailpoint.beta.api.tenant_api import TenantApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.tenant import Tenant + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get Tenant Information. @@ -11239,6 +15772,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/transforms#create-transform source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: transform = '''{ "name" : "Timestamp To Date", "attributes" : "{}", @@ -11260,6 +15803,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/transforms#delete-transform source: | + 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 @@ -11275,6 +15826,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/transforms#get-transform source: | + from sailpoint.beta.api.transforms_api import TransformsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.transform_read import TransformRead + 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 @@ -11292,6 +15852,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/transforms#list-transforms source: | + from sailpoint.beta.api.transforms_api import TransformsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.transform_read import TransformRead + 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) @@ -11313,6 +15882,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/transforms#update-transform source: | + 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 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", @@ -11335,6 +15914,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#complete-trigger-invocation source: | + from sailpoint.beta.api.triggers_api import TriggersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.complete_invocation import CompleteInvocation + 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" : { @@ -11357,6 +15945,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#create-subscription source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: subscription_post_request = '''{ "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", "httpConfig" : { @@ -11398,6 +15996,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#delete-subscription source: | + 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 @@ -11413,6 +16019,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#list-subscriptions source: | + from sailpoint.beta.api.triggers_api import TriggersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.subscription import Subscription + 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) @@ -11434,6 +16049,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#list-trigger-invocation-status source: | + from sailpoint.beta.api.triggers_api import TriggersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.invocation_status import InvocationStatus + 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) @@ -11455,6 +16079,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#list-triggers source: | + from sailpoint.beta.api.triggers_api import TriggersApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.trigger import Trigger + 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) @@ -11476,6 +16109,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#patch-subscription source: | + 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 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 subscription_patch_request_inner = '''[sailpoint.beta.SubscriptionPatchRequestInner()]''' # List[SubscriptionPatchRequestInner] | try: @@ -11494,6 +16137,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#start-test-trigger-invocation source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: test_invocation = '''{ "input" : { "identityId" : "201327fda1c44704ac01181e963d463c" @@ -11520,6 +16173,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#test-subscription-filter source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: validate_filter_input_dto = '''{ "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", "input" : { @@ -11542,6 +16205,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#update-subscription source: | + 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 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\")]", @@ -11583,6 +16256,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/ui-metadata#get-tenant-ui-metadata source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get a tenant UI metadata @@ -11599,6 +16281,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/ui-metadata#set-tenant-ui-metadata source: | + 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 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", @@ -11620,6 +16312,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/vendor-connector-mappings#create-vendor-connector-mapping source: | + 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 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" : { @@ -11659,6 +16360,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/vendor-connector-mappings#delete-vendor-connector-mapping source: | + 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 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" : { @@ -11698,6 +16409,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/vendor-connector-mappings#get-vendor-connector-mappings source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List Vendor Connector Mappings @@ -11714,6 +16434,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#cancel-workflow-execution source: | + 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 @@ -11729,6 +16457,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#create-workflow source: | + 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 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 @@ -11746,6 +16484,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#delete-workflow source: | + 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 @@ -11761,6 +16507,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow import Workflow + 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 @@ -11778,6 +16533,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution source: | + 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 @@ -11795,6 +16558,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-execution-history source: | + 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 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 @@ -11812,6 +16584,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#get-workflow-executions source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow_execution import WorkflowExecution + 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) @@ -11833,6 +16614,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#list-complete-workflow-library source: | + 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 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: @@ -11851,6 +16641,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-actions source: | + 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 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) @@ -11870,6 +16669,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-operators source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List Workflow Library Operators @@ -11886,6 +16694,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-triggers source: | + 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 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) @@ -11905,6 +16722,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#list-workflows source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.workflow import Workflow + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List Workflows @@ -11921,6 +16747,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#patch-workflow source: | + 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 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 json_patch_operation = '''[{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] | try: @@ -11939,6 +16775,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#post-external-execute-workflow source: | + 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 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: @@ -11957,6 +16803,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#post-workflow-external-trigger source: | + 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 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 @@ -11974,6 +16829,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#test-external-execute-workflow source: | + 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 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: @@ -11992,6 +16857,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#test-workflow source: | + 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 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: @@ -12010,6 +16885,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#update-workflow source: | + 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 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" : { @@ -12065,6 +16950,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/work-items#approve-approval-item source: | + 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 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: @@ -12083,6 +16977,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/work-items#approve-approval-items-in-bulk source: | + 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 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 @@ -12100,6 +17003,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/work-items#complete-work-item source: | + 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 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 body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) try: @@ -12118,6 +17030,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/work-items#forward-work-item source: | + 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 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", @@ -12138,6 +17059,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/work-items#get-completed-work-items source: | + 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 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) @@ -12158,6 +17088,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/work-items#get-count-completed-work-items source: | + 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 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 @@ -12175,6 +17114,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/work-items#get-count-work-items source: | + 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 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 @@ -12192,6 +17140,14 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/work-items#get-work-item source: | + from sailpoint.beta.api.work_items_api import WorkItemsApi + 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 work item. # str | ID of the work item. owner_id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) try: @@ -12210,6 +17166,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/work-items#get-work-items-summary source: | + 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 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 @@ -12227,6 +17192,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/work-items#list-work-items source: | + 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 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) @@ -12247,6 +17221,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/work-items#reject-approval-item source: | + 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 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: @@ -12265,6 +17248,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/work-items#reject-approval-items-in-bulk source: | + 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 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 @@ -12282,6 +17274,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/work-items#submit-account-selection source: | + 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 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: @@ -12300,6 +17301,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/work-reassignment#create-reassignment-configuration source: | + 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 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", @@ -12323,6 +17334,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/work-reassignment#delete-reassignment-configuration source: | + 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 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: @@ -12339,6 +17359,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/work-reassignment#get-evaluate-reassignment-configuration source: | + 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 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) @@ -12358,6 +17388,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/work-reassignment#get-reassignment-config-types source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List Reassignment Config Types @@ -12374,6 +17413,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/work-reassignment#get-reassignment-configuration source: | + 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 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 @@ -12391,6 +17439,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/work-reassignment#get-tenant-config-configuration source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get Tenant-wide Reassignment Configuration settings @@ -12407,6 +17464,15 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/work-reassignment#list-reassignment-configurations source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: limit = 20 # int | Max number of results to return. (optional) (default to 20) # int | Max number of results to return. (optional) (default to 20) 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) try: @@ -12425,6 +17491,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/work-reassignment#put-reassignment-config source: | + 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 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", @@ -12449,6 +17525,16 @@ - lang: Python label: SDK_tools/sdk/python/beta/methods/work-reassignment#put-tenant-configuration source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: tenant_configuration_request = '''{ "configDetails" : { "disabled" : true diff --git a/sailpoint/v2024/docs/Examples/python_code_examples_overlay.yaml b/sailpoint/v2024/docs/Examples/python_code_examples_overlay.yaml index 0048892bb..27153acc0 100644 --- a/sailpoint/v2024/docs/Examples/python_code_examples_overlay.yaml +++ b/sailpoint/v2024/docs/Examples/python_code_examples_overlay.yaml @@ -4,6 +4,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-model-metadata#get-access-model-metadata-attribute source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -22,6 +32,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-model-metadata#get-access-model-metadata-attribute-value source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') @@ -41,6 +61,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-model-metadata#list-access-model-metadata-attribute source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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: @@ -59,6 +89,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-model-metadata#list-access-model-metadata-attribute-value source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -77,6 +117,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-profiles#create-access-profile source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: access_profile = '''{ "owner" : { "name" : "support", @@ -178,6 +227,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-profiles#delete-access-profile source: | + 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 @@ -193,6 +250,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-profiles#delete-access-profiles-in-bulk source: | + 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 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 @@ -213,6 +280,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-profiles#get-access-profile source: | + 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 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 @@ -230,6 +306,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-profiles#get-access-profile-entitlements source: | + from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.entitlement import Entitlement + 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) @@ -252,6 +337,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-profiles#list-access-profiles source: | + 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 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) @@ -276,6 +370,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-profiles#patch-access-profile source: | + 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 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 json_patch_operation = '''[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}]''' # List[JsonPatchOperation] | try: @@ -294,6 +398,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-profiles#update-access-profiles-in-bulk source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') access_profile_bulk_update_request_inner = '''[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]''' # List[AccessProfileBulkUpdateRequestInner] | try: @@ -312,6 +427,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#approve-access-request source: | + 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 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", @@ -338,6 +462,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#forward-access-request source: | + 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 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", @@ -359,6 +492,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#get-access-request-approval-summary source: | + 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 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: @@ -377,6 +519,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#list-access-request-approvers source: | + 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 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) @@ -397,6 +548,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#list-completed-approvals source: | + 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 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) @@ -419,6 +579,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#list-pending-approvals source: | + 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 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) @@ -441,6 +610,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#reject-access-request source: | + 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 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", @@ -467,6 +645,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-request-identity-metrics#get-access-request-identity-metrics source: | + 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. @@ -486,6 +672,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-requests#approve-bulk-access-request source: | + 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 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" ] @@ -506,6 +701,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-requests#cancel-access-request source: | + 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 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." @@ -526,6 +730,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-requests#cancel-access-request-in-bulk source: | + 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 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." @@ -546,6 +759,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-requests#close-access-request source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') close_access_request = '''{ "executionStatus" : "Terminated", @@ -569,6 +792,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-requests#create-access-request source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: access_request = '''{ "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], "clientMetadata" : { @@ -639,6 +872,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-requests#get-access-request-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get Access Request Configuration @@ -655,6 +897,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-requests#list-access-request-status source: | + 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 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) @@ -681,6 +932,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-requests#list-administrators-access-request-status source: | + 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 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) @@ -707,6 +967,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-requests#set-access-request-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: access_request_config = '''{ "requestOnBehalfOfConfig" : { "allowRequestOnBehalfOfEmployeeByManager" : true, @@ -749,6 +1018,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/account-activities#get-account-activity source: | + 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 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 @@ -766,6 +1044,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/account-activities#list-account-activities source: | + 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 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) @@ -790,6 +1077,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/account-aggregations#get-account-aggregation-status source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -808,6 +1105,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#create-account source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: account_attributes_create = '''{ "attributes" : { "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", @@ -834,6 +1141,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#delete-account source: | + 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 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 @@ -851,6 +1167,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#delete-account-async source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -869,6 +1195,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#disable-account source: | + 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 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, @@ -890,6 +1226,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#disable-account-for-identity source: | + 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() + + configuration.experimental = true + + 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: @@ -908,6 +1253,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#disable-accounts-for-identities source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') identities_accounts_bulk_request = '''{ "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] @@ -928,6 +1284,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#enable-account source: | + 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 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, @@ -949,6 +1315,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#enable-account-for-identity source: | + 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() + + configuration.experimental = true + + 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: @@ -967,6 +1342,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#enable-accounts-for-identities source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') identities_accounts_bulk_request = '''{ "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] @@ -987,6 +1373,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#get-account source: | + from sailpoint.v2024.api.accounts_api import AccountsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.account import Account + 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 @@ -1004,6 +1399,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#get-account-entitlements source: | + from sailpoint.v2024.api.accounts_api import AccountsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.entitlement import Entitlement + 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) @@ -1024,6 +1428,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#list-accounts source: | + from sailpoint.v2024.api.accounts_api import AccountsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.account import Account + 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) @@ -1046,6 +1459,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#put-account source: | + 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 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" : { @@ -1072,6 +1495,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#submit-reload-account source: | + 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 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 @@ -1089,6 +1521,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#unlock-account source: | + 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 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, @@ -1111,6 +1553,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#update-account source: | + 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. try: @@ -1129,6 +1579,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/account-usages#get-usages-by-account-id source: | + 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 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) @@ -1150,6 +1609,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/application-discovery#get-discovered-applications source: | + 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 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) @@ -1171,6 +1639,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/application-discovery#get-manual-discover-applications-csv-template source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Download CSV Template for Discovery @@ -1187,6 +1664,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/application-discovery#send-manual-discover-applications-csv-template source: | + 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 @@ -1202,6 +1687,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/approvals#get-approval source: | + from sailpoint.v2024.api.approvals_api import ApprovalsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.approval import Approval + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -1220,6 +1715,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/approvals#get-approvals source: | + from sailpoint.v2024.api.approvals_api import ApprovalsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.approval import Approval + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -1240,6 +1745,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#create-source-app source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') source_app_create_dto = '''{ "name" : "my app", @@ -1267,6 +1783,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#delete-access-profiles-from-source-app-by-bulk source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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] | @@ -1287,6 +1813,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#delete-source-app source: | + from sailpoint.v2024.api.apps_api import AppsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.source_app import SourceApp + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -1305,6 +1841,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#get-source-app source: | + from sailpoint.v2024.api.apps_api import AppsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.source_app import SourceApp + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -1323,6 +1869,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#list-access-profiles-for-source-app source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -1344,6 +1900,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#list-all-source-app source: | + from sailpoint.v2024.api.apps_api import AppsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.source_app import SourceApp + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) 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) @@ -1366,6 +1932,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#list-all-user-apps source: | + from sailpoint.v2024.api.apps_api import AppsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.user_app import UserApp + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -1387,6 +1963,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#list-assigned-source-app source: | + from sailpoint.v2024.api.apps_api import AppsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.source_app import SourceApp + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) 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) @@ -1409,6 +1995,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#list-available-accounts-for-user-app source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -1429,6 +2025,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#list-available-source-apps source: | + from sailpoint.v2024.api.apps_api import AppsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.source_app import SourceApp + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) 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) @@ -1451,6 +2057,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#list-owned-user-apps source: | + from sailpoint.v2024.api.apps_api import AppsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.user_app import UserApp + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) 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) @@ -1472,6 +2088,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#patch-source-app source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') json_patch_operation = '''[{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}]''' # List[JsonPatchOperation] | (optional) @@ -1491,6 +2118,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#patch-user-app source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | (optional) @@ -1510,6 +2148,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#update-source-apps-in-bulk source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') source_app_bulk_update_request = '''{ "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], @@ -1537,6 +2185,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/auth-profile#get-profile-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch. try: @@ -1555,6 +2213,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/auth-profile#get-profile-config-list source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # Get list of Auth Profiles @@ -1572,6 +2240,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/auth-profile#patch-profile-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | @@ -1591,6 +2270,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/auth-users#get-auth-user source: | + 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 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 @@ -1608,6 +2296,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/auth-users#patch-auth-user source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID json_patch_operation = '''[{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. try: @@ -1626,6 +2324,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/branding#create-branding-item source: | + from sailpoint.v2024.api.branding_api import BrandingApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.branding_item import BrandingItem + 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) @@ -1650,6 +2357,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/branding#delete-branding source: | + 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 @@ -1665,6 +2380,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/branding#get-branding source: | + from sailpoint.v2024.api.branding_api import BrandingApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.branding_item import BrandingItem + 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 @@ -1682,6 +2406,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/branding#get-branding-list source: | + from sailpoint.v2024.api.branding_api import BrandingApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.branding_item import BrandingItem + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List of branding items @@ -1698,6 +2431,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/branding#set-branding-item source: | + from sailpoint.v2024.api.branding_api import BrandingApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.branding_item import BrandingItem + 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 @@ -1723,6 +2465,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaign-filters#create-campaign-filter source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: campaign_filter_details = '''{ "owner" : "SailPoint Support", "mode" : "INCLUSION", @@ -1757,6 +2508,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaign-filters#delete-campaign-filters source: | + 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. try: # Deletes Campaign Filters @@ -1772,6 +2531,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaign-filters#get-campaign-filter-by-id source: | + 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 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 @@ -1789,6 +2557,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaign-filters#list-campaign-filters source: | + 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 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) @@ -1808,6 +2585,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaign-filters#update-campaign-filter source: | + 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 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", @@ -1843,6 +2629,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#complete-campaign source: | + 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 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" @@ -1863,6 +2658,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#create-campaign source: | + from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.campaign import Campaign + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: campaign = '''{ "totalCertifications" : 100, "sourcesWithOrphanEntitlements" : [ { @@ -1989,6 +2793,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#create-campaign-template source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: campaign_template = '''{ "ownerRef" : { "name" : "Mister Manager", @@ -2130,6 +2943,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#delete-campaign-template source: | + 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 @@ -2145,6 +2966,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#delete-campaign-template-schedule source: | + 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 @@ -2160,6 +2989,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#delete-campaigns source: | + 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 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. @@ -2179,6 +3017,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-active-campaigns source: | + 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 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) @@ -2201,6 +3048,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign source: | + 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 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: @@ -2219,6 +3075,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign-reports source: | + 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 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 @@ -2236,6 +3101,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign-reports-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get Campaign Reports Configuration @@ -2252,6 +3126,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign-template source: | + 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 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 @@ -2269,6 +3152,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign-template-schedule source: | + from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.schedule import Schedule + 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 @@ -2286,6 +3178,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign-templates source: | + 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 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) @@ -2307,6 +3208,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#move source: | + 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 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" ], @@ -2332,6 +3243,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#patch-campaign-template source: | + 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 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. json_patch_operation = '''[{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) try: @@ -2350,6 +3271,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#set-campaign-reports-config source: | + 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 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. @@ -2369,6 +3299,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#set-campaign-template-schedule source: | + from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.schedule import Schedule + 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" : { @@ -2404,6 +3343,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#start-campaign source: | + 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 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" @@ -2424,6 +3372,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#start-campaign-remediation-scan source: | + 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 @@ -2441,6 +3397,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#start-campaign-report source: | + 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 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: @@ -2459,6 +3424,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#start-generate-campaign-template source: | + 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 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 @@ -2476,6 +3450,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#update-campaign source: | + 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 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. json_patch_operation = '''[{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 try: @@ -2494,6 +3478,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certifications#get-certification-task source: | + from sailpoint.v2024.api.certifications_api import CertificationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.certification_task import CertificationTask + 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 @@ -2511,6 +3504,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certifications#get-identity-certification source: | + 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 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 @@ -2528,6 +3530,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certifications#get-identity-certification-item-permissions source: | + from sailpoint.v2024.api.certifications_api import CertificationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.permission_dto import PermissionDto + 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) @@ -2550,6 +3561,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certifications#get-pending-certification-tasks source: | + from sailpoint.v2024.api.certifications_api import CertificationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.certification_task import CertificationTask + 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) @@ -2571,6 +3591,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certifications#list-certification-reviewers source: | + 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 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) @@ -2593,6 +3622,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certifications#list-identity-access-review-items source: | + 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 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) @@ -2618,6 +3656,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certifications#list-identity-certifications source: | + 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 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) @@ -2640,6 +3687,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certifications#make-identity-decision source: | + 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 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 review_decision = '''[{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. try: @@ -2658,6 +3715,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certifications#reassign-identity-certifications source: | + 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 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", @@ -2686,6 +3753,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certifications#sign-off-identity-certification source: | + 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 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 @@ -2703,6 +3779,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certifications#submit-reassign-certs-async source: | + 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 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", @@ -2731,6 +3817,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-access-summaries source: | + 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 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) @@ -2754,6 +3849,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-decision-summary source: | + 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 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: @@ -2772,6 +3876,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summaries source: | + 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 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) @@ -2794,6 +3907,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summary source: | + 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 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: @@ -2812,6 +3934,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#create-deploy source: | + 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 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. @@ -2831,6 +3963,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#create-object-mapping source: | + 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 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", @@ -2855,6 +3997,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#create-object-mappings source: | + 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 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" : [ { @@ -2887,6 +4039,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#create-uploaded-configuration source: | + 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 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: @@ -2905,6 +4066,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#delete-backup source: | + 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 @@ -2920,6 +4089,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#delete-draft source: | + 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 @@ -2935,6 +4112,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#delete-object-mapping source: | + 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: @@ -2951,6 +4136,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#delete-uploaded-configuration source: | + 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 @@ -2966,6 +4159,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#get-deploy source: | + 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 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 @@ -2983,6 +4185,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#get-object-mappings source: | + 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 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 @@ -3000,6 +4211,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#get-uploaded-configuration source: | + 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 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 @@ -3017,6 +4237,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#list-backups source: | + 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 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 @@ -3034,6 +4263,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#list-deploys source: | + from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.list_deploys200_response import ListDeploys200Response + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List Deploys @@ -3050,6 +4288,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#list-drafts source: | + 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 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 @@ -3067,6 +4314,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#list-uploaded-configurations source: | + 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 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 @@ -3084,6 +4340,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#update-object-mappings source: | + 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 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" : { @@ -3115,6 +4381,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#create-connector-rule source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') connector_rule_create_request = '''{ "sourceCode" : { @@ -3158,6 +4435,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#delete-connector-rule source: | + 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() + + configuration.experimental = true + + 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: @@ -3174,6 +4460,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#get-connector-rule source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -3192,6 +4488,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#get-connector-rule-list source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') limit = 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) @@ -3212,6 +4518,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#put-connector-rule source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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 = '''{ @@ -3257,6 +4574,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#test-connector-rule source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') source_code = '''{ "version" : "1.0", @@ -3278,6 +4606,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#create-custom-connector source: | + 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 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, @@ -3301,6 +4639,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#delete-custom-connector source: | + 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 @@ -3316,6 +4662,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector source: | + from sailpoint.v2024.api.connectors_api import ConnectorsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.connector_detail import ConnectorDetail + 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: @@ -3334,6 +4689,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector-correlation-config source: | + 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 @@ -3351,6 +4714,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector-list source: | + 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 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) @@ -3372,6 +4744,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector-source-config source: | + 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 @@ -3389,6 +4769,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector-source-template source: | + 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 @@ -3406,6 +4794,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector-translations source: | + 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: @@ -3424,6 +4820,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#put-connector-correlation-config source: | + from sailpoint.v2024.api.connectors_api import ConnectorsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.update_detail import UpdateDetail + 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: @@ -3442,6 +4847,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#put-connector-source-config source: | + from sailpoint.v2024.api.connectors_api import ConnectorsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.update_detail import UpdateDetail + 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: @@ -3460,6 +4874,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#put-connector-source-template source: | + from sailpoint.v2024.api.connectors_api import ConnectorsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.update_detail import UpdateDetail + 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: @@ -3478,6 +4901,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#put-connector-translations source: | + from sailpoint.v2024.api.connectors_api import ConnectorsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.update_detail import UpdateDetail + 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: @@ -3496,6 +4928,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#update-connector source: | + 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 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. json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of connector detail update operations try: @@ -3514,6 +4956,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#create-form-definition source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') body = '''{ "owner" : { @@ -3642,6 +5095,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#create-form-definition-dynamic-schema source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') body = '''{ "description" : "A description", @@ -3668,6 +5132,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#create-form-definition-file-request source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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 @@ -3687,6 +5161,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#create-form-instance source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') body = '''{ "formInput" : { @@ -3725,6 +5210,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#delete-form-definition source: | + 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() + + configuration.experimental = true + + 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: @@ -3743,6 +5237,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#export-form-definitions-by-tenant source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -3764,6 +5268,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#get-file-from-s3 source: | + 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() + + configuration.experimental = true + + 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') @@ -3783,6 +5296,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#get-form-definition-by-key source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -3801,6 +5324,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#get-form-instance-by-key source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -3819,6 +5352,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#get-form-instance-file source: | + 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() + + configuration.experimental = true + + 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') @@ -3838,6 +5380,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#import-form-definitions source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) try: @@ -3856,6 +5409,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#patch-form-definition source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -3875,6 +5438,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#patch-form-instance source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -3894,6 +5467,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#search-form-definitions-by-tenant source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -3915,6 +5498,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#search-form-element-data-by-element-id source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') @@ -3937,6 +5530,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#search-form-instances-by-tenant source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # List form instances by tenant. @@ -3954,6 +5557,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#search-pre-defined-select-options source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # List predefined select options. @@ -3971,6 +5584,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#show-preview-data-source source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -4003,6 +5627,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-password-instructions#create-custom-password-instructions source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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.", @@ -4025,6 +5659,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-password-instructions#delete-custom-password-instructions source: | + 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() + + configuration.experimental = true + + 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) @@ -4042,6 +5685,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-password-instructions#get-custom-password-instructions source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -4061,6 +5714,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/data-segmentation#create-data-segment source: | + 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 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 @@ -4078,6 +5740,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/data-segmentation#delete-data-segment source: | + 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() + + configuration.experimental = true + + 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) @@ -4095,6 +5766,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/data-segmentation#get-data-segment source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -4113,6 +5794,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/data-segmentation#get-data-segment-identity-membership source: | + 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() + + configuration.experimental = true + + 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: @@ -4131,6 +5821,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/data-segmentation#get-data-segmentation-enabled-for-user source: | + 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() + + configuration.experimental = true + + 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: @@ -4149,6 +5848,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/data-segmentation#list-data-segments source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -4173,6 +5882,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/data-segmentation#patch-data-segment source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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 @@ -4192,6 +5911,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/data-segmentation#publish-data-segment source: | + 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() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') request_body = '''['request_body_example']''' # List[str] | A list of segment ids that you wish to publish publish_all = True # bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to True) # bool | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to True) @@ -4209,6 +5937,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/dimensions#create-dimension source: | + from sailpoint.v2024.api.dimensions_api import DimensionsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.dimension import Dimension + 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" : { @@ -4313,6 +6050,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/dimensions#delete-bulk-dimensions source: | + 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 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" ] @@ -4333,6 +6080,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/dimensions#delete-dimension source: | + 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: @@ -4349,6 +6104,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/dimensions#get-dimension source: | + from sailpoint.v2024.api.dimensions_api import DimensionsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.dimension import Dimension + 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: @@ -4367,6 +6131,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/dimensions#get-dimension-entitlements source: | + from sailpoint.v2024.api.dimensions_api import DimensionsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.entitlement import Entitlement + 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) @@ -4390,6 +6163,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/dimensions#list-dimension-access-profiles source: | + from sailpoint.v2024.api.dimensions_api import DimensionsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.access_profile import AccessProfile + 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) @@ -4413,6 +6195,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/dimensions#list-dimensions source: | + from sailpoint.v2024.api.dimensions_api import DimensionsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.dimension import Dimension + 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) @@ -4436,6 +6227,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/dimensions#patch-dimension source: | + 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 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 json_patch_operation = '''[{op=replace, path=/description, value=Test Description}, {op=replace, path=/name, value=new name}]''' # List[JsonPatchOperation] | @@ -4455,6 +6256,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#create-access-model-metadata-for-entitlement source: | + from sailpoint.v2024.api.entitlements_api import EntitlementsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.entitlement import Entitlement + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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. @@ -4475,6 +6286,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#delete-access-model-metadata-from-entitlement source: | + 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() + + configuration.experimental = true + + 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. @@ -4493,6 +6313,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#get-entitlement source: | + from sailpoint.v2024.api.entitlements_api import EntitlementsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.entitlement import Entitlement + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -4511,6 +6341,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#get-entitlement-request-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -4529,6 +6369,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#import-entitlements-by-source source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -4548,6 +6398,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#list-entitlement-children source: | + from sailpoint.v2024.api.entitlements_api import EntitlementsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.entitlement import Entitlement + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -4571,6 +6431,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#list-entitlement-parents source: | + from sailpoint.v2024.api.entitlements_api import EntitlementsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.entitlement import Entitlement + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -4594,6 +6464,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#list-entitlements source: | + from sailpoint.v2024.api.entitlements_api import EntitlementsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.entitlement import Entitlement + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -4620,6 +6500,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#patch-entitlement source: | + from sailpoint.v2024.api.entitlements_api import EntitlementsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.entitlement import Entitlement + from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}]''' # List[JsonPatchOperation] | (optional) @@ -4639,6 +6530,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#put-entitlement-request-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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 = '''{ @@ -4663,6 +6564,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#reset-source-entitlements source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -4681,6 +6592,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#update-entitlements-in-bulk source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') entitlement_bulk_update_request = '''{ "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], @@ -4708,6 +6629,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#create-auth-org-network-config source: | + 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 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, @@ -4729,6 +6659,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#get-auth-org-network-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get security network configuration. @@ -4745,6 +6684,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#patch-auth-org-network-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: json_patch_operation = '''[{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. try: # Update security network configuration. @@ -4762,6 +6711,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/governance-groups#create-workgroup source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') workgroup_dto = '''{ "owner" : { @@ -4795,6 +6754,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/governance-groups#delete-workgroup source: | + 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() + + configuration.experimental = true + + 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: @@ -4811,6 +6779,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/governance-groups#delete-workgroup-members source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') identity_preview_response_identity = '''[sailpoint.v2024.IdentityPreviewResponseIdentity()]''' # List[IdentityPreviewResponseIdentity] | List of identities to be removed from a Governance Group members list. @@ -4830,6 +6809,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/governance-groups#delete-workgroups-in-bulk source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') workgroup_bulk_delete_request = '''{ "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] @@ -4850,6 +6840,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/governance-groups#get-workgroup source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -4868,6 +6868,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/governance-groups#list-connections source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -4890,6 +6900,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/governance-groups#list-workgroup-members source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -4912,6 +6932,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/governance-groups#list-workgroups source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -4934,6 +6964,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/governance-groups#patch-workgroup source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') json_patch_operation = '''[{op=replace, path=/description, value=Governance Group new description.}]''' # List[JsonPatchOperation] | (optional) @@ -4953,6 +6994,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/governance-groups#update-workgroup-members source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') identity_preview_response_identity = '''[sailpoint.v2024.IdentityPreviewResponseIdentity()]''' # List[IdentityPreviewResponseIdentity] | List of identities to be added to a Governance Group members list. @@ -4972,6 +7024,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') access_request_recommendation_action_item_dto = '''{ "access" : { @@ -4996,6 +7059,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') access_request_recommendation_action_item_dto = '''{ "access" : { @@ -5020,6 +7094,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') access_request_recommendation_action_item_dto = '''{ "access" : { @@ -5044,6 +7129,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') access_request_recommendation_action_item_dto = '''[sailpoint.v2024.AccessRequestRecommendationActionItemDto()]''' # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. try: @@ -5062,6 +7158,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -5086,6 +7192,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-config source: | + 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_config_dto import AccessRequestRecommendationConfigDto + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # Get Access Request Recommendations config @@ -5103,6 +7219,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) 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) @@ -5125,6 +7251,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) 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) @@ -5147,6 +7283,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) 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) @@ -5169,6 +7315,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#set-access-request-recommendations-config source: | + 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_config_dto import AccessRequestRecommendationConfigDto + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') access_request_recommendation_config_dto = '''{ "scoreThreshold" : 0.5, @@ -5194,6 +7350,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-common-access#create-common-access source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') common_access_item_request = '''{ "access" : { @@ -5222,6 +7389,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-common-access#get-common-access source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -5244,6 +7421,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-common-access#update-common-access-status-in-bulk source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') common_access_id_status = '''[sailpoint.v2024.CommonAccessIDStatus()]''' # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access try: @@ -5262,6 +7449,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-outliers#export-outliers-zip source: | + from sailpoint.v2024.api.iai_outliers_api import IAIOutliersApi + from sailpoint.v2024.api_client import ApiClient + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') type = 'LOW_SIMILARITY' # str | Type of the identity outliers snapshot to filter on (optional) # str | Type of the identity outliers snapshot to filter on (optional) try: @@ -5280,6 +7476,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-identity-outlier-snapshots source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) 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) @@ -5302,6 +7508,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-identity-outliers source: | + from sailpoint.v2024.api.iai_outliers_api import IAIOutliersApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.outlier import Outlier + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) 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) @@ -5325,6 +7541,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-latest-identity-outlier-snapshots source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') type = 'LOW_SIMILARITY' # str | Type of the identity outliers snapshot to filter on (optional) # str | Type of the identity outliers snapshot to filter on (optional) try: @@ -5343,6 +7569,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-outlier-contributing-feature-summary source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: outlier_feature_id = '04654b66-7561-4090-94f9-abee0722a1af' # str | Contributing feature id # str | Contributing feature id x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: @@ -5361,6 +7597,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-peer-group-outliers-contributing-features source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) @@ -5384,6 +7630,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-outliers#ignore-identity-outliers source: | + from sailpoint.v2024.api.iai_outliers_api import IAIOutliersApi + from sailpoint.v2024.api_client import ApiClient + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') request_body = '''['request_body_example']''' # List[str] | try: @@ -5400,6 +7655,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-outliers#list-outliers-contributing-feature-access-items source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id contributing_feature_name = 'entitlement_count' # str | The name of contributing feature # str | The name of contributing feature x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -5424,6 +7689,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-outliers#un-ignore-identity-outliers source: | + from sailpoint.v2024.api.iai_outliers_api import IAIOutliersApi + from sailpoint.v2024.api_client import ApiClient + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') request_body = '''['request_body_example']''' # List[str] | try: @@ -5440,6 +7714,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-peer-group-strategies#get-peer-group-outliers source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -5461,6 +7745,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-recommendations#get-recommendations source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') recommendation_request_dto = '''{ "prescribeMode" : false, @@ -5497,6 +7792,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-recommendations#get-recommendations-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # Get certification recommendation config values @@ -5514,6 +7819,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-recommendations#update-recommendations-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') recommendation_config_dto = '''{ "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], @@ -5537,6 +7852,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#create-potential-role-provision-request source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') @@ -5565,6 +7891,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#create-role-mining-sessions source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') role_mining_session_dto = '''{ "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", @@ -5614,6 +7951,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#download-role-mining-potential-role-zip source: | + 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() + + configuration.experimental = true + + 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 @@ -5634,6 +7980,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#export-role-mining-potential-role source: | + 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() + + configuration.experimental = true + + 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') @@ -5653,6 +8008,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#export-role-mining-potential-role-async source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') @@ -5676,6 +8042,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#export-role-mining-potential-role-status source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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 @@ -5696,6 +8072,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-all-potential-role-summaries source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -5718,6 +8104,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-entitlement-distribution-potential-role source: | + 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() + + configuration.experimental = true + + 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') @@ -5738,6 +8133,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-entitlements-potential-role source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') @@ -5763,6 +8168,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-excluded-entitlements-potential-role source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') @@ -5787,6 +8202,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-identities-potential-role source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') @@ -5811,6 +8236,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') @@ -5830,6 +8265,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role-applications source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') @@ -5853,6 +8298,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role-entitlements source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') @@ -5876,6 +8331,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role-source-identity-usage source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') @@ -5899,6 +8364,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role-summaries source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -5922,6 +8397,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-role-mining-potential-role source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -5940,6 +8425,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-role-mining-session source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -5958,6 +8453,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-role-mining-session-status source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -5976,6 +8481,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-role-mining-sessions source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -5998,6 +8513,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-saved-potential-roles source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -6019,6 +8544,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#patch-potential-role source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') @@ -6039,6 +8574,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#patch-potential-role-0 source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') @@ -6059,6 +8604,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#patch-role-mining-session source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') json_patch_operation = '''[{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. @@ -6078,6 +8633,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#update-entitlements-potential-role source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') @@ -6101,6 +8667,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/icons#delete-icon source: | + 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() + + configuration.experimental = true + + 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') @@ -6118,6 +8693,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/icons#set-icon source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') @@ -6138,6 +8723,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identities#delete-identity source: | + 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() + + configuration.experimental = true + + 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: @@ -6154,6 +8748,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identities#get-identity source: | + from sailpoint.v2024.api.identities_api import IdentitiesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.identity import Identity + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -6172,6 +8776,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identities#get-identity-ownership-details source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -6190,6 +8804,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identities#get-role-assignment source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') @@ -6209,6 +8833,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identities#get-role-assignments source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -6229,6 +8863,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identities#list-identities source: | + from sailpoint.v2024.api.identities_api import IdentitiesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.identity import Identity + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -6252,6 +8896,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identities#reset-identity source: | + 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() + + configuration.experimental = true + + 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: @@ -6268,6 +8921,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identities#send-identity-verification-account-token source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID send_account_verification_request = '''{ @@ -6288,6 +8951,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identities#start-identities-invite source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') invite_identities_request = '''{ "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], @@ -6309,6 +8983,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identities#start-identity-processing source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') process_identities_request = '''{ "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] @@ -6329,6 +9014,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identities#synchronize-attributes-for-identity source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -6347,6 +9042,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-attributes#create-identity-attribute source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') identity_attribute = '''{ "standard" : false, @@ -6386,6 +9091,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-attributes#delete-identity-attribute source: | + 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() + + configuration.experimental = true + + 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: @@ -6402,6 +9116,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-attributes#delete-identity-attributes-in-bulk source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') identity_attribute_names = '''{ "ids" : [ "name", "displayName" ] @@ -6420,6 +9144,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-attributes#get-identity-attribute source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -6438,6 +9172,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-attributes#list-identity-attributes source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -6459,6 +9203,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-attributes#put-identity-attribute source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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 = '''{ @@ -6499,6 +9253,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-history#compare-identity-snapshots source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -6523,6 +9287,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-history#compare-identity-snapshots-access-type source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') @@ -6548,6 +9322,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-history#get-historical-identity source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -6566,6 +9350,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-history#get-historical-identity-events source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -6590,6 +9384,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-history#get-identity-snapshot source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') @@ -6609,6 +9413,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-history#get-identity-snapshot-summary source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -6633,6 +9447,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-history#get-identity-start-date source: | + 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() + + configuration.experimental = true + + 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: @@ -6651,6 +9474,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-history#list-historical-identities source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -6673,6 +9506,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-history#list-identity-access-items source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -6695,6 +9538,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-history#list-identity-snapshot-access-items source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') @@ -6715,6 +9568,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-history#list-identity-snapshots source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -6738,6 +9601,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-profiles#create-identity-profile source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: identity_profile = '''{ "owner" : { "name" : "William Wilson", @@ -6803,6 +9675,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-profiles#delete-identity-profile source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. try: # Delete Identity Profile @@ -6820,6 +9701,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-profiles#delete-identity-profiles source: | + 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 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. try: # Delete Identity Profiles @@ -6837,6 +9727,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-profiles#export-identity-profiles source: | + 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 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) @@ -6858,6 +9757,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-profiles#generate-identity-preview source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') identity_preview_request = '''{ "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", @@ -6902,6 +9812,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-profiles#get-default-identity-attribute-config source: | + 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 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 @@ -6919,6 +9838,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-profiles#get-identity-profile source: | + 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 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. try: # Get Identity Profile @@ -6936,6 +9864,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-profiles#import-identity-profiles source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: identity_profile_exported_object = '''[sailpoint.v2024.IdentityProfileExportedObject()]''' # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. try: # Import Identity Profiles @@ -6953,6 +9891,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-profiles#list-identity-profiles source: | + 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 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) @@ -6974,6 +9921,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-profiles#sync-identity-profile source: | + 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 @@ -6991,6 +9946,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-profiles#update-identity-profile source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. json_patch_operation = '''[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}]''' # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. try: @@ -7009,6 +9974,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#create-lifecycle-state source: | + 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 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" ], @@ -7051,6 +10025,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#delete-lifecycle-state source: | + 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 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: @@ -7069,6 +10052,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#get-lifecycle-state source: | + 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 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: @@ -7087,6 +10079,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#get-lifecycle-states source: | + 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 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) @@ -7108,6 +10109,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#set-lifecycle-state source: | + 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 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: @@ -7126,6 +10137,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#update-lifecycle-states source: | + 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 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. json_patch_operation = '''[{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 @@ -7145,6 +10166,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/machine-accounts#get-machine-account source: | + from sailpoint.v2024.api.machine_accounts_api import MachineAccountsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.machine_account import MachineAccount + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine 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: @@ -7163,6 +10194,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/machine-accounts#list-machine-accounts source: | + from sailpoint.v2024.api.machine_accounts_api import MachineAccountsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.machine_account import MachineAccount + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) 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) @@ -7185,6 +10226,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/machine-accounts#update-machine-account source: | + from sailpoint.v2024.api.machine_accounts_api import MachineAccountsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.machine_account import MachineAccount + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine 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') request_body = '''{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. @@ -7204,6 +10255,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/machine-identities#create-machine-identity source: | + from sailpoint.v2024.api.machine_identities_api import MachineIdentitiesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.machine_identity import MachineIdentity + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') machine_identity = '''{ "created" : "2015-05-28T14:07:17Z", @@ -7231,6 +10292,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/machine-identities#delete-machine-identity source: | + from sailpoint.v2024.api.machine_identities_api import MachineIdentitiesApi + from sailpoint.v2024.api_client import ApiClient + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine 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: @@ -7247,6 +10317,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/machine-identities#get-machine-identity source: | + from sailpoint.v2024.api.machine_identities_api import MachineIdentitiesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.machine_identity import MachineIdentity + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine 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: @@ -7265,6 +10345,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/machine-identities#list-machine-identities source: | + from sailpoint.v2024.api.machine_identities_api import MachineIdentitiesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.machine_identity import MachineIdentity + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') sorters = 'businessApplication' # 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: **businessApplication, 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: **businessApplication, name** (optional) 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) @@ -7286,6 +10376,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/machine-identities#update-machine-identity source: | + from sailpoint.v2024.api.machine_identities_api import MachineIdentitiesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.machine_identity import MachineIdentity + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID. # str | Machine 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') request_body = '''{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. @@ -7305,6 +10405,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clients#create-managed-client source: | + 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 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", @@ -7327,6 +10437,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clients#delete-managed-client source: | + 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 @@ -7342,6 +10460,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clients#get-managed-client source: | + 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 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 @@ -7359,6 +10486,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clients#get-managed-client-status source: | + 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 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: @@ -7377,6 +10514,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clients#get-managed-clients source: | + 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 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) @@ -7397,6 +10543,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clients#update-managed-client source: | + 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 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. json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. try: @@ -7415,6 +10571,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clusters#create-managed-cluster source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: managed_cluster_request = '''{ "configuration" : { "clusterExternalId" : "externalId", @@ -7440,6 +10606,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clusters#delete-managed-cluster source: | + 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: @@ -7456,6 +10630,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clusters#get-client-log-configuration source: | + 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 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 @@ -7473,6 +10656,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clusters#get-managed-cluster source: | + 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 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 @@ -7490,6 +10682,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clusters#get-managed-clusters source: | + 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 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) @@ -7510,6 +10711,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clusters#put-client-log-configuration source: | + 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 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: @@ -7528,6 +10739,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clusters#update-managed-cluster source: | + 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 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. json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. try: @@ -7546,6 +10767,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-duo-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Configuration of Duo MFA method @@ -7562,6 +10792,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-kba-config source: | + 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 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 @@ -7579,6 +10818,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-okta-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Configuration of Okta MFA method @@ -7595,6 +10843,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-duo-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: mfa_duo_config = '''{ "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", "host" : "example.com", @@ -7622,6 +10879,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfa-okta-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: mfa_okta_config = '''{ "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", "host" : "example.com", @@ -7645,6 +10911,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#set-mfakba-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | try: # Set MFA KBA configuration @@ -7662,6 +10938,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#test-mfa-config source: | + 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 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 @@ -7679,6 +10964,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#approve-non-employee-request source: | + 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 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" @@ -7699,6 +10994,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#create-non-employee-record source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: non_employee_request_body = '''{ "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", @@ -7729,6 +11034,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#create-non-employee-request source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: non_employee_request_body = '''{ "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", @@ -7759,6 +11074,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#create-non-employee-source source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: non_employee_source_request_body = '''{ "owner" : { "id" : "2c91808570313110017040b06f344ec9" @@ -7801,6 +11126,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes source: | + 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 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", @@ -7826,6 +11161,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-record source: | + 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 @@ -7841,6 +11184,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk source: | + 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 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 @@ -7856,6 +11208,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-request source: | + 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 @@ -7871,6 +11231,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute source: | + 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: @@ -7887,6 +11255,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-source source: | + 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 @@ -7902,6 +11278,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes source: | + 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 @@ -7917,6 +11301,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#export-non-employee-records source: | + 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 @@ -7932,6 +11324,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template source: | + 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 @@ -7947,6 +11347,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-approval source: | + 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 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: @@ -7965,6 +11374,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-approval-summary source: | + 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 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 @@ -7982,6 +11400,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status source: | + 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 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 @@ -7999,6 +11426,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-record source: | + 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 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 @@ -8016,6 +11452,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-request source: | + 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 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 @@ -8033,6 +11478,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-request-summary source: | + 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 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 @@ -8050,6 +11504,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute source: | + 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 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: @@ -8068,6 +11531,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-source source: | + 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 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 @@ -8085,6 +11557,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes source: | + 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 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 @@ -8102,6 +11583,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk source: | + 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 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: @@ -8120,6 +11610,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#list-non-employee-approvals source: | + 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 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) @@ -8142,6 +11641,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#list-non-employee-records source: | + 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 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) @@ -8163,6 +11671,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#list-non-employee-requests source: | + 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 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) @@ -8185,6 +11702,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#list-non-employee-sources source: | + 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 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) @@ -8207,6 +11733,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#patch-non-employee-record source: | + 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 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) json_patch_operation = '''[{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. try: @@ -8225,6 +11761,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute source: | + 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 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 json_patch_operation = '''[{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'. @@ -8244,6 +11790,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#patch-non-employee-source source: | + 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 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 json_patch_operation = '''[{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. try: @@ -8262,6 +11818,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#reject-non-employee-request source: | + 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 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" @@ -8282,6 +11848,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#update-non-employee-record source: | + 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 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", @@ -8313,6 +11889,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#create-domain-dkim source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') domain_address = '''{ "domain" : "sailpoint.com" @@ -8333,6 +11920,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#create-notification-template source: | + from sailpoint.v2024.api.notifications_api import NotificationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.template_dto import TemplateDto + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') template_dto = '''{ "slackTemplate" : "slackTemplate", @@ -8368,6 +11965,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#create-verified-from-address source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') email_status_dto = '''{ "isVerifiedByDomain" : false, @@ -8391,6 +11998,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#delete-notification-templates-in-bulk source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') template_bulk_delete_dto = '''[sailpoint.v2024.TemplateBulkDeleteDto()]''' # List[TemplateBulkDeleteDto] | try: @@ -8407,6 +12024,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#delete-verified-from-address source: | + 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() + + configuration.experimental = true + + 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: @@ -8423,6 +12049,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#get-dkim-attributes source: | + from sailpoint.v2024.api.notifications_api import NotificationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.dkim_attributes import DkimAttributes + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # Get DKIM Attributes @@ -8440,6 +12076,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#get-mail-from-attributes source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -8458,6 +12104,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#get-notification-template source: | + from sailpoint.v2024.api.notifications_api import NotificationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.template_dto import TemplateDto + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -8476,6 +12132,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#get-notifications-template-context source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # Get Notification Template Context @@ -8493,6 +12159,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#list-from-addresses source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) 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) @@ -8515,6 +12191,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#list-notification-preferences source: | + from sailpoint.v2024.api.notifications_api import NotificationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.preferences_dto import PreferencesDto + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # List Notification Preferences for tenant. @@ -8532,6 +12218,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#list-notification-template-defaults source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) 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) @@ -8552,6 +12248,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#list-notification-templates source: | + from sailpoint.v2024.api.notifications_api import NotificationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.template_dto import TemplateDto + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) 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) @@ -8572,6 +12278,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#put-mail-from-attributes source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') mail_from_attributes_dto = '''{ "identity" : "BobSmith@sailpoint.com", @@ -8593,6 +12310,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#send-test-notification source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') send_test_notification_request_dto = '''{ "context" : "{}", @@ -8613,6 +12340,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/o-auth-clients#create-oauth-client source: | + 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 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", @@ -8646,6 +12383,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/o-auth-clients#delete-oauth-client source: | + 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 @@ -8661,6 +12406,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/o-auth-clients#get-oauth-client source: | + 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 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 @@ -8678,6 +12432,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/o-auth-clients#list-oauth-clients source: | + 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 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 @@ -8695,6 +12458,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/o-auth-clients#patch-oauth-client source: | + 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 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 json_patch_operation = '''[{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 try: @@ -8713,6 +12486,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/org-config#get-org-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # Get Org Config Settings @@ -8730,6 +12513,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/org-config#get-valid-time-zones source: | + 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() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') limit = 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) @@ -8750,6 +12542,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/org-config#patch-org-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') json_patch_operation = '''[{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. try: @@ -8768,6 +12571,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-configuration#create-password-org-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: password_org_config = '''{ "digitTokenLength" : 9, "digitTokenEnabled" : true, @@ -8790,6 +12602,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-configuration#get-password-org-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get Password Org Config @@ -8806,6 +12627,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-configuration#put-password-org-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: password_org_config = '''{ "digitTokenLength" : 9, "digitTokenEnabled" : true, @@ -8828,6 +12658,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-dictionary#get-password-dictionary source: | + 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 @@ -8844,6 +12682,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-dictionary#put-password-dictionary source: | + 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 @@ -8859,6 +12705,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-management#create-digit-token source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') password_digit_token_reset = '''{ "durationMinutes" : 5, @@ -8881,6 +12738,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-management#get-password-change-status source: | + 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 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 @@ -8898,6 +12764,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-management#query-password-info source: | + 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 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" @@ -8918,6 +12794,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-management#set-password source: | + 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 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", @@ -8941,6 +12827,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-policies#create-password-policy source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: password_policy_v3_dto = '''{ "validateAgainstAccountName" : true, "minLength" : 8, @@ -8990,6 +12885,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-policies#delete-password-policy source: | + 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 @@ -9005,6 +12908,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-policies#get-password-policy-by-id source: | + 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 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 @@ -9022,6 +12934,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-policies#list-password-policies source: | + 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 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) @@ -9041,6 +12962,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-policies#set-password-policy source: | + 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 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, @@ -9091,6 +13021,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-sync-groups#create-password-sync-group source: | + 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 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", @@ -9115,6 +13054,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-sync-groups#delete-password-sync-group source: | + 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 @@ -9130,6 +13077,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-sync-groups#get-password-sync-group source: | + 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 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 @@ -9147,6 +13103,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-sync-groups#get-password-sync-groups source: | + 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 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) @@ -9166,6 +13131,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-sync-groups#update-password-sync-group source: | + 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 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", @@ -9191,6 +13165,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/personal-access-tokens#create-personal-access-token source: | + 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 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, @@ -9212,6 +13196,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/personal-access-tokens#delete-personal-access-token source: | + 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 @@ -9227,6 +13219,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/personal-access-tokens#list-personal-access-tokens source: | + 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 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: @@ -9245,6 +13246,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/personal-access-tokens#patch-personal-access-token source: | + 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 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 json_patch_operation = '''[{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 try: @@ -9263,6 +13274,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/public-identities#get-public-identities source: | + 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 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) @@ -9285,6 +13305,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/public-identities-config#get-public-identity-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get the Public Identities Configuration @@ -9301,6 +13330,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/public-identities-config#update-public-identity-config source: | + 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 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" : [ { @@ -9332,6 +13370,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/reports-data-extraction#cancel-report source: | + 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 @@ -9347,6 +13393,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/reports-data-extraction#get-report source: | + 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) @@ -9367,6 +13421,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/reports-data-extraction#get-report-result source: | + 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 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: @@ -9385,6 +13448,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/reports-data-extraction#start-report source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: report_details = '''{ "reportType" : "ACCOUNTS", "arguments" : { @@ -9408,6 +13481,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/requestable-objects#list-requestable-objects source: | + 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 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) term = 'Finance Role' # str | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) # str | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) @@ -9433,6 +13517,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/role-insights#create-role-insight-requests source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # Generate insights for roles @@ -9450,6 +13544,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/role-insights#download-role-insights-entitlements-changes source: | + 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() + + configuration.experimental = true + + 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) @@ -9470,6 +13573,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/role-insights#get-entitlement-changes-identities source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') @@ -9495,6 +13608,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insight source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -9513,6 +13636,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -9535,6 +13668,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights-current-entitlements source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -9554,6 +13697,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights-entitlements-changes source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -9574,6 +13727,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights-requests source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -9592,6 +13755,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights-summary source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # Get role insights summary information @@ -9609,6 +13782,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#create-role source: | + from sailpoint.v2024.api.roles_api import RolesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.role import Role + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: role = '''{ "owner" : { "name" : "support", @@ -9783,6 +13965,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#delete-bulk-roles source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: role_bulk_delete_request = '''{ "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] }''' # RoleBulkDeleteRequest | @@ -9802,6 +13994,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#delete-metadata-from-role-by-key-and-value source: | + 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. @@ -9819,6 +14019,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#delete-role source: | + 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 @@ -9834,6 +14042,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#get-bulk-update-status source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get Bulk-Update Statuses @@ -9850,6 +14067,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#get-bulk-update-status-by-id source: | + 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 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 @@ -9867,6 +14093,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#get-role source: | + from sailpoint.v2024.api.roles_api import RolesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.role import Role + 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 @@ -9884,6 +14119,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#get-role-assigned-identities source: | + from sailpoint.v2024.api.roles_api import RolesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.role_identity import RoleIdentity + 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) @@ -9906,6 +14150,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#get-role-entitlements source: | + from sailpoint.v2024.api.roles_api import RolesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.entitlement import Entitlement + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -9929,6 +14183,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#list-roles source: | + from sailpoint.v2024.api.roles_api import RolesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.role import Role + 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) @@ -9953,6 +14216,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#patch-role source: | + 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 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 json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]''' # List[JsonPatchOperation] | try: @@ -9971,6 +14244,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#search-roles-by-filter source: | + 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 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) @@ -10001,6 +14284,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#update-attribute-key-and-value-to-role source: | + from sailpoint.v2024.api.roles_api import RolesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.role import Role + 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. @@ -10020,6 +14312,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#update-roles-metadata-by-filter source: | + 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 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", @@ -10045,6 +14347,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#update-roles-metadata-by-ids source: | + 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 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" : [ { @@ -10070,6 +14382,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#update-roles-metadata-by-query source: | + 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 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\"" : { @@ -10110,6 +14432,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/saved-search#create-saved-search source: | + 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 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 @@ -10127,6 +14459,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/saved-search#delete-saved-search source: | + 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 @@ -10142,6 +14482,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/saved-search#execute-saved-search source: | + 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 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" : "", @@ -10168,6 +14517,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/saved-search#get-saved-search source: | + 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 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 @@ -10185,6 +14543,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/saved-search#list-saved-searches source: | + 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 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) @@ -10205,6 +14572,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/saved-search#put-saved-search source: | + 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 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" : { @@ -10267,6 +14643,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/scheduled-search#create-scheduled-search source: | + 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 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 @@ -10284,6 +14670,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/scheduled-search#delete-scheduled-search source: | + 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 @@ -10299,6 +14693,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/scheduled-search#get-scheduled-search source: | + 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 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 @@ -10316,6 +14719,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/scheduled-search#list-scheduled-search source: | + 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 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) @@ -10336,6 +14748,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/scheduled-search#unsubscribe-scheduled-search source: | + 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 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", @@ -10355,6 +14776,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/scheduled-search#update-scheduled-search source: | + 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 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" : { @@ -10463,6 +14893,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/search#search-aggregate source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: search = '''{ "queryDsl" : { "match" : { @@ -10599,6 +15039,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/search#search-count source: | + from sailpoint.v2024.api.search_api import SearchApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.search import Search + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: search = '''{ "queryDsl" : { "match" : { @@ -10730,6 +15179,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/search#search-get source: | + 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 = 'identities' # 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: @@ -10748,6 +15205,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/search#search-post source: | + from sailpoint.v2024.api.search_api import SearchApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.search import Search + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: search = '''{ "queryDsl" : { "match" : { @@ -10884,6 +15350,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/search-attribute-configuration#create-search-attribute-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') search_attribute_config = '''{ "displayName" : "New Mail Attribute", @@ -10909,6 +15385,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/search-attribute-configuration#delete-search-attribute-config source: | + 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() + + configuration.experimental = true + + 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. x_sail_point_experimental = 'true' # 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: @@ -10925,6 +15410,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/search-attribute-configuration#get-search-attribute-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # List Extended Search Attributes @@ -10942,6 +15437,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/search-attribute-configuration#get-single-search-attribute-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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. x_sail_point_experimental = 'true' # 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: @@ -10960,6 +15465,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/search-attribute-configuration#patch-search-attribute-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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. x_sail_point_experimental = 'true' # 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_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | @@ -10979,6 +15495,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/segments#create-segment source: | + from sailpoint.v2024.api.segments_api import SegmentsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.segment import Segment + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: segment = '''{ "owner" : { "name" : "support", @@ -11019,6 +15544,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/segments#delete-segment source: | + 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 @@ -11034,6 +15567,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/segments#get-segment source: | + from sailpoint.v2024.api.segments_api import SegmentsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.segment import Segment + 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 @@ -11051,6 +15593,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/segments#list-segments source: | + from sailpoint.v2024.api.segments_api import SegmentsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.segment import Segment + 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) @@ -11070,6 +15621,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/segments#patch-segment source: | + from sailpoint.v2024.api.segments_api import SegmentsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.segment import Segment + 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 try: @@ -11088,6 +15648,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#create-service-desk-integration source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: service_desk_integration_dto = '''{ "ownerRef" : "", "cluster" : "xyzzy999", @@ -11138,6 +15707,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#delete-service-desk-integration source: | + 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 @@ -11153,6 +15730,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-service-desk-integration source: | + 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 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 @@ -11170,6 +15756,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-service-desk-integration-template source: | + 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 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 @@ -11187,6 +15782,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-service-desk-integration-types source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List Service Desk integration types @@ -11203,6 +15807,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-service-desk-integrations source: | + 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 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) @@ -11224,6 +15837,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-status-check-details source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get the time check configuration @@ -11240,6 +15862,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#patch-service-desk-integration source: | + 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 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: @@ -11258,6 +15890,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#put-service-desk-integration source: | + 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 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" : "", @@ -11309,6 +15950,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#update-status-check-details source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: queued_check_config_details = '''{ "provisioningStatusCheckIntervalMinutes" : "30", "provisioningMaxStatusCheckDays" : "2" @@ -11329,6 +15979,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sim-integrations#create-sim-integration source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') sim_integration_details = '''{ "cluster" : "xyzzy999", @@ -11364,6 +16025,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sim-integrations#delete-sim-integration source: | + 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() + + configuration.experimental = true + + 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: @@ -11380,6 +16050,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integration source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -11398,6 +16078,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integrations source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # List the existing SIM integrations. @@ -11415,6 +16105,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-before-provisioning-rule source: | + 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_dto import ServiceDeskIntegrationDto + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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 = '''{ @@ -11444,6 +16145,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-sim-attributes source: | + 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_dto import ServiceDeskIntegrationDto + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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 = '''{ @@ -11473,6 +16185,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sim-integrations#put-sim-integration source: | + from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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 = '''{ @@ -11509,6 +16232,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#create-sod-policy source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: sod_policy = '''{ "conflictingAccessCriteria" : { "leftCriteria" : { @@ -11581,6 +16313,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy source: | + 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: @@ -11597,6 +16337,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy-schedule source: | + 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 @@ -11612,6 +16360,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-custom-violation-report source: | + 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: @@ -11630,6 +16386,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-default-violation-report source: | + 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 @@ -11647,6 +16411,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-all-report-run-status source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get multi-report run task status @@ -11663,6 +16436,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy source: | + 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 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 @@ -11680,6 +16462,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy-schedule source: | + 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 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 @@ -11697,6 +16488,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-run-status source: | + 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 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 @@ -11714,6 +16514,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-status source: | + 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 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 @@ -11731,6 +16540,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#list-sod-policies source: | + 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 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) @@ -11752,6 +16570,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#patch-sod-policy source: | + 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 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. json_patch_operation = '''[{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 try: @@ -11770,6 +16598,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-policy-schedule source: | + 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 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" : { @@ -11873,6 +16710,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#put-sod-policy source: | + 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 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" : { @@ -11946,6 +16792,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-evaluate-sod-policy source: | + 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 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 @@ -11963,6 +16818,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-all-policies-for-org source: | + 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 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) @@ -11982,6 +16847,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-policy source: | + 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 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 @@ -11999,6 +16873,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-predict-sod-violations source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: identity_with_new_access = '''{ "identityId" : "2c91808568c529c60168cca6f90c1313", "accessRefs" : [ { @@ -12027,6 +16911,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-violations#start-violation-check source: | + 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 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 @@ -12044,6 +16938,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#create-provisioning-policy source: | + 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 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", @@ -12101,6 +17004,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#create-source source: | + from sailpoint.v2024.api.sources_api import SourcesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.source import Source + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: source = '''{ "cluster" : { "name" : "Corporate Cluster", @@ -12201,6 +17113,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#create-source-schedule source: | + from sailpoint.v2024.api.sources_api import SourcesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.schedule1 import Schedule1 + 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: @@ -12219,6 +17140,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#create-source-schema source: | + from sailpoint.v2024.api.sources_api import SourcesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.model_schema import ModelSchema + 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: @@ -12237,6 +17167,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#delete-accounts-async source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -12255,6 +17195,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#delete-native-change-detection-config source: | + 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() + + configuration.experimental = true + + 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: @@ -12271,6 +17220,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#delete-provisioning-policy source: | + from sailpoint.v2024.api.sources_api import SourcesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.usage_type import UsageType + 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: @@ -12287,6 +17245,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#delete-source source: | + 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 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 @@ -12304,6 +17271,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#delete-source-schedule source: | + 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: @@ -12320,6 +17295,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#delete-source-schema source: | + 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: @@ -12336,6 +17319,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-accounts-schema source: | + 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 @@ -12351,6 +17342,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-correlation-config source: | + from sailpoint.v2024.api.sources_api import SourcesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.correlation_config import CorrelationConfig + 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 @@ -12368,6 +17368,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-entitlements-schema source: | + 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: @@ -12384,6 +17392,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-native-change-detection-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -12402,6 +17420,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-provisioning-policy source: | + 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 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: @@ -12420,6 +17448,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-source source: | + from sailpoint.v2024.api.sources_api import SourcesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.source import Source + 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 @@ -12437,6 +17474,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-source-attr-sync-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -12455,6 +17502,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-source-config source: | + from sailpoint.v2024.api.sources_api import SourcesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.connector_detail import ConnectorDetail + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -12474,6 +17531,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-source-entitlement-request-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # Get Source Entitlement Request Configuration @@ -12491,6 +17558,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-source-health source: | + 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 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 @@ -12508,6 +17584,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-source-schedule source: | + from sailpoint.v2024.api.sources_api import SourcesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.schedule1 import Schedule1 + 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: @@ -12526,6 +17611,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-source-schedules source: | + from sailpoint.v2024.api.sources_api import SourcesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.schedule1 import Schedule1 + 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 @@ -12543,6 +17637,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-source-schema source: | + from sailpoint.v2024.api.sources_api import SourcesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.model_schema import ModelSchema + 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: @@ -12561,6 +17664,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-source-schemas source: | + from sailpoint.v2024.api.sources_api import SourcesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.model_schema import ModelSchema + 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) @@ -12580,6 +17692,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#import-accounts source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -12600,6 +17722,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#import-accounts-schema source: | + from sailpoint.v2024.api.sources_api import SourcesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.model_schema import ModelSchema + 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: @@ -12618,6 +17749,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#import-connector-file source: | + from sailpoint.v2024.api.sources_api import SourcesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.source import Source + 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: @@ -12636,6 +17776,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#import-entitlements-schema source: | + from sailpoint.v2024.api.sources_api import SourcesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.model_schema import ModelSchema + 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) @@ -12655,6 +17804,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#import-uncorrelated-accounts source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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) @@ -12674,6 +17833,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#list-provisioning-policies source: | + 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 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 @@ -12691,6 +17859,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#list-sources source: | + from sailpoint.v2024.api.sources_api import SourcesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.source import Source + 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) @@ -12714,6 +17891,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#peek-resource-objects source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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 = '''{ @@ -12736,6 +17924,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#ping-cluster source: | + from sailpoint.v2024.api.sources_api import SourcesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.status_response import StatusResponse + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -12754,6 +17952,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#put-correlation-config source: | + from sailpoint.v2024.api.sources_api import SourcesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.correlation_config import CorrelationConfig + 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" : [ { @@ -12792,6 +17999,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#put-native-change-detection-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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 = '''{ @@ -12818,6 +18035,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#put-provisioning-policy source: | + 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 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 = '''{ @@ -12876,6 +18103,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#put-source source: | + from sailpoint.v2024.api.sources_api import SourcesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.source import Source + 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" : { @@ -12976,6 +18212,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#put-source-attr-sync-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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 = '''{ @@ -13012,6 +18258,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#put-source-schema source: | + from sailpoint.v2024.api.sources_api import SourcesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.model_schema import ModelSchema + 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 | @@ -13031,6 +18286,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#sync-attributes-for-source source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -13049,6 +18314,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#test-source-configuration source: | + from sailpoint.v2024.api.sources_api import SourcesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.status_response import StatusResponse + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -13067,6 +18342,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#test-source-connection source: | + from sailpoint.v2024.api.sources_api import SourcesApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.status_response import StatusResponse + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -13085,6 +18370,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#update-password-policy-holders source: | + 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 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 password_policy_holders_dto_inner = '''[sailpoint.v2024.PasswordPolicyHoldersDtoInner()]''' # List[PasswordPolicyHoldersDtoInner] | try: @@ -13103,6 +18397,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#update-provisioning-policies-in-bulk source: | + 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 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 = '''[sailpoint.v2024.ProvisioningPolicyDto()]''' # List[ProvisioningPolicyDto] | try: @@ -13121,6 +18424,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#update-provisioning-policy source: | + 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 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. json_patch_operation = '''[{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. @@ -13140,6 +18454,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#update-source source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. json_patch_operation = '''[{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). try: @@ -13158,6 +18482,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#update-source-entitlement-request-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') source_entitlement_request_config = '''{ "accessRequestConfig" : { @@ -13188,6 +18522,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#update-source-schedule source: | + 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 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. json_patch_operation = '''[{op=replace, path=/cronExpression, value=0 0 6 * * ?}]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the schedule. @@ -13207,6 +18551,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#update-source-schema source: | + 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 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. json_patch_operation = '''[{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. @@ -13226,6 +18580,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/source-usages#get-status-by-source-id source: | + 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 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 @@ -13243,6 +18606,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/source-usages#get-usages-by-source-id source: | + 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 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) @@ -13264,6 +18636,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sp-config#export-sp-config source: | + 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 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. @@ -13283,6 +18665,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export source: | + 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 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. @@ -13300,6 +18691,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export-status source: | + 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 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 @@ -13317,6 +18717,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import source: | + 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 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 @@ -13334,6 +18743,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import-status source: | + 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 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 @@ -13351,6 +18769,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sp-config#import-sp-config source: | + 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 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.v2024.ImportOptions()''' # ImportOptions | (optional) @@ -13370,6 +18798,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/sp-config#list-sp-config-objects source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get config object details @@ -13386,6 +18823,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#get-sed-batch-stats source: | + 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 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 @@ -13403,6 +18849,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#get-sed-batches source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List Sed Batch Request @@ -13419,6 +18874,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#list-seds source: | + 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 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) @@ -13443,6 +18907,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#patch-sed source: | + 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 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 sed_patch = '''[sailpoint.v2024.SedPatch()]''' # List[SedPatch] | Sed Patch Request try: @@ -13461,6 +18935,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#submit-sed-approval source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: sed_approval = '''[sailpoint.v2024.SedApproval()]''' # List[SedApproval] | Sed Approval try: # Submit Bulk Approval Request @@ -13478,6 +18962,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#submit-sed-assignment source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: sed_assignment = '''{ "assignee" : { "type" : "SOURCE_OWNER", @@ -13501,6 +18995,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#submit-sed-batch-request source: | + 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 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" ] @@ -13521,6 +19025,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/tagged-objects#delete-tagged-object source: | + 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: @@ -13537,6 +19049,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/tagged-objects#delete-tags-to-many-object source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: bulk_remove_tagged_object = '''{ "objectRefs" : [ { "name" : "William Wilson", @@ -13563,6 +19084,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/tagged-objects#get-tagged-object source: | + 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 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: @@ -13581,6 +19111,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/tagged-objects#list-tagged-objects source: | + 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 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) @@ -13601,6 +19140,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/tagged-objects#list-tagged-objects-by-type source: | + 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 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) @@ -13622,6 +19170,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/tagged-objects#put-tagged-object source: | + 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 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 = '''{ @@ -13648,6 +19205,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/tagged-objects#set-tag-to-object source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: tagged_object = '''{ "objectRef" : { "name" : "William Wilson", @@ -13670,6 +19236,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/tagged-objects#set-tags-to-many-objects source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: bulk_add_tagged_object = '''{ "objectRefs" : [ { "name" : "William Wilson", @@ -13699,6 +19275,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/task-management#get-pending-task-headers source: | + 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() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -13717,6 +19302,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/task-management#get-pending-tasks source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -13737,6 +19332,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/task-management#get-task-status source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -13755,6 +19360,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/task-management#get-task-status-list source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) 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) @@ -13777,6 +19392,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/task-management#update-task-status source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the object. @@ -13796,6 +19422,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/tenant#get-tenant source: | + from sailpoint.v2024.api.tenant_api import TenantApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.tenant import Tenant + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get Tenant Information. @@ -13812,6 +19447,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/transforms#create-transform source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: transform = '''{ "name" : "Timestamp To Date", "attributes" : "{}", @@ -13833,6 +19478,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/transforms#delete-transform source: | + 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 @@ -13848,6 +19501,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/transforms#get-transform source: | + from sailpoint.v2024.api.transforms_api import TransformsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.transform_read import TransformRead + 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 @@ -13865,6 +19527,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/transforms#list-transforms source: | + from sailpoint.v2024.api.transforms_api import TransformsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.transform_read import TransformRead + 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) @@ -13886,6 +19557,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/transforms#update-transform source: | + 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 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", @@ -13908,6 +19589,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/triggers#complete-trigger-invocation source: | + from sailpoint.v2024.api.triggers_api import TriggersApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.complete_invocation import CompleteInvocation + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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 = '''{ @@ -13931,6 +19622,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/triggers#create-subscription source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') subscription_post_request = '''{ "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", @@ -13973,6 +19675,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/triggers#delete-subscription source: | + 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() + + configuration.experimental = true + + 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: @@ -13989,6 +19700,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/triggers#list-subscriptions source: | + from sailpoint.v2024.api.triggers_api import TriggersApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.subscription import Subscription + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) 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) @@ -14011,6 +19732,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/triggers#list-trigger-invocation-status source: | + from sailpoint.v2024.api.triggers_api import TriggersApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.invocation_status import InvocationStatus + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) 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) @@ -14033,6 +19764,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/triggers#list-triggers source: | + from sailpoint.v2024.api.triggers_api import TriggersApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.trigger import Trigger + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) 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) @@ -14055,6 +19796,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/triggers#patch-subscription source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') subscription_patch_request_inner = '''[sailpoint.v2024.SubscriptionPatchRequestInner()]''' # List[SubscriptionPatchRequestInner] | @@ -14074,6 +19826,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/triggers#start-test-trigger-invocation source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') test_invocation = '''{ "input" : { @@ -14101,6 +19864,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/triggers#test-subscription-filter source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') validate_filter_input_dto = '''{ "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", @@ -14124,6 +19898,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/triggers#update-subscription source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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 = '''{ @@ -14166,6 +19951,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/ui-metadata#get-tenant-ui-metadata source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # Get a tenant UI metadata @@ -14183,6 +19978,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/ui-metadata#set-tenant-ui-metadata source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') tenant_ui_metadata_item_update_request = '''{ "usernameEmptyText" : "Please provide your work email address...", @@ -14205,6 +20011,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/vendor-connector-mappings#create-vendor-connector-mapping source: | + 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 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" : { @@ -14244,6 +20059,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/vendor-connector-mappings#delete-vendor-connector-mapping source: | + 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 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" : { @@ -14283,6 +20108,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/vendor-connector-mappings#get-vendor-connector-mappings source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List Vendor Connector Mappings @@ -14299,6 +20133,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#cancel-workflow-execution source: | + 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 @@ -14314,6 +20156,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#create-external-execute-workflow source: | + 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 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: @@ -14332,6 +20184,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow source: | + 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 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 @@ -14349,6 +20211,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow-external-trigger source: | + 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 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 @@ -14366,6 +20237,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#delete-workflow source: | + 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 @@ -14381,6 +20260,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow import Workflow + 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 @@ -14398,6 +20286,14 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution source: | + 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 @@ -14415,6 +20311,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution-history source: | + 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 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 @@ -14432,6 +20337,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-executions source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow_execution import WorkflowExecution + 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) @@ -14453,6 +20367,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#list-complete-workflow-library source: | + 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 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: @@ -14471,6 +20394,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-actions source: | + 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 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) @@ -14490,6 +20422,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-operators source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List Workflow Library Operators @@ -14506,6 +20447,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-triggers source: | + 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 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) @@ -14525,6 +20475,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflows source: | + from sailpoint.v2024.api.workflows_api import WorkflowsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.workflow import Workflow + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List Workflows @@ -14541,6 +20500,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#patch-workflow source: | + 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 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 json_patch_operation = '''[{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] | try: @@ -14559,6 +20528,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#put-workflow source: | + 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 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" : { @@ -14615,6 +20594,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#test-external-execute-workflow source: | + 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 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: @@ -14633,6 +20622,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#test-workflow source: | + 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 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: @@ -14651,6 +20650,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#approve-approval-item source: | + 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 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: @@ -14669,6 +20677,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#approve-approval-items-in-bulk source: | + 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 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 @@ -14686,6 +20703,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#complete-work-item source: | + 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 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 body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) try: @@ -14704,6 +20730,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#forward-work-item source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') work_item_forward = '''{ @@ -14725,6 +20761,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#get-completed-work-items source: | + 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 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) @@ -14745,6 +20790,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#get-count-completed-work-items source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) try: @@ -14763,6 +20818,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#get-count-work-items source: | + 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 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 @@ -14780,6 +20844,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#get-work-item source: | + 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 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 @@ -14797,6 +20870,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#get-work-items-summary source: | + 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 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 @@ -14814,6 +20896,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#list-work-items source: | + 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 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) @@ -14834,6 +20925,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#reject-approval-item source: | + 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 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: @@ -14852,6 +20952,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#reject-approval-items-in-bulk source: | + 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 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 @@ -14869,6 +20978,15 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#submit-account-selection source: | + 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 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: @@ -14887,6 +21005,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-reassignment#create-reassignment-configuration source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') configuration_item_request = '''{ "endDate" : "2022-07-30T17:00:00Z", @@ -14911,6 +21040,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-reassignment#delete-reassignment-configuration source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') @@ -14928,6 +21067,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-evaluate-reassignment-configuration source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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') @@ -14948,6 +21098,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-reassignment-config-types source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # List Reassignment Config Types @@ -14965,6 +21125,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-reassignment-configuration source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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: @@ -14983,6 +21153,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-tenant-config-configuration source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # Get Tenant-wide Reassignment Configuration settings @@ -15000,6 +21180,16 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-reassignment#list-reassignment-configurations source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # List Reassignment Configurations @@ -15017,6 +21207,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-reassignment#put-reassignment-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + 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 = '''{ @@ -15042,6 +21243,17 @@ - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-reassignment#put-tenant-configuration source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') tenant_configuration_request = '''{ "configDetails" : { diff --git a/sailpoint/v3/docs/Examples/python_code_examples_overlay.yaml b/sailpoint/v3/docs/Examples/python_code_examples_overlay.yaml index 51da6e33e..b3e37989e 100644 --- a/sailpoint/v3/docs/Examples/python_code_examples_overlay.yaml +++ b/sailpoint/v3/docs/Examples/python_code_examples_overlay.yaml @@ -4,6 +4,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/access-profiles#create-access-profile source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: access_profile = '''{ "owner" : { "name" : "support", @@ -105,6 +114,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/access-profiles#delete-access-profile source: | + 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 @@ -120,6 +137,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/access-profiles#delete-access-profiles-in-bulk source: | + 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 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 @@ -140,6 +167,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/access-profiles#get-access-profile source: | + 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 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 @@ -157,6 +193,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/access-profiles#get-access-profile-entitlements source: | + from sailpoint.v3.api.access_profiles_api import AccessProfilesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.entitlement import Entitlement + 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) @@ -179,6 +224,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/access-profiles#list-access-profiles source: | + 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 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) @@ -203,6 +257,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/access-profiles#patch-access-profile source: | + 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 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 json_patch_operation = '''[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}]''' # List[JsonPatchOperation] | try: @@ -221,6 +285,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/access-request-approvals#approve-access-request source: | + 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 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", @@ -247,6 +320,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/access-request-approvals#forward-access-request source: | + 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 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", @@ -268,6 +350,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/access-request-approvals#get-access-request-approval-summary source: | + 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 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: @@ -286,6 +377,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/access-request-approvals#list-completed-approvals source: | + 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 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) @@ -308,6 +408,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/access-request-approvals#list-pending-approvals source: | + 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 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) @@ -330,6 +439,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/access-request-approvals#reject-access-request source: | + 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 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", @@ -356,6 +474,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/access-requests#cancel-access-request source: | + 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 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." @@ -376,6 +503,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/access-requests#create-access-request source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: access_request = '''{ "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], "clientMetadata" : { @@ -446,6 +583,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/access-requests#get-access-request-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get Access Request Configuration @@ -462,6 +608,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/access-requests#list-access-request-status source: | + 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 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) @@ -488,6 +643,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/access-requests#set-access-request-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: access_request_config = '''{ "requestOnBehalfOfConfig" : { "allowRequestOnBehalfOfEmployeeByManager" : true, @@ -530,6 +694,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/account-activities#get-account-activity source: | + 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 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 @@ -547,6 +720,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/account-activities#list-account-activities source: | + 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 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) @@ -571,6 +753,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/accounts#create-account source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: account_attributes_create = '''{ "attributes" : { "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", @@ -597,6 +789,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/accounts#delete-account source: | + 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 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 @@ -614,6 +815,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/accounts#disable-account source: | + 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 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, @@ -635,6 +846,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/accounts#enable-account source: | + 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 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, @@ -656,6 +877,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/accounts#get-account source: | + from sailpoint.v3.api.accounts_api import AccountsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.account import Account + 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 @@ -673,6 +903,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/accounts#get-account-entitlements source: | + from sailpoint.v3.api.accounts_api import AccountsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.entitlement import Entitlement + 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) @@ -693,6 +932,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/accounts#list-accounts source: | + from sailpoint.v3.api.accounts_api import AccountsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.account import Account + 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) @@ -715,6 +963,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/accounts#put-account source: | + 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 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" : { @@ -741,6 +999,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/accounts#submit-reload-account source: | + 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 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 @@ -758,6 +1025,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/accounts#unlock-account source: | + 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 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, @@ -780,6 +1057,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/accounts#update-account source: | + 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. try: @@ -798,6 +1083,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/account-usages#get-usages-by-account-id source: | + 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 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) @@ -819,6 +1113,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/application-discovery#get-discovered-applications source: | + 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 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) @@ -840,6 +1143,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/application-discovery#get-manual-discover-applications-csv-template source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Download CSV Template for Discovery @@ -856,6 +1168,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/application-discovery#send-manual-discover-applications-csv-template source: | + 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 @@ -871,6 +1191,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/auth-users#get-auth-user source: | + 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 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 @@ -888,6 +1217,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/auth-users#patch-auth-user source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID json_patch_operation = '''[{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. try: @@ -906,6 +1245,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/branding#create-branding-item source: | + from sailpoint.v3.api.branding_api import BrandingApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.branding_item import BrandingItem + 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) @@ -930,6 +1278,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/branding#delete-branding source: | + 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 @@ -945,6 +1301,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/branding#get-branding source: | + from sailpoint.v3.api.branding_api import BrandingApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.branding_item import BrandingItem + 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 @@ -962,6 +1327,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/branding#get-branding-list source: | + from sailpoint.v3.api.branding_api import BrandingApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.branding_item import BrandingItem + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List of branding items @@ -978,6 +1352,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/branding#set-branding-item source: | + from sailpoint.v3.api.branding_api import BrandingApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.branding_item import BrandingItem + 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 @@ -1003,6 +1386,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#create-campaign-filter source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: campaign_filter_details = '''{ "owner" : "SailPoint Support", "mode" : "INCLUSION", @@ -1037,6 +1429,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#delete-campaign-filters source: | + 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. try: # Deletes Campaign Filters @@ -1052,6 +1452,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#get-campaign-filter-by-id source: | + 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 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 @@ -1069,6 +1478,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#list-campaign-filters source: | + 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 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) @@ -1088,6 +1506,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#update-campaign-filter source: | + 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 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", @@ -1123,6 +1550,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#complete-campaign source: | + 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 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" @@ -1143,6 +1579,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#create-campaign source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.campaign import Campaign + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: campaign = '''{ "totalCertifications" : 100, "sourcesWithOrphanEntitlements" : [ { @@ -1268,6 +1713,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#create-campaign-template source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: campaign_template = '''{ "ownerRef" : { "name" : "Mister Manager", @@ -1408,6 +1862,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#delete-campaign-template source: | + 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 @@ -1423,6 +1885,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#delete-campaign-template-schedule source: | + 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 @@ -1438,6 +1908,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#delete-campaigns source: | + 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 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. @@ -1457,6 +1936,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-active-campaigns source: | + 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 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) @@ -1479,6 +1967,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign source: | + 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 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: @@ -1497,6 +1994,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign-reports source: | + 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 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 @@ -1514,6 +2020,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign-reports-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get Campaign Reports Configuration @@ -1530,6 +2045,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign-template source: | + 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 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 @@ -1547,6 +2071,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign-template-schedule source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.schedule import Schedule + 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 @@ -1564,6 +2097,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign-templates source: | + 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 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) @@ -1585,6 +2127,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#move source: | + 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 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" ], @@ -1610,6 +2162,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#patch-campaign-template source: | + 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 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. json_patch_operation = '''[{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) try: @@ -1628,6 +2190,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#set-campaign-reports-config source: | + 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 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. @@ -1647,6 +2218,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#set-campaign-template-schedule source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.schedule import Schedule + 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" : { @@ -1682,6 +2262,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#start-campaign source: | + 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 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" @@ -1702,6 +2291,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#start-campaign-remediation-scan source: | + 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 @@ -1719,6 +2316,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#start-campaign-report source: | + 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 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: @@ -1737,6 +2343,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#start-generate-campaign-template source: | + 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 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 @@ -1754,6 +2369,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-campaigns#update-campaign source: | + 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 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. json_patch_operation = '''[{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 try: @@ -1772,6 +2397,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certifications#get-certification-task source: | + from sailpoint.v3.api.certifications_api import CertificationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.certification_task import CertificationTask + 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 @@ -1789,6 +2423,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certifications#get-identity-certification source: | + 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 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 @@ -1806,6 +2449,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certifications#get-identity-certification-item-permissions source: | + from sailpoint.v3.api.certifications_api import CertificationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.permission_dto import PermissionDto + 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) @@ -1828,6 +2480,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certifications#get-pending-certification-tasks source: | + from sailpoint.v3.api.certifications_api import CertificationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.certification_task import CertificationTask + 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) @@ -1849,6 +2510,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certifications#list-certification-reviewers source: | + 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 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) @@ -1871,6 +2541,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certifications#list-identity-access-review-items source: | + 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 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) @@ -1896,6 +2575,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certifications#list-identity-certifications source: | + 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 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) @@ -1918,6 +2606,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certifications#make-identity-decision source: | + 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 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 review_decision = '''[{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. try: @@ -1936,6 +2634,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certifications#reassign-identity-certifications source: | + 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 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", @@ -1964,6 +2672,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certifications#sign-off-identity-certification source: | + 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 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 @@ -1981,6 +2698,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certifications#submit-reassign-certs-async source: | + 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 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", @@ -2009,6 +2736,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-access-summaries source: | + 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 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) @@ -2032,6 +2768,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-decision-summary source: | + 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 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: @@ -2050,6 +2795,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summaries source: | + 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 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) @@ -2072,6 +2826,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summary source: | + 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 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: @@ -2090,6 +2853,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/configuration-hub#create-object-mapping source: | + 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 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", @@ -2114,6 +2887,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/configuration-hub#create-object-mappings source: | + 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 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" : [ { @@ -2146,6 +2929,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/configuration-hub#create-uploaded-configuration source: | + 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 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: @@ -2164,6 +2956,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/configuration-hub#delete-object-mapping source: | + 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: @@ -2180,6 +2980,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/configuration-hub#delete-uploaded-configuration source: | + 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 @@ -2195,6 +3003,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/configuration-hub#get-object-mappings source: | + 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 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 @@ -2212,6 +3029,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/configuration-hub#get-uploaded-configuration source: | + 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 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 @@ -2229,6 +3055,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/configuration-hub#list-uploaded-configurations source: | + 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 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 @@ -2246,6 +3081,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/configuration-hub#update-object-mappings source: | + 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 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" : { @@ -2277,6 +3122,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/connectors#create-custom-connector source: | + 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 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, @@ -2300,6 +3155,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/connectors#delete-custom-connector source: | + 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 @@ -2315,6 +3178,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/connectors#get-connector source: | + from sailpoint.v3.api.connectors_api import ConnectorsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.connector_detail import ConnectorDetail + 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: @@ -2333,6 +3205,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/connectors#get-connector-list source: | + 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 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) @@ -2354,6 +3235,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/connectors#get-connector-source-config source: | + 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 @@ -2371,6 +3260,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/connectors#get-connector-source-template source: | + 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 @@ -2388,6 +3285,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/connectors#get-connector-translations source: | + 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: @@ -2406,6 +3311,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/connectors#put-connector-source-config source: | + from sailpoint.v3.api.connectors_api import ConnectorsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.update_detail import UpdateDetail + 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: @@ -2424,6 +3338,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/connectors#put-connector-source-template source: | + from sailpoint.v3.api.connectors_api import ConnectorsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.update_detail import UpdateDetail + 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: @@ -2442,6 +3365,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/connectors#put-connector-translations source: | + from sailpoint.v3.api.connectors_api import ConnectorsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.update_detail import UpdateDetail + 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: @@ -2460,6 +3392,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/connectors#update-connector source: | + 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 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. json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of connector detail update operations try: @@ -2478,6 +3420,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#create-auth-org-network-config source: | + 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 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, @@ -2499,6 +3450,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#get-auth-org-lockout-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get Auth Org Lockout Configuration. @@ -2515,6 +3475,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#get-auth-org-network-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get security network configuration. @@ -2531,6 +3500,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#get-auth-org-service-provider-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get Service Provider Configuration. @@ -2547,6 +3525,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#get-auth-org-session-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get Auth Org Session Configuration. @@ -2563,6 +3550,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#patch-auth-org-lockout-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: json_patch_operation = '''[{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` try: # Update Auth Org Lockout Configuration @@ -2580,6 +3577,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#patch-auth-org-network-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: json_patch_operation = '''[{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. try: # Update security network configuration. @@ -2597,6 +3604,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#patch-auth-org-service-provider-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: json_patch_operation = '''[{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) try: # Update Service Provider Configuration @@ -2614,6 +3631,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#patch-auth-org-session-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: json_patch_operation = '''[{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.` try: # Update Auth Org Session Configuration @@ -2631,6 +3658,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/identity-profiles#create-identity-profile source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: identity_profile = '''{ "owner" : { "name" : "William Wilson", @@ -2696,6 +3732,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/identity-profiles#delete-identity-profile source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. try: # Delete Identity Profile @@ -2713,6 +3758,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/identity-profiles#delete-identity-profiles source: | + 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 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. try: # Delete Identity Profiles @@ -2730,6 +3784,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/identity-profiles#export-identity-profiles source: | + 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 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) @@ -2751,6 +3814,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/identity-profiles#get-default-identity-attribute-config source: | + 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 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 @@ -2768,6 +3840,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/identity-profiles#get-identity-profile source: | + 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 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. try: # Get Identity Profile @@ -2785,6 +3866,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/identity-profiles#import-identity-profiles source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: identity_profile_exported_object = '''[sailpoint.v3.IdentityProfileExportedObject()]''' # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. try: # Import Identity Profiles @@ -2802,6 +3893,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/identity-profiles#list-identity-profiles source: | + 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 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) @@ -2823,6 +3923,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/identity-profiles#show-identity-preview source: | + 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 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" : { @@ -2866,6 +3976,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/identity-profiles#sync-identity-profile source: | + 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 @@ -2883,6 +4001,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/identity-profiles#update-identity-profile source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. json_patch_operation = '''[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}]''' # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. try: @@ -2901,6 +4029,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/lifecycle-states#create-lifecycle-state source: | + 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 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" ], @@ -2943,6 +4080,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/lifecycle-states#delete-lifecycle-state source: | + 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 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: @@ -2961,6 +4107,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/lifecycle-states#get-lifecycle-state source: | + 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 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: @@ -2979,6 +4134,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/lifecycle-states#get-lifecycle-states source: | + 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 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) @@ -3000,6 +4164,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/lifecycle-states#set-lifecycle-state source: | + 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 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: @@ -3018,6 +4192,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/lifecycle-states#update-lifecycle-states source: | + 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 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. json_patch_operation = '''[{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 @@ -3037,6 +4221,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/managed-clients#create-managed-client source: | + 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 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", @@ -3059,6 +4253,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/managed-clients#delete-managed-client source: | + 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 @@ -3074,6 +4276,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client source: | + 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 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 @@ -3091,6 +4302,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client-status source: | + 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 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: @@ -3109,6 +4330,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-clients source: | + 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 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) @@ -3129,6 +4359,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/managed-clients#update-managed-client source: | + 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 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. json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. try: @@ -3147,6 +4387,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/managed-clusters#create-managed-cluster source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: managed_cluster_request = '''{ "configuration" : { "clusterExternalId" : "externalId", @@ -3172,6 +4422,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/managed-clusters#delete-managed-cluster source: | + 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: @@ -3188,6 +4446,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-client-log-configuration source: | + 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 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 @@ -3205,6 +4472,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-cluster source: | + 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 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 @@ -3222,6 +4498,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-clusters source: | + 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 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) @@ -3242,6 +4527,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/managed-clusters#put-client-log-configuration source: | + 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 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: @@ -3260,6 +4555,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/managed-clusters#update-managed-cluster source: | + 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 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. json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. try: @@ -3278,6 +4583,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/mfa-configuration#delete-mfa-config source: | + 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 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 @@ -3295,6 +4609,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/mfa-configuration#get-mfa-duo-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Configuration of Duo MFA method @@ -3311,6 +4634,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/mfa-configuration#get-mfa-kba-config source: | + 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 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 @@ -3328,6 +4660,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/mfa-configuration#get-mfa-okta-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Configuration of Okta MFA method @@ -3344,6 +4685,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/mfa-configuration#set-mfa-duo-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: mfa_duo_config = '''{ "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", "host" : "example.com", @@ -3371,6 +4721,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/mfa-configuration#set-mfa-okta-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: mfa_okta_config = '''{ "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", "host" : "example.com", @@ -3394,6 +4753,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/mfa-configuration#set-mfakba-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | try: # Set MFA KBA configuration @@ -3411,6 +4780,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/mfa-configuration#test-mfa-config source: | + 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 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 @@ -3428,6 +4806,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/mfa-controller#create-send-token source: | + 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 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" @@ -3448,6 +4836,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/mfa-controller#ping-verification-status source: | + 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 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" @@ -3468,6 +4866,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/mfa-controller#send-duo-verify-request source: | + 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 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" @@ -3488,6 +4896,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/mfa-controller#send-kba-answers source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | try: # Authenticate KBA provided MFA method @@ -3505,6 +4923,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/mfa-controller#send-okta-verify-request source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: okta_verification_request = '''{ "userId" : "example@mail.com" }''' # OktaVerificationRequest | @@ -3524,6 +4952,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/mfa-controller#send-token-auth-request source: | + 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 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", @@ -3545,6 +4983,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#approve-non-employee-request source: | + 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 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" @@ -3565,6 +5013,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#create-non-employee-record source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: non_employee_request_body = '''{ "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", @@ -3595,6 +5053,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#create-non-employee-request source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: non_employee_request_body = '''{ "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", @@ -3625,6 +5093,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#create-non-employee-source source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: non_employee_source_request_body = '''{ "owner" : { "id" : "2c91808570313110017040b06f344ec9" @@ -3667,6 +5145,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes source: | + 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 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", @@ -3692,6 +5180,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-record source: | + 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 @@ -3707,6 +5203,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk source: | + 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 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 @@ -3722,6 +5227,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-request source: | + 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 @@ -3737,6 +5250,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute source: | + 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: @@ -3753,6 +5274,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-source source: | + 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 @@ -3768,6 +5297,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes source: | + 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 @@ -3783,6 +5320,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#export-non-employee-records source: | + 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 @@ -3798,6 +5343,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template source: | + 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 @@ -3813,6 +5366,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-approval source: | + 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 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: @@ -3831,6 +5393,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-approval-summary source: | + 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 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 @@ -3848,6 +5419,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status source: | + 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 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 @@ -3865,6 +5445,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-record source: | + 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 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 @@ -3882,6 +5471,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-request source: | + 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 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 @@ -3899,6 +5497,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-request-summary source: | + 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 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 @@ -3916,6 +5523,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute source: | + 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 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: @@ -3934,6 +5550,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-source source: | + 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 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 @@ -3951,6 +5576,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes source: | + 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 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 @@ -3968,6 +5602,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk source: | + 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 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: @@ -3986,6 +5629,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#list-non-employee-approvals source: | + 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 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) @@ -4008,6 +5660,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#list-non-employee-records source: | + 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 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) @@ -4029,6 +5690,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#list-non-employee-requests source: | + 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 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) @@ -4051,6 +5721,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#list-non-employee-sources source: | + 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 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) @@ -4073,6 +5752,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#patch-non-employee-record source: | + 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 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) json_patch_operation = '''[{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. try: @@ -4091,6 +5780,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute source: | + 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 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 json_patch_operation = '''[{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'. @@ -4110,6 +5809,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#patch-non-employee-source source: | + 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 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 json_patch_operation = '''[{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. try: @@ -4128,6 +5837,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#reject-non-employee-request source: | + 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 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" @@ -4148,6 +5867,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#update-non-employee-record source: | + 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 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", @@ -4179,6 +5908,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/o-auth-clients#create-oauth-client source: | + 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 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", @@ -4212,6 +5951,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/o-auth-clients#delete-oauth-client source: | + 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 @@ -4227,6 +5974,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/o-auth-clients#get-oauth-client source: | + 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 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 @@ -4244,6 +6000,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/o-auth-clients#list-oauth-clients source: | + 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 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 @@ -4261,6 +6026,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/o-auth-clients#patch-oauth-client source: | + 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 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 json_patch_operation = '''[{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 try: @@ -4279,6 +6054,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/password-configuration#create-password-org-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: password_org_config = '''{ "digitTokenLength" : 9, "digitTokenEnabled" : true, @@ -4301,6 +6085,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/password-configuration#get-password-org-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get Password Org Config @@ -4317,6 +6110,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/password-configuration#put-password-org-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: password_org_config = '''{ "digitTokenLength" : 9, "digitTokenEnabled" : true, @@ -4339,6 +6141,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/password-dictionary#get-password-dictionary source: | + 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 @@ -4355,6 +6165,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/password-dictionary#put-password-dictionary source: | + 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 @@ -4370,6 +6188,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/password-management#get-password-change-status source: | + 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 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 @@ -4387,6 +6214,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/password-management#query-password-info source: | + 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 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" @@ -4407,6 +6244,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/password-management#set-password source: | + 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 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", @@ -4430,6 +6277,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/password-policies#create-password-policy source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: password_policy_v3_dto = '''{ "validateAgainstAccountName" : true, "minLength" : 8, @@ -4479,6 +6335,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/password-policies#delete-password-policy source: | + 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 @@ -4494,6 +6358,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/password-policies#get-password-policy-by-id source: | + 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 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 @@ -4511,6 +6384,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/password-policies#list-password-policies source: | + 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 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) @@ -4530,6 +6412,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/password-policies#set-password-policy source: | + 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 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, @@ -4580,6 +6471,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/password-sync-groups#create-password-sync-group source: | + 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 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", @@ -4604,6 +6504,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/password-sync-groups#delete-password-sync-group source: | + 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 @@ -4619,6 +6527,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/password-sync-groups#get-password-sync-group source: | + 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 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 @@ -4636,6 +6553,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/password-sync-groups#get-password-sync-groups source: | + 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 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) @@ -4655,6 +6581,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/password-sync-groups#update-password-sync-group source: | + 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 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", @@ -4680,6 +6615,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/personal-access-tokens#create-personal-access-token source: | + 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 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, @@ -4701,6 +6646,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/personal-access-tokens#delete-personal-access-token source: | + 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 @@ -4716,6 +6669,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/personal-access-tokens#list-personal-access-tokens source: | + 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 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: @@ -4734,6 +6696,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/personal-access-tokens#patch-personal-access-token source: | + 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 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 json_patch_operation = '''[{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 try: @@ -4752,6 +6724,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/public-identities#get-public-identities source: | + 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 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) @@ -4774,6 +6755,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/public-identities-config#get-public-identity-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get the Public Identities Configuration @@ -4790,6 +6780,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/public-identities-config#update-public-identity-config source: | + 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 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" : [ { @@ -4821,6 +6820,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/reports-data-extraction#cancel-report source: | + 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 @@ -4836,6 +6843,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/reports-data-extraction#get-report source: | + 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) @@ -4856,6 +6871,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/reports-data-extraction#get-report-result source: | + 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 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: @@ -4874,6 +6898,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/reports-data-extraction#start-report source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: report_details = '''{ "reportType" : "ACCOUNTS", "arguments" : { @@ -4897,6 +6931,17 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/requestable-objects#list-requestable-objects source: | + 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 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) term = 'Finance Role' # str | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) # str | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) @@ -4922,6 +6967,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/roles#create-role source: | + from sailpoint.v3.api.roles_api import RolesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.role import Role + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: role = '''{ "owner" : { "name" : "support", @@ -5096,6 +7150,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/roles#delete-bulk-roles source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: role_bulk_delete_request = '''{ "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] }''' # RoleBulkDeleteRequest | @@ -5115,6 +7179,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/roles#delete-role source: | + 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 @@ -5130,6 +7202,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/roles#get-role source: | + from sailpoint.v3.api.roles_api import RolesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.role import Role + 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 @@ -5147,6 +7228,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/roles#get-role-assigned-identities source: | + from sailpoint.v3.api.roles_api import RolesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.role_identity import RoleIdentity + 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) @@ -5169,6 +7259,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/roles#list-roles source: | + from sailpoint.v3.api.roles_api import RolesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.role import Role + 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) @@ -5193,6 +7292,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/roles#patch-role source: | + 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 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 json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]''' # List[JsonPatchOperation] | try: @@ -5211,6 +7320,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/saved-search#create-saved-search source: | + 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 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 @@ -5228,6 +7347,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/saved-search#delete-saved-search source: | + 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 @@ -5243,6 +7370,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/saved-search#execute-saved-search source: | + 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 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" : "", @@ -5269,6 +7405,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/saved-search#get-saved-search source: | + 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 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 @@ -5286,6 +7431,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/saved-search#list-saved-searches source: | + 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 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) @@ -5306,6 +7460,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/saved-search#put-saved-search source: | + 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 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" : { @@ -5368,6 +7531,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/scheduled-search#create-scheduled-search source: | + 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 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 @@ -5385,6 +7558,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/scheduled-search#delete-scheduled-search source: | + 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 @@ -5400,6 +7581,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/scheduled-search#get-scheduled-search source: | + 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 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 @@ -5417,6 +7607,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/scheduled-search#list-scheduled-search source: | + 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 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) @@ -5437,6 +7636,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/scheduled-search#unsubscribe-scheduled-search source: | + 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 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", @@ -5456,6 +7664,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/scheduled-search#update-scheduled-search source: | + 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 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" : { @@ -5516,6 +7733,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/search#search-aggregate source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: search = '''{ "queryDsl" : { "match" : { @@ -5652,6 +7879,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/search#search-count source: | + from sailpoint.v3.api.search_api import SearchApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.search import Search + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: search = '''{ "queryDsl" : { "match" : { @@ -5783,6 +8019,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/search#search-get source: | + 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 = 'identities' # 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: @@ -5801,6 +8045,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/search#search-post source: | + from sailpoint.v3.api.search_api import SearchApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.search import Search + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: search = '''{ "queryDsl" : { "match" : { @@ -5937,6 +8190,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#create-search-attribute-config source: | + 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 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", @@ -5961,6 +8223,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#delete-search-attribute-config source: | + 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 @@ -5976,6 +8246,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#get-search-attribute-config source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List Extended Search Attributes @@ -5992,6 +8271,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#get-single-search-attribute-config source: | + 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 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 @@ -6009,6 +8297,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#patch-search-attribute-config source: | + 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 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. json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | try: @@ -6027,6 +8325,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/segments#create-segment source: | + from sailpoint.v3.api.segments_api import SegmentsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.segment import Segment + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: segment = '''{ "owner" : { "name" : "support", @@ -6067,6 +8374,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/segments#delete-segment source: | + 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 @@ -6082,6 +8397,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/segments#get-segment source: | + from sailpoint.v3.api.segments_api import SegmentsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.segment import Segment + 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 @@ -6099,6 +8423,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/segments#list-segments source: | + from sailpoint.v3.api.segments_api import SegmentsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.segment import Segment + 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) @@ -6118,6 +8451,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/segments#patch-segment source: | + from sailpoint.v3.api.segments_api import SegmentsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.segment import Segment + 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 try: @@ -6136,6 +8478,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/service-desk-integration#create-service-desk-integration source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: service_desk_integration_dto = '''{ "ownerRef" : "", "cluster" : "xyzzy999", @@ -6186,6 +8537,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/service-desk-integration#delete-service-desk-integration source: | + 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 @@ -6201,6 +8560,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/service-desk-integration#get-service-desk-integration source: | + 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 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 @@ -6218,6 +8586,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/service-desk-integration#get-service-desk-integration-template source: | + 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 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 @@ -6235,6 +8612,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/service-desk-integration#get-service-desk-integration-types source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List Service Desk integration types @@ -6251,6 +8637,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/service-desk-integration#get-service-desk-integrations source: | + 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 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) @@ -6272,6 +8667,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/service-desk-integration#get-status-check-details source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get the time check configuration @@ -6288,6 +8692,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/service-desk-integration#patch-service-desk-integration source: | + 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 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: @@ -6306,6 +8720,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/service-desk-integration#put-service-desk-integration source: | + 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 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" : "", @@ -6357,6 +8780,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/service-desk-integration#update-status-check-details source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: queued_check_config_details = '''{ "provisioningStatusCheckIntervalMinutes" : "30", "provisioningMaxStatusCheckDays" : "2" @@ -6377,6 +8809,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-policies#create-sod-policy source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: sod_policy = '''{ "conflictingAccessCriteria" : { "leftCriteria" : { @@ -6449,6 +8890,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy source: | + 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: @@ -6465,6 +8914,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy-schedule source: | + 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 @@ -6480,6 +8937,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-policies#get-custom-violation-report source: | + 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: @@ -6498,6 +8963,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-policies#get-default-violation-report source: | + 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 @@ -6515,6 +8988,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-all-report-run-status source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # Get multi-report run task status @@ -6531,6 +9013,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy source: | + 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 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 @@ -6548,6 +9039,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy-schedule source: | + 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 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 @@ -6565,6 +9065,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-run-status source: | + 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 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 @@ -6582,6 +9091,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-status source: | + 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 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 @@ -6599,6 +9117,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-policies#list-sod-policies source: | + 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 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) @@ -6620,6 +9147,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-policies#patch-sod-policy source: | + 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 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. json_patch_operation = '''[{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 try: @@ -6638,6 +9175,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-policies#put-policy-schedule source: | + 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 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" : { @@ -6693,6 +9239,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-policies#put-sod-policy source: | + 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 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" : { @@ -6766,6 +9321,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-policies#start-evaluate-sod-policy source: | + 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 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 @@ -6783,6 +9347,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-all-policies-for-org source: | + 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 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) @@ -6802,6 +9376,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-policy source: | + 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 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 @@ -6819,6 +9402,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-violations#start-predict-sod-violations source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: identity_with_new_access = '''{ "identityId" : "2c91808568c529c60168cca6f90c1313", "accessRefs" : [ { @@ -6847,6 +9440,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sod-violations#start-violation-check source: | + 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 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 @@ -6864,6 +9467,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#create-provisioning-policy source: | + 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 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", @@ -6921,6 +9533,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#create-source source: | + from sailpoint.v3.api.sources_api import SourcesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.source import Source + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: source = '''{ "cluster" : { "name" : "Corporate Cluster", @@ -7021,6 +9642,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#create-source-schema source: | + from sailpoint.v3.api.sources_api import SourcesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.model_schema import ModelSchema + 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: @@ -7039,6 +9669,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#delete-provisioning-policy source: | + from sailpoint.v3.api.sources_api import SourcesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.usage_type import UsageType + 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: @@ -7055,6 +9694,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#delete-source source: | + 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 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 @@ -7072,6 +9720,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#delete-source-schema source: | + 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: @@ -7088,6 +9744,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#get-accounts-schema source: | + 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 @@ -7103,6 +9767,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#get-entitlements-schema source: | + 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: @@ -7119,6 +9791,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#get-provisioning-policy source: | + 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 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: @@ -7137,6 +9819,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#get-source source: | + from sailpoint.v3.api.sources_api import SourcesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.source import Source + 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 @@ -7154,6 +9845,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#get-source-connections source: | + 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 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 @@ -7171,6 +9871,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#get-source-health source: | + 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 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 @@ -7188,6 +9897,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#get-source-schema source: | + from sailpoint.v3.api.sources_api import SourcesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.model_schema import ModelSchema + 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: @@ -7206,6 +9924,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#get-source-schemas source: | + from sailpoint.v3.api.sources_api import SourcesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.model_schema import ModelSchema + 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) @@ -7225,6 +9952,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#import-accounts-schema source: | + from sailpoint.v3.api.sources_api import SourcesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.model_schema import ModelSchema + 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: @@ -7243,6 +9979,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#import-connector-file source: | + from sailpoint.v3.api.sources_api import SourcesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.source import Source + 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: @@ -7261,6 +10006,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#import-entitlements-schema source: | + from sailpoint.v3.api.sources_api import SourcesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.model_schema import ModelSchema + 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) @@ -7280,6 +10034,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#list-provisioning-policies source: | + 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 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 @@ -7297,6 +10060,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#list-sources source: | + from sailpoint.v3.api.sources_api import SourcesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.source import Source + 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) @@ -7320,6 +10092,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#put-provisioning-policy source: | + 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 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 = '''{ @@ -7378,6 +10160,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#put-source source: | + from sailpoint.v3.api.sources_api import SourcesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.source import Source + 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" : { @@ -7478,6 +10269,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#put-source-schema source: | + from sailpoint.v3.api.sources_api import SourcesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.model_schema import ModelSchema + 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 | @@ -7497,6 +10297,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#update-provisioning-policies-in-bulk source: | + 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 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 = '''[sailpoint.v3.ProvisioningPolicyDto()]''' # List[ProvisioningPolicyDto] | try: @@ -7515,6 +10324,17 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#update-provisioning-policy source: | + 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 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. json_patch_operation = '''[{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. @@ -7534,6 +10354,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#update-source source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. json_patch_operation = '''[{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). try: @@ -7552,6 +10382,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/sources#update-source-schema source: | + 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 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. json_patch_operation = '''[{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. @@ -7571,6 +10411,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/source-usages#get-status-by-source-id source: | + 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 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 @@ -7588,6 +10437,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/source-usages#get-usages-by-source-id source: | + 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 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) @@ -7609,6 +10467,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/tagged-objects#delete-tagged-object source: | + 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: @@ -7625,6 +10491,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/tagged-objects#delete-tags-to-many-object source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: bulk_remove_tagged_object = '''{ "objectRefs" : [ { "name" : "William Wilson", @@ -7651,6 +10526,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/tagged-objects#get-tagged-object source: | + 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 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: @@ -7669,6 +10553,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/tagged-objects#list-tagged-objects source: | + 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 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) @@ -7689,6 +10582,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/tagged-objects#list-tagged-objects-by-type source: | + 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 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) @@ -7710,6 +10612,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/tagged-objects#put-tagged-object source: | + 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 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 = '''{ @@ -7736,6 +10647,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/tagged-objects#set-tag-to-object source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: tagged_object = '''{ "objectRef" : { "name" : "William Wilson", @@ -7758,6 +10678,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/tagged-objects#set-tags-to-many-objects source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: bulk_add_tagged_object = '''{ "objectRefs" : [ { "name" : "William Wilson", @@ -7787,6 +10717,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/transforms#create-transform source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: transform = '''{ "name" : "Timestamp To Date", "attributes" : "{}", @@ -7808,6 +10748,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/transforms#delete-transform source: | + 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 @@ -7823,6 +10771,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/transforms#get-transform source: | + from sailpoint.v3.api.transforms_api import TransformsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.transform_read import TransformRead + 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 @@ -7840,6 +10797,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/transforms#list-transforms source: | + from sailpoint.v3.api.transforms_api import TransformsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.transform_read import TransformRead + 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) @@ -7861,6 +10827,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/transforms#update-transform source: | + 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 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", @@ -7883,6 +10859,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/vendor-connector-mappings#create-vendor-connector-mapping source: | + 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 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" : { @@ -7922,6 +10907,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/vendor-connector-mappings#delete-vendor-connector-mapping source: | + 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 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" : { @@ -7961,6 +10956,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/vendor-connector-mappings#get-vendor-connector-mappings source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List Vendor Connector Mappings @@ -7977,6 +10981,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/workflows#cancel-workflow-execution source: | + 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 @@ -7992,6 +11004,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/workflows#create-external-execute-workflow source: | + 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 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: @@ -8010,6 +11032,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/workflows#create-workflow source: | + 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 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 @@ -8027,6 +11059,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/workflows#create-workflow-external-trigger source: | + 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 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 @@ -8044,6 +11085,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/workflows#delete-workflow source: | + 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 @@ -8059,6 +11108,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow source: | + from sailpoint.v3.api.workflows_api import WorkflowsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.workflow import Workflow + 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 @@ -8076,6 +11134,14 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow-execution source: | + 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 @@ -8093,6 +11159,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow-execution-history source: | + 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 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 @@ -8110,6 +11185,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/workflows#get-workflow-executions source: | + from sailpoint.v3.api.workflows_api import WorkflowsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.workflow_execution import WorkflowExecution + 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) @@ -8131,6 +11215,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/workflows#list-complete-workflow-library source: | + 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 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: @@ -8149,6 +11242,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/workflows#list-workflow-library-actions source: | + 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 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) @@ -8168,6 +11270,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/workflows#list-workflow-library-operators source: | + 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 pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List Workflow Library Operators @@ -8184,6 +11295,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/workflows#list-workflow-library-triggers source: | + 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 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) @@ -8203,6 +11323,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/workflows#list-workflows source: | + from sailpoint.v3.api.workflows_api import WorkflowsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.workflow import Workflow + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: try: # List Workflows @@ -8219,6 +11348,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/workflows#patch-workflow source: | + 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 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 json_patch_operation = '''[{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] | try: @@ -8237,6 +11376,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/workflows#put-workflow source: | + 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 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" : { @@ -8293,6 +11442,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/workflows#test-external-execute-workflow source: | + 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 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: @@ -8311,6 +11470,16 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/workflows#test-workflow source: | + 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 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: @@ -8329,6 +11498,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-item source: | + 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 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: @@ -8347,6 +11525,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/work-items#approve-approval-items-in-bulk source: | + 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 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 @@ -8364,6 +11551,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/work-items#complete-work-item source: | + 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 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 body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) try: @@ -8382,6 +11578,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/work-items#get-completed-work-items source: | + 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 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) @@ -8402,6 +11607,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/work-items#get-count-completed-work-items source: | + 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 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 @@ -8419,6 +11633,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/work-items#get-count-work-items source: | + 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 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 @@ -8436,6 +11659,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/work-items#get-work-item source: | + 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 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 @@ -8453,6 +11685,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/work-items#get-work-items-summary source: | + 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 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 @@ -8470,6 +11711,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/work-items#list-work-items source: | + 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 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) @@ -8490,6 +11740,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-item source: | + 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 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: @@ -8508,6 +11767,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/work-items#reject-approval-items-in-bulk source: | + 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 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 @@ -8525,6 +11793,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/work-items#send-work-item-forward source: | + 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 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", @@ -8545,6 +11822,15 @@ - lang: Python label: SDK_tools/sdk/python/v3/methods/work-items#submit-account-selection source: | + 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 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: diff --git a/sdk-resources/resources/developerSite_code_examples.mustache b/sdk-resources/resources/developerSite_code_examples.mustache index 01b226d5a..53ec2ca53 100644 --- a/sdk-resources/resources/developerSite_code_examples.mustache +++ b/sdk-resources/resources/developerSite_code_examples.mustache @@ -6,6 +6,20 @@ - lang: Python label: SDK_tools/sdk/python/{{#lambda.lowercase}}{{subModuleName}}{{/lambda.lowercase}}/methods/{{#lambda.kebabcase}}{{#lambda.titlecase}}{{baseName}}{{/lambda.titlecase}}{{/lambda.kebabcase}}#{{#lambda.kebabcase}}{{#lambda.titlecase}}{{operationId}}{{/lambda.titlecase}}{{/lambda.kebabcase}} source: | + from {{{packageName}}}.api.{{#lambda.snakecase}}{{classname}}{{/lambda.snakecase}} import {{#lambda.titlecase}}{{classname}}{{/lambda.titlecase}} + from {{{packageName}}}.api_client import ApiClient + {{#vendorExtensions.x-py-example-import}} + {{{.}}} + {{/vendorExtensions.x-py-example-import}} + from pprint import pprint + from sailpoint.configuration import Configuration + configuration = Configuration() + + {{#headerParams}} + configuration.experimental = true + {{/headerParams}} + + with ApiClient(configuration) as api_client: {{#allParams}} {{^isArray}} {{#isModel}}