- path: /access-model-metadata/attributes/{key} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-model-metadata#get-access-model-metadata-attribute source: | 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) - path: /access-model-metadata/attributes/{key}/values/{value} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-model-metadata#get-access-model-metadata-attribute-value source: | 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') 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) except Exception as e: print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute_value: %s\n" % e) - path: /access-model-metadata/attributes method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-model-metadata#list-access-model-metadata-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') 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) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) - path: /access-model-metadata/attributes/{key}/values method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-model-metadata#list-access-model-metadata-attribute-value source: | 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) except Exception as 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 = { "owner" : { "name" : "support", "id" : "2c9180a46faadee4016fb4e018c20639", "type" : "IDENTITY" }, "entitlements" : [ { "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", "id" : "2c91809773dee32014e13e122092014e", "type" : "ENTITLEMENT" }, { "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", "id" : "2c91809773dee32014e13e122092014e", "type" : "ENTITLEMENT" } ], "created" : "2021-03-01T22:32:58.104Z", "description" : "Collection of entitlements to read/write the employee database", "source" : { "name" : "ODS-AD-SOURCE", "id" : "2c91809773dee3610173fdb0b6061ef4", "type" : "SOURCE" }, "enabled" : true, "revocationRequestConfig" : { "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" }, { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" } ] }, "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" }, { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" } ], "denialCommentsRequired" : true }, "name" : "Employee-database-read-write", "provisioningCriteria" : { "children" : [ { "children" : [ { "children" : "children", "attribute" : "email", "operation" : "EQUALS", "value" : "carlee.cert1c9f9b6fd@mailinator.com" }, { "children" : "children", "attribute" : "email", "operation" : "EQUALS", "value" : "carlee.cert1c9f9b6fd@mailinator.com" } ], "attribute" : "email", "operation" : "EQUALS", "value" : "carlee.cert1c9f9b6fd@mailinator.com" }, { "children" : [ { "children" : "children", "attribute" : "email", "operation" : "EQUALS", "value" : "carlee.cert1c9f9b6fd@mailinator.com" }, { "children" : "children", "attribute" : "email", "operation" : "EQUALS", "value" : "carlee.cert1c9f9b6fd@mailinator.com" } ], "attribute" : "email", "operation" : "EQUALS", "value" : "carlee.cert1c9f9b6fd@mailinator.com" } ], "attribute" : "email", "operation" : "EQUALS", "value" : "carlee.cert1c9f9b6fd@mailinator.com" }, "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) - path: /access-profiles/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-profiles#delete-access-profile 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) except Exception as 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 = { "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) - path: /access-profiles/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-profiles#get-access-profile 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) except Exception as e: print("Exception when calling AccessProfilesApi->get_access_profile: %s\n" % e) - path: /access-profiles/{id}/entitlements method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-profiles#get-access-profile-entitlements source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = '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) except Exception as e: print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) - path: /access-profiles method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-profiles#list-access-profiles source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 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* **requestable**: *eq* **source.id**: *eq, in* Composite operators supported: *and, or* 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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Composite operators supported: *and, or* 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, 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 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) except Exception as e: print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) - path: /access-profiles/{id} method: PATCH xCodeSample: - lang: Python 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) - path: /access-profiles/bulk-update-requestable method: POST xCodeSample: - lang: Python 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] | 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) except Exception as e: print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) - path: /access-request-approvals/{approvalId}/approve method: POST xCodeSample: - lang: Python 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 = { "created" : "2017-07-11T18:45:37.098Z", "author" : { "name" : "john.doe", "id" : "2c9180847e25f377017e2ae8cae4650b", "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) - path: /access-request-approvals/{approvalId}/forward method: POST xCodeSample: - lang: Python 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 = { "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) - path: /access-request-approvals/approval-summary method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#get-access-request-approval-summary source: | 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) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->get_access_request_approval_summary: %s\n" % e) - path: /access-request-approvals/{accessRequestId}/approvers method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#list-access-request-approvers source: | 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) 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) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_access_request_approvers: %s\n" % e) - path: /access-request-approvals/completed method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#list-completed-approvals source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = '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) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) - path: /access-request-approvals/pending method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-request-approvals#list-pending-approvals source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = '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) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) - path: /access-request-approvals/{approvalId}/reject method: POST xCodeSample: - lang: Python 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 = { "created" : "2017-07-11T18:45:37.098Z", "author" : { "name" : "john.doe", "id" : "2c9180847e25f377017e2ae8cae4650b", "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) - path: /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-request-identity-metrics#get-access-request-identity-metrics source: | 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. 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) except Exception as 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 = { "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) - 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 = { "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) - 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 = { "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) - path: /access-requests/close method: POST xCodeSample: - lang: Python 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 = { "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) - path: /access-requests method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-requests#create-access-request source: | access_request = { "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" }, "requestType" : "GRANT_ACCESS", "requestedItems" : [ { "clientMetadata" : { "requestedAppName" : "test-app", "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" }, "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" }, { "clientMetadata" : { "requestedAppName" : "test-app", "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" }, "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" }, { "clientMetadata" : { "requestedAppName" : "test-app", "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" }, "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" }, { "clientMetadata" : { "requestedAppName" : "test-app", "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" }, "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" }, { "clientMetadata" : { "requestedAppName" : "test-app", "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" }, "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "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) - path: /access-request-config method: GET xCodeSample: - lang: Python 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) except Exception as e: print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e) - path: /access-request-status method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-requests#list-access-request-status source: | 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) assigned_to = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) # str | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (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) 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) filters = 'accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, 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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, 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: **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) except Exception as e: print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) - path: /access-request-administration method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/access-requests#list-administrators-access-request-status source: | 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) assigned_to = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) # str | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (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) 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) filters = 'accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, 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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, 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: **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) except Exception as 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 = { "requestOnBehalfOfConfig" : { "allowRequestOnBehalfOfEmployeeByManager" : true, "allowRequestOnBehalfOfAnyoneByAnyone" : true }, "approvalReminderAndEscalationConfig" : { "fallbackApproverRef" : { "name" : "Alison Ferguso", "id" : "5168015d32f890ca15812c9180835d2e", "type" : "IDENTITY", "email" : "alison.ferguso@identitysoon.com" }, "maxReminders" : 1, "daysUntilEscalation" : 0, "daysBetweenReminders" : 0 }, "autoApprovalEnabled" : true, "entitlementRequestConfig" : { "requestCommentsRequired" : false, "deniedCommentsRequired" : false, "allowEntitlementRequest" : true, "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" }, "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) - path: /account-activities/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/account-activities#get-account-activity 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) except Exception as e: print("Exception when calling AccountActivitiesApi->get_account_activity: %s\n" % e) - path: /account-activities method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/account-activities#list-account-activities source: | 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) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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 = '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) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) - path: /account-aggregations/{id}/status method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/account-aggregations#get-account-aggregation-status source: | 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) except Exception as 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 = { "attributes" : { "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", "city" : "Austin", "displayName" : "John Doe", "userName" : "jdoe", "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) - path: /accounts/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#delete-account 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) except Exception as e: print("Exception when calling AccountsApi->delete_account: %s\n" % e) - path: /accounts/{id}/remove method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#delete-account-async source: | 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) except Exception as e: print("Exception when calling AccountsApi->delete_account_async: %s\n" % e) - path: /accounts/{id}/disable method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#disable-account source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id 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) - path: /identities-accounts/{id}/disable method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#disable-account-for-identity source: | 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) except Exception as 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/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 = { "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) - path: /accounts/{id}/enable method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#enable-account source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id 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) - path: /identities-accounts/{id}/enable method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#enable-account-for-identity source: | 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) except Exception as 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/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 = { "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) - path: /accounts/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#get-account 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) except Exception as e: print("Exception when calling AccountsApi->get_account: %s\n" % e) - path: /accounts/{id}/entitlements method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#get-account-entitlements source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as e: print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) - path: /accounts method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#list-accounts 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) 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) 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) except Exception as e: print("Exception when calling AccountsApi->list_accounts: %s\n" % e) - path: /accounts/{id} method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#put-account source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. account_attributes = { "attributes" : { "city" : "Austin", "displayName" : "John Doe", "userName" : "jdoe", "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) - path: /accounts/{id}/reload method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#submit-reload-account 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) except Exception as e: print("Exception when calling AccountsApi->submit_reload_account: %s\n" % e) - path: /accounts/{id}/unlock method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/accounts#unlock-account source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. # str | The account ID. 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) - path: /accounts/{id} method: PATCH xCodeSample: - lang: Python 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) - path: /account-usages/{accountId}/summaries method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/account-usages#get-usages-by-account-id source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as e: print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/application-discovery#get-discovered-applications 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) 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) 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) except Exception as e: print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) - path: /manual-discover-applications-template method: GET xCodeSample: - lang: Python 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) except Exception as e: print("Exception when calling ApplicationDiscoveryApi->get_manual_discover_applications_csv_template: %s\n" % e) - path: /manual-discover-applications method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/application-discovery#send-manual-discover-applications-csv-template 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) except Exception as e: print("Exception when calling ApplicationDiscoveryApi->send_manual_discover_applications_csv_template: %s\n" % e) - path: /generic-approvals/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/approvals#get-approval source: | 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) except Exception as e: print("Exception when calling ApprovalsApi->get_approval: %s\n" % e) - path: /generic-approvals method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/approvals#get-approvals 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') 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) 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) except Exception as e: print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) - path: /source-apps method: POST xCodeSample: - lang: Python 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 = { "name" : "my app", "description" : "the source app for engineers", "accountSource" : { "name" : "ODS-AD-Source", "id" : "2c9180827ca885d7017ca8ce28a000eb", "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) - path: /source-apps/{id}/access-profiles/bulk-remove method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/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 x_sail_point_experimental = 'true' # 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] | limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) except Exception as e: print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) - path: /source-apps/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#delete-source-app source: | 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) except Exception as e: print("Exception when calling AppsApi->delete_source_app: %s\n" % e) - path: /source-apps/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#get-source-app 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') 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) except Exception as e: print("Exception when calling AppsApi->get_source_app: %s\n" % e) - path: /source-apps/{id}/access-profiles method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#list-access-profiles-for-source-app 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') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) except Exception as e: print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) - path: /source-apps/all method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#list-all-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') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) 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) except Exception as e: print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) - path: /user-apps/all method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#list-all-user-apps source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as e: print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) - path: /source-apps/assigned method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#list-assigned-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') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) 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) except Exception as e: print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) - path: /user-apps/{id}/available-accounts method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#list-available-accounts-for-user-app source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as e: print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) - path: /source-apps method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#list-available-source-apps 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') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) 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) except Exception as e: print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) - path: /user-apps method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#list-owned-user-apps 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') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) 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) except Exception as e: print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) - path: /source-apps/{id} method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#patch-source-app 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) - path: /user-apps/{id} method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/apps#patch-user-app 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) - path: /source-apps/bulk-update method: POST xCodeSample: - lang: Python 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 = { "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], "jsonPatch" : [ { "op" : "replace", "path" : "/enabled", "value" : false }, { "op" : "replace", "path" : "/matchAllAccounts", "value" : false } ] } # 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) except Exception as e: print("Exception when calling AppsApi->update_source_apps_in_bulk: %s\n" % e) - path: /auth-profiles/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/auth-profile#get-profile-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') 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) except Exception as e: print("Exception when calling AuthProfileApi->get_profile_config: %s\n" % e) - path: /auth-profiles method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/auth-profile#get-profile-config-list 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) except Exception as e: print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) - path: /auth-profiles/{id} method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/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. x_sail_point_experimental = 'true' # 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) - path: /auth-users/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/auth-users#get-auth-user 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) except Exception as e: print("Exception when calling AuthUsersApi->get_auth_user: %s\n" % e) - path: /auth-users/{id} method: PATCH xCodeSample: - lang: Python 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) - path: /brandings method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/branding#create-branding-item source: | 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) active_link_color = 'active_link_color_example' # str | hex value of color for link (optional) # str | hex value of color for link (optional) navigation_color = 'navigation_color_example' # str | hex value of color for navigation bar (optional) # str | hex value of color for navigation bar (optional) email_from_address = 'email_from_address_example' # str | email from address (optional) # str | email from address (optional) 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) except Exception as e: print("Exception when calling BrandingApi->create_branding_item: %s\n" % e) - path: /brandings/{name} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/branding#delete-branding 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) except Exception as e: print("Exception when calling BrandingApi->delete_branding: %s\n" % e) - path: /brandings/{name} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/branding#get-branding 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) except Exception as e: print("Exception when calling BrandingApi->get_branding: %s\n" % e) - path: /brandings method: GET xCodeSample: - lang: Python 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) except Exception as e: print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) - path: /brandings/{name} method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/branding#set-branding-item source: | 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 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) active_link_color = 'active_link_color_example' # str | hex value of color for link (optional) # str | hex value of color for link (optional) navigation_color = 'navigation_color_example' # str | hex value of color for navigation bar (optional) # str | hex value of color for navigation bar (optional) email_from_address = 'email_from_address_example' # str | email from address (optional) # str | email from address (optional) 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) except Exception as 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 = { "owner" : "SailPoint Support", "mode" : "INCLUSION", "isSystemFilter" : false, "name" : "Identity Attribute Campaign Filter", "description" : "Campaign filter to certify data based on an identity attribute's specified property.", "id" : "5ec18cef39020d6fd7a60ad3970aba61", "criteriaList" : [ { "type" : "IDENTITY_ATTRIBUTE", "property" : "displayName", "value" : "support", "operation" : "CONTAINS", "negateResult" : false, "shortCircuit" : false, "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) - 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. 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) except Exception as e: print("Exception when calling CertificationCampaignFiltersApi->delete_campaign_filters: %s\n" % e) - path: /campaign-filters/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaign-filters#get-campaign-filter-by-id 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) except Exception as e: print("Exception when calling CertificationCampaignFiltersApi->get_campaign_filter_by_id: %s\n" % e) - path: /campaign-filters method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaign-filters#list-campaign-filters 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) 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) except Exception as e: print("Exception when calling CertificationCampaignFiltersApi->list_campaign_filters: %s\n" % e) - path: /campaign-filters/{id} method: POST xCodeSample: - lang: Python 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 = { "owner" : "SailPoint Support", "mode" : "INCLUSION", "isSystemFilter" : false, "name" : "Identity Attribute Campaign Filter", "description" : "Campaign filter to certify data based on an identity attribute's specified property.", "id" : "5ec18cef39020d6fd7a60ad3970aba61", "criteriaList" : [ { "type" : "IDENTITY_ATTRIBUTE", "property" : "displayName", "value" : "support", "operation" : "CONTAINS", "negateResult" : false, "shortCircuit" : false, "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) - path: /campaigns/{id}/complete method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#complete-campaign source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID. 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) - path: /campaigns method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#create-campaign source: | campaign = { "totalCertifications" : 100, "sourcesWithOrphanEntitlements" : [ { "name" : "Source with orphan entitlements", "id" : "2c90ad2a70ace7d50170acf22ca90010", "type" : "SOURCE" }, { "name" : "Source with orphan entitlements", "id" : "2c90ad2a70ace7d50170acf22ca90010", "type" : "SOURCE" } ], "recommendationsEnabled" : true, "sunsetCommentsRequired" : true, "created" : "2020-03-03T22:15:13.611Z", "machineAccountCampaignInfo" : { "reviewerType" : "ACCOUNT_OWNER", "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] }, "description" : "Everyone needs to be reviewed by their manager", "type" : "MANAGER", "sourceOwnerCampaignInfo" : { "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] }, "emailNotificationEnabled" : false, "alerts" : [ { "level" : "ERROR", "localizations" : [ { "localeOrigin" : "DEFAULT", "text" : "The request was syntactically correct but its content is semantically invalid.", "locale" : "en-US" }, { "localeOrigin" : "DEFAULT", "text" : "The request was syntactically correct but its content is semantically invalid.", "locale" : "en-US" } ] }, { "level" : "ERROR", "localizations" : [ { "localeOrigin" : "DEFAULT", "text" : "The request was syntactically correct but its content is semantically invalid.", "locale" : "en-US" }, { "localeOrigin" : "DEFAULT", "text" : "The request was syntactically correct but its content is semantically invalid.", "locale" : "en-US" } ] } ], "filter" : { "name" : "Test Filter", "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", "type" : "CAMPAIGN_FILTER" }, "searchCampaignInfo" : { "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], "query" : "Search Campaign query description", "description" : "Search Campaign description", "reviewer" : { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, "type" : "ACCESS", "accessConstraints" : [ { "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], "type" : "ENTITLEMENT", "operator" : "SELECTED" }, { "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], "type" : "ENTITLEMENT", "operator" : "SELECTED" }, { "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], "type" : "ENTITLEMENT", "operator" : "SELECTED" }, { "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], "type" : "ENTITLEMENT", "operator" : "SELECTED" }, { "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], "type" : "ENTITLEMENT", "operator" : "SELECTED" } ] }, "autoRevokeAllowed" : false, "name" : "Manager Campaign", "mandatoryCommentRequirement" : "NO_DECISIONS", "modified" : "2020-03-03T22:20:12.674Z", "roleCompositionCampaignInfo" : { "remediatorRef" : { "name" : "Role Admin", "id" : "2c90ad2a70ace7d50170acf22ca90010", "type" : "IDENTITY" }, "reviewerId" : "2c91808568c529c60168cca6f90c1313", "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], "query" : "Search Query", "description" : "Role Composition Description", "reviewer" : { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" } }, "completedCertifications" : 10, "id" : "2c9079b270a266a60170a2779fcb0007", "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) - path: /campaign-templates method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#create-campaign-template source: | campaign_template = { "ownerRef" : { "name" : "Mister Manager", "id" : "2c918086676d3e0601677611dbde220f", "type" : "IDENTITY", "email" : "mr.manager@example.com" }, "deadlineDuration" : "P2W", "created" : "2020-03-05T22:44:00.364Z", "scheduled" : false, "name" : "Manager Campaign Template", "description" : "Template for the annual manager campaign.", "modified" : "2020-03-05T22:52:09.969Z", "campaign" : { "totalCertifications" : 100, "sourcesWithOrphanEntitlements" : [ { "name" : "Source with orphan entitlements", "id" : "2c90ad2a70ace7d50170acf22ca90010", "type" : "SOURCE" }, { "name" : "Source with orphan entitlements", "id" : "2c90ad2a70ace7d50170acf22ca90010", "type" : "SOURCE" } ], "recommendationsEnabled" : true, "sunsetCommentsRequired" : true, "created" : "2020-03-03T22:15:13.611Z", "machineAccountCampaignInfo" : { "reviewerType" : "ACCOUNT_OWNER", "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] }, "description" : "Everyone needs to be reviewed by their manager", "type" : "MANAGER", "sourceOwnerCampaignInfo" : { "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] }, "emailNotificationEnabled" : false, "alerts" : [ { "level" : "ERROR", "localizations" : [ { "localeOrigin" : "DEFAULT", "text" : "The request was syntactically correct but its content is semantically invalid.", "locale" : "en-US" }, { "localeOrigin" : "DEFAULT", "text" : "The request was syntactically correct but its content is semantically invalid.", "locale" : "en-US" } ] }, { "level" : "ERROR", "localizations" : [ { "localeOrigin" : "DEFAULT", "text" : "The request was syntactically correct but its content is semantically invalid.", "locale" : "en-US" }, { "localeOrigin" : "DEFAULT", "text" : "The request was syntactically correct but its content is semantically invalid.", "locale" : "en-US" } ] } ], "filter" : { "name" : "Test Filter", "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", "type" : "CAMPAIGN_FILTER" }, "searchCampaignInfo" : { "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], "query" : "Search Campaign query description", "description" : "Search Campaign description", "reviewer" : { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, "type" : "ACCESS", "accessConstraints" : [ { "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], "type" : "ENTITLEMENT", "operator" : "SELECTED" }, { "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], "type" : "ENTITLEMENT", "operator" : "SELECTED" }, { "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], "type" : "ENTITLEMENT", "operator" : "SELECTED" }, { "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], "type" : "ENTITLEMENT", "operator" : "SELECTED" }, { "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], "type" : "ENTITLEMENT", "operator" : "SELECTED" } ] }, "autoRevokeAllowed" : false, "name" : "Manager Campaign", "mandatoryCommentRequirement" : "NO_DECISIONS", "modified" : "2020-03-03T22:20:12.674Z", "roleCompositionCampaignInfo" : { "remediatorRef" : { "name" : "Role Admin", "id" : "2c90ad2a70ace7d50170acf22ca90010", "type" : "IDENTITY" }, "reviewerId" : "2c91808568c529c60168cca6f90c1313", "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], "query" : "Search Query", "description" : "Role Composition Description", "reviewer" : { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" } }, "completedCertifications" : 10, "id" : "2c9079b270a266a60170a2779fcb0007", "deadline" : "2020-03-15T10:00:01.456Z", "status" : "ACTIVE", "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) - path: /campaign-templates/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#delete-campaign-template 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) except Exception as e: print("Exception when calling CertificationCampaignsApi->delete_campaign_template: %s\n" % e) - path: /campaign-templates/{id}/schedule method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#delete-campaign-template-schedule 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) except Exception as 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 = { "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) - path: /campaigns method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-active-campaigns source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 \"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) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) - path: /campaigns/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign source: | 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) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e) - path: /campaigns/{id}/reports method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign-reports 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) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) - path: /campaigns/reports-configuration method: GET xCodeSample: - lang: Python 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) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e) - path: /campaign-templates/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign-template 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) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e) - path: /campaign-templates/{id}/schedule method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign-template-schedule 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) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e) - path: /campaign-templates method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#get-campaign-templates 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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' # str | Sort results using the standard syntax described 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) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) - path: /campaigns/{id}/reassign method: POST xCodeSample: - lang: Python 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 = { "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) - path: /campaign-templates/{id} method: PATCH xCodeSample: - lang: Python 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) - 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 = { "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) - path: /campaign-templates/{id}/schedule method: PUT xCodeSample: - lang: Python 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 = { "hours" : { "values" : [ "1" ], "interval" : 2, "type" : "LIST" }, "months" : { "values" : [ "1" ], "interval" : 2, "type" : "LIST" }, "timeZoneId" : "CST", "days" : { "values" : [ "1" ], "interval" : 2, "type" : "LIST" }, "expiration" : "2000-01-23T04:56:07.000+00:00", "type" : "WEEKLY" } # 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) except Exception as e: print("Exception when calling CertificationCampaignsApi->set_campaign_template_schedule: %s\n" % e) - path: /campaigns/{id}/activate method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#start-campaign source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID. 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) - path: /campaigns/{id}/run-remediation-scan method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#start-campaign-remediation-scan 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) except Exception as e: print("Exception when calling CertificationCampaignsApi->start_campaign_remediation_scan: %s\n" % e) - path: /campaigns/{id}/run-report/{type} method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#start-campaign-report source: | 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) except Exception as e: print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e) - path: /campaign-templates/{id}/generate method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-campaigns#start-generate-campaign-template 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) except Exception as e: print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e) - path: /campaigns/{id} method: PATCH xCodeSample: - lang: Python 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) - path: /certification-tasks/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certifications#get-certification-task 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) except Exception as e: print("Exception when calling CertificationsApi->get_certification_task: %s\n" % e) - path: /certifications/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certifications#get-identity-certification 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) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification: %s\n" % e) - path: /certifications/{certificationId}/access-review-items/{itemId}/permissions method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certifications#get-identity-certification-item-permissions source: | 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) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) - path: /certification-tasks method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certifications#get-pending-certification-tasks source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as e: print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) - path: /certifications/{id}/reviewers method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certifications#list-certification-reviewers source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 \"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) except Exception as e: print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) - path: /certifications/{id}/access-review-items method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certifications#list-identity-access-review-items source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = '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* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **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: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) sorters = 'access.name,-accessProfile.sourceName' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) entitlements = 'identityEntitlement' # str | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** 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 entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) 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) except Exception as e: print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) - path: /certifications method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certifications#list-identity-certifications source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = '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) except Exception as e: print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) - path: /certifications/{id}/decide method: POST xCodeSample: - lang: Python 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) - path: /certifications/{id}/reassign method: POST xCodeSample: - lang: Python 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 = { "reason" : "reassigned for some reason", "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", "reassign" : [ { "id" : "ef38f94347e94562b5bb8424a56397d8", "type" : "ITEM" }, { "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) - path: /certifications/{id}/sign-off method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certifications#sign-off-identity-certification 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) except Exception as e: print("Exception when calling CertificationsApi->sign_off_identity_certification: %s\n" % e) - path: /certifications/{id}/reassign-async method: POST xCodeSample: - lang: Python 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 = { "reason" : "reassigned for some reason", "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", "reassign" : [ { "id" : "ef38f94347e94562b5bb8424a56397d8", "type" : "ITEM" }, { "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) - path: /certifications/{id}/access-summaries/{type} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-access-summaries source: | 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) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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 = '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) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) - path: /certifications/{id}/decision-summary method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-decision-summary source: | 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) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) - path: /certifications/{id}/identity-summaries method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summaries source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = '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) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) - path: /certifications/{id}/identity-summaries/{identitySummaryId} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/certification-summaries#get-identity-summary source: | 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) except Exception as 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 = { "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) - path: /configuration-hub/object-mappings/{sourceOrg} method: POST xCodeSample: - lang: Python 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 = { "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) - path: /configuration-hub/object-mappings/{sourceOrg}/bulk-create method: POST xCodeSample: - lang: Python 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 = { "newObjectsMappings" : [ { "targetValue" : "My New Governance Group Name", "jsonPath" : "$.name", "sourceValue" : "My Governance Group Name", "enabled" : false, "objectType" : "IDENTITY" }, { "targetValue" : "My New Governance Group Name", "jsonPath" : "$.name", "sourceValue" : "My Governance Group Name", "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) - path: /configuration-hub/backups/uploads method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#create-uploaded-configuration source: | 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) except Exception as e: print("Exception when calling ConfigurationHubApi->create_uploaded_configuration: %s\n" % e) - path: /configuration-hub/backups/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#delete-backup 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) except Exception as e: print("Exception when calling ConfigurationHubApi->delete_backup: %s\n" % e) - path: /configuration-hub/drafts/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#delete-draft 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) except Exception as e: print("Exception when calling ConfigurationHubApi->delete_draft: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#delete-object-mapping source: | 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) except Exception as e: print("Exception when calling ConfigurationHubApi->delete_object_mapping: %s\n" % e) - path: /configuration-hub/backups/uploads/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#delete-uploaded-configuration 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) except Exception as e: print("Exception when calling ConfigurationHubApi->delete_uploaded_configuration: %s\n" % e) - path: /configuration-hub/deploys/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#get-deploy 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) except Exception as e: print("Exception when calling ConfigurationHubApi->get_deploy: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#get-object-mappings 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) except Exception as e: print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) - path: /configuration-hub/backups/uploads/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#get-uploaded-configuration 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) except Exception as e: print("Exception when calling ConfigurationHubApi->get_uploaded_configuration: %s\n" % e) - path: /configuration-hub/backups method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#list-backups 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) except Exception as e: print("Exception when calling ConfigurationHubApi->list_backups: %s\n" % e) - path: /configuration-hub/deploys method: GET xCodeSample: - lang: Python 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) except Exception as e: print("Exception when calling ConfigurationHubApi->list_deploys: %s\n" % e) - path: /configuration-hub/drafts method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#list-drafts 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) except Exception as e: print("Exception when calling ConfigurationHubApi->list_drafts: %s\n" % e) - path: /configuration-hub/backups/uploads method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/configuration-hub#list-uploaded-configurations 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) except Exception as e: print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch method: POST xCodeSample: - lang: Python 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 = { "patches" : { "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { "op" : "replace", "path" : "/enabled", "value" : true } ], "00bece34-f50d-4227-8878-76f620b5a971" : [ { "op" : "replace", "path" : "/targetValue", "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) - path: /connector-rules method: POST xCodeSample: - lang: Python 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 = { "sourceCode" : { "version" : "1.0", "script" : "return \"Mr. \" + firstName;" }, "signature" : { "output" : { "name" : "firstName", "description" : "the first name of the identity", "type" : "String" }, "input" : [ { "name" : "firstName", "description" : "the first name of the identity", "type" : "String" }, { "name" : "firstName", "description" : "the first name of the identity", "type" : "String" } ] }, "name" : "WebServiceBeforeOperationRule", "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) - path: /connector-rules/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#delete-connector-rule source: | 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) except Exception as e: print("Exception when calling ConnectorRuleManagementApi->delete_connector_rule: %s\n" % e) - path: /connector-rules/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#get-connector-rule source: | 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) except Exception as e: print("Exception when calling ConnectorRuleManagementApi->get_connector_rule: %s\n" % e) - path: /connector-rules method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#get-connector-rule-list 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') 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as e: print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) - path: /connector-rules/{id} method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/connector-rule-management#put-connector-rule 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 = { "sourceCode" : { "version" : "1.0", "script" : "return \"Mr. \" + firstName;" }, "signature" : { "output" : { "name" : "firstName", "description" : "the first name of the identity", "type" : "String" }, "input" : [ { "name" : "firstName", "description" : "the first name of the identity", "type" : "String" }, { "name" : "firstName", "description" : "the first name of the identity", "type" : "String" } ] }, "name" : "WebServiceBeforeOperationRule", "description" : "This rule does that", "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) - path: /connector-rules/validate method: POST xCodeSample: - lang: Python 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 = { "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) - path: /connectors method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#create-custom-connector source: | 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) - path: /connectors/{scriptName} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#delete-custom-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. 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) except Exception as e: print("Exception when calling ConnectorsApi->delete_custom_connector: %s\n" % e) - path: /connectors/{scriptName} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#get-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. 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) except Exception as e: print("Exception when calling ConnectorsApi->get_connector: %s\n" % e) - path: /connectors/{scriptName}/correlation-config method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector-correlation-config 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) except Exception as e: print("Exception when calling ConnectorsApi->get_connector_correlation_config: %s\n" % e) - path: /connectors method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector-list source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as e: print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) - path: /connectors/{scriptName}/source-config method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector-source-config 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) except Exception as e: print("Exception when calling ConnectorsApi->get_connector_source_config: %s\n" % e) - path: /connectors/{scriptName}/source-template method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector-source-template 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) except Exception as e: print("Exception when calling ConnectorsApi->get_connector_source_template: %s\n" % e) - path: /connectors/{scriptName}/translations/{locale} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#get-connector-translations 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. 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) except Exception as e: print("Exception when calling ConnectorsApi->get_connector_translations: %s\n" % e) - path: /connectors/{scriptName}/correlation-config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#put-connector-correlation-config 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. 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) except Exception as e: print("Exception when calling ConnectorsApi->put_connector_correlation_config: %s\n" % e) - path: /connectors/{scriptName}/source-config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#put-connector-source-config 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. 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) except Exception as e: print("Exception when calling ConnectorsApi->put_connector_source_config: %s\n" % e) - path: /connectors/{scriptName}/source-template method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#put-connector-source-template 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. 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) except Exception as e: print("Exception when calling ConnectorsApi->put_connector_source_template: %s\n" % e) - path: /connectors/{scriptName}/translations/{locale} method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/connectors#put-connector-translations 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. 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) except Exception as e: print("Exception when calling ConnectorsApi->put_connector_translations: %s\n" % e) - path: /connectors/{scriptName} method: PATCH xCodeSample: - lang: Python 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) - path: /form-definitions method: POST xCodeSample: - lang: Python 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 = { "owner" : { "name" : "Grant Smith", "id" : "2c9180867624cbd7017642d8c8c81f67", "type" : "IDENTITY" }, "formConditions" : [ { "ruleOperator" : "AND", "effects" : [ { "config" : { "defaultValueLabel" : "Access to Remove", "element" : "8110662963316867" }, "effectType" : "HIDE" }, { "config" : { "defaultValueLabel" : "Access to Remove", "element" : "8110662963316867" }, "effectType" : "HIDE" } ], "rules" : [ { "sourceType" : "ELEMENT", "valueType" : "STRING", "source" : "department", "value" : "Engineering", "operator" : "EQ" }, { "sourceType" : "ELEMENT", "valueType" : "STRING", "source" : "department", "value" : "Engineering", "operator" : "EQ" } ] }, { "ruleOperator" : "AND", "effects" : [ { "config" : { "defaultValueLabel" : "Access to Remove", "element" : "8110662963316867" }, "effectType" : "HIDE" }, { "config" : { "defaultValueLabel" : "Access to Remove", "element" : "8110662963316867" }, "effectType" : "HIDE" } ], "rules" : [ { "sourceType" : "ELEMENT", "valueType" : "STRING", "source" : "department", "value" : "Engineering", "operator" : "EQ" }, { "sourceType" : "ELEMENT", "valueType" : "STRING", "source" : "department", "value" : "Engineering", "operator" : "EQ" } ] } ], "formInput" : [ { "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", "id" : "00000000-0000-0000-0000-000000000000", "label" : "input1", "type" : "STRING" }, { "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", "id" : "00000000-0000-0000-0000-000000000000", "label" : "input1", "type" : "STRING" } ], "name" : "My form", "description" : "My form description", "usedBy" : [ { "name" : "Access Request Form", "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", "type" : "WORKFLOW" }, { "name" : "Access Request Form", "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", "type" : "WORKFLOW" } ], "formElements" : [ { "id" : "00000000-0000-0000-0000-000000000000", "validations" : [ { "validationType" : "REQUIRED" }, { "validationType" : "REQUIRED" } ], "elementType" : "TEXT", "config" : { "label" : "Department" }, "key" : "department" }, { "id" : "00000000-0000-0000-0000-000000000000", "validations" : [ { "validationType" : "REQUIRED" }, { "validationType" : "REQUIRED" } ], "elementType" : "TEXT", "config" : { "label" : "Department" }, "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) - path: /form-definitions/forms-action-dynamic-schema method: POST xCodeSample: - lang: Python 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 = { "description" : "A description", "attributes" : { "formDefinitionId" : "00000000-0000-0000-0000-000000000000" }, "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) - path: /form-definitions/{formDefinitionID}/upload method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#create-form-definition-file-request source: | 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 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) except Exception as 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/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 = { "formInput" : { "input1" : "Sales" }, "standAloneForm" : false, "createdBy" : { "id" : "00000000-0000-0000-0000-000000000000", "type" : "WORKFLOW_EXECUTION" }, "recipients" : [ { "id" : "00000000-0000-0000-0000-000000000000", "type" : "IDENTITY" }, { "id" : "00000000-0000-0000-0000-000000000000", "type" : "IDENTITY" } ], "expire" : "2023-08-12T20:14:57.74486Z", "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) - path: /form-definitions/{formDefinitionID} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#delete-form-definition 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') 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) except Exception as e: print("Exception when calling CustomFormsApi->delete_form_definition: %s\n" % e) - path: /form-definitions/export method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#export-form-definitions-by-tenant 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') 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) 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) except Exception as e: print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) - path: /form-definitions/{formDefinitionID}/file/{fileID} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#get-file-from-s3 source: | 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') 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) except Exception as e: print("Exception when calling CustomFormsApi->get_file_from_s3: %s\n" % e) - path: /form-definitions/{formDefinitionID} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#get-form-definition-by-key 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') 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) except Exception as e: print("Exception when calling CustomFormsApi->get_form_definition_by_key: %s\n" % e) - path: /form-instances/{formInstanceID} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#get-form-instance-by-key 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') 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) except Exception as e: print("Exception when calling CustomFormsApi->get_form_instance_by_key: %s\n" % e) - path: /form-instances/{formInstanceID}/file/{fileID} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#get-form-instance-file source: | 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') 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) except Exception as 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/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) 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) except Exception as e: print("Exception when calling CustomFormsApi->import_form_definitions: %s\n" % e) - path: /form-definitions/{formDefinitionID} method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#patch-form-definition 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) 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) except Exception as e: print("Exception when calling CustomFormsApi->patch_form_definition: %s\n" % e) - path: /form-instances/{formInstanceID} method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#patch-form-instance 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) 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) except Exception as e: print("Exception when calling CustomFormsApi->patch_form_instance: %s\n" % e) - path: /form-definitions method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#search-form-definitions-by-tenant 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') 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) 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) except Exception as e: print("Exception when calling CustomFormsApi->search_form_definitions_by_tenant: %s\n" % e) - path: /form-instances/{formInstanceID}/data-source/{formElementID} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#search-form-element-data-by-element-id source: | 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') 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 = '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) except Exception as e: print("Exception when calling CustomFormsApi->search_form_element_data_by_element_id: %s\n" % e) - path: /form-instances method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#search-form-instances-by-tenant 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) except Exception as e: print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) - path: /form-definitions/predefined-select-options method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#search-pre-defined-select-options 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) except Exception as e: print("Exception when calling CustomFormsApi->search_pre_defined_select_options: %s\n" % e) - path: /form-definitions/{formDefinitionID}/data-source method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-forms#show-preview-data-source 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') 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 = { "dataSource" : { "config" : { "indices" : [ "identities" ], "query" : "*", "aggregationBucketField" : "attributes.cloudStatus.exact", "objectType" : "IDENTITY" }, "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) - path: /custom-password-instructions method: POST xCodeSample: - lang: Python 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 = { "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) - path: /custom-password-instructions/{pageId} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-password-instructions#delete-custom-password-instructions source: | 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) 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) except Exception as e: print("Exception when calling CustomPasswordInstructionsApi->delete_custom_password_instructions: %s\n" % e) - path: /custom-password-instructions/{pageId} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/custom-password-instructions#get-custom-password-instructions source: | 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) 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) except Exception as 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 | 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) except Exception as e: print("Exception when calling DataSegmentationApi->create_data_segment: %s\n" % e) - path: /data-segments/{segmentId} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/data-segmentation#delete-data-segment source: | 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) 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) except Exception as e: print("Exception when calling DataSegmentationApi->delete_data_segment: %s\n" % e) - path: /data-segments/{segmentId} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/data-segmentation#get-data-segment source: | 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) except Exception as e: print("Exception when calling DataSegmentationApi->get_data_segment: %s\n" % e) - path: /data-segments/membership/{identityId} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/data-segmentation#get-data-segment-identity-membership source: | 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) except Exception as e: print("Exception when calling DataSegmentationApi->get_data_segment_identity_membership: %s\n" % e) - path: /data-segments/user-enabled/{identityId} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/data-segmentation#get-data-segmentation-enabled-for-user source: | 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) except Exception as e: print("Exception when calling DataSegmentationApi->get_data_segmentation_enabled_for_user: %s\n" % e) - path: /data-segments method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/data-segmentation#list-data-segments 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') 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) published = True # bool | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to True) # bool | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as e: print("Exception when calling DataSegmentationApi->list_data_segments: %s\n" % e) - path: /data-segments/{segmentId} method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/data-segmentation#patch-data-segment 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 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) except Exception as e: print("Exception when calling DataSegmentationApi->patch_data_segment: %s\n" % e) - path: /data-segments/{segmentId} method: POST xCodeSample: - lang: Python 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 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) except Exception as e: print("Exception when calling DataSegmentationApi->publish_data_segment: %s\n" % e) - path: /roles/{roleId}/dimensions method: POST xCodeSample: - lang: Python 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 = { "owner" : { "name" : "support", "id" : "2c9180a46faadee4016fb4e018c20639", "type" : "IDENTITY" }, "entitlements" : [ { "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", "id" : "2c91809773dee32014e13e122092014e", "type" : "ENTITLEMENT" }, { "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", "id" : "2c91809773dee32014e13e122092014e", "type" : "ENTITLEMENT" } ], "accessProfiles" : [ { "name" : "Access Profile 2567", "id" : "ff808081751e6e129f1518161919ecca", "type" : "ACCESS_PROFILE" }, { "name" : "Access Profile 2567", "id" : "ff808081751e6e129f1518161919ecca", "type" : "ACCESS_PROFILE" } ], "created" : "2021-03-01T22:32:58.104Z", "name" : "Dimension 2567", "modified" : "2021-03-02T20:22:28.104Z", "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", "id" : "2c918086749d78830174a1a40e121518", "membership" : { "criteria" : { "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", "children" : [ { "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", "children" : [ { "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", "operation" : "EQUALS", "key" : { "property" : "attribute.email", "type" : "IDENTITY" } }, { "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", "operation" : "EQUALS", "key" : { "property" : "attribute.email", "type" : "IDENTITY" } } ], "operation" : "EQUALS", "key" : { "property" : "attribute.email", "type" : "IDENTITY" } }, { "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", "children" : [ { "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", "operation" : "EQUALS", "key" : { "property" : "attribute.email", "type" : "IDENTITY" } }, { "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", "operation" : "EQUALS", "key" : { "property" : "attribute.email", "type" : "IDENTITY" } } ], "operation" : "EQUALS", "key" : { "property" : "attribute.email", "type" : "IDENTITY" } } ], "operation" : "EQUALS", "key" : { "property" : "attribute.email", "type" : "IDENTITY" } }, "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) - path: /roles/{roleId}/dimensions/bulk-delete method: POST xCodeSample: - lang: Python 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 = { "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) - path: /roles/{roleId}/dimensions/{dimensionId} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/dimensions#delete-dimension 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 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) except Exception as e: print("Exception when calling DimensionsApi->delete_dimension: %s\n" % e) - path: /roles/{roleId}/dimensions/{dimensionId} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/dimensions#get-dimension 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 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) except Exception as e: print("Exception when calling DimensionsApi->get_dimension: %s\n" % e) - path: /roles/{roleId}/dimensions/{dimensionId}/entitlements method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/dimensions#get-dimension-entitlements 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 limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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 = '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) except Exception as e: print("Exception when calling DimensionsApi->get_dimension_entitlements: %s\n" % e) - path: /roles/{roleId}/dimensions/{dimensionId}/access-profiles method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/dimensions#list-dimension-access-profiles 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 limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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 = '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) except Exception as e: print("Exception when calling DimensionsApi->list_dimension_access_profiles: %s\n" % e) - path: /roles/{roleId}/dimensions method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/dimensions#list-dimensions source: | 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) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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 = '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) except Exception as e: print("Exception when calling DimensionsApi->list_dimensions: %s\n" % e) - path: /roles/{roleId}/dimensions/{dimensionId} method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/dimensions#patch-dimension 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) - path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#create-access-model-metadata-for-entitlement source: | 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. x_sail_point_experimental = 'true' # str | 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) except Exception as 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: - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#delete-access-model-metadata-from-entitlement source: | 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. x_sail_point_experimental = 'true' # str | 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) except Exception as e: print("Exception when calling EntitlementsApi->delete_access_model_metadata_from_entitlement: %s\n" % e) - path: /entitlements/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#get-entitlement source: | 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) except Exception as e: print("Exception when calling EntitlementsApi->get_entitlement: %s\n" % e) - path: /entitlements/{id}/entitlement-request-config method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#get-entitlement-request-config source: | 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) except Exception as e: print("Exception when calling EntitlementsApi->get_entitlement_request_config: %s\n" % e) - path: /entitlements/aggregate/sources/{id} method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#import-entitlements-by-source source: | 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) 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) except Exception as e: print("Exception when calling EntitlementsApi->import_entitlements_by_source: %s\n" % e) - path: /entitlements/{id}/children method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#list-entitlement-children source: | 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) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) 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) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) - path: /entitlements/{id}/parents method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#list-entitlement-parents source: | 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) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) 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) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) - path: /entitlements method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#list-entitlements 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') 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) 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) include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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: **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) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) - path: /entitlements/{id} method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#patch-entitlement 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) - path: /entitlements/{id}/entitlement-request-config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#put-entitlement-request-config 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 = { "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) - path: /entitlements/reset/sources/{id} method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/entitlements#reset-source-entitlements source: | 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) except Exception as 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/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 = { "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], "jsonPatch" : [ { "op" : "replace", "path" : "/privileged", "value" : false }, { "op" : "replace", "path" : "/requestable", "value" : false } ] } # 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) except Exception as 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 = { "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) - path: /auth-org/network-config method: GET xCodeSample: - lang: Python 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) except Exception as 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) - path: /workgroups method: POST xCodeSample: - lang: Python 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 = { "owner" : { "emailAddress" : "support@sailpoint.com", "displayName" : "Support", "name" : "Support", "id" : "2c9180a46faadee4016fb4e018c20639", "type" : "IDENTITY" }, "connectionCount" : 1641498673000, "created" : "2022-01-06T19:51:13Z", "memberCount" : 1641498673000, "name" : "DB Access Governance Group", "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) - path: /workgroups/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/governance-groups#delete-workgroup 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') 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) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroup: %s\n" % e) - path: /workgroups/{workgroupId}/members/bulk-delete method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/governance-groups#delete-workgroup-members 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. 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) 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/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 = { "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) - path: /workgroups/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/governance-groups#get-workgroup 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') 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) except Exception as e: print("Exception when calling GovernanceGroupsApi->get_workgroup: %s\n" % e) - path: /workgroups/{workgroupId}/connections method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/governance-groups#list-connections 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') offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) 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) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) - path: /workgroups/{workgroupId}/members method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/governance-groups#list-workgroup-members 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') offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) 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) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) - path: /workgroups method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/governance-groups#list-workgroups 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') offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) 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) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) - path: /workgroups/{id} method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/governance-groups#patch-workgroup 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) - path: /workgroups/{workgroupId}/members/bulk-add method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/governance-groups#update-workgroup-members 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. 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) 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/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" : { "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) - path: /ai-access-request-recommendations/requested-items method: POST xCodeSample: - lang: Python 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" : { "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) - path: /ai-access-request-recommendations/viewed-items method: POST xCodeSample: - lang: Python 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" : { "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) - path: /ai-access-request-recommendations/viewed-items/bulk-create method: POST xCodeSample: - lang: Python 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) - path: /ai-access-request-recommendations method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-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') 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) include_translation_messages = False # bool | If *true* it will populate a list of translation messages in the response. (optional) (default to False) # bool | If *true* it will populate a list of translation messages in the response. (optional) (default to False) 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) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) - path: /ai-access-request-recommendations/config method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-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') 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) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_config: %s\n" % e) - path: /ai-access-request-recommendations/ignored-items method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-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') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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 = '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) except Exception as 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: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-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') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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 = '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) except Exception as 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: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-access-request-recommendations#get-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') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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 = '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) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) - path: /ai-access-request-recommendations/config method: PUT xCodeSample: - lang: Python 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 = { "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) - path: /common-access method: POST xCodeSample: - lang: Python 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 = { "access" : { "ownerName" : "ownerName", "name" : "name", "description" : "description", "id" : "id", "type" : "ACCESS_PROFILE", "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) - path: /common-access method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-common-access#get-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') offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) 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) except Exception as 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/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 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) except Exception as e: print("Exception when calling IAICommonAccessApi->update_common_access_status_in_bulk: %s\n" % e) - path: /outliers/export method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-outliers#export-outliers-zip 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') 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) except Exception as e: print("Exception when calling IAIOutliersApi->export_outliers_zip: %s\n" % e) - path: /outlier-summaries method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-identity-outlier-snapshots 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') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) 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) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) - path: /outliers method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-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') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) 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) 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) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) - path: /outlier-summaries/latest method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-latest-identity-outlier-snapshots 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') 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) except Exception as e: print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) - path: /outlier-feature-summaries/{outlierFeatureId} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-outlier-contributing-feature-summary source: | 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) except Exception as e: print("Exception when calling IAIOutliersApi->get_outlier_contributing_feature_summary: %s\n" % e) - path: /outliers/{outlierId}/contributing-features method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-outliers#get-peer-group-outliers-contributing-features source: | 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) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) 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) except Exception as 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/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] | 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) except Exception as e: print("Exception when calling IAIOutliersApi->ignore_identity_outliers: %s\n" % e) - path: /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-outliers#list-outliers-contributing-feature-access-items source: | 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') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) 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) except Exception as 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/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] | 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) except Exception as e: print("Exception when calling IAIOutliersApi->un_ignore_identity_outliers: %s\n" % e) - path: /peer-group-strategies/{strategy}/identity-outliers method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-peer-group-strategies#get-peer-group-outliers source: | 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) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) except Exception as 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/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 = { "prescribeMode" : false, "excludeInterpretations" : false, "requests" : [ { "item" : { "id" : "2c938083633d259901633d2623ec0375", "type" : "ENTITLEMENT" }, "identityId" : "2c938083633d259901633d25c68c00fa" }, { "item" : { "id" : "2c938083633d259901633d2623ec0375", "type" : "ENTITLEMENT" }, "identityId" : "2c938083633d259901633d25c68c00fa" } ], "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) - path: /recommendations/config method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-recommendations#get-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') 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) except Exception as 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/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 = { "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) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#create-potential-role-provision-request 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 x_sail_point_experimental = 'true' # 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 = { "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) - path: /role-mining-sessions method: POST xCodeSample: - lang: Python 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 = { "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", "prescribedPruneThreshold" : 10, "pruneThreshold" : 50, "saved" : true, "potentialRolesReadyCount" : 0, "scope" : { "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], "attributeFilterCriteria" : { "displayName" : { "untranslated" : "Location: Miami" }, "ariaLabel" : { "untranslated" : "Location: Miami" }, "data" : { "displayName" : { "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" }, "name" : "location", "operator" : "EQUALS", "values" : [ "Miami" ] } }, "criteria" : "source.name:DataScienceDataset" }, "potentialRoleCount" : 0, "name" : "Saved RM Session - 07/10", "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) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#download-role-mining-potential-role-zip 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 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) except Exception as 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: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#export-role-mining-potential-role 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 x_sail_point_experimental = 'true' # str | 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) except Exception as 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: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#export-role-mining-potential-role-async 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 x_sail_point_experimental = 'true' # 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 = { "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) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#export-role-mining-potential-role-status 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 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) except Exception as e: print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_status: %s\n" % e) - path: /role-mining-potential-roles method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-all-potential-role-summaries 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') 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) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) except Exception as 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: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-entitlement-distribution-potential-role 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 x_sail_point_experimental = 'true' # 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) except Exception as 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: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-entitlements-potential-role 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 x_sail_point_experimental = 'true' # 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) (default to True) # bool | Boolean determining whether common access entitlements will be included or not (optional) (default to True) sorters = 'popularity' # str | Sort results using the standard syntax described 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, entitlementName, applicationName** The default sort is **popularity** 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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) filters = 'applicationName sw \"AD\"' # str | Filter results using the standard syntax described in [V3 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* **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: **applicationName**: *sw* **entitlementRef.name**: *sw* (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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as 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: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-excluded-entitlements-potential-role 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 x_sail_point_experimental = 'true' # 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 = '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) filters = 'applicationName sw \"AD\"' # str | Filter results using the standard syntax described in [V3 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* **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: **applicationName**: *sw* **entitlementRef.name**: *sw* (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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as 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: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-identities-potential-role 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 x_sail_point_experimental = 'true' # 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 = '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 = '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: **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) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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: # 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) except Exception as 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: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role 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 x_sail_point_experimental = 'true' # str | 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) except Exception as 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: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role-applications source: | 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') 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) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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: # 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) except Exception as 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: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role-entitlements source: | 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') 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) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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: # 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) except Exception as 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: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role-source-identity-usage source: | 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') 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) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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: # 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) except Exception as 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: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-potential-role-summaries source: | 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) 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) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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: # 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) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) - path: /role-mining-potential-roles/{potentialRoleId} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-role-mining-potential-role source: | 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) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_role_mining_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-role-mining-session 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. x_sail_point_experimental = 'true' # str | 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) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_role_mining_session: %s\n" % e) - path: /role-mining-sessions/{sessionId}/status method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-role-mining-session-status source: | 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) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_role_mining_session_status: %s\n" % e) - path: /role-mining-sessions method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-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') 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) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) - path: /role-mining-potential-roles/saved method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#get-saved-potential-roles 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') 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as 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: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#patch-potential-role 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 x_sail_point_experimental = 'true' # 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] | 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) except Exception as e: print("Exception when calling IAIRoleMiningApi->patch_potential_role: %s\n" % e) - path: /role-mining-potential-roles/{potentialRoleId} method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#patch-potential-role-0 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 x_sail_point_experimental = 'true' # 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] | 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) except Exception as e: print("Exception when calling IAIRoleMiningApi->patch_potential_role_0: %s\n" % e) - path: /role-mining-sessions/{sessionId} method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/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 x_sail_point_experimental = 'true' # 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) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/iai-role-mining#update-entitlements-potential-role 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 x_sail_point_experimental = 'true' # 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 = { "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) - path: /icons/{objectType}/{objectId} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/icons#delete-icon source: | 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') 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) except Exception as e: print("Exception when calling IconsApi->delete_icon: %s\n" % e) - path: /icons/{objectType}/{objectId} method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/icons#set-icon source: | 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') 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) except Exception as e: print("Exception when calling IconsApi->set_icon: %s\n" % e) - path: /identities/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identities#delete-identity source: | 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) except Exception as e: print("Exception when calling IdentitiesApi->delete_identity: %s\n" % e) - path: /identities/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identities#get-identity source: | 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) except Exception as e: print("Exception when calling IdentitiesApi->get_identity: %s\n" % e) - path: /identities/{identityId}/ownership method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identities#get-identity-ownership-details source: | 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) except Exception as e: print("Exception when calling IdentitiesApi->get_identity_ownership_details: %s\n" % e) - path: /identities/{identityId}/role-assignments/{assignmentId} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identities#get-role-assignment source: | 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') 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) except Exception as e: print("Exception when calling IdentitiesApi->get_role_assignment: %s\n" % e) - path: /identities/{identityId}/role-assignments method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identities#get-role-assignments source: | 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) 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) except Exception as e: print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) - path: /identities method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identities#list-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') 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) except Exception as e: print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) - path: /identities/{id}/reset method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identities#reset-identity source: | 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) except Exception as e: print("Exception when calling IdentitiesApi->reset_identity: %s\n" % e) - path: /identities/{id}/verification/account/send method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identities#send-identity-verification-account-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') id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID send_account_verification_request = { "sourceName" : "Active Directory Source", "via" : "EMAIL_WORK" } # 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) except Exception as 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/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 = { "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) - path: /identities/process method: POST xCodeSample: - lang: Python 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 = { "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) - path: /identities/{identityId}/synchronize-attributes method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identities#synchronize-attributes-for-identity source: | 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) except Exception as 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/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 = { "standard" : false, "system" : false, "sources" : [ { "type" : "rule", "properties" : { "ruleType" : "IdentityAttribute", "ruleName" : "Cloud Promote Identity Attribute" } }, { "type" : "rule", "properties" : { "ruleType" : "IdentityAttribute", "ruleName" : "Cloud Promote Identity Attribute" } } ], "displayName" : "Cost Center", "name" : "costCenter", "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) - path: /identity-attributes/{name} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-attributes#delete-identity-attribute 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') 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) except Exception as 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/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 = { "ids" : [ "name", "displayName" ] } # IdentityAttributeNames | try: # Bulk delete Identity Attributes Result = identity_attribute_names.from_json(identity_attribute_names) api_instance.delete_identity_attributes_in_bulk(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) except Exception as e: print("Exception when calling IdentityAttributesApi->delete_identity_attributes_in_bulk: %s\n" % e) - path: /identity-attributes/{name} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-attributes#get-identity-attribute 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') 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) except Exception as e: print("Exception when calling IdentityAttributesApi->get_identity_attribute: %s\n" % e) - path: /identity-attributes method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-attributes#list-identity-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') 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as e: print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) - path: /identity-attributes/{name} method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-attributes#put-identity-attribute 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 = { "standard" : false, "system" : false, "sources" : [ { "type" : "rule", "properties" : { "ruleType" : "IdentityAttribute", "ruleName" : "Cloud Promote Identity Attribute" } }, { "type" : "rule", "properties" : { "ruleType" : "IdentityAttribute", "ruleName" : "Cloud Promote Identity Attribute" } } ], "displayName" : "Cost Center", "name" : "costCenter", "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) - path: /historical-identities/{id}/compare method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-history#compare-identity-snapshots source: | 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) 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) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) - path: /historical-identities/{id}/compare/{access-type} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-history#compare-identity-snapshots-access-type source: | 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') 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) snapshot1 = '2008-03-01T13:00:00Z' # str | The snapshot 1 of identity (optional) # str | The snapshot 1 of identity (optional) snapshot2 = '2009-03-01T13:00:00Z' # str | The snapshot 2 of identity (optional) # str | The snapshot 2 of identity (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 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) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) - path: /historical-identities/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-history#get-historical-identity source: | 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) except Exception as e: print("Exception when calling IdentityHistoryApi->get_historical_identity: %s\n" % e) - path: /historical-identities/{id}/events method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-history#get-historical-identity-events source: | 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) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) except Exception as e: print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) - path: /historical-identities/{id}/snapshots/{date} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-history#get-identity-snapshot source: | 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') 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) except Exception as e: print("Exception when calling IdentityHistoryApi->get_identity_snapshot: %s\n" % e) - path: /historical-identities/{id}/snapshot-summary method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-history#get-identity-snapshot-summary source: | 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) 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) time_zone = 'UTC' # str | The time zone. Defaults to UTC if not provided (optional) # str | The time zone. Defaults to UTC if not provided (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 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) except Exception as e: print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) - path: /historical-identities/{id}/start-date method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-history#get-identity-start-date source: | 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) except Exception as e: print("Exception when calling IdentityHistoryApi->get_identity_start_date: %s\n" % e) - path: /historical-identities method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-history#list-historical-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') 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) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) except Exception as e: print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) - path: /historical-identities/{id}/access-items method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-history#list-identity-access-items source: | 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) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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) 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) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) - path: /historical-identities/{id}/snapshots/{date}/access-items method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-history#list-identity-snapshot-access-items source: | 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') 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) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) - path: /historical-identities/{id}/snapshots method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-history#list-identity-snapshots source: | 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) 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) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) except Exception as 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 = { "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" } # 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) - path: /identity-profiles/{identity-profile-id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-profiles#delete-identity-profile 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) except Exception as 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. 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) except Exception as e: print("Exception when calling IdentityProfilesApi->delete_identity_profiles: %s\n" % e) - path: /identity-profiles/export method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-profiles#export-identity-profiles 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = '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) except Exception as e: print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) - path: /identity-profiles/identity-preview method: POST xCodeSample: - lang: Python 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 = { "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "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 } } # 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) - path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-profiles#get-default-identity-attribute-config 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) except Exception as e: print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e) - path: /identity-profiles/{identity-profile-id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-profiles#get-identity-profile 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) except Exception as 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) - path: /identity-profiles method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-profiles#list-identity-profiles 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = '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) except Exception as e: print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/process-identities method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/identity-profiles#sync-identity-profile 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) except Exception as e: print("Exception when calling IdentityProfilesApi->sync_identity_profile: %s\n" % e) - path: /identity-profiles/{identity-profile-id} method: PATCH xCodeSample: - lang: Python 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) - path: /identity-profiles/{identity-profile-id}/lifecycle-states method: POST xCodeSample: - lang: Python 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 = { "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], "emailNotificationOption" : { "notifyManagers" : true, "notifySpecificUsers" : true, "emailAddressList" : [ "test@test.com", "test2@test.com" ], "notifyAllAdmins" : true }, "created" : "2015-05-28T14:07:17Z", "name" : "aName", "modified" : "2015-05-28T14:07:17Z", "description" : "Lifecycle description", "accountActions" : [ { "action" : "ENABLE", "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] }, { "action" : "ENABLE", "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] } ], "id" : "id12345", "identityCount" : 42, "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) - path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#delete-lifecycle-state 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. 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) except Exception as 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: - lang: Python label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#get-lifecycle-state 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. 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) except Exception as e: print("Exception when calling LifecycleStatesApi->get_lifecycle_state: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/lifecycle-states method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#get-lifecycle-states source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as e: print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) - path: /identities/{identity-id}/set-lifecycle-state method: POST xCodeSample: - lang: Python 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) - path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/lifecycle-states#update-lifecycle-states 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) - path: /machine-accounts/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/machine-accounts#get-machine-account 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') 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) except Exception as e: print("Exception when calling MachineAccountsApi->get_machine_account: %s\n" % e) - path: /machine-accounts method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/machine-accounts#list-machine-accounts 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') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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 = '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) except Exception as e: print("Exception when calling MachineAccountsApi->list_machine_accounts: %s\n" % e) - path: /machine-accounts/{id} method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/machine-accounts#update-machine-account 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. 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) except Exception as e: print("Exception when calling MachineAccountsApi->update_machine_account: %s\n" % e) - path: /machine-identities method: POST xCodeSample: - lang: Python 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 = { "created" : "2015-05-28T14:07:17Z", "businessApplication" : "ADService", "name" : "aName", "modified" : "2015-05-28T14:07:17Z", "description" : "", "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) - path: /machine-identities/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/machine-identities#delete-machine-identity 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') 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) except Exception as e: print("Exception when calling MachineIdentitiesApi->delete_machine_identity: %s\n" % e) - path: /machine-identities/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/machine-identities#get-machine-identity 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') 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) except Exception as e: print("Exception when calling MachineIdentitiesApi->get_machine_identity: %s\n" % e) - path: /machine-identities method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/machine-identities#list-machine-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') 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) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) except Exception as e: print("Exception when calling MachineIdentitiesApi->list_machine_identities: %s\n" % e) - path: /machine-identities/{id} method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/machine-identities#update-machine-identity 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. 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) except Exception as 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 = { "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) - path: /managed-clients/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clients#delete-managed-client 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) except Exception as e: print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e) - path: /managed-clients/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clients#get-managed-client 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) except Exception as e: print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) - path: /managed-clients/{id}/status method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clients#get-managed-client-status source: | 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) except Exception as e: print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) - path: /managed-clients method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clients#get-managed-clients source: | offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) 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) except Exception as e: print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) - path: /managed-clients/{id} method: PATCH xCodeSample: - lang: Python 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) - path: /managed-clusters method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clusters#create-managed-cluster source: | managed_cluster_request = { "configuration" : { "clusterExternalId" : "externalId", "ccgVersion" : "77.0.0" }, "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) - path: /managed-clusters/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clusters#delete-managed-cluster source: | 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) except Exception as e: print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) - path: /managed-clusters/{id}/log-config method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clusters#get-client-log-configuration 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) except Exception as e: print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) - path: /managed-clusters/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clusters#get-managed-cluster 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) except Exception as e: print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) - path: /managed-clusters method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/managed-clusters#get-managed-clusters source: | offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) 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) except Exception as e: print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) - path: /managed-clusters/{id}/log-config method: PUT xCodeSample: - lang: Python 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) - path: /managed-clusters/{id} method: PATCH xCodeSample: - lang: Python 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) - path: /mfa/duo-web/config method: GET xCodeSample: - lang: Python 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) except Exception as e: print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) - path: /mfa/kba/config method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#get-mfa-kba-config 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) except Exception as e: print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) - path: /mfa/okta-verify/config method: GET xCodeSample: - lang: Python 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) except Exception as 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 = { "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", "host" : "example.com", "configProperties" : { "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", "ikey" : "Q123WE45R6TY7890ZXCV" }, "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) - 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 = { "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) - 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) - path: /mfa/{method}/test method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/mfa-configuration#test-mfa-config 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) except Exception as e: print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) - path: /non-employee-approvals/{id}/approve method: POST xCodeSample: - lang: Python 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 = { "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) - 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 = { "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", "lastName" : "Smith", "manager" : "jane.doe", "data" : { "description" : "Auditing" }, "accountName" : "william.smith", "phone" : "5125555555", "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) - 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 = { "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", "lastName" : "Smith", "manager" : "jane.doe", "data" : { "description" : "Auditing" }, "accountName" : "william.smith", "phone" : "5125555555", "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) - 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 = { "owner" : { "id" : "2c91808570313110017040b06f344ec9" }, "managementWorkgroup" : "123299", "accountManagers" : [ { "id" : "2c91808570313110017040b06f344ec9" }, { "id" : "2c91808570313110017040b06f344ec9" }, { "id" : "2c91808570313110017040b06f344ec9" }, { "id" : "2c91808570313110017040b06f344ec9" }, { "id" : "2c91808570313110017040b06f344ec9" } ], "name" : "Retail", "description" : "Source description", "approvers" : [ { "id" : "2c91808570313110017040b06f344ec9" }, { "id" : "2c91808570313110017040b06f344ec9" }, { "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) - path: /non-employee-sources/{sourceId}/schema-attributes method: POST xCodeSample: - lang: Python 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 = { "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) - path: /non-employee-records/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-record 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) except Exception as 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. 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) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_records_in_bulk: %s\n" % e) - path: /non-employee-requests/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-request 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) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_request: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute 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 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) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_schema_attribute: %s\n" % e) - path: /non-employee-sources/{sourceId} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-source 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) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes 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) except Exception as 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: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#export-non-employee-records 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) except Exception as 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: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template 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) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_source_schema_template: %s\n" % e) - path: /non-employee-approvals/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-approval source: | 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) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval: %s\n" % e) - path: /non-employee-approvals/summary/{requested-for} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-approval-summary 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) except Exception as 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: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status 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) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) - path: /non-employee-records/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-record 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) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) - path: /non-employee-requests/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-request 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) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) - path: /non-employee-requests/summary/{requested-for} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-request-summary 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) except Exception as 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: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute 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 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) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) - path: /non-employee-sources/{sourceId} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-source 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) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes 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) except Exception as 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: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk source: | 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) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk: %s\n" % e) - path: /non-employee-approvals method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#list-non-employee-approvals source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = '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) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) - path: /non-employee-records method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#list-non-employee-records 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = '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) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) - path: /non-employee-requests method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#list-non-employee-requests source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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,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) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) - path: /non-employee-sources method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#list-non-employee-sources 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) requested_for = 'me' # str | Identity the request was made for. Use 'me' to indicate the current user. (optional) # str | Identity the request was made for. Use 'me' to indicate the current user. (optional) 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) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) - path: /non-employee-records/{id} method: PATCH xCodeSample: - lang: Python 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) - path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute 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) - path: /non-employee-sources/{sourceId} method: PATCH xCodeSample: - lang: Python 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) - path: /non-employee-approvals/{id}/reject method: POST xCodeSample: - lang: Python 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 = { "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) - path: /non-employee-records/{id} method: PUT xCodeSample: - lang: Python 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 = { "sourceId" : "2c91808568c529c60168cca6f90c1313", "firstName" : "William", "lastName" : "Smith", "manager" : "jane.doe", "data" : { "description" : "Auditing" }, "accountName" : "william.smith", "phone" : "5125555555", "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) - path: /verified-domains method: POST xCodeSample: - lang: Python 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" : "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) - path: /notification-templates method: POST xCodeSample: - lang: Python 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 = { "slackTemplate" : "slackTemplate", "footer" : "footer", "teamsTemplate" : "teamsTemplate", "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", "created" : "2020-01-01T00:00:00Z", "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", "medium" : "EMAIL", "locale" : "en", "body" : "Please go to the task manager", "name" : "Task Manager Subscription", "replyTo" : "$__global.emailFromAddress", "header" : "header", "modified" : "2020-01-01T00:00:00Z", "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) - path: /verified-from-addresses method: POST xCodeSample: - lang: Python 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 = { "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) - path: /notification-templates/bulk-delete method: POST xCodeSample: - lang: Python 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] | 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) except Exception as e: print("Exception when calling NotificationsApi->delete_notification_templates_in_bulk: %s\n" % e) - path: /verified-from-addresses/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#delete-verified-from-address source: | 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) except Exception as e: print("Exception when calling NotificationsApi->delete_verified_from_address: %s\n" % e) - path: /verified-domains method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#get-dkim-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') 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) except Exception as e: print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) - path: /mail-from-attributes/{identity} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#get-mail-from-attributes source: | 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) except Exception as e: print("Exception when calling NotificationsApi->get_mail_from_attributes: %s\n" % e) - path: /notification-templates/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#get-notification-template source: | 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) except Exception as e: print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e) - path: /notification-template-context method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#get-notifications-template-context 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) except Exception as e: print("Exception when calling NotificationsApi->get_notifications_template_context: %s\n" % e) - path: /verified-from-addresses method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#list-from-addresses 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') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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 = '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) except Exception as e: print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) - path: /notification-preferences/{key} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#list-notification-preferences 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) except Exception as e: print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e) - path: /notification-template-defaults method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#list-notification-template-defaults 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') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) except Exception as e: print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) - path: /notification-templates method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/notifications#list-notification-templates 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') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) except Exception as 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/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 = { "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) - path: /send-test-notification method: POST xCodeSample: - lang: Python 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 = { "context" : "{}", "medium" : "EMAIL", "key" : "cloud_manual_work_item_summary" } # 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) except Exception as 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 = { "internal" : false, "businessName" : "Acme-Solar", "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", "refreshTokenValiditySeconds" : 86400, "type" : "CONFIDENTIAL", "redirectUris" : [ "http://localhost:12345" ], "enabled" : true, "accessType" : "OFFLINE", "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], "strongAuthSupported" : false, "homepageUrl" : "http://localhost:12345", "accessTokenValiditySeconds" : 750, "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) - path: /oauth-clients/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/o-auth-clients#delete-oauth-client 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) except Exception as e: print("Exception when calling OAuthClientsApi->delete_oauth_client: %s\n" % e) - path: /oauth-clients/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/o-auth-clients#get-oauth-client 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) except Exception as e: print("Exception when calling OAuthClientsApi->get_oauth_client: %s\n" % e) - path: /oauth-clients method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/o-auth-clients#list-oauth-clients 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) except Exception as e: print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) - path: /oauth-clients/{id} method: PATCH xCodeSample: - lang: Python 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) - path: /org-config method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/org-config#get-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') 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) except Exception as e: print("Exception when calling OrgConfigApi->get_org_config: %s\n" % e) - path: /org-config/valid-time-zones method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/org-config#get-valid-time-zones 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') 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as 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/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) - 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 = { "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) - path: /password-org-config method: GET xCodeSample: - lang: Python 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) except Exception as 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 = { "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) - path: /password-dictionary method: GET xCodeSample: - lang: Python 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) except Exception as e: print("Exception when calling PasswordDictionaryApi->get_password_dictionary: %s\n" % e) - path: /password-dictionary method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-dictionary#put-password-dictionary 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) except Exception as 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/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 = { "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) - path: /password-change-status/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-management#get-password-change-status 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) except Exception as 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 = { "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) - path: /set-password method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-management#set-password source: | 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) - 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 = { "validateAgainstAccountName" : true, "minLength" : 8, "description" : "Information about the Password Policy", "requireStrongAuthUntrustedGeographies" : true, "enablePasswdExpiration" : true, "minNumeric" : 8, "lastUpdated" : 1939056206564, "validateAgainstAccountId" : false, "dateCreated" : 1639056206564, "accountNameMinWordLength" : 6, "minUpper" : 8, "firstExpirationReminder" : 45, "modified" : "modified", "id" : "2c91808e7d976f3b017d9f5ceae440c8", "requireStrongAuthn" : true, "useDictionary" : false, "minSpecial" : 8, "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], "passwordExpiration" : 8, "maxRepeatedChars" : 3, "minCharacterTypes" : 5, "minAlpha" : 5, "created" : "created", "useAccountAttributes" : false, "accountIdMinWordLength" : 4, "minLower" : 8, "useIdentityAttributes" : false, "defaultPolicy" : true, "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) - path: /password-policies/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-policies#delete-password-policy 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) except Exception as e: print("Exception when calling PasswordPoliciesApi->delete_password_policy: %s\n" % e) - path: /password-policies/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-policies#get-password-policy-by-id 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) except Exception as e: print("Exception when calling PasswordPoliciesApi->get_password_policy_by_id: %s\n" % e) - path: /password-policies method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-policies#list-password-policies 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as e: print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) - path: /password-policies/{id} method: PUT xCodeSample: - lang: Python 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 = { "validateAgainstAccountName" : true, "minLength" : 8, "description" : "Information about the Password Policy", "requireStrongAuthUntrustedGeographies" : true, "enablePasswdExpiration" : true, "minNumeric" : 8, "lastUpdated" : 1939056206564, "validateAgainstAccountId" : false, "dateCreated" : 1639056206564, "accountNameMinWordLength" : 6, "minUpper" : 8, "firstExpirationReminder" : 45, "modified" : "modified", "id" : "2c91808e7d976f3b017d9f5ceae440c8", "requireStrongAuthn" : true, "useDictionary" : false, "minSpecial" : 8, "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], "passwordExpiration" : 8, "maxRepeatedChars" : 3, "minCharacterTypes" : 5, "minAlpha" : 5, "created" : "created", "useAccountAttributes" : false, "accountIdMinWordLength" : 4, "minLower" : 8, "useIdentityAttributes" : false, "defaultPolicy" : true, "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) - 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 = { "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) - path: /password-sync-groups/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-sync-groups#delete-password-sync-group 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) except Exception as e: print("Exception when calling PasswordSyncGroupsApi->delete_password_sync_group: %s\n" % e) - path: /password-sync-groups/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-sync-groups#get-password-sync-group 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) except Exception as e: print("Exception when calling PasswordSyncGroupsApi->get_password_sync_group: %s\n" % e) - path: /password-sync-groups method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/password-sync-groups#get-password-sync-groups 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as e: print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) - path: /password-sync-groups/{id} method: PUT xCodeSample: - lang: Python 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 = { "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) - 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 = { "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) - path: /personal-access-tokens/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/personal-access-tokens#delete-personal-access-token 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) except Exception as e: print("Exception when calling PersonalAccessTokensApi->delete_personal_access_token: %s\n" % e) - path: /personal-access-tokens method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/personal-access-tokens#list-personal-access-tokens source: | 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) except Exception as e: print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) - path: /personal-access-tokens/{id} method: PATCH xCodeSample: - lang: Python 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) - path: /public-identities method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/public-identities#get-public-identities 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = 'firstname eq \"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: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *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* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) 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) except Exception as e: print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) - path: /public-identities-config method: GET xCodeSample: - lang: Python 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) except Exception as 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 = { "modified" : "2018-06-25T20:22:28.104Z", "attributes" : [ { "name" : "Country", "key" : "country" }, { "name" : "Country", "key" : "country" } ], "modifiedBy" : { "name" : "Thomas Edison", "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) - path: /reports/{id}/cancel method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/reports-data-extraction#cancel-report 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) except Exception as e: print("Exception when calling ReportsDataExtractionApi->cancel_report: %s\n" % e) - path: /reports/{taskResultId} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/reports-data-extraction#get-report source: | 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) 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) except Exception as e: print("Exception when calling ReportsDataExtractionApi->get_report: %s\n" % e) - path: /reports/{taskResultId}/result method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/reports-data-extraction#get-report-result source: | 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) except Exception as 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 = { "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) - path: /requestable-objects method: GET xCodeSample: - lang: Python 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) 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) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) except Exception as e: print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) - path: /role-insights/requests method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/role-insights#create-role-insight-requests 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) except Exception as e: print("Exception when calling RoleInsightsApi->create_role_insight_requests: %s\n" % e) - path: /role-insights/{insightId}/entitlement-changes/download method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/role-insights#download-role-insights-entitlements-changes source: | 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) 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) except Exception as 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: - lang: Python label: SDK_tools/sdk/python/v2024/methods/role-insights#get-entitlement-changes-identities source: | 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') 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) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) 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) except Exception as e: print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) - path: /role-insights/{insightId} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insight source: | 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) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insight: %s\n" % e) - path: /role-insights method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights 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') offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) 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) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) - path: /role-insights/{insightId}/current-entitlements method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights-current-entitlements source: | 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) 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) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) - path: /role-insights/{insightId}/entitlement-changes method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights-entitlements-changes source: | 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) 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) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) - path: /role-insights/requests/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights-requests source: | 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) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_requests: %s\n" % e) - path: /role-insights/summary method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/role-insights#get-role-insights-summary 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) except Exception as 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 = { "owner" : { "name" : "support", "id" : "2c9180a46faadee4016fb4e018c20639", "type" : "IDENTITY" }, "entitlements" : [ { "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", "id" : "2c91809773dee32014e13e122092014e", "type" : "ENTITLEMENT" }, { "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", "id" : "2c91809773dee32014e13e122092014e", "type" : "ENTITLEMENT" } ], "dimensional" : false, "created" : "2021-03-01T22:32:58.104Z", "dimensionRefs" : [ { "name" : "Role 2", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "DIMENSION" }, { "name" : "Role 2", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "DIMENSION" } ], "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", "membership" : { "identities" : [ { "aliasName" : "t.edison", "name" : "Thomas Edison", "id" : "2c9180a46faadee4016fb4e018c20639", "type" : "IDENTITY" }, { "aliasName" : "t.edison", "name" : "Thomas Edison", "id" : "2c9180a46faadee4016fb4e018c20639", "type" : "IDENTITY" } ], "criteria" : { "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", "children" : [ { "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", "children" : [ { "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", "operation" : "EQUALS", "key" : { "sourceId" : "2c9180867427f3a301745aec18211519", "property" : "attribute.email", "type" : "ACCOUNT" } }, { "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", "operation" : "EQUALS", "key" : { "sourceId" : "2c9180867427f3a301745aec18211519", "property" : "attribute.email", "type" : "ACCOUNT" } } ], "operation" : "EQUALS", "key" : { "sourceId" : "2c9180867427f3a301745aec18211519", "property" : "attribute.email", "type" : "ACCOUNT" } }, { "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", "children" : [ { "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", "operation" : "EQUALS", "key" : { "sourceId" : "2c9180867427f3a301745aec18211519", "property" : "attribute.email", "type" : "ACCOUNT" } }, { "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", "operation" : "EQUALS", "key" : { "sourceId" : "2c9180867427f3a301745aec18211519", "property" : "attribute.email", "type" : "ACCOUNT" } } ], "operation" : "EQUALS", "key" : { "sourceId" : "2c9180867427f3a301745aec18211519", "property" : "attribute.email", "type" : "ACCOUNT" } } ], "operation" : "EQUALS", "key" : { "sourceId" : "2c9180867427f3a301745aec18211519", "property" : "attribute.email", "type" : "ACCOUNT" } }, "type" : "IDENTITY_LIST" }, "enabled" : true, "revocationRequestConfig" : { "commentsRequired" : false, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" }, { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" } ], "denialCommentsRequired" : false }, "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "legacyMembershipInfo" : { "type" : "IDENTITY_LIST" }, "accessRequestConfig" : { "commentsRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" }, { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" } ], "denialCommentsRequired" : true }, "accessProfiles" : [ { "name" : "Access Profile 2567", "id" : "ff808081751e6e129f1518161919ecca", "type" : "ACCESS_PROFILE" }, { "name" : "Access Profile 2567", "id" : "ff808081751e6e129f1518161919ecca", "type" : "ACCESS_PROFILE" } ], "name" : "Role 2567", "modified" : "2021-03-02T20:22:28.104Z", "accessModelMetadata" : { "attributes" : [ { "key" : "iscPrivacy", "name" : "Privacy", "multiselect" : false, "status" : "active", "type" : "governance", "objectTypes" : [ "all" ], "description" : "Specifies the level of privacy associated with an access item.", "values" : [ { "value" : "public", "name" : "Public", "status" : "active" } ] } ] }, "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) - 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 = { "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) - path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#delete-metadata-from-role-by-key-and-value source: | 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. 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) except Exception as e: print("Exception when calling RolesApi->delete_metadata_from_role_by_key_and_value: %s\n" % e) - path: /roles/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#delete-role 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) except Exception as e: print("Exception when calling RolesApi->delete_role: %s\n" % e) - path: /roles/access-model-metadata/bulk-update method: GET xCodeSample: - lang: Python 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) except Exception as e: print("Exception when calling RolesApi->get_bulk_update_status: %s\n" % e) - path: /roles/access-model-metadata/bulk-update/id method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#get-bulk-update-status-by-id 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) except Exception as e: print("Exception when calling RolesApi->get_bulk_update_status_by_id: %s\n" % e) - path: /roles/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#get-role 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) except Exception as e: print("Exception when calling RolesApi->get_role: %s\n" % e) - path: /roles/{id}/assigned-identities method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#get-role-assigned-identities source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 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) except Exception as e: print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) - path: /roles/{id}/entitlements method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#get-role-entitlements source: | 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) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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 = '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) except Exception as e: print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) - path: /roles method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#list-roles source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = 'requestable 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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (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) 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) except Exception as e: print("Exception when calling RolesApi->list_roles: %s\n" % e) - path: /roles/{id} method: PATCH xCodeSample: - lang: Python 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) - path: /roles/filter method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#search-roles-by-filter source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) 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 = { "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) - path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/roles#update-attribute-key-and-value-to-role source: | 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. 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) except Exception as 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 = { "values" : [ { "attribute" : "iscFederalClassifications", "values" : [ "topSecret" ] } ], "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) - 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 = { "roles" : [ "b1db89554cfa431cb8b9921ea38d9367" ], "values" : [ { "attribute" : "iscFederalClassifications", "values" : [ "topSecret" ] } ], "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) - 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 = { "query" : { "query\"" : { "indices" : [ "roles" ], "queryType" : "TEXT", "textQuery" : { "terms" : [ "test123" ], "fields" : [ "id" ], "matchAny" : false, "contains" : true }, "includeNested" : false } }, "values" : [ { "attributeValue" : [ "topSecret" ], "attributeKey" : "iscFederalClassifications" }, { "attributeValue" : [ "topSecret" ], "attributeKey" : "iscFederalClassifications" } ], "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) - 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. 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) except Exception as e: print("Exception when calling SavedSearchApi->create_saved_search: %s\n" % e) - path: /saved-searches/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/saved-search#delete-saved-search 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) except Exception as e: print("Exception when calling SavedSearchApi->delete_saved_search: %s\n" % e) - path: /saved-searches/{id}/execute method: POST xCodeSample: - lang: Python 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 = { "owner" : "", "recipients" : [ { "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, { "id" : "2c91808568c529c60168cca6f90c1313", "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. 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) except Exception as e: print("Exception when calling SavedSearchApi->execute_saved_search: %s\n" % e) - path: /saved-searches/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/saved-search#get-saved-search 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) except Exception as e: print("Exception when calling SavedSearchApi->get_saved_search: %s\n" % e) - path: /saved-searches method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/saved-search#list-saved-searches source: | offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) 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) except Exception as e: print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) - path: /saved-searches/{id} method: PUT xCodeSample: - lang: Python 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 = { "owner" : { "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, "created" : "2018-06-25T20:22:28.104Z", "columns" : { "identity" : [ { "field" : "displayName", "header" : "Display Name" }, { "field" : "e-mail", "header" : "Work Email" } ] }, "query" : "@accounts(disabled:true)", "description" : "Disabled accounts", "orderBy" : { "identity" : [ "lastName", "firstName" ], "role" : [ "name" ] }, "sort" : [ "displayName" ], "filters" : { "terms" : [ "account_count", "account_count" ], "range" : { "lower" : { "inclusive" : false, "value" : "1" }, "upper" : { "inclusive" : false, "value" : "1" } }, "exclude" : false, "type" : "RANGE" }, "ownerId" : "2c91808568c529c60168cca6f90c1313", "indices" : [ "identities" ], "public" : false, "name" : "Disabled accounts", "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) - 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. 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) except Exception as e: print("Exception when calling ScheduledSearchApi->create_scheduled_search: %s\n" % e) - path: /scheduled-searches/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/scheduled-search#delete-scheduled-search 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) except Exception as e: print("Exception when calling ScheduledSearchApi->delete_scheduled_search: %s\n" % e) - path: /scheduled-searches/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/scheduled-search#get-scheduled-search 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) except Exception as e: print("Exception when calling ScheduledSearchApi->get_scheduled_search: %s\n" % e) - path: /scheduled-searches method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/scheduled-search#list-scheduled-search source: | offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) 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) except Exception as e: print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) - path: /scheduled-searches/{id}/unsubscribe method: POST xCodeSample: - lang: Python 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 = { "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" } # 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) except Exception as e: print("Exception when calling ScheduledSearchApi->unsubscribe_scheduled_search: %s\n" % e) - path: /scheduled-searches/{id} method: PUT xCodeSample: - lang: Python 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 = { "owner" : { "id" : "2c9180867624cbd7017642d8c8c81f67", "type" : "IDENTITY" }, "displayQueryDetails" : false, "created" : "", "description" : "Daily disabled accounts", "ownerId" : "2c9180867624cbd7017642d8c8c81f67", "enabled" : false, "schedule" : { "hours" : { "accountMatchConfig" : { "matchExpression" : { "and" : true, "matchTerms" : [ { "name" : "", "value" : "", "container" : true, "and" : false, "children" : [ { "name" : "businessCategory", "value" : "Service", "op" : "eq", "container" : false, "and" : false } ] } ] } }, "applicationId" : "2c91808874ff91550175097daaec161c\"" }, "months" : { "accountMatchConfig" : { "matchExpression" : { "and" : true, "matchTerms" : [ { "name" : "", "value" : "", "container" : true, "and" : false, "children" : [ { "name" : "businessCategory", "value" : "Service", "op" : "eq", "container" : false, "and" : false } ] } ] } }, "applicationId" : "2c91808874ff91550175097daaec161c\"" }, "timeZoneId" : "America/Chicago", "days" : { "accountMatchConfig" : { "matchExpression" : { "and" : true, "matchTerms" : [ { "name" : "", "value" : "", "container" : true, "and" : false, "children" : [ { "name" : "businessCategory", "value" : "Service", "op" : "eq", "container" : false, "and" : false } ] } ] } }, "applicationId" : "2c91808874ff91550175097daaec161c\"" }, "expiration" : "2018-06-25T20:22:28.104Z", "type" : "WEEKLY" }, "recipients" : [ { "id" : "2c9180867624cbd7017642d8c8c81f67", "type" : "IDENTITY" }, { "id" : "2c9180867624cbd7017642d8c8c81f67", "type" : "IDENTITY" } ], "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", "name" : "Daily disabled accounts", "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) - path: /search/aggregate method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/search#search-aggregate source: | search = { "queryDsl" : { "match" : { "name" : "john.doe" } }, "aggregationType" : "DSL", "aggregationsVersion" : "", "query" : { "query" : "name:a*", "timeZone" : "America/Chicago", "fields" : "[firstName,lastName,email]", "innerHit" : { "query" : "source.name:\\\"Active Directory\\\"", "type" : "access" } }, "aggregationsDsl" : { }, "sort" : [ "displayName", "+id" ], "filters" : { }, "queryVersion" : "", "queryType" : "SAILPOINT", "includeNested" : true, "queryResultFilter" : { "excludes" : [ "stacktrace" ], "includes" : [ "name", "displayName" ] }, "indices" : [ "identities" ], "typeAheadQuery" : { "field" : "source.name", "size" : 100, "query" : "Work", "sortByValue" : true, "nestedType" : "access", "sort" : "asc", "maxExpansions" : 10 }, "textQuery" : { "contains" : true, "terms" : [ "The quick brown fox", "3141592", "7" ], "matchAny" : false, "fields" : [ "displayName", "employeeNumber", "roleCount" ] }, "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], "aggregations" : { "filter" : { "field" : "access.type", "name" : "Entitlements", "type" : "TERM", "value" : "ENTITLEMENT" }, "bucket" : { "field" : "attributes.city", "size" : 100, "minDocCount" : 2, "name" : "Identity Locations", "type" : "TERMS" }, "metric" : { "field" : "@access.name", "name" : "Access Name Count", "type" : "COUNT" }, "subAggregation" : { "filter" : { "field" : "access.type", "name" : "Entitlements", "type" : "TERM", "value" : "ENTITLEMENT" }, "bucket" : { "field" : "attributes.city", "size" : 100, "minDocCount" : 2, "name" : "Identity Locations", "type" : "TERMS" }, "metric" : { "field" : "@access.name", "name" : "Access Name Count", "type" : "COUNT" }, "subAggregation" : { "filter" : { "field" : "access.type", "name" : "Entitlements", "type" : "TERM", "value" : "ENTITLEMENT" }, "bucket" : { "field" : "attributes.city", "size" : 100, "minDocCount" : 2, "name" : "Identity Locations", "type" : "TERMS" }, "metric" : { "field" : "@access.name", "name" : "Access Name Count", "type" : "COUNT" }, "nested" : { "name" : "id", "type" : "access" } }, "nested" : { "name" : "id", "type" : "access" } }, "nested" : { "name" : "id", "type" : "access" } } } # 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) except Exception as 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 = { "queryDsl" : { "match" : { "name" : "john.doe" } }, "aggregationType" : "DSL", "aggregationsVersion" : "", "query" : { "query" : "name:a*", "timeZone" : "America/Chicago", "fields" : "[firstName,lastName,email]", "innerHit" : { "query" : "source.name:\\\"Active Directory\\\"", "type" : "access" } }, "aggregationsDsl" : { }, "sort" : [ "displayName", "+id" ], "filters" : { }, "queryVersion" : "", "queryType" : "SAILPOINT", "includeNested" : true, "queryResultFilter" : { "excludes" : [ "stacktrace" ], "includes" : [ "name", "displayName" ] }, "indices" : [ "identities" ], "typeAheadQuery" : { "field" : "source.name", "size" : 100, "query" : "Work", "sortByValue" : true, "nestedType" : "access", "sort" : "asc", "maxExpansions" : 10 }, "textQuery" : { "contains" : true, "terms" : [ "The quick brown fox", "3141592", "7" ], "matchAny" : false, "fields" : [ "displayName", "employeeNumber", "roleCount" ] }, "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], "aggregations" : { "filter" : { "field" : "access.type", "name" : "Entitlements", "type" : "TERM", "value" : "ENTITLEMENT" }, "bucket" : { "field" : "attributes.city", "size" : 100, "minDocCount" : 2, "name" : "Identity Locations", "type" : "TERMS" }, "metric" : { "field" : "@access.name", "name" : "Access Name Count", "type" : "COUNT" }, "subAggregation" : { "filter" : { "field" : "access.type", "name" : "Entitlements", "type" : "TERM", "value" : "ENTITLEMENT" }, "bucket" : { "field" : "attributes.city", "size" : 100, "minDocCount" : 2, "name" : "Identity Locations", "type" : "TERMS" }, "metric" : { "field" : "@access.name", "name" : "Access Name Count", "type" : "COUNT" }, "subAggregation" : { "filter" : { "field" : "access.type", "name" : "Entitlements", "type" : "TERM", "value" : "ENTITLEMENT" }, "bucket" : { "field" : "attributes.city", "size" : 100, "minDocCount" : 2, "name" : "Identity Locations", "type" : "TERMS" }, "metric" : { "field" : "@access.name", "name" : "Access Name Count", "type" : "COUNT" }, "nested" : { "name" : "id", "type" : "access" } }, "nested" : { "name" : "id", "type" : "access" } }, "nested" : { "name" : "id", "type" : "access" } } } # 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) except Exception as e: print("Exception when calling SearchApi->search_count: %s\n" % e) - path: /search/{index}/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/search#search-get source: | 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) except Exception as 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 = { "queryDsl" : { "match" : { "name" : "john.doe" } }, "aggregationType" : "DSL", "aggregationsVersion" : "", "query" : { "query" : "name:a*", "timeZone" : "America/Chicago", "fields" : "[firstName,lastName,email]", "innerHit" : { "query" : "source.name:\\\"Active Directory\\\"", "type" : "access" } }, "aggregationsDsl" : { }, "sort" : [ "displayName", "+id" ], "filters" : { }, "queryVersion" : "", "queryType" : "SAILPOINT", "includeNested" : true, "queryResultFilter" : { "excludes" : [ "stacktrace" ], "includes" : [ "name", "displayName" ] }, "indices" : [ "identities" ], "typeAheadQuery" : { "field" : "source.name", "size" : 100, "query" : "Work", "sortByValue" : true, "nestedType" : "access", "sort" : "asc", "maxExpansions" : 10 }, "textQuery" : { "contains" : true, "terms" : [ "The quick brown fox", "3141592", "7" ], "matchAny" : false, "fields" : [ "displayName", "employeeNumber", "roleCount" ] }, "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], "aggregations" : { "filter" : { "field" : "access.type", "name" : "Entitlements", "type" : "TERM", "value" : "ENTITLEMENT" }, "bucket" : { "field" : "attributes.city", "size" : 100, "minDocCount" : 2, "name" : "Identity Locations", "type" : "TERMS" }, "metric" : { "field" : "@access.name", "name" : "Access Name Count", "type" : "COUNT" }, "subAggregation" : { "filter" : { "field" : "access.type", "name" : "Entitlements", "type" : "TERM", "value" : "ENTITLEMENT" }, "bucket" : { "field" : "attributes.city", "size" : 100, "minDocCount" : 2, "name" : "Identity Locations", "type" : "TERMS" }, "metric" : { "field" : "@access.name", "name" : "Access Name Count", "type" : "COUNT" }, "subAggregation" : { "filter" : { "field" : "access.type", "name" : "Entitlements", "type" : "TERM", "value" : "ENTITLEMENT" }, "bucket" : { "field" : "attributes.city", "size" : 100, "minDocCount" : 2, "name" : "Identity Locations", "type" : "TERMS" }, "metric" : { "field" : "@access.name", "name" : "Access Name Count", "type" : "COUNT" }, "nested" : { "name" : "id", "type" : "access" } }, "nested" : { "name" : "id", "type" : "access" } }, "nested" : { "name" : "id", "type" : "access" } } } # 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) except Exception as 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/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 = { "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) - path: /accounts/search-attribute-config/{name} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/search-attribute-configuration#delete-search-attribute-config source: | 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) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/search-attribute-configuration#get-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') 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) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/search-attribute-configuration#get-single-search-attribute-config source: | 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) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/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. x_sail_point_experimental = 'true' # 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) - path: /segments method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/segments#create-segment source: | segment = { "owner" : { "name" : "support", "id" : "2c9180a46faadee4016fb4e018c20639", "type" : "IDENTITY" }, "created" : "2020-01-01T00:00:00Z", "visibilityCriteria" : { "expression" : { "children" : [ ], "attribute" : "location", "value" : { "type" : "STRING", "value" : "Austin" }, "operator" : "EQUALS" } }, "name" : "segment-xyz", "modified" : "2020-01-01T00:00:00Z", "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) - path: /segments/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/segments#delete-segment 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) except Exception as e: print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) - path: /segments/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/segments#get-segment 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) except Exception as e: print("Exception when calling SegmentsApi->get_segment: %s\n" % e) - path: /segments method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/segments#list-segments 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as e: print("Exception when calling SegmentsApi->list_segments: %s\n" % e) - path: /segments/{id} method: PATCH xCodeSample: - lang: Python 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) - 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 = { "ownerRef" : "", "cluster" : "xyzzy999", "created" : "2024-01-17T18:45:25.994Z", "description" : "A very nice Service Desk integration", "clusterRef" : "", "type" : "ServiceNowSDIM", "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], "provisioningConfig" : { "managedResourceRefs" : [ { "type" : "SOURCE", "id" : "2c9180855d191c59015d291ceb051111", "name" : "My Source 1" }, { "type" : "SOURCE", "id" : "2c9180855d191c59015d291ceb052222", "name" : "My Source 2" } ], "provisioningRequestExpiration" : 7, "noProvisioningRequests" : true, "universalManager" : true, "planInitializerScript" : { "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" } }, "name" : "Service Desk Integration Name", "modified" : "2024-02-18T18:45:25.994Z", "attributes" : { "property" : "value", "key" : "value" }, "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) - path: /service-desk-integrations/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#delete-service-desk-integration 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) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e) - path: /service-desk-integrations/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-service-desk-integration 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) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e) - path: /service-desk-integrations/templates/{scriptName} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-service-desk-integration-template 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) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e) - path: /service-desk-integrations/types method: GET xCodeSample: - lang: Python 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) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) - path: /service-desk-integrations method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/service-desk-integration#get-service-desk-integrations source: | offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) 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) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) - path: /service-desk-integrations/status-check-configuration method: GET xCodeSample: - lang: Python 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) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) - path: /service-desk-integrations/{id} method: PATCH xCodeSample: - lang: Python 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) - path: /service-desk-integrations/{id} method: PUT xCodeSample: - lang: Python 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 = { "ownerRef" : "", "cluster" : "xyzzy999", "created" : "2024-01-17T18:45:25.994Z", "description" : "A very nice Service Desk integration", "clusterRef" : "", "type" : "ServiceNowSDIM", "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], "provisioningConfig" : { "managedResourceRefs" : [ { "type" : "SOURCE", "id" : "2c9180855d191c59015d291ceb051111", "name" : "My Source 1" }, { "type" : "SOURCE", "id" : "2c9180855d191c59015d291ceb052222", "name" : "My Source 2" } ], "provisioningRequestExpiration" : 7, "noProvisioningRequests" : true, "universalManager" : true, "planInitializerScript" : { "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" } }, "name" : "Service Desk Integration Name", "modified" : "2024-02-18T18:45:25.994Z", "attributes" : { "property" : "value", "key" : "value" }, "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) - 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 = { "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) - path: /sim-integrations method: POST xCodeSample: - lang: Python 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 = { "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}", "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], "created" : "2015-05-28T14:07:17Z", "name" : "aName", "modified" : "2015-05-28T14:07:17Z", "description" : "Integration description", "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", "id" : "id12345", "type" : "ServiceNow Service Desk", "beforeProvisioningRule" : { "name" : "Example Rule", "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) - path: /sim-integrations/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sim-integrations#delete-sim-integration source: | 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) except Exception as e: print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) - path: /sim-integrations/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integration 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') 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) except Exception as e: print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) - path: /sim-integrations method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sim-integrations#get-sim-integrations 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) except Exception as e: print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) - path: /sim-integrations/{id}/beforeProvisioningRule method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-before-provisioning-rule 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 = { "operations" : [ { "op" : "replace", "path" : "/description", "value" : "New description" }, { "op" : "replace", "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) - path: /sim-integrations/{id} method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sim-integrations#patch-sim-attributes 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 = { "operations" : [ { "op" : "replace", "path" : "/description", "value" : "New description" }, { "op" : "replace", "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) - path: /sim-integrations/{id} method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sim-integrations#put-sim-integration 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 = { "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}", "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], "created" : "2015-05-28T14:07:17Z", "name" : "aName", "modified" : "2015-05-28T14:07:17Z", "description" : "Integration description", "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", "id" : "id12345", "type" : "ServiceNow Service Desk", "beforeProvisioningRule" : { "name" : "Example Rule", "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) - path: /sod-policies method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#create-sod-policy source: | sod_policy = { "conflictingAccessCriteria" : { "leftCriteria" : { "name" : "money-in", "criteriaList" : [ { "type" : "ENTITLEMENT", "id" : "2c9180866166b5b0016167c32ef31a66", "name" : "Administrator" }, { "type" : "ENTITLEMENT", "id" : "2c9180866166b5b0016167c32ef31a67", "name" : "Administrator" } ] }, "rightCriteria" : { "name" : "money-in", "criteriaList" : [ { "type" : "ENTITLEMENT", "id" : "2c9180866166b5b0016167c32ef31a66", "name" : "Administrator" }, { "type" : "ENTITLEMENT", "id" : "2c9180866166b5b0016167c32ef31a67", "name" : "Administrator" } ] } }, "ownerRef" : { "name" : "Support", "id" : "2c9180a46faadee4016fb4e018c20639", "type" : "IDENTITY" }, "created" : "2020-01-01T00:00:00Z", "scheduled" : true, "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", "description" : "This policy ensures compliance of xyz", "violationOwnerAssignmentConfig" : { "assignmentRule" : "MANAGER", "ownerRef" : { "name" : "Support", "id" : "2c9180a46faadee4016fb4e018c20639", "type" : "IDENTITY" } }, "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", "type" : "GENERAL", "tags" : [ "TAG1", "TAG2" ], "name" : "policy-xyz", "modified" : "2020-01-01T00:00:00Z", "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", "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) - path: /sod-policies/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy source: | 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) except Exception as e: print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) - path: /sod-policies/{id}/schedule method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#delete-sod-policy-schedule 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) except Exception as e: print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) - path: /sod-violation-report/{reportResultId}/download/{fileName} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-custom-violation-report source: | 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) except Exception as e: print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) - path: /sod-violation-report/{reportResultId}/download method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-default-violation-report 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) except Exception as e: print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) - path: /sod-violation-report method: GET xCodeSample: - lang: Python 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) except Exception as e: print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) - path: /sod-policies/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy 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) except Exception as e: print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) - path: /sod-policies/{id}/schedule method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-policy-schedule 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) except Exception as e: print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) - path: /sod-policies/sod-violation-report-status/{reportResultId} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-run-status 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) except Exception as e: print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) - path: /sod-policies/{id}/violation-report method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#get-sod-violation-report-status 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) except Exception as e: print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) - path: /sod-policies method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#list-sod-policies 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = '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) except Exception as e: print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) - path: /sod-policies/{id} method: PATCH xCodeSample: - lang: Python 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) - path: /sod-policies/{id}/schedule method: PUT xCodeSample: - lang: Python 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 = { "schedule" : { "hours" : { "accountMatchConfig" : { "matchExpression" : { "and" : true, "matchTerms" : [ { "name" : "", "value" : "", "container" : true, "and" : false, "children" : [ { "name" : "businessCategory", "value" : "Service", "op" : "eq", "container" : false, "and" : false } ] } ] } }, "applicationId" : "2c91808874ff91550175097daaec161c\"" }, "months" : { "accountMatchConfig" : { "matchExpression" : { "and" : true, "matchTerms" : [ { "name" : "", "value" : "", "container" : true, "and" : false, "children" : [ { "name" : "businessCategory", "value" : "Service", "op" : "eq", "container" : false, "and" : false } ] } ] } }, "applicationId" : "2c91808874ff91550175097daaec161c\"" }, "timeZoneId" : "America/Chicago", "days" : { "accountMatchConfig" : { "matchExpression" : { "and" : true, "matchTerms" : [ { "name" : "", "value" : "", "container" : true, "and" : false, "children" : [ { "name" : "businessCategory", "value" : "Service", "op" : "eq", "container" : false, "and" : false } ] } ] } }, "applicationId" : "2c91808874ff91550175097daaec161c\"" }, "expiration" : "2018-06-25T20:22:28.104Z", "type" : "WEEKLY" }, "created" : "2020-01-01T00:00:00Z", "recipients" : [ { "name" : "Michael Michaels", "id" : "2c7180a46faadee4016fb4e018c20642", "type" : "IDENTITY" }, { "name" : "Michael Michaels", "id" : "2c7180a46faadee4016fb4e018c20642", "type" : "IDENTITY" } ], "name" : "SCH-1584312283015", "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", "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) - path: /sod-policies/{id} method: PUT xCodeSample: - lang: Python 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 = { "conflictingAccessCriteria" : { "leftCriteria" : { "name" : "money-in", "criteriaList" : [ { "type" : "ENTITLEMENT", "id" : "2c9180866166b5b0016167c32ef31a66", "name" : "Administrator" }, { "type" : "ENTITLEMENT", "id" : "2c9180866166b5b0016167c32ef31a67", "name" : "Administrator" } ] }, "rightCriteria" : { "name" : "money-in", "criteriaList" : [ { "type" : "ENTITLEMENT", "id" : "2c9180866166b5b0016167c32ef31a66", "name" : "Administrator" }, { "type" : "ENTITLEMENT", "id" : "2c9180866166b5b0016167c32ef31a67", "name" : "Administrator" } ] } }, "ownerRef" : { "name" : "Support", "id" : "2c9180a46faadee4016fb4e018c20639", "type" : "IDENTITY" }, "created" : "2020-01-01T00:00:00Z", "scheduled" : true, "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", "description" : "This policy ensures compliance of xyz", "violationOwnerAssignmentConfig" : { "assignmentRule" : "MANAGER", "ownerRef" : { "name" : "Support", "id" : "2c9180a46faadee4016fb4e018c20639", "type" : "IDENTITY" } }, "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", "type" : "GENERAL", "tags" : [ "TAG1", "TAG2" ], "name" : "policy-xyz", "modified" : "2020-01-01T00:00:00Z", "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", "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) - path: /sod-policies/{id}/evaluate method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-evaluate-sod-policy 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) except Exception as 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 = { "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) - path: /sod-policies/{id}/violation-report/run method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sod-policies#start-sod-policy 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) except Exception as 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 = { "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" } ] } # 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) - 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 | 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) except Exception as e: print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: - lang: Python 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 = { "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" } # 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) - path: /sources method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#create-source source: | source = { "cluster" : { "name" : "Corporate Cluster", "id" : "2c9180866166b5b0016167c32ef31a66", "type" : "CLUSTER" }, "deleteThreshold" : 10, "connectorId" : "active-directory", "description" : "This is the corporate directory.", "type" : "OpenLDAP - Direct", "connectorClass" : "sailpoint.connector.LDAPConnector", "connectionType" : "file", "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], "passwordPolicies" : [ { "type" : "PASSWORD_POLICY", "id" : "2c9180855d191c59015d291ceb053980", "name" : "Corporate Password Policy" }, { "type" : "PASSWORD_POLICY", "id" : "2c9180855d191c59015d291ceb057777", "name" : "Vendor Password Policy" } ], "modified" : "2024-01-23T18:08:50.897Z", "id" : "2c91808568c529c60168cca6f90c1324", "connectorImplementationId" : "delimited-file", "managerCorrelationRule" : { "name" : "Example Rule", "id" : "2c918085708c274401708c2a8a760001", "type" : "RULE" }, "owner" : { "name" : "MyName", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, "managementWorkgroup" : { "name" : "My Management Workgroup", "id" : "2c91808568c529c60168cca6f90c2222", "type" : "GOVERNANCE_GROUP" }, "accountCorrelationRule" : { "name" : "Example Rule", "id" : "2c918085708c274401708c2a8a760001", "type" : "RULE" }, "authoritative" : false, "connectorAttributes" : { "healthCheckTimeout" : 30, "authSearchAttributes" : [ "cn", "uid", "mail" ] }, "created" : "2022-02-08T14:50:03.827Z", "managerCorrelationMapping" : { "accountAttributeName" : "manager", "identityAttributeName" : "manager" }, "credentialProviderEnabled" : false, "accountCorrelationConfig" : { "name" : "Directory [source-62867] Account Correlation", "id" : "2c9180855d191c59015d28583727245a", "type" : "ACCOUNT_CORRELATION_CONFIG" }, "connector" : "active-directory", "healthy" : true, "schemas" : [ { "type" : "CONNECTOR_SCHEMA", "id" : "2c9180835d191a86015d28455b4b232a", "name" : "account" }, { "type" : "CONNECTOR_SCHEMA", "id" : "2c9180835d191a86015d28455b4b232b", "name" : "group" } ], "name" : "My Source", "connectorName" : "Active Directory", "category" : "CredentialProvider", "beforeProvisioningRule" : { "name" : "Example Rule", "id" : "2c918085708c274401708c2a8a760001", "type" : "RULE" }, "status" : "SOURCE_STATE_HEALTHY", "since" : "2021-09-28T15:48:29.3801666300Z" } # 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) except Exception as e: print("Exception when calling SourcesApi->create_source: %s\n" % e) - path: /sources/{sourceId}/schedules method: POST xCodeSample: - lang: Python 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) - path: /sources/{sourceId}/schemas method: POST xCodeSample: - lang: Python 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) - path: /sources/{id}/remove-accounts method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#delete-accounts-async source: | 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) except Exception as e: print("Exception when calling SourcesApi->delete_accounts_async: %s\n" % e) - path: /sources/{sourceId}/native-change-detection-config method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#delete-native-change-detection-config 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') 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) except Exception as e: print("Exception when calling SourcesApi->delete_native_change_detection_config: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#delete-provisioning-policy 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. 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) except Exception as e: print("Exception when calling SourcesApi->delete_provisioning_policy: %s\n" % e) - path: /sources/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#delete-source 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) except Exception as e: print("Exception when calling SourcesApi->delete_source: %s\n" % e) - path: /sources/{sourceId}/schedules/{scheduleType} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#delete-source-schedule source: | 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) except Exception as e: print("Exception when calling SourcesApi->delete_source_schedule: %s\n" % e) - path: /sources/{sourceId}/schemas/{schemaId} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#delete-source-schema source: | 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) except Exception as e: print("Exception when calling SourcesApi->delete_source_schema: %s\n" % e) - path: /sources/{id}/schemas/accounts method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-accounts-schema 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) except Exception as e: print("Exception when calling SourcesApi->get_accounts_schema: %s\n" % e) - path: /sources/{id}/correlation-config method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-correlation-config 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) except Exception as e: print("Exception when calling SourcesApi->get_correlation_config: %s\n" % e) - path: /sources/{id}/schemas/entitlements method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-entitlements-schema 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_entitlements_schema(id, ) # Below is a request that includes all optional parameters # api_instance.get_entitlements_schema(id, schema_name) except Exception as e: print("Exception when calling SourcesApi->get_entitlements_schema: %s\n" % e) - path: /sources/{sourceId}/native-change-detection-config method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-native-change-detection-config 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') 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) except Exception as e: print("Exception when calling SourcesApi->get_native_change_detection_config: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-provisioning-policy 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. 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) except Exception as e: print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) - path: /sources/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-source 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) except Exception as e: print("Exception when calling SourcesApi->get_source: %s\n" % e) - path: /sources/{id}/attribute-sync-config method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-source-attr-sync-config 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') 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) except Exception as e: print("Exception when calling SourcesApi->get_source_attr_sync_config: %s\n" % e) - path: /sources/{id}/connectors/source-config method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-source-config source: | 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) 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) except Exception as e: print("Exception when calling SourcesApi->get_source_config: %s\n" % e) - path: /sources/{id}/entitlement-request-config method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-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') 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) except Exception as e: print("Exception when calling SourcesApi->get_source_entitlement_request_config: %s\n" % e) - path: /sources/{sourceId}/source-health method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-source-health 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) except Exception as e: print("Exception when calling SourcesApi->get_source_health: %s\n" % e) - path: /sources/{sourceId}/schedules/{scheduleType} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-source-schedule source: | 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) except Exception as e: print("Exception when calling SourcesApi->get_source_schedule: %s\n" % e) - path: /sources/{sourceId}/schedules method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-source-schedules 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) except Exception as e: print("Exception when calling SourcesApi->get_source_schedules: %s\n" % e) - path: /sources/{sourceId}/schemas/{schemaId} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-source-schema source: | 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) except Exception as e: print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) - path: /sources/{sourceId}/schemas method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#get-source-schemas source: | 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) 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) except Exception as e: print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) - path: /sources/{id}/load-accounts method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#import-accounts source: | 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) 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) except Exception as e: print("Exception when calling SourcesApi->import_accounts: %s\n" % e) - path: /sources/{id}/schemas/accounts method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#import-accounts-schema 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_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) except Exception as e: print("Exception when calling SourcesApi->import_accounts_schema: %s\n" % e) - path: /sources/{sourceId}/upload-connector-file method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#import-connector-file source: | 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) except Exception as e: print("Exception when calling SourcesApi->import_connector_file: %s\n" % e) - path: /sources/{id}/schemas/entitlements method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#import-entitlements-schema 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) 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) except Exception as e: print("Exception when calling SourcesApi->import_entitlements_schema: %s\n" % e) - path: /sources/{id}/load-uncorrelated-accounts method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#import-uncorrelated-accounts source: | 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) 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) except Exception as e: print("Exception when calling SourcesApi->import_uncorrelated_accounts: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#list-provisioning-policies 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) except Exception as e: print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) - path: /sources method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#list-sources 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 \"Employees\"' # str | Filter results using the standard syntax described in [V3 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* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, 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: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, 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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, 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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) 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) except Exception as e: print("Exception when calling SourcesApi->list_sources: %s\n" % e) - path: /sources/{sourceId}/connector/peek-resource-objects method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#peek-resource-objects 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 = { "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) - path: /sources/{sourceId}/connector/ping-cluster method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#ping-cluster 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') 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) except Exception as e: print("Exception when calling SourcesApi->ping_cluster: %s\n" % e) - path: /sources/{id}/correlation-config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#put-correlation-config source: | id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id correlation_config = { "attributeAssignments" : [ { "filterString" : "first_name == \"John\"", "ignoreCase" : false, "complex" : false, "property" : "first_name", "value" : "firstName", "operation" : "EQ", "matchMode" : "ANYWHERE" }, { "filterString" : "first_name == \"John\"", "ignoreCase" : false, "complex" : false, "property" : "first_name", "value" : "firstName", "operation" : "EQ", "matchMode" : "ANYWHERE" } ], "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) - path: /sources/{sourceId}/native-change-detection-config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#put-native-change-detection-config 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 = { "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) - path: /sources/{sourceId}/provisioning-policies/{usageType} method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#put-provisioning-policy 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 = { "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" } # 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) - path: /sources/{id} method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#put-source source: | id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. source = { "cluster" : { "name" : "Corporate Cluster", "id" : "2c9180866166b5b0016167c32ef31a66", "type" : "CLUSTER" }, "deleteThreshold" : 10, "connectorId" : "active-directory", "description" : "This is the corporate directory.", "type" : "OpenLDAP - Direct", "connectorClass" : "sailpoint.connector.LDAPConnector", "connectionType" : "file", "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], "passwordPolicies" : [ { "type" : "PASSWORD_POLICY", "id" : "2c9180855d191c59015d291ceb053980", "name" : "Corporate Password Policy" }, { "type" : "PASSWORD_POLICY", "id" : "2c9180855d191c59015d291ceb057777", "name" : "Vendor Password Policy" } ], "modified" : "2024-01-23T18:08:50.897Z", "id" : "2c91808568c529c60168cca6f90c1324", "connectorImplementationId" : "delimited-file", "managerCorrelationRule" : { "name" : "Example Rule", "id" : "2c918085708c274401708c2a8a760001", "type" : "RULE" }, "owner" : { "name" : "MyName", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, "managementWorkgroup" : { "name" : "My Management Workgroup", "id" : "2c91808568c529c60168cca6f90c2222", "type" : "GOVERNANCE_GROUP" }, "accountCorrelationRule" : { "name" : "Example Rule", "id" : "2c918085708c274401708c2a8a760001", "type" : "RULE" }, "authoritative" : false, "connectorAttributes" : { "healthCheckTimeout" : 30, "authSearchAttributes" : [ "cn", "uid", "mail" ] }, "created" : "2022-02-08T14:50:03.827Z", "managerCorrelationMapping" : { "accountAttributeName" : "manager", "identityAttributeName" : "manager" }, "credentialProviderEnabled" : false, "accountCorrelationConfig" : { "name" : "Directory [source-62867] Account Correlation", "id" : "2c9180855d191c59015d28583727245a", "type" : "ACCOUNT_CORRELATION_CONFIG" }, "connector" : "active-directory", "healthy" : true, "schemas" : [ { "type" : "CONNECTOR_SCHEMA", "id" : "2c9180835d191a86015d28455b4b232a", "name" : "account" }, { "type" : "CONNECTOR_SCHEMA", "id" : "2c9180835d191a86015d28455b4b232b", "name" : "group" } ], "name" : "My Source", "connectorName" : "Active Directory", "category" : "CredentialProvider", "beforeProvisioningRule" : { "name" : "Example Rule", "id" : "2c918085708c274401708c2a8a760001", "type" : "RULE" }, "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) - path: /sources/{id}/attribute-sync-config method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#put-source-attr-sync-config 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 = { "attributes" : [ { "name" : "email", "displayName" : "Email", "enabled" : true, "target" : "mail" }, { "name" : "firstname", "displayName" : "First Name", "enabled" : false, "target" : "givenName" } ], "source" : { "name" : "HR Active Directory", "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) - path: /sources/{sourceId}/schemas/{schemaId} method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#put-source-schema 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) - path: /sources/{id}/synchronize-attributes method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#sync-attributes-for-source source: | 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) except Exception as e: print("Exception when calling SourcesApi->sync_attributes_for_source: %s\n" % e) - path: /sources/{sourceId}/connector/test-configuration method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#test-source-configuration 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') 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) except Exception as e: print("Exception when calling SourcesApi->test_source_configuration: %s\n" % e) - path: /sources/{sourceId}/connector/check-connection method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#test-source-connection 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') 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) except Exception as e: print("Exception when calling SourcesApi->test_source_connection: %s\n" % e) - path: /sources/{sourceId}/password-policies method: PATCH xCodeSample: - lang: Python 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) - path: /sources/{sourceId}/provisioning-policies/bulk-update method: POST xCodeSample: - lang: Python 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) - path: /sources/{sourceId}/provisioning-policies/{usageType} method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#update-provisioning-policy 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) - path: /sources/{id} method: PATCH xCodeSample: - lang: Python 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) - path: /sources/{id}/entitlement-request-config method: PUT xCodeSample: - lang: Python 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 = { "accessRequestConfig" : { "denialCommentRequired" : false, "approvalSchemes" : [ { "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", "approverType" : "GOVERNANCE_GROUP" }, { "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", "approverType" : "GOVERNANCE_GROUP" } ], "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) - path: /sources/{sourceId}/schedules/{scheduleType} method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#update-source-schedule 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) - path: /sources/{sourceId}/schemas/{schemaId} method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sources#update-source-schema 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) - path: /source-usages/{sourceId}/status method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/source-usages#get-status-by-source-id 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) except Exception as e: print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) - path: /source-usages/{sourceId}/summaries method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/source-usages#get-usages-by-source-id source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as 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 = { "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) - path: /sp-config/export/{id}/download method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export 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) except Exception as e: print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) - path: /sp-config/export/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-export-status 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) except Exception as e: print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) - path: /sp-config/import/{id}/download method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import 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) except Exception as e: print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) - path: /sp-config/import/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sp-config#get-sp-config-import-status 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) except Exception as e: print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) - path: /sp-config/import method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/sp-config#import-sp-config 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) - path: /sp-config/config-objects method: GET xCodeSample: - lang: Python 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) except Exception as e: print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#get-sed-batch-stats 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) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batch_stats: %s\n" % e) - path: /suggested-entitlement-description-batches method: GET xCodeSample: - lang: Python 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) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batches: %s\n" % e) - path: /suggested-entitlement-descriptions method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/suggested-entitlement-description#list-seds 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = '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) count_only = False # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to False) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to False) 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) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) - path: /suggested-entitlement-descriptions method: PATCH xCodeSample: - lang: Python 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) - 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) - 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 = { "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) - 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 = { "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) - path: /tagged-objects/{type}/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/tagged-objects#delete-tagged-object source: | 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) except Exception as 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 = { "objectRefs" : [ { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" } ], "tags" : [ "BU_FINANCE", "PCI" ] } # 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) except Exception as e: print("Exception when calling TaggedObjectsApi->delete_tags_to_many_object: %s\n" % e) - path: /tagged-objects/{type}/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/tagged-objects#get-tagged-object source: | 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) except Exception as e: print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e) - path: /tagged-objects method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/tagged-objects#list-tagged-objects 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) - path: /tagged-objects/{type} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/tagged-objects#list-tagged-objects-by-type source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) - path: /tagged-objects/{type}/{id} method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/tagged-objects#put-tagged-object 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 = { "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) - path: /tagged-objects method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/tagged-objects#set-tag-to-object source: | tagged_object = { "objectRef" : { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, "tags" : [ "BU_FINANCE", "PCI" ] } # 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) except Exception as 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 = { "objectRefs" : [ { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" } ], "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) - path: /task-status/pending-tasks method: HEAD xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/task-management#get-pending-task-headers 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') offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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: # 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) except Exception as e: print("Exception when calling TaskManagementApi->get_pending_task_headers: %s\n" % e) - path: /task-status/pending-tasks method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/task-management#get-pending-tasks 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') offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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: # 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) except Exception as e: print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) - path: /task-status/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/task-management#get-task-status 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') 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) except Exception as e: print("Exception when calling TaskManagementApi->get_task_status: %s\n" % e) - path: /task-status method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/task-management#get-task-status-list 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') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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 = '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) except Exception as e: print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) - path: /task-status/{id} method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/task-management#update-task-status 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) - path: /tenant method: GET xCodeSample: - lang: Python 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) except Exception as 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 = { "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) - path: /transforms/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/transforms#delete-transform 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) except Exception as e: print("Exception when calling TransformsApi->delete_transform: %s\n" % e) - path: /transforms/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/transforms#get-transform 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) except Exception as e: print("Exception when calling TransformsApi->get_transform: %s\n" % e) - path: /transforms method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/transforms#list-transforms source: | offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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) 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) except Exception as e: print("Exception when calling TransformsApi->list_transforms: %s\n" % e) - path: /transforms/{id} method: PUT xCodeSample: - lang: Python 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 = { "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) - path: /trigger-invocations/{id}/complete method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/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. x_sail_point_experimental = 'true' # 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 = { "output" : { "approved" : false }, "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", "error" : "Access request is denied." } # 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) except Exception as 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/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 = { "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", "httpConfig" : { "bearerTokenAuthConfig" : { "bearerToken" : "bearerToken" }, "httpAuthenticationType" : "BASIC_AUTH", "httpDispatchMode" : "SYNC", "basicAuthConfig" : { "password" : "password", "userName" : "user@example.com" }, "url" : "https://www.example.com" }, "triggerId" : "idn:access-requested", "name" : "Access request subscription", "description" : "Access requested to site xyz", "eventBridgeConfig" : { "awsRegion" : "us-west-1", "awsAccount" : "123456789012" }, "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) - path: /trigger-subscriptions/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/triggers#delete-subscription 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') 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) except Exception as e: print("Exception when calling TriggersApi->delete_subscription: %s\n" % e) - path: /trigger-subscriptions method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/triggers#list-subscriptions 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') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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 = '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) except Exception as e: print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) - path: /trigger-invocations/status method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/triggers#list-trigger-invocation-status 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') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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 = '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) except Exception as e: print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) - path: /triggers method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/triggers#list-triggers 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') limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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 = '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) except Exception as e: print("Exception when calling TriggersApi->list_triggers: %s\n" % e) - path: /trigger-subscriptions/{id} method: PATCH xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/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 x_sail_point_experimental = 'true' # 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] | 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) 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/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 = { "input" : { "identityId" : "201327fda1c44704ac01181e963d463c" }, "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], "triggerId" : "idn:access-request-post-approval", "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) - path: /trigger-subscriptions/validate-filter method: POST xCodeSample: - lang: Python 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 = { "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) - path: /trigger-subscriptions/{id} method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/triggers#update-subscription 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 = { "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", "httpConfig" : { "bearerTokenAuthConfig" : { "bearerToken" : "bearerToken" }, "httpAuthenticationType" : "BASIC_AUTH", "httpDispatchMode" : "SYNC", "basicAuthConfig" : { "password" : "password", "userName" : "user@example.com" }, "url" : "https://www.example.com" }, "name" : "Access request subscription", "description" : "Access requested to site xyz", "eventBridgeConfig" : { "awsRegion" : "us-west-1", "awsAccount" : "123456789012" }, "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) - path: /ui-metadata/tenant method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/ui-metadata#get-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') 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) except Exception as 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/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 = { "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) - 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 = { "createdAt" : "2024-03-13T12:56:19.391294Z", "deletedAt" : { "Valid" : false, "Time" : "0001-01-01T00:00:00Z" }, "updatedBy" : { "Valid" : true, "String" : "user-67891" }, "connector" : "Example connector", "createdBy" : "admin", "vendor" : "Example vendor", "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", "deletedBy" : { "Valid" : false, "String" : "" }, "updatedAt" : { "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) - 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 = { "createdAt" : "2024-03-13T12:56:19.391294Z", "deletedAt" : { "Valid" : false, "Time" : "0001-01-01T00:00:00Z" }, "updatedBy" : { "Valid" : true, "String" : "user-67891" }, "connector" : "Example connector", "createdBy" : "admin", "vendor" : "Example vendor", "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", "deletedBy" : { "Valid" : false, "String" : "" }, "updatedAt" : { "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) - path: /vendor-connector-mappings method: GET xCodeSample: - lang: Python 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) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) - path: /workflow-executions/{id}/cancel method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#cancel-workflow-execution 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) except Exception as e: print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) - path: /workflows/execute/external/{id} method: POST xCodeSample: - lang: Python 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) - 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 | 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) except Exception as e: print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) - path: /workflows/{id}/external/oauth-clients method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#create-workflow-external-trigger 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) except Exception as e: print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) - path: /workflows/{id} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#delete-workflow 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) except Exception as e: print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) - path: /workflows/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow 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) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) - path: /workflow-executions/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution 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) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) - path: /workflow-executions/{id}/history method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-execution-history 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) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) - path: /workflows/{id}/executions method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#get-workflow-executions source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) - path: /workflow-library method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#list-complete-workflow-library 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) 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) except Exception as e: print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) - path: /workflow-library/actions method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-actions 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) 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) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) - path: /workflow-library/operators method: GET xCodeSample: - lang: Python 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) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) - path: /workflow-library/triggers method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/workflows#list-workflow-library-triggers 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) 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) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) - path: /workflows method: GET xCodeSample: - lang: Python 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) except Exception as e: print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) - path: /workflows/{id} method: PATCH xCodeSample: - lang: Python 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) - path: /workflows/{id} method: PUT xCodeSample: - lang: Python 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 = { "owner" : { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, "name" : "Send Email", "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", "type" : "ACTION" }, "success" : { "type" : "success" } } }, "trigger" : { "displayName" : "displayName", "attributes" : { "description" : "Triggered when an identity's manager attribute changes", "attributeToFilter" : "LifecycleState", "id" : "idn:identity-attributes-changed", "filter.$" : "$.changes[?(@.attribute == 'manager')]" }, "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) - path: /workflows/execute/external/{id}/test method: POST xCodeSample: - lang: Python 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) - path: /workflows/{id}/test method: POST xCodeSample: - lang: Python 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) - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#approve-approval-item source: | 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) except Exception as e: print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) - path: /work-items/bulk-approve/{id} method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#approve-approval-items-in-bulk 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) except Exception as e: print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) - path: /work-items/{id} method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#complete-work-item source: | 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) except Exception as e: print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) - path: /work-items/{id}/forward method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#forward-work-item 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 = { "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", "comment" : "I'm going on vacation.", "sendNotifications" : true } # 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) except Exception as e: print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e) - path: /work-items/completed method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#get-completed-work-items source: | 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as e: print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) - path: /work-items/completed/count method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#get-count-completed-work-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') 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) except Exception as e: print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) - path: /work-items/count method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#get-count-work-items 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) except Exception as e: print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) - path: /work-items/{id} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#get-work-item 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) except Exception as e: print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) - path: /work-items/summary method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#get-work-items-summary 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) except Exception as e: print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) - path: /work-items method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#list-work-items 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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) except Exception as e: print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) - path: /work-items/{id}/reject/{approvalItemId} method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#reject-approval-item source: | 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) except Exception as e: print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) - path: /work-items/bulk-reject/{id} method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#reject-approval-items-in-bulk 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) except Exception as e: print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) - path: /work-items/{id}/submit-account-selection method: POST xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-items#submit-account-selection source: | 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) except Exception as 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/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 = { "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) - path: /reassignment-configurations/{identityId}/{configType} method: DELETE xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-reassignment#delete-reassignment-configuration source: | 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') 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) except Exception as e: print("Exception when calling WorkReassignmentApi->delete_reassignment_configuration: %s\n" % e) - path: /reassignment-configurations/{identityId}/evaluate/{configType} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-evaluate-reassignment-configuration source: | 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) 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) except Exception as e: print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) - path: /reassignment-configurations/types method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-reassignment-config-types 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) except Exception as e: print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) - path: /reassignment-configurations/{identityId} method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-reassignment-configuration source: | 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) except Exception as e: print("Exception when calling WorkReassignmentApi->get_reassignment_configuration: %s\n" % e) - path: /reassignment-configurations/tenant-config method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-reassignment#get-tenant-config-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') 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) except Exception as e: print("Exception when calling WorkReassignmentApi->get_tenant_config_configuration: %s\n" % e) - path: /reassignment-configurations method: GET xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-reassignment#list-reassignment-configurations 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) except Exception as e: print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) - path: /reassignment-configurations/{identityId} method: PUT xCodeSample: - lang: Python label: SDK_tools/sdk/python/v2024/methods/work-reassignment#put-reassignment-config 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 = { "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) - path: /reassignment-configurations/tenant-config method: PUT xCodeSample: - lang: Python 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 = { "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)