- path: /access-model-metadata/attributes/{key} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-model-metadata#get-access-model-metadata-attribute source: | $Key = "iscPrivacy" # String | Technical name of the Attribute. # Get Access Model Metadata Attribute try { Get-BetaAccessModelMetadataAttribute -Key $Key # Below is a request that includes all optional parameters # Get-BetaAccessModelMetadataAttribute -Key $Key } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/access-model-metadata#get-access-model-metadata-attribute source: | key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. try: # Get Access Model Metadata Attribute api_response = api_instance.get_access_model_metadata_attribute(key) # Below is a request that includes all optional parameters # api_response = api_instance.get_access_model_metadata_attribute(key) print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute:\n") pprint(api_response) except Exception as e: print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute: %s\n" % e) - path: /access-model-metadata/attributes/{key}/values/{value} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-model-metadata#get-access-model-metadata-attribute-value source: | $Key = "iscPrivacy" # String | Technical name of the Attribute. $Value = "public" # String | Technical name of the Attribute value. # Get Access Model Metadata Value try { Get-BetaAccessModelMetadataAttributeValue -Key $Key -Value $Value # Below is a request that includes all optional parameters # Get-BetaAccessModelMetadataAttributeValue -Key $Key -Value $Value } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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. try: # Get Access Model Metadata Value api_response = api_instance.get_access_model_metadata_attribute_value(key, value) # Below is a request that includes all optional parameters # api_response = api_instance.get_access_model_metadata_attribute_value(key, value) print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute_value:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-model-metadata#list-access-model-metadata-attribute source: | $Filters = "name eq "Privacy"" # String | Filter results using the standard syntax described in [V3 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) # List Access Model Metadata Attributes try { Get-BetaAccessModelMetadataAttribute # Below is a request that includes all optional parameters # Get-BetaAccessModelMetadataAttribute -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/access-model-metadata#list-access-model-metadata-attribute source: | filters = 'name eq \"Privacy\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) try: # List Access Model Metadata Attributes api_response = api_instance.list_access_model_metadata_attribute() # Below is a request that includes all optional parameters # api_response = api_instance.list_access_model_metadata_attribute(filters) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-model-metadata#list-access-model-metadata-attribute-value source: | $Key = "iscPrivacy" # String | Technical name of the Attribute. # List Access Model Metadata Values try { Get-BetaAccessModelMetadataAttributeValue -Key $Key # Below is a request that includes all optional parameters # Get-BetaAccessModelMetadataAttributeValue -Key $Key } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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. try: # List Access Model Metadata Values api_response = api_instance.list_access_model_metadata_attribute_value(key) # Below is a request that includes all optional parameters # api_response = api_instance.list_access_model_metadata_attribute_value(key) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-profiles#create-access-profile source: | $AccessProfile = @" { "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 } "@ # Create Access Profile try { $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile New-BetaAccessProfile -AccessProfile $Result # Below is a request that includes all optional parameters # New-BetaAccessProfile -AccessProfile $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessProfile" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-profiles#list-access-profiles source: | $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | 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 # Int32 | 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 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 API Standard 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* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described 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) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | 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) $IncludeUnsegmented = $false # Boolean | 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) # List Access Profiles try { Get-BetaAccessProfiles # Below is a request that includes all optional parameters # Get-BetaAccessProfiles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfiles" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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* 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* 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: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-profiles#delete-access-profile source: | $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete # Delete the specified Access Profile try { Remove-BetaAccessProfile -Id $Id # Below is a request that includes all optional parameters # Remove-BetaAccessProfile -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfile" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/{id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-profiles#get-access-profile source: | $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile # Get an Access Profile try { Get-BetaAccessProfile -Id $Id # Below is a request that includes all optional parameters # Get-BetaAccessProfile -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfile" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-profiles#patch-access-profile source: | $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Patch a specified Access Profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation Update-BetaAccessProfile -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters # Update-BetaAccessProfile -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfile" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/access-profiles#patch-access-profile source: | id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to patch # str | ID of the Access Profile to patch [{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}] # List[JsonPatchOperation] | json_patch_operation = { "op" : "replace", "path" : "/description", "value" : "New description" } # List[JsonPatchOperation] | try: # Patch a specified Access Profile Result = json_patch_operation.from_json(json_patch_operation) api_response = api_instance.patch_access_profile(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.patch_access_profile(id, Result) print("The response of AccessProfilesApi->patch_access_profile:\n") pprint(api_response) except Exception as e: print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e) - path: /access-profiles/bulk-delete method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-profiles#delete-access-profiles-in-bulk source: | $AccessProfileBulkDeleteRequest = @" { "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], "bestEffortOnly" : true } "@ # Delete Access Profile(s) try { $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest Remove-BetaAccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result # Below is a request that includes all optional parameters # Remove-BetaAccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesInBulk" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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}/entitlements method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-profiles#get-access-profile-entitlements source: | $Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 API Standard 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" # String | Sort results using the standard syntax described 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) # List Access Profile's Entitlements try { Get-BetaAccessProfileEntitlements -Id $Id # Below is a request that includes all optional parameters # Get-BetaAccessProfileEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfileEntitlements" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/bulk-update-requestable method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-profiles#update-access-profiles-in-bulk source: | $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ # Update Access Profile(s) requestable field. try { $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner Update-BetaAccessProfilesInBulk -AccessProfileBulkUpdateRequestInner $Result # Below is a request that includes all optional parameters # Update-BetaAccessProfilesInBulk -AccessProfileBulkUpdateRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfilesInBulk" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/access-profiles#update-access-profiles-in-bulk source: | [{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}] # List[AccessProfileBulkUpdateRequestInner] | access_profile_bulk_update_request_inner = [{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}] # List[AccessProfileBulkUpdateRequestInner] | try: # Update Access Profile(s) requestable field. Result = access_profile_bulk_update_request_inner.from_json(access_profile_bulk_update_request_inner) api_response = api_instance.update_access_profiles_in_bulk(Result) # Below is a request that includes all optional parameters # api_response = api_instance.update_access_profiles_in_bulk(Result) print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#approve-access-request source: | $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. $CommentDto = @" { "author" : { "name" : "Adam Kennedy", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, "created" : "2017-07-11T18:45:37.098Z", "comment" : "This is a comment." } "@ # Approve Access Request Approval try { $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto Approve-BetaAccessRequest -ApprovalId $ApprovalId -CommentDto $Result # Below is a request that includes all optional parameters # Approve-BetaAccessRequest -ApprovalId $ApprovalId -CommentDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaAccessRequest" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/access-request-approvals#approve-access-request source: | approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. comment_dto = { "author" : { "name" : "Adam Kennedy", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, "created" : "2017-07-11T18:45:37.098Z", "comment" : "This is a comment." } # CommentDto | Reviewer's comment. try: # Approve Access Request Approval Result = comment_dto.from_json(comment_dto) api_response = api_instance.approve_access_request(approval_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.approve_access_request(approval_id, Result) print("The response of AccessRequestApprovalsApi->approve_access_request:\n") pprint(api_response) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->approve_access_request: %s\n" % e) - path: /access-request-approvals/{approvalId}/forward method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#forward-access-request source: | $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. $ForwardApprovalDto = @" { "newOwnerId" : "newOwnerId", "comment" : "comment" } "@ # Forward Access Request Approval try { $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto Invoke-BetaForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result # Below is a request that includes all optional parameters # Invoke-BetaForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardAccessRequest" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/access-request-approvals#forward-access-request source: | approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. forward_approval_dto = { "newOwnerId" : "newOwnerId", "comment" : "comment" } # ForwardApprovalDto | Information about the forwarded approval. try: # Forward Access Request Approval Result = forward_approval_dto.from_json(forward_approval_dto) api_response = api_instance.forward_access_request(approval_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.forward_access_request(approval_id, Result) print("The response of AccessRequestApprovalsApi->forward_access_request:\n") pprint(api_response) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->forward_access_request: %s\n" % e) - path: /access-request-approvals/approval-summary method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#get-access-request-approval-summary source: | $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | 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) $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) # Get Access Requests Approvals Number try { Get-BetaAccessRequestApprovalSummary # Below is a request that includes all optional parameters # Get-BetaAccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestApprovalSummary" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/completed method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#list-completed-approvals source: | $OwnerId = "MyOwnerId" # String | 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 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard 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 = "MySorters" # String | Sort results using the standard syntax described 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) # Completed Access Request Approvals List try { Get-BetaCompletedApprovals # Below is a request that includes all optional parameters # Get-BetaCompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedApprovals" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/access-request-approvals#list-completed-approvals source: | owner_id = 'owner_id_example' # str | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # str | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = 'filters_example' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) sorters = 'sorters_example' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) try: # Completed Access Request Approvals List api_response = api_instance.list_completed_approvals() # Below is a request that includes all optional parameters # api_response = api_instance.list_completed_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") pprint(api_response) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) - path: /access-request-approvals/pending method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#list-pending-approvals source: | $OwnerId = "MyOwnerId" # String | 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 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional) $Sorters = "MySorters" # String | Sort results using the standard syntax described 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) # Pending Access Request Approvals List try { Get-BetaPendingApprovals # Below is a request that includes all optional parameters # Get-BetaPendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingApprovals" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/access-request-approvals#list-pending-approvals source: | owner_id = 'owner_id_example' # str | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # str | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = 'filters_example' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional) sorters = 'sorters_example' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) try: # Pending Access Request Approvals List api_response = api_instance.list_pending_approvals() # Below is a request that includes all optional parameters # api_response = api_instance.list_pending_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-request-approvals#reject-access-request source: | $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. $CommentDto = @" { "author" : { "name" : "Adam Kennedy", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, "created" : "2017-07-11T18:45:37.098Z", "comment" : "This is a comment." } "@ # Reject Access Request Approval try { $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto Deny-BetaAccessRequest -ApprovalId $ApprovalId -CommentDto $Result # Below is a request that includes all optional parameters # Deny-BetaAccessRequest -ApprovalId $ApprovalId -CommentDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaAccessRequest" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/access-request-approvals#reject-access-request source: | approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. comment_dto = { "author" : { "name" : "Adam Kennedy", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, "created" : "2017-07-11T18:45:37.098Z", "comment" : "This is a comment." } # CommentDto | Reviewer's comment. try: # Reject Access Request Approval Result = comment_dto.from_json(comment_dto) api_response = api_instance.reject_access_request(approval_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.reject_access_request(approval_id, Result) print("The response of AccessRequestApprovalsApi->reject_access_request:\n") pprint(api_response) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e) - path: /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-request-identity-metrics#get-access-request-identity-metrics source: | $IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. $RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. $Type = "ENTITLEMENT" # String | Requested access item's type. # Return access request identity metrics try { Get-BetaAccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type # Below is a request that includes all optional parameters # Get-BetaAccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestIdentityMetrics" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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-requests/cancel method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-requests#cancel-access-request source: | $CancelAccessRequest = @" { "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", "comment" : "I requested this role by mistake." } "@ # Cancel Access Request try { $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest Suspend-BetaAccessRequest -CancelAccessRequest $Result # Below is a request that includes all optional parameters # Suspend-BetaAccessRequest -CancelAccessRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaAccessRequest" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/close method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-requests#close-access-request source: | $CloseAccessRequest = @" { "executionStatus" : "Terminated", "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], "completionStatus" : "Failure", "message" : "The IdentityNow Administrator manually closed this request." } "@ # Close Access Request try { $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest Close-BetaAccessRequest -CloseAccessRequest $Result # Below is a request that includes all optional parameters # Close-BetaAccessRequest -CloseAccessRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-BetaAccessRequest" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/access-requests#close-access-request source: | close_access_request = { "executionStatus" : "Terminated", "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], "completionStatus" : "Failure", "message" : "The IdentityNow Administrator manually closed this request." } # CloseAccessRequest | try: # Close Access Request Result = close_access_request.from_json(close_access_request) api_response = api_instance.close_access_request(Result) # Below is a request that includes all optional parameters # api_response = api_instance.close_access_request(Result) print("The response of AccessRequestsApi->close_access_request:\n") pprint(api_response) except Exception as e: print("Exception when calling AccessRequestsApi->close_access_request: %s\n" % e) - path: /access-requests method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-requests#create-access-request source: | $AccessRequest = @" { "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" } ] } "@ # Submit Access Request try { $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest New-BetaAccessRequest -AccessRequest $Result # Below is a request that includes all optional parameters # New-BetaAccessRequest -AccessRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessRequest" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-requests#get-access-request-config source: | # Get Access Request Configuration try { Get-BetaAccessRequestConfig # Below is a request that includes all optional parameters # Get-BetaAccessRequestConfig } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/access-requests#get-access-request-config source: | try: # Get Access Request Configuration api_response = api_instance.get_access_request_config() # Below is a request that includes all optional parameters # api_response = api_instance.get_access_request_config() print("The response of AccessRequestsApi->get_access_request_config:\n") pprint(api_response) except Exception as e: print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e) - path: /access-request-config method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-requests#set-access-request-config source: | $AccessRequestConfig = @" { "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 } "@ # Update Access Request Configuration try { $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig Set-BetaAccessRequestConfig -AccessRequestConfig $Result # Below is a request that includes all optional parameters # Set-BetaAccessRequestConfig -AccessRequestConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaAccessRequestConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: /access-request-status method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/access-requests#list-access-request-status source: | $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | 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) $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | 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 # Boolean | 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 = 100 # Int32 | Max number of results to return. (optional) (default to 250) $Offset = 10 # Int32 | 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"" # String | Filter results using the standard syntax described in [V3 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" # String | Sort results using the standard syntax described 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) $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) # Access Request Status try { Get-BetaAccessRequestStatus # Below is a request that includes all optional parameters # Get-BetaAccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestStatus" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: /account-activities/{id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/account-activities#get-account-activity source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id # Get Account Activity try { Get-BetaAccountActivity -Id $Id # Below is a request that includes all optional parameters # Get-BetaAccountActivity -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountActivity" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/account-activities#get-account-activity source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account activity id # str | The account activity id try: # Get Account Activity api_response = api_instance.get_account_activity(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_account_activity(id) print("The response of AccountActivitiesApi->get_account_activity:\n") pprint(api_response) except Exception as e: print("Exception when calling AccountActivitiesApi->get_account_activity: %s\n" % e) - path: /account-activities method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/account-activities#list-account-activities source: | $RequestedFor = "MyRequestedFor" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) $RequestedBy = "MyRequestedBy" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) $RegardingIdentity = "MyRegardingIdentity" # String | 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) $Type = "MyType" # String | The type of account activity. (optional) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) $Sorters = "MySorters" # String | Sort results using the standard syntax described 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) # List Account Activities try { Get-BetaAccountActivities # Below is a request that includes all optional parameters # Get-BetaAccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountActivities" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/account-activities#list-account-activities source: | requested_for = 'requested_for_example' # str | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) requested_by = 'requested_by_example' # str | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) regarding_identity = 'regarding_identity_example' # str | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # str | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) type = 'type_example' # str | The type of account activity. (optional) # str | The type of account activity. (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 = 'filters_example' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) sorters = 'sorters_example' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) try: # List Account Activities api_response = api_instance.list_account_activities() # Below is a request that includes all optional parameters # api_response = api_instance.list_account_activities(requested_for, requested_by, regarding_identity, type, limit, offset, count, filters, sorters) print("The response of AccountActivitiesApi->list_account_activities:\n") pprint(api_response) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) - path: /account-aggregations/{id}/status method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/account-aggregations#get-account-aggregation-status source: | $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id # In-progress Account Aggregation status try { Get-BetaAccountAggregationStatus -Id $Id # Below is a request that includes all optional parameters # Get-BetaAccountAggregationStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountAggregationStatus" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/account-aggregations#get-account-aggregation-status source: | id = '2c91808477a6b0c60177a81146b8110b' # str | The account aggregation id # str | The account aggregation id try: # In-progress Account Aggregation status api_response = api_instance.get_account_aggregation_status(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_account_aggregation_status(id) print("The response of AccountAggregationsApi->get_account_aggregation_status:\n") pprint(api_response) except Exception as e: print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) - path: /account-usages/{accountId}/summaries method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/account-usages#get-usages-by-account-id source: | $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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" # String | Sort results using the standard syntax described 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) # Returns account usage insights try { Get-BetaUsagesByAccountId -AccountId $AccountId # Below is a request that includes all optional parameters # Get-BetaUsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: /accounts method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/accounts#create-account source: | $AccountAttributesCreate = @" { "attributes" : { "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", "city" : "Austin", "displayName" : "John Doe", "userName" : "jdoe", "sAMAccountName" : "jDoe", "mail" : "john.doe@sailpoint.com" } } "@ # Create Account try { $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate New-BetaAccount -AccountAttributesCreate $Result # Below is a request that includes all optional parameters # New-BetaAccount -AccountAttributesCreate $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccount" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/accounts#list-accounts source: | $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional) # Accounts List try { Get-BetaAccounts # Below is a request that includes all optional parameters # Get-BetaAccounts -DetailLevel $DetailLevel -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccounts" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#list-accounts source: | detail_level = 'FULL' # str | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) # str | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* (optional) sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional) try: # Accounts List api_response = api_instance.list_accounts() # Below is a request that includes all optional parameters # api_response = api_instance.list_accounts(detail_level, limit, offset, count, filters, sorters) print("The response of AccountsApi->list_accounts:\n") pprint(api_response) except Exception as e: print("Exception when calling AccountsApi->list_accounts: %s\n" % e) - path: /accounts/{id} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/accounts#delete-account source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. # Delete Account try { Remove-BetaAccount -Id $Id # Below is a request that includes all optional parameters # Remove-BetaAccount -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccount" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/accounts#get-account source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. # Account Details try { Get-BetaAccount -Id $Id # Below is a request that includes all optional parameters # Get-BetaAccount -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccount" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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} method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/accounts#put-account source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. $AccountAttributes = @" { "attributes" : { "city" : "Austin", "displayName" : "John Doe", "userName" : "jdoe", "sAMAccountName" : "jDoe", "mail" : "john.doe@sailpoint.com" } } "@ # Update Account try { $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes Send-BetaAccount -Id $Id -AccountAttributes $Result # Below is a request that includes all optional parameters # Send-BetaAccount -Id $Id -AccountAttributes $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaAccount" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/accounts#update-account source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. $RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. $RequestBody = @"{Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}}"@ # Update Account try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody Update-BetaAccount -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters # Update-BetaAccount -Id $Id -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccount" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#update-account source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. request_body = {Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}} # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. request_body = {Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}} # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. try: # Update Account Result = request_body.from_json(request_body) api_response = api_instance.update_account(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.update_account(id, Result) print("The response of AccountsApi->update_account:\n") pprint(api_response) except Exception as e: print("Exception when calling AccountsApi->update_account: %s\n" % e) - path: /accounts/{id}/remove method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/accounts#delete-account-async source: | $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id # Remove Account try { Remove-BetaAccountAsync -Id $Id # Below is a request that includes all optional parameters # Remove-BetaAccountAsync -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccountAsync" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#delete-account-async source: | id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account id try: # Remove Account api_response = api_instance.delete_account_async(id) # Below is a request that includes all optional parameters # api_response = api_instance.delete_account_async(id) print("The response of AccountsApi->delete_account_async:\n") pprint(api_response) except Exception as e: print("Exception when calling AccountsApi->delete_account_async: %s\n" % e) - path: /accounts/{id}/disable method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/accounts#disable-account source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id $AccountToggleRequest = @" { "forceProvisioning" : false, "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" } "@ # Disable Account try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest Disable-BetaAccount -Id $Id -AccountToggleRequest $Result # Below is a request that includes all optional parameters # Disable-BetaAccount -Id $Id -AccountToggleRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccount" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/accounts#disable-account-for-identity source: | $Id = "2c91808384203c2d018437e631158309" # String | The identity id. # Disable IDN Account for Identity try { Disable-BetaAccountForIdentity -Id $Id # Below is a request that includes all optional parameters # Disable-BetaAccountForIdentity -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountForIdentity" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#disable-account-for-identity source: | id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. try: # Disable IDN Account for Identity api_response = api_instance.disable_account_for_identity(id) # Below is a request that includes all optional parameters # api_response = api_instance.disable_account_for_identity(id) print("The response of AccountsApi->disable_account_for_identity:\n") pprint(api_response) except Exception as e: print("Exception when calling AccountsApi->disable_account_for_identity: %s\n" % e) - path: /identities-accounts/disable method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/accounts#disable-accounts-for-identities source: | $IdentitiesAccountsBulkRequest = @" { "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] } "@ # Disable IDN Accounts for Identities try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest Disable-BetaAccountsForIdentities -IdentitiesAccountsBulkRequest $Result # Below is a request that includes all optional parameters # Disable-BetaAccountsForIdentities -IdentitiesAccountsBulkRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountsForIdentities" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#disable-accounts-for-identities source: | identities_accounts_bulk_request = { "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] } # IdentitiesAccountsBulkRequest | try: # Disable IDN Accounts for Identities Result = identities_accounts_bulk_request.from_json(identities_accounts_bulk_request) api_response = api_instance.disable_accounts_for_identities(Result) # Below is a request that includes all optional parameters # api_response = api_instance.disable_accounts_for_identities(Result) print("The response of AccountsApi->disable_accounts_for_identities:\n") pprint(api_response) except Exception as e: print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) - path: /accounts/{id}/enable method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/accounts#enable-account source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id $AccountToggleRequest = @" { "forceProvisioning" : false, "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" } "@ # Enable Account try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest Enable-BetaAccount -Id $Id -AccountToggleRequest $Result # Below is a request that includes all optional parameters # Enable-BetaAccount -Id $Id -AccountToggleRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccount" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/accounts#enable-account-for-identity source: | $Id = "2c91808384203c2d018437e631158309" # String | The identity id. # Enable IDN Account for Identity try { Enable-BetaAccountForIdentity -Id $Id # Below is a request that includes all optional parameters # Enable-BetaAccountForIdentity -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountForIdentity" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#enable-account-for-identity source: | id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. try: # Enable IDN Account for Identity api_response = api_instance.enable_account_for_identity(id) # Below is a request that includes all optional parameters # api_response = api_instance.enable_account_for_identity(id) print("The response of AccountsApi->enable_account_for_identity:\n") pprint(api_response) except Exception as e: print("Exception when calling AccountsApi->enable_account_for_identity: %s\n" % e) - path: /identities-accounts/enable method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/accounts#enable-accounts-for-identities source: | $IdentitiesAccountsBulkRequest = @" { "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] } "@ # Enable IDN Accounts for Identities try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest Enable-BetaAccountsForIdentities -IdentitiesAccountsBulkRequest $Result # Below is a request that includes all optional parameters # Enable-BetaAccountsForIdentities -IdentitiesAccountsBulkRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountsForIdentities" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#enable-accounts-for-identities source: | identities_accounts_bulk_request = { "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] } # IdentitiesAccountsBulkRequest | try: # Enable IDN Accounts for Identities Result = identities_accounts_bulk_request.from_json(identities_accounts_bulk_request) api_response = api_instance.enable_accounts_for_identities(Result) # Below is a request that includes all optional parameters # api_response = api_instance.enable_accounts_for_identities(Result) print("The response of AccountsApi->enable_accounts_for_identities:\n") pprint(api_response) except Exception as e: print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) - path: /accounts/{id}/entitlements method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/accounts#get-account-entitlements source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # Account Entitlements try { Get-BetaAccountEntitlements -Id $Id # Below is a request that includes all optional parameters # Get-BetaAccountEntitlements -Id $Id -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountEntitlements" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/accounts#get-account-entitlements source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) try: # Account Entitlements api_response = api_instance.get_account_entitlements(id, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_account_entitlements(id, offset, limit, count) print("The response of AccountsApi->get_account_entitlements:\n") pprint(api_response) except Exception as e: print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) - path: /accounts/{id}/reload method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/accounts#submit-reload-account source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id # Reload Account try { Submit-BetaReloadAccount -Id $Id # Below is a request that includes all optional parameters # Submit-BetaReloadAccount -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaReloadAccount" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/accounts#unlock-account source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. $AccountUnlockRequest = @" { "forceProvisioning" : false, "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", "unlockIDNAccount" : false } "@ # Unlock Account try { $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest Unlock-BetaAccount -Id $Id -AccountUnlockRequest $Result # Below is a request that includes all optional parameters # Unlock-BetaAccount -Id $Id -AccountUnlockRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-BetaAccount" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: /discovered-applications/{id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/application-discovery#get-discovered-application-by-id source: | $Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID. # Get Discovered Application by ID try { Get-BetaDiscoveredApplicationByID -Id $Id # Below is a request that includes all optional parameters # Get-BetaDiscoveredApplicationByID -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDiscoveredApplicationByID" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/application-discovery#get-discovered-application-by-id source: | id = '123e4567-e89b-12d3-a456-426655440000' # str | Discovered application's ID. # str | Discovered application's ID. try: # Get Discovered Application by ID api_instance.get_discovered_application_by_id(id) # Below is a request that includes all optional parameters # api_instance.get_discovered_application_by_id(id) except Exception as e: print("Exception when calling ApplicationDiscoveryApi->get_discovered_application_by_id: %s\n" % e) - path: /discovered-applications/{id} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/application-discovery#patch-discovered-application-by-id source: | $Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID. $JsonPatchOperations = @"{ "op" : "replace", "path" : "/dismissed", "value" : true }"@ # Patch Discovered Application by ID try { Update-BetaDiscoveredApplicationByID -Id $Id # Below is a request that includes all optional parameters # Update-BetaDiscoveredApplicationByID -Id $Id -JsonPatchOperations $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaDiscoveredApplicationByID" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/application-discovery#patch-discovered-application-by-id source: | id = '123e4567-e89b-12d3-a456-426655440000' # str | Discovered application's ID. # str | Discovered application's ID. [{op=replace, path=/dismissed, value=true}] # List[JsonPatchOperations] | (optional) json_patch_operations = { "op" : "replace", "path" : "/dismissed", "value" : true } # List[JsonPatchOperations] | (optional) try: # Patch Discovered Application by ID api_instance.patch_discovered_application_by_id(id, ) # Below is a request that includes all optional parameters # api_instance.patch_discovered_application_by_id(id, Result) except Exception as e: print("Exception when calling ApplicationDiscoveryApi->patch_discovered_application_by_id: %s\n" % e) - path: /discovered-applications method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/application-discovery#get-discovered-applications source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = "SLIM" # String | 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")" # String | Filter results using the standard syntax described in [V3 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" # String | Sort results using the standard syntax described 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) # Retrieve discovered applications for tenant try { Get-BetaDiscoveredApplications # Below is a request that includes all optional parameters # Get-BetaDiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDiscoveredApplications" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: # Retrieve discovered applications for tenant api_response = api_instance.get_discovered_applications() # Below is a request that includes all optional parameters # api_response = api_instance.get_discovered_applications(limit, offset, detail, filter, sorters) print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") pprint(api_response) except Exception as e: print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) - path: /manual-discover-applications-template method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/application-discovery#get-manual-discover-applications-csv-template source: | # Download CSV Template for Discovery try { Get-BetaManualDiscoverApplicationsCsvTemplate # Below is a request that includes all optional parameters # Get-BetaManualDiscoverApplicationsCsvTemplate } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManualDiscoverApplicationsCsvTemplate" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/application-discovery#get-manual-discover-applications-csv-template source: | try: # Download CSV Template for Discovery api_response = api_instance.get_manual_discover_applications_csv_template() # Below is a request that includes all optional parameters # api_response = api_instance.get_manual_discover_applications_csv_template() print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/application-discovery#send-manual-discover-applications-csv-template source: | $File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. # Upload CSV to Discover Applications try { Send-BetaManualDiscoverApplicationsCsvTemplate -File $File # Below is a request that includes all optional parameters # Send-BetaManualDiscoverApplicationsCsvTemplate -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaManualDiscoverApplicationsCsvTemplate" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/approvals#get-approval source: | $Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that to be returned. # Get Approval try { Get-BetaApproval -Id $Id # Below is a request that includes all optional parameters # Get-BetaApproval -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApproval" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/approvals#get-approval source: | id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | ID of the approval that to be returned. # str | ID of the approval that to be returned. try: # Get Approval api_response = api_instance.get_approval(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_approval(id) print("The response of ApprovalsApi->get_approval:\n") pprint(api_response) except Exception as e: print("Exception when calling ApprovalsApi->get_approval: %s\n" % e) - path: /generic-approvals method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/approvals#get-approvals source: | $Mine = $true # Boolean | Returns the list of approvals for the current caller. (optional) $RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID. (optional) $Filters = "filters=status eq PENDING" # String | Filter results using the standard syntax described in [V3 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) # Get Approvals try { Get-BetaApprovals # Below is a request that includes all optional parameters # Get-BetaApprovals -Mine $Mine -RequesterId $RequesterId -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApprovals" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/approvals#get-approvals source: | 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() # Below is a request that includes all optional parameters # api_response = api_instance.get_approvals(mine, requester_id, filters) print("The response of ApprovalsApi->get_approvals:\n") pprint(api_response) except Exception as e: print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) - path: /source-apps method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/apps#create-source-app source: | $SourceAppCreateDto = @" { "name" : "my app", "description" : "the source app for engineers", "accountSource" : { "name" : "ODS-AD-Source", "id" : "2c9180827ca885d7017ca8ce28a000eb", "type" : "SOURCE" }, "matchAllAccounts" : true } "@ # Create source app try { $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto New-BetaSourceApp -SourceAppCreateDto $Result # Below is a request that includes all optional parameters # New-BetaSourceApp -SourceAppCreateDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceApp" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#create-source-app source: | 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(Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_source_app(Result) print("The response of AppsApi->create_source_app:\n") pprint(api_response) except Exception as e: print("Exception when calling AppsApi->create_source_app: %s\n" % e) - path: /source-apps method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/apps#list-available-source-apps source: | $Limit = 250 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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" # String | Sort results using the standard syntax described 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"" # String | Filter results using the standard syntax described in [V3 API Standard 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) # List available source apps try { Get-BetaAvailableSourceApps # Below is a request that includes all optional parameters # Get-BetaAvailableSourceApps -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableSourceApps" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#list-available-source-apps 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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() # Below is a request that includes all optional parameters # api_response = api_instance.list_available_source_apps(limit, count, offset, sorters, filters) print("The response of AppsApi->list_available_source_apps:\n") pprint(api_response) except Exception as e: print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) - path: /source-apps/{id}/access-profiles/bulk-remove method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/apps#delete-access-profiles-from-source-app-by-bulk source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app $RequestBody = "MyRequestBody" # String[] | $RequestBody = @""@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # Bulk remove access profiles from the specified source app try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody Remove-BetaAccessProfilesFromSourceAppByBulk -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters # Remove-BetaAccessProfilesFromSourceAppByBulk -Id $Id -RequestBody $Result -Limit $Limit } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesFromSourceAppByBulk" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#delete-access-profiles-from-source-app-by-bulk source: | id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app request_body = ['request_body_example'] # List[str] | request_body = ['request_body_example'] # List[str] | limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) try: # Bulk remove access profiles from the specified source app Result = request_body.from_json(request_body) api_response = api_instance.delete_access_profiles_from_source_app_by_bulk(id, Result, ) # Below is a request that includes all optional parameters # api_response = api_instance.delete_access_profiles_from_source_app_by_bulk(id, Result, limit) print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/apps#delete-source-app source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. # Delete source app by ID try { Remove-BetaSourceApp -Id $Id # Below is a request that includes all optional parameters # Remove-BetaSourceApp -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSourceApp" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#delete-source-app source: | id = '2c9180835d191a86015d28455b4a2329' # str | source app ID. # str | source app ID. try: # Delete source app by ID api_response = api_instance.delete_source_app(id) # Below is a request that includes all optional parameters # api_response = api_instance.delete_source_app(id) print("The response of AppsApi->delete_source_app:\n") pprint(api_response) except Exception as e: print("Exception when calling AppsApi->delete_source_app: %s\n" % e) - path: /source-apps/{id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/apps#get-source-app source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app # Get source app by ID try { Get-BetaSourceApp -Id $Id # Below is a request that includes all optional parameters # Get-BetaSourceApp -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceApp" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#get-source-app source: | id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app try: # Get source app by ID api_response = api_instance.get_source_app(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_source_app(id) print("The response of AppsApi->get_source_app:\n") pprint(api_response) except Exception as e: print("Exception when calling AppsApi->get_source_app: %s\n" % e) - path: /source-apps/{id} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/apps#patch-source-app source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patch $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Patch source app by ID try { Update-BetaSourceApp -Id $Id # Below is a request that includes all optional parameters # Update-BetaSourceApp -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceApp" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#patch-source-app source: | id = '2c91808a7813090a017814121e121518' # str | ID of the source app to patch # str | ID of the source app to patch [{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}] # List[JsonPatchOperation] | (optional) json_patch_operation = { "op" : "replace", "path" : "/description", "value" : "New description" } # List[JsonPatchOperation] | (optional) try: # Patch source app by ID api_response = api_instance.patch_source_app(id, ) # Below is a request that includes all optional parameters # api_response = api_instance.patch_source_app(id, Result) print("The response of AppsApi->patch_source_app:\n") pprint(api_response) except Exception as e: print("Exception when calling AppsApi->patch_source_app: %s\n" % e) - path: /source-apps/{id}/access-profiles method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/apps#list-access-profiles-for-source-app source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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"" # String | Filter results using the standard syntax described in [V3 API Standard 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) # List access profiles for the specified source app try { Get-BetaAccessProfilesForSourceApp -Id $Id # Below is a request that includes all optional parameters # Get-BetaAccessProfilesForSourceApp -Id $Id -Limit $Limit -Offset $Offset -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfilesForSourceApp" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#list-access-profiles-for-source-app source: | id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) filters = 'name eq \"developer access profile\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) try: # List access profiles for the specified source app api_response = api_instance.list_access_profiles_for_source_app(id, ) # Below is a request that includes all optional parameters # api_response = api_instance.list_access_profiles_for_source_app(id, limit, offset, filters) print("The response of AppsApi->list_access_profiles_for_source_app:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/apps#list-all-source-app source: | $Limit = 250 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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" # String | Sort results using the standard syntax described 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" # String | Filter results using the standard syntax described in [V3 API Standard 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) # List all source apps try { Get-BetaAllSourceApp # Below is a request that includes all optional parameters # Get-BetaAllSourceApp -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllSourceApp" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#list-all-source-app 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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() # Below is a request that includes all optional parameters # api_response = api_instance.list_all_source_app(limit, count, offset, sorters, filters) print("The response of AppsApi->list_all_source_app:\n") pprint(api_response) except Exception as e: print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) - path: /user-apps/all method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/apps#list-all-user-apps source: | $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* $Limit = 250 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # List all user apps try { Get-BetaAllUserApps -Filters $Filters # Below is a request that includes all optional parameters # Get-BetaAllUserApps -Filters $Filters -Limit $Limit -Count $Count -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllUserApps" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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* limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results 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, ) # Below is a request that includes all optional parameters # api_response = api_instance.list_all_user_apps(filters, limit, count, offset) print("The response of AppsApi->list_all_user_apps:\n") pprint(api_response) except Exception as e: print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) - path: /source-apps/assigned method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/apps#list-assigned-source-app source: | $Limit = 250 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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" # String | Sort results using the standard syntax described 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"" # String | Filter results using the standard syntax described in [V3 API Standard 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) # List assigned source apps try { Get-BetaAssignedSourceApp # Below is a request that includes all optional parameters # Get-BetaAssignedSourceApp -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAssignedSourceApp" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#list-assigned-source-app 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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() # Below is a request that includes all optional parameters # api_response = api_instance.list_assigned_source_app(limit, count, offset, sorters, filters) print("The response of AppsApi->list_assigned_source_app:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/apps#list-available-accounts-for-user-app source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app $Limit = 250 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # List available accounts for user app try { Get-BetaAvailableAccountsForUserApp -Id $Id # Below is a request that includes all optional parameters # Get-BetaAvailableAccountsForUserApp -Id $Id -Limit $Limit -Count $Count -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableAccountsForUserApp" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#list-available-accounts-for-user-app source: | id = '2c91808a7813090a017814121e121518' # str | ID of the user app # str | ID of the user app limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) try: # List available accounts for user app api_response = api_instance.list_available_accounts_for_user_app(id, ) # Below is a request that includes all optional parameters # api_response = api_instance.list_available_accounts_for_user_app(id, limit, count, offset) print("The response of AppsApi->list_available_accounts_for_user_app:\n") pprint(api_response) except Exception as e: print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) - path: /user-apps method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/apps#list-owned-user-apps source: | $Limit = 250 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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"" # String | Filter results using the standard syntax described in [V3 API Standard 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) # List owned user apps try { Get-BetaOwnedUserApps # Below is a request that includes all optional parameters # Get-BetaOwnedUserApps -Limit $Limit -Count $Count -Offset $Offset -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOwnedUserApps" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#list-owned-user-apps 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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() # Below is a request that includes all optional parameters # api_response = api_instance.list_owned_user_apps(limit, count, offset, filters) print("The response of AppsApi->list_owned_user_apps:\n") pprint(api_response) except Exception as e: print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) - path: /user-apps/{id} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/apps#patch-user-app source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Patch user app by ID try { Update-BetaUserApp -Id $Id # Below is a request that includes all optional parameters # Update-BetaUserApp -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaUserApp" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#patch-user-app source: | id = '2c91808a7813090a017814121e121518' # str | ID of the user app to patch # str | ID of the user app to patch [sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] | (optional) json_patch_operation = { "op" : "replace", "path" : "/description", "value" : "New description" } # List[JsonPatchOperation] | (optional) try: # Patch user app by ID api_response = api_instance.patch_user_app(id, ) # Below is a request that includes all optional parameters # api_response = api_instance.patch_user_app(id, Result) print("The response of AppsApi->patch_user_app:\n") pprint(api_response) except Exception as e: print("Exception when calling AppsApi->patch_user_app: %s\n" % e) - path: /source-apps/bulk-update method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/apps#update-source-apps-in-bulk source: | $SourceAppBulkUpdateRequest = @" { "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], "jsonPatch" : [ { "op" : "replace", "path" : "/enabled", "value" : false }, { "op" : "replace", "path" : "/matchAllAccounts", "value" : false } ] } "@ # Bulk update source apps try { Update-BetaSourceAppsInBulk # Below is a request that includes all optional parameters # Update-BetaSourceAppsInBulk -SourceAppBulkUpdateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceAppsInBulk" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/apps#update-source-apps-in-bulk source: | 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() # Below is a request that includes all optional parameters # api_instance.update_source_apps_in_bulk(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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/auth-profile#get-profile-config source: | $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to get. # Get Auth Profile. try { Get-BetaProfileConfig -Id $Id # Below is a request that includes all optional parameters # Get-BetaProfileConfig -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProfileConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/auth-profile#get-profile-config source: | id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to get. # str | ID of the Auth Profile to get. try: # Get Auth Profile. api_response = api_instance.get_profile_config(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_profile_config(id) print("The response of AuthProfileApi->get_profile_config:\n") pprint(api_response) except Exception as e: print("Exception when calling AuthProfileApi->get_profile_config: %s\n" % e) - path: /auth-profiles/{id} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/auth-profile#patch-profile-config source: | $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Patch a specified Auth Profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation Update-BetaProfileConfig -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters # Update-BetaProfileConfig -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProfileConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/auth-profile#patch-profile-config source: | id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch. [sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] | json_patch_operation = { "op" : "replace", "path" : "/description", "value" : "New description" } # List[JsonPatchOperation] | try: # Patch a specified Auth Profile Result = json_patch_operation.from_json(json_patch_operation) api_response = api_instance.patch_profile_config(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.patch_profile_config(id, Result) print("The response of AuthProfileApi->patch_profile_config:\n") pprint(api_response) except Exception as e: print("Exception when calling AuthProfileApi->patch_profile_config: %s\n" % e) - path: /auth-profiles method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/auth-profile#get-profile-config-list source: | # Get list of Auth Profiles. try { Get-BetaProfileConfigList # Below is a request that includes all optional parameters # Get-BetaProfileConfigList } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProfileConfigList" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/auth-profile#get-profile-config-list source: | try: # Get list of Auth Profiles. api_response = api_instance.get_profile_config_list() # Below is a request that includes all optional parameters # api_response = api_instance.get_profile_config_list() print("The response of AuthProfileApi->get_profile_config_list:\n") pprint(api_response) except Exception as e: print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) - path: /campaigns/{id}/complete method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#complete-campaign source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. $CompleteCampaignOptions = @" { "autoCompleteAction" : "REVOKE" } "@ # Complete a Campaign try { Complete-BetaCampaign -Id $Id # Below is a request that includes all optional parameters # Complete-BetaCampaign -Id $Id -CompleteCampaignOptions $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaCampaign" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#complete-campaign source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID. complete_campaign_options = { "autoCompleteAction" : "REVOKE" } # CompleteCampaignOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) try: # Complete a Campaign api_response = api_instance.complete_campaign(id, ) # Below is a request that includes all optional parameters # api_response = api_instance.complete_campaign(id, Result) print("The response of CertificationCampaignsApi->complete_campaign:\n") pprint(api_response) except Exception as e: print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e) - path: /campaigns method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/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" }, "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" } "@ # Create Campaign try { $Result = ConvertFrom-JsonToCampaign -Json $Campaign New-BetaCampaign -Campaign $Result # Below is a request that includes all optional parameters # New-BetaCampaign -Campaign $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaign" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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" }, "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 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: /campaigns method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-active-campaigns source: | $Detail = "SLIM" # String | 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 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 API Standard 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" # String | Sort results using the standard syntax described 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) # List Campaigns try { Get-BetaActiveCampaigns # Below is a request that includes all optional parameters # Get-BetaActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaActiveCampaigns" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: /campaign-templates method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#create-campaign-template source: | $CampaignTemplate = @" { "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" }, "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" } "@ # Create a Campaign Template try { $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate New-BetaCampaignTemplate -CampaignTemplate $Result # Below is a request that includes all optional parameters # New-BetaCampaignTemplate -CampaignTemplate $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaignTemplate" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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" }, "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 method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign-templates source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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" # String | Sort results using the standard syntax described 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"" # String | Filter results using the standard syntax described in [V3 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) # List Campaign Templates try { Get-BetaCampaignTemplates # Below is a request that includes all optional parameters # Get-BetaCampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplates" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: /campaign-templates/{id} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#delete-campaign-template source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. # Delete a Campaign Template try { Remove-BetaCampaignTemplate -Id $Id # Below is a request that includes all optional parameters # Remove-BetaCampaignTemplate -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaignTemplate" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign-template source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. # Get a Campaign Template try { Get-BetaCampaignTemplate -Id $Id # Below is a request that includes all optional parameters # Get-BetaCampaignTemplate -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplate" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#patch-campaign-template source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Update a Campaign Template try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation Update-BetaCampaignTemplate -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters # Update-BetaCampaignTemplate -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaignTemplate" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#patch-campaign-template source: | id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified. [{op=replace, path=/description, value=Updated description!}, {op=replace, path=/campaign/filter/id, value=ff80818155fe8c080155fe8d925b0316}] # List[JsonPatchOperation] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) json_patch_operation = { "op" : "replace", "path" : "/description", "value" : "New description" } # List[JsonPatchOperation] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) try: # Update a Campaign Template Result = json_patch_operation.from_json(json_patch_operation) api_response = api_instance.patch_campaign_template(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.patch_campaign_template(id, Result) print("The response of CertificationCampaignsApi->patch_campaign_template:\n") pprint(api_response) except Exception as e: print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e) - path: /campaign-templates/{id}/schedule method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#delete-campaign-template-schedule source: | $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. # Delete Campaign Template Schedule try { Remove-BetaCampaignTemplateSchedule -Id $Id # Below is a request that includes all optional parameters # Remove-BetaCampaignTemplateSchedule -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaignTemplateSchedule" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: /campaign-templates/{id}/schedule method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign-template-schedule source: | $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. # Get Campaign Template Schedule try { Get-BetaCampaignTemplateSchedule -Id $Id # Below is a request that includes all optional parameters # Get-BetaCampaignTemplateSchedule -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplateSchedule" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/{id}/schedule method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#set-campaign-template-schedule source: | $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | 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" } "@ # Set Campaign Template Schedule try { Set-BetaCampaignTemplateSchedule -Id $Id # Below is a request that includes all optional parameters # Set-BetaCampaignTemplateSchedule -Id $Id -Schedule $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignTemplateSchedule" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#set-campaign-template-schedule source: | id = '04bedce387bd47b2ae1f86eb0bb36dee' # str | ID of the campaign template being scheduled. # str | ID of the campaign template being scheduled. schedule = { "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/delete method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#delete-campaigns source: | $DeleteCampaignsRequest = @" { "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] } "@ # Delete Campaigns try { $Result = ConvertFrom-JsonToDeleteCampaignsRequest -Json $DeleteCampaignsRequest Remove-BetaCampaigns -DeleteCampaignsRequest $Result # Below is a request that includes all optional parameters # Remove-BetaCampaigns -DeleteCampaignsRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaigns" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#delete-campaigns source: | delete_campaigns_request = { "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] } # DeleteCampaignsRequest | IDs of the campaigns to delete. try: # Delete Campaigns Result = delete_campaigns_request.from_json(delete_campaigns_request) api_response = api_instance.delete_campaigns(Result) # Below is a request that includes all optional parameters # api_response = api_instance.delete_campaigns(Result) print("The response of CertificationCampaignsApi->delete_campaigns:\n") pprint(api_response) except Exception as e: print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e) - path: /campaigns/{id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign source: | $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. # Get Campaign try { Get-BetaCampaign -Id $Id # Below is a request that includes all optional parameters # Get-BetaCampaign -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaign" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-campaign source: | id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign to be retrieved. # str | ID of the campaign to be retrieved. try: # Get Campaign api_response = api_instance.get_campaign(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_campaign(id) print("The response of CertificationCampaignsApi->get_campaign:\n") pprint(api_response) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e) - path: /campaigns/{id} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#update-campaign source: | $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign being modified. $RequestBody = # SystemCollectionsHashtable[] | 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 $RequestBody = @"[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]"@ # Update a Campaign try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody Update-BetaCampaign -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters # Update-BetaCampaign -Id $Id -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaign" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#update-campaign source: | id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign being modified. # str | ID of the campaign being modified. request_body = [{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}] # List[object] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline request_body = [{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}] # List[object] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline try: # Update a Campaign Result = request_body.from_json(request_body) api_response = api_instance.update_campaign(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.update_campaign(id, Result) print("The response of CertificationCampaignsApi->update_campaign:\n") pprint(api_response) except Exception as e: print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) - path: /campaigns/{id}/reports method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign-reports source: | $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. # Get Campaign Reports try { Get-BetaCampaignReports -Id $Id # Below is a request that includes all optional parameters # Get-BetaCampaignReports -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignReports" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign-reports-config source: | # Get Campaign Reports Configuration try { Get-BetaCampaignReportsConfig # Below is a request that includes all optional parameters # Get-BetaCampaignReportsConfig } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignReportsConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#get-campaign-reports-config source: | try: # Get Campaign Reports Configuration api_response = api_instance.get_campaign_reports_config() # Below is a request that includes all optional parameters # api_response = api_instance.get_campaign_reports_config() print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n") pprint(api_response) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e) - path: /campaigns/reports-configuration method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#set-campaign-reports-config source: | $CampaignReportsConfig = @" { "identityAttributeColumns" : [ "firstname", "lastname" ] } "@ # Set Campaign Reports Configuration try { $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig Set-BetaCampaignReportsConfig -CampaignReportsConfig $Result # Below is a request that includes all optional parameters # Set-BetaCampaignReportsConfig -CampaignReportsConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignReportsConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: /campaigns/{id}/reassign method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#move source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID $AdminReviewReassign = @" { "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], "reason" : "reassigned for some reason", "reassignTo" : { "id" : "ef38f94347e94562b5bb8424a56397d8", "type" : "IDENTITY" } } "@ # Reassign Certifications try { $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign Move-Beta -Id $Id -AdminReviewReassign $Result # Below is a request that includes all optional parameters # Move-Beta -Id $Id -AdminReviewReassign $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-Beta" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/certification-campaigns#move source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification campaign ID # str | The certification campaign ID admin_review_reassign = { "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: /campaigns/{id}/activate method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#start-campaign source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. $ActivateCampaignOptions = @" { "timeZone" : "-05:00" } "@ # Activate a Campaign try { Start-BetaCampaign -Id $Id # Below is a request that includes all optional parameters # Start-BetaCampaign -Id $Id -ActivateCampaignOptions $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaign" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#start-campaign-remediation-scan source: | $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. # Run Campaign Remediation Scan try { Start-BetaCampaignRemediationScan -Id $Id # Below is a request that includes all optional parameters # Start-BetaCampaignRemediationScan -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaignRemediationScan" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#start-campaign-report source: | $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of report to run. # Run Campaign Report try { Start-BetaCampaignReport -Id $Id -Type $Type # Below is a request that includes all optional parameters # Start-BetaCampaignReport -Id $Id -Type $Type } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaignReport" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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.beta.ReportType() # ReportType | Type of report to run. # ReportType | Type of report to run. try: # Run Campaign Report api_response = api_instance.start_campaign_report(id, type) # Below is a request that includes all optional parameters # api_response = api_instance.start_campaign_report(id, type) print("The response of CertificationCampaignsApi->start_campaign_report:\n") pprint(api_response) except Exception as e: print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e) - path: /campaign-templates/{id}/generate method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#start-generate-campaign-template source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. # Generate a Campaign from Template try { Start-BetaGenerateCampaignTemplate -Id $Id # Below is a request that includes all optional parameters # Start-BetaGenerateCampaignTemplate -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaGenerateCampaignTemplate" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: /certifications/{certificationId}/access-review-items/{itemId}/permissions method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certifications#get-identity-certification-item-permissions source: | $CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID $ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID $Filters = "target eq "SYS.OBJAUTH2"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (optional) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # Permissions for Entitlement Certification Item try { Get-BetaIdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId # Below is a request that includes all optional parameters # Get-BetaIdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationItemPermissions" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (optional) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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: /certifications/{id}/tasks-pending method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certifications#get-identity-certification-pending-tasks source: | $Id = "MyId" # String | The identity campaign certification ID # Pending Certification Tasks try { Get-BetaIdentityCertificationPendingTasks -Id $Id # Below is a request that includes all optional parameters # Get-BetaIdentityCertificationPendingTasks -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationPendingTasks" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/certifications#get-identity-certification-pending-tasks source: | id = 'id_example' # str | The identity campaign certification ID # str | The identity campaign certification ID try: # Pending Certification Tasks api_response = api_instance.get_identity_certification_pending_tasks(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_identity_certification_pending_tasks(id) print("The response of CertificationsApi->get_identity_certification_pending_tasks:\n") pprint(api_response) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_pending_tasks: %s\n" % e) - path: /certifications/{id}/tasks/{taskId} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certifications#get-identity-certification-task-status source: | $Id = "MyId" # String | The identity campaign certification ID $TaskId = "MyTaskId" # String | The certification task ID # Certification Task Status try { Get-BetaIdentityCertificationTaskStatus -Id $Id -TaskId $TaskId # Below is a request that includes all optional parameters # Get-BetaIdentityCertificationTaskStatus -Id $Id -TaskId $TaskId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationTaskStatus" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/certifications#get-identity-certification-task-status source: | id = 'id_example' # str | The identity campaign certification ID # str | The identity campaign certification ID task_id = 'task_id_example' # str | The certification task ID # str | The certification task ID try: # Certification Task Status api_response = api_instance.get_identity_certification_task_status(id, task_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_identity_certification_task_status(id, task_id) print("The response of CertificationsApi->get_identity_certification_task_status:\n") pprint(api_response) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_task_status: %s\n" % e) - path: /certifications/{id}/reviewers method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certifications#list-certification-reviewers source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 API Standard 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" # String | Sort results using the standard syntax described 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) # List of Reviewers for certification try { Get-BetaCertificationReviewers -Id $Id # Below is a request that includes all optional parameters # Get-BetaCertificationReviewers -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCertificationReviewers" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certifications#list-certifications source: | $ReviewerIdentitiy = "MyReviewerIdentitiy" # String | The ID of reviewer identity. *me* indicates the current user. (optional) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* (optional) $Sorters = "MySorters" # String | Sort results using the standard syntax described 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) # Certifications by IDs try { Get-BetaCertifications # Below is a request that includes all optional parameters # Get-BetaCertifications -ReviewerIdentitiy $ReviewerIdentitiy -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCertifications" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/certifications#list-certifications source: | reviewer_identitiy = 'reviewer_identitiy_example' # str | The ID of reviewer identity. *me* indicates the current user. (optional) # str | The ID of reviewer identity. *me* indicates the current user. (optional) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = 'filters_example' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* (optional) sorters = 'sorters_example' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) try: # Certifications by IDs api_response = api_instance.list_certifications() # Below is a request that includes all optional parameters # api_response = api_instance.list_certifications(reviewer_identitiy, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_certifications:\n") pprint(api_response) except Exception as e: print("Exception when calling CertificationsApi->list_certifications: %s\n" % e) - path: /certifications/{id}/reassign-async method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/certifications#submit-reassign-certs-async source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID $ReviewReassign = @" { "reason" : "reassigned for some reason", "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", "reassign" : [ { "id" : "ef38f94347e94562b5bb8424a56397d8", "type" : "ITEM" }, { "id" : "ef38f94347e94562b5bb8424a56397d8", "type" : "ITEM" } ] } "@ # Reassign Certifications Asynchronously try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign Submit-BetaReassignCertsAsync -Id $Id -ReviewReassign $Result # Below is a request that includes all optional parameters # Submit-BetaReassignCertsAsync -Id $Id -ReviewReassign $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaReassignCertsAsync" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/certifications#submit-reassign-certs-async source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID review_reassign = { "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: /connector-rules method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#create-connector-rule source: | $ConnectorRuleCreateRequest = @" { "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" } "@ # Create Connector Rule try { $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest New-BetaConnectorRule -ConnectorRuleCreateRequest $Result # Below is a request that includes all optional parameters # New-BetaConnectorRule -ConnectorRuleCreateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaConnectorRule" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/connector-rule-management#create-connector-rule source: | 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 | The connector rule to create try: # Create Connector Rule Result = connector_rule_create_request.from_json(connector_rule_create_request) api_response = api_instance.create_connector_rule(Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_connector_rule(Result) print("The response of ConnectorRuleManagementApi->create_connector_rule:\n") pprint(api_response) except Exception as e: print("Exception when calling ConnectorRuleManagementApi->create_connector_rule: %s\n" % e) - path: /connector-rules method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#get-connector-rule-list source: | # List Connector Rules try { Get-BetaConnectorRuleList # Below is a request that includes all optional parameters # Get-BetaConnectorRuleList } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorRuleList" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/connector-rule-management#get-connector-rule-list source: | try: # List Connector Rules api_response = api_instance.get_connector_rule_list() # Below is a request that includes all optional parameters # api_response = api_instance.get_connector_rule_list() print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") pprint(api_response) except Exception as e: print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) - path: /connector-rules/{id} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#delete-connector-rule source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete # Delete a Connector-Rule try { Remove-BetaConnectorRule -Id $Id # Below is a request that includes all optional parameters # Remove-BetaConnectorRule -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaConnectorRule" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 try: # Delete a Connector-Rule api_instance.delete_connector_rule(id) # Below is a request that includes all optional parameters # api_instance.delete_connector_rule(id) except Exception as e: print("Exception when calling ConnectorRuleManagementApi->delete_connector_rule: %s\n" % e) - path: /connector-rules/{id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#get-connector-rule source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to retrieve # Connector-Rule by ID try { Get-BetaConnectorRule -Id $Id # Below is a request that includes all optional parameters # Get-BetaConnectorRule -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorRule" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/connector-rule-management#get-connector-rule source: | id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to retrieve # str | ID of the connector rule to retrieve try: # Connector-Rule by ID api_response = api_instance.get_connector_rule(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_connector_rule(id) print("The response of ConnectorRuleManagementApi->get_connector_rule:\n") pprint(api_response) except Exception as e: print("Exception when calling ConnectorRuleManagementApi->get_connector_rule: %s\n" % e) - path: /connector-rules/{id} method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#update-connector-rule source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to update $ConnectorRuleUpdateRequest = @" { "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" } "@ # Update a Connector Rule try { Update-BetaConnectorRule -Id $Id # Below is a request that includes all optional parameters # Update-BetaConnectorRule -Id $Id -ConnectorRuleUpdateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaConnectorRule" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/connector-rule-management#update-connector-rule source: | id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to update # str | ID of the connector rule to update connector_rule_update_request = { "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 | The connector rule with updated data (optional) try: # Update a Connector Rule api_response = api_instance.update_connector_rule(id, ) # Below is a request that includes all optional parameters # api_response = api_instance.update_connector_rule(id, Result) print("The response of ConnectorRuleManagementApi->update_connector_rule:\n") pprint(api_response) except Exception as e: print("Exception when calling ConnectorRuleManagementApi->update_connector_rule: %s\n" % e) - path: /connector-rules/validate method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#validate-connector-rule source: | $SourceCode = @" { "version" : "1.0", "script" : "return \"Mr. \" + firstName;" } "@ # Validate Connector Rule try { $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode Confirm-BetaConnectorRule -SourceCode $Result # Below is a request that includes all optional parameters # Confirm-BetaConnectorRule -SourceCode $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Confirm-BetaConnectorRule" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/connector-rule-management#validate-connector-rule source: | source_code = { "version" : "1.0", "script" : "return \"Mr. \" + firstName;" } # SourceCode | The code to validate try: # Validate Connector Rule Result = source_code.from_json(source_code) api_response = api_instance.validate_connector_rule(Result) # Below is a request that includes all optional parameters # api_response = api_instance.validate_connector_rule(Result) print("The response of ConnectorRuleManagementApi->validate_connector_rule:\n") pprint(api_response) except Exception as e: print("Exception when calling ConnectorRuleManagementApi->validate_connector_rule: %s\n" % e) - path: /connectors method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/connectors#get-connector-list source: | $Filters = "directConnect eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* (optional) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) # Get Connector List try { Get-BetaConnectorList # Below is a request that includes all optional parameters # Get-BetaConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorList" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* (optional) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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: /form-definitions method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/custom-forms#create-form-definition source: | $CreateFormDefinitionRequest = @" { "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" } ] } "@ # Creates a form definition. try { New-BetaFormDefinition # Below is a request that includes all optional parameters # New-BetaFormDefinition -CreateFormDefinitionRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinition" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-definition source: | create_form_definition_request = { "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() # Below is a request that includes all optional parameters # api_response = api_instance.create_form_definition(Result) print("The response of CustomFormsApi->create_form_definition:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomFormsApi->create_form_definition: %s\n" % e) - path: /form-definitions method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/custom-forms#search-form-definitions-by-tenant source: | $Offset = 250 # Int64 | 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 # Int64 | 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"" # String | Filter results using the standard syntax described in [V3 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" # String | Sort results using the standard syntax described 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") # Export form definitions by tenant. try { Search-BetaFormDefinitionsByTenant # Below is a request that includes all optional parameters # Search-BetaFormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormDefinitionsByTenant" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#search-form-definitions-by-tenant source: | 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() # Below is a request that includes all optional parameters # api_response = api_instance.search_form_definitions_by_tenant(offset, limit, filters, sorters) print("The response of CustomFormsApi->search_form_definitions_by_tenant:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomFormsApi->search_form_definitions_by_tenant: %s\n" % e) - path: /form-definitions/template method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/custom-forms#create-form-definition-by-template source: | $CreateFormDefinitionRequest = @" { "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" } ] } "@ # Create a form definition by template. try { New-BetaFormDefinitionByTemplate # Below is a request that includes all optional parameters # New-BetaFormDefinitionByTemplate -CreateFormDefinitionRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionByTemplate" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-definition-by-template source: | create_form_definition_request = { "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: # Create a form definition by template. api_response = api_instance.create_form_definition_by_template() # Below is a request that includes all optional parameters # api_response = api_instance.create_form_definition_by_template(Result) print("The response of CustomFormsApi->create_form_definition_by_template:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomFormsApi->create_form_definition_by_template: %s\n" % e) - path: /form-definitions/forms-action-dynamic-schema method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/custom-forms#create-form-definition-dynamic-schema source: | $Body = @" { "description" : "A description", "attributes" : { "formDefinitionId" : "00000000-0000-0000-0000-000000000000" }, "id" : "00000000-0000-0000-0000-000000000000", "type" : "action", "versionNumber" : 1 } "@ # Generate JSON Schema dynamically. try { New-BetaFormDefinitionDynamicSchema # Below is a request that includes all optional parameters # New-BetaFormDefinitionDynamicSchema -Body $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionDynamicSchema" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-definition-dynamic-schema source: | 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() # Below is a request that includes all optional parameters # api_response = api_instance.create_form_definition_dynamic_schema(Result) print("The response of CustomFormsApi->create_form_definition_dynamic_schema:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomFormsApi->create_form_definition_dynamic_schema: %s\n" % e) - path: /form-definitions/{formDefinitionID}/upload method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/custom-forms#create-form-definition-file-request source: | $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID $File = # System.IO.FileInfo | File specifying the multipart # Upload new form definition file. try { New-BetaFormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File # Below is a request that includes all optional parameters # New-BetaFormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionFileRequest" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 file = None # bytearray | File specifying the multipart # bytearray | File specifying the multipart try: # Upload new form definition file. api_response = api_instance.create_form_definition_file_request(form_definition_id, file) # Below is a request that includes all optional parameters # api_response = api_instance.create_form_definition_file_request(form_definition_id, file) print("The response of CustomFormsApi->create_form_definition_file_request:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomFormsApi->create_form_definition_file_request: %s\n" % e) - path: /form-instances method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/custom-forms#create-form-instance source: | $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 } "@ # Creates a form instance. try { New-BetaFormInstance # Below is a request that includes all optional parameters # New-BetaFormInstance -Body $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormInstance" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#create-form-instance source: | 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() # Below is a request that includes all optional parameters # api_response = api_instance.create_form_instance(Result) print("The response of CustomFormsApi->create_form_instance:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomFormsApi->create_form_instance: %s\n" % e) - path: /form-instances method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/custom-forms#search-form-instances-by-tenant source: | # List form instances by tenant. try { Search-BetaFormInstancesByTenant # Below is a request that includes all optional parameters # Search-BetaFormInstancesByTenant } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormInstancesByTenant" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#search-form-instances-by-tenant source: | try: # List form instances by tenant. api_response = api_instance.search_form_instances_by_tenant() # Below is a request that includes all optional parameters # api_response = api_instance.search_form_instances_by_tenant() print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) - path: /form-definitions/{formDefinitionID} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/custom-forms#delete-form-definition source: | $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID # Deletes a form definition. try { Remove-BetaFormDefinition -FormDefinitionID $FormDefinitionID # Below is a request that includes all optional parameters # Remove-BetaFormDefinition -FormDefinitionID $FormDefinitionID } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaFormDefinition" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#delete-form-definition source: | form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID try: # Deletes a form definition. api_response = api_instance.delete_form_definition(form_definition_id) # Below is a request that includes all optional parameters # api_response = api_instance.delete_form_definition(form_definition_id) print("The response of CustomFormsApi->delete_form_definition:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomFormsApi->delete_form_definition: %s\n" % e) - path: /form-definitions/{formDefinitionID} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/custom-forms#get-form-definition-by-key source: | $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID # Return a form definition. try { Get-BetaFormDefinitionByKey -FormDefinitionID $FormDefinitionID # Below is a request that includes all optional parameters # Get-BetaFormDefinitionByKey -FormDefinitionID $FormDefinitionID } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormDefinitionByKey" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 try: # Return a form definition. api_response = api_instance.get_form_definition_by_key(form_definition_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_form_definition_by_key(form_definition_id) print("The response of CustomFormsApi->get_form_definition_by_key:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomFormsApi->get_form_definition_by_key: %s\n" % e) - path: /form-definitions/{formDefinitionID} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/custom-forms#patch-form-definition source: | $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) $Body = @"[{op=replace, path=/description, value=test-description}]"@ # Patch a form definition. try { Update-BetaFormDefinition -FormDefinitionID $FormDefinitionID # Below is a request that includes all optional parameters # Update-BetaFormDefinition -FormDefinitionID $FormDefinitionID -Body $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaFormDefinition" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#patch-form-definition source: | form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID body = [{op=replace, path=/description, value=test-description}] # List[Dict[str, object]] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) body = [{op=replace, path=/description, value=test-description}] # List[Dict[str, object]] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) try: # Patch a form definition. api_response = api_instance.patch_form_definition(form_definition_id, ) # Below is a request that includes all optional parameters # api_response = api_instance.patch_form_definition(form_definition_id, Result) print("The response of CustomFormsApi->patch_form_definition:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomFormsApi->patch_form_definition: %s\n" % e) - path: /form-definitions/export method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/custom-forms#export-form-definitions-by-tenant source: | $Offset = 0 # Int64 | 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 # Int64 | 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"" # String | Filter results using the standard syntax described in [V3 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" # String | Sort results using the standard syntax described 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") # List form definitions by tenant. try { Export-BetaFormDefinitionsByTenant # Below is a request that includes all optional parameters # Export-BetaFormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaFormDefinitionsByTenant" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#export-form-definitions-by-tenant source: | 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() # Below is a request that includes all optional parameters # api_response = api_instance.export_form_definitions_by_tenant(offset, limit, filters, sorters) print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/custom-forms#get-file-from-s3 source: | $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. # Download definition file by fileId. try { Get-BetaFileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID # Below is a request that includes all optional parameters # Get-BetaFileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFileFromS3" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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. try: # Download definition file by fileId. api_response = api_instance.get_file_from_s3(form_definition_id, file_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_file_from_s3(form_definition_id, file_id) print("The response of CustomFormsApi->get_file_from_s3:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomFormsApi->get_file_from_s3: %s\n" % e) - path: /form-instances/{formInstanceID} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/custom-forms#get-form-instance-by-key source: | $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID # Returns a form instance. try { Get-BetaFormInstanceByKey -FormInstanceID $FormInstanceID # Below is a request that includes all optional parameters # Get-BetaFormInstanceByKey -FormInstanceID $FormInstanceID } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormInstanceByKey" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 try: # Returns a form instance. api_response = api_instance.get_form_instance_by_key(form_instance_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_form_instance_by_key(form_instance_id) print("The response of CustomFormsApi->get_form_instance_by_key:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomFormsApi->get_form_instance_by_key: %s\n" % e) - path: /form-instances/{formInstanceID} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/custom-forms#patch-form-instance source: | $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID $Body = @{ key_example = } # Map[] | 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}}]"@ # Patch a form instance. try { Update-BetaFormInstance -FormInstanceID $FormInstanceID # Below is a request that includes all optional parameters # Update-BetaFormInstance -FormInstanceID $FormInstanceID -Body $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaFormInstance" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#patch-form-instance source: | form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID body = [{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}] # List[Dict[str, object]] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) body = [{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}] # List[Dict[str, object]] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) try: # Patch a form instance. api_response = api_instance.patch_form_instance(form_instance_id, ) # Below is a request that includes all optional parameters # api_response = api_instance.patch_form_instance(form_instance_id, Result) print("The response of CustomFormsApi->patch_form_instance:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomFormsApi->patch_form_instance: %s\n" % e) - path: /form-instances/{formInstanceID}/file/{fileID} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/custom-forms#get-form-instance-file source: | $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. # Download instance file by fileId. try { Get-BetaFormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID # Below is a request that includes all optional parameters # Get-BetaFormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormInstanceFile" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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. try: # Download instance file by fileId. api_response = api_instance.get_form_instance_file(form_instance_id, file_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_form_instance_file(form_instance_id, file_id) print("The response of CustomFormsApi->get_form_instance_file:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomFormsApi->get_form_instance_file: %s\n" % e) - path: /form-definitions/import method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/custom-forms#import-form-definitions source: | $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}}]"@ # Import form definitions from export. try { Import-BetaFormDefinitions # Below is a request that includes all optional parameters # Import-BetaFormDefinitions -Body $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaFormDefinitions" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#import-form-definitions source: | [{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}] # List[ImportFormDefinitionsRequestInner] | Body is the request payload to import form definitions (optional) body = [{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}] # List[ImportFormDefinitionsRequestInner] | Body is the request payload to import form definitions (optional) try: # Import form definitions from export. api_response = api_instance.import_form_definitions() # Below is a request that includes all optional parameters # api_response = api_instance.import_form_definitions(Result) print("The response of CustomFormsApi->import_form_definitions:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomFormsApi->import_form_definitions: %s\n" % e) - path: /form-instances/{formInstanceID}/data-source/{formElementID} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/custom-forms#search-form-element-data-by-element-id source: | $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID $FormElementID = "1" # String | Form element ID $Limit = 250 # Int64 | 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"" # String | Filter results using the standard syntax described in [V3 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" # String | 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) # Retrieves dynamic data by element. try { Search-BetaFormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID # Below is a request that includes all optional parameters # Search-BetaFormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -Limit $Limit -Filters $Filters -Query $Query } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormElementDataByElementID" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 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, ) # Below is a request that includes all optional parameters # api_response = api_instance.search_form_element_data_by_element_id(form_instance_id, form_element_id, limit, filters, query) print("The response of CustomFormsApi->search_form_element_data_by_element_id:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomFormsApi->search_form_element_data_by_element_id: %s\n" % e) - path: /form-definitions/predefined-select-options method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/custom-forms#search-pre-defined-select-options source: | # List predefined select options. try { Search-BetaPreDefinedSelectOptions # Below is a request that includes all optional parameters # Search-BetaPreDefinedSelectOptions } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaPreDefinedSelectOptions" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#search-pre-defined-select-options source: | try: # List predefined select options. api_response = api_instance.search_pre_defined_select_options() # Below is a request that includes all optional parameters # api_response = api_instance.search_pre_defined_select_options() print("The response of CustomFormsApi->search_pre_defined_select_options:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/custom-forms#show-preview-data-source source: | $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID $Limit = 10 # Int64 | 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"" # String | Filter results using the standard syntax described in [V3 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" # String | 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) $FormElementPreviewRequest = @" { "dataSource" : { "config" : { "indices" : [ "identities" ], "query" : "*", "aggregationBucketField" : "attributes.cloudStatus.exact", "objectType" : "IDENTITY" }, "dataSourceType" : "STATIC" } } "@ # Preview form definition data source. try { Show-BetaPreviewDataSource -FormDefinitionID $FormDefinitionID # Below is a request that includes all optional parameters # Show-BetaPreviewDataSource -FormDefinitionID $FormDefinitionID -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaPreviewDataSource" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-forms#show-preview-data-source source: | form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID limit = 10 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) filters = 'value eq \"ID01\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) 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, ) # Below is a request that includes all optional parameters # api_response = api_instance.show_preview_data_source(form_definition_id, limit, filters, query, Result) print("The response of CustomFormsApi->show_preview_data_source:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomFormsApi->show_preview_data_source: %s\n" % e) - path: /custom-password-instructions method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/custom-password-instructions#create-custom-password-instructions source: | $CustomPasswordInstruction = @" { "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" } "@ # Create Custom Password Instructions try { $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction New-BetaCustomPasswordInstructions -CustomPasswordInstruction $Result # Below is a request that includes all optional parameters # New-BetaCustomPasswordInstructions -CustomPasswordInstruction $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCustomPasswordInstructions" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/custom-password-instructions#create-custom-password-instructions source: | custom_password_instruction = { "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", "pageId" : "change-password:enter-password", "locale" : "en" } # CustomPasswordInstruction | try: # Create Custom Password Instructions Result = custom_password_instruction.from_json(custom_password_instruction) api_response = api_instance.create_custom_password_instructions(Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_custom_password_instructions(Result) print("The response of CustomPasswordInstructionsApi->create_custom_password_instructions:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomPasswordInstructionsApi->create_custom_password_instructions: %s\n" % e) - path: /custom-password-instructions/{pageId} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/custom-password-instructions#delete-custom-password-instructions source: | $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to delete. $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) # Delete Custom Password Instructions by page ID try { Remove-BetaCustomPasswordInstructions -PageId $PageId # Below is a request that includes all optional parameters # Remove-BetaCustomPasswordInstructions -PageId $PageId -Locale $Locale } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCustomPasswordInstructions" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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. locale = 'locale_example' # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) try: # Delete Custom Password Instructions by page ID api_instance.delete_custom_password_instructions(page_id, ) # Below is a request that includes all optional parameters # api_instance.delete_custom_password_instructions(page_id, locale) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/custom-password-instructions#get-custom-password-instructions source: | $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to query. $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) # Get Custom Password Instructions by Page ID try { Get-BetaCustomPasswordInstructions -PageId $PageId # Below is a request that includes all optional parameters # Get-BetaCustomPasswordInstructions -PageId $PageId -Locale $Locale } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomPasswordInstructions" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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. locale = 'locale_example' # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) try: # Get Custom Password Instructions by Page ID api_response = api_instance.get_custom_password_instructions(page_id, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_custom_password_instructions(page_id, locale) print("The response of CustomPasswordInstructionsApi->get_custom_password_instructions:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomPasswordInstructionsApi->get_custom_password_instructions: %s\n" % e) - path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/entitlements#create-access-model-metadata-for-entitlement source: | $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. $AttributeValue = "public" # String | Technical name of the Attribute Value. # Add metadata to an entitlement. try { New-BetaAccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue # Below is a request that includes all optional parameters # New-BetaAccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessModelMetadataForEntitlement" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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. try: # Add metadata to an entitlement. api_response = api_instance.create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value) # Below is a request that includes all optional parameters # api_response = api_instance.create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value) print("The response of EntitlementsApi->create_access_model_metadata_for_entitlement:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/entitlements#delete-access-model-metadata-from-entitlement source: | $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. $AttributeValue = "public" # String | Technical name of the Attribute Value. # Remove metadata from an entitlement. try { Remove-BetaAccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue # Below is a request that includes all optional parameters # Remove-BetaAccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessModelMetadataFromEntitlement" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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. try: # Remove metadata from an entitlement. api_instance.delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value) # Below is a request that includes all optional parameters # api_instance.delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/entitlements#get-entitlement source: | $Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID # Get an entitlement try { Get-BetaEntitlement -Id $Id # Below is a request that includes all optional parameters # Get-BetaEntitlement -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlement" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#get-entitlement source: | id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID try: # Get an entitlement api_response = api_instance.get_entitlement(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_entitlement(id) print("The response of EntitlementsApi->get_entitlement:\n") pprint(api_response) except Exception as e: print("Exception when calling EntitlementsApi->get_entitlement: %s\n" % e) - path: /entitlements/{id} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/entitlements#patch-entitlement source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Patch an entitlement try { Update-BetaEntitlement -Id $Id # Below is a request that includes all optional parameters # Update-BetaEntitlement -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlement" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#patch-entitlement source: | id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch [{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}] # List[JsonPatchOperation] | (optional) json_patch_operation = { "op" : "replace", "path" : "/description", "value" : "New description" } # List[JsonPatchOperation] | (optional) try: # Patch an entitlement api_response = api_instance.patch_entitlement(id, ) # Below is a request that includes all optional parameters # api_response = api_instance.patch_entitlement(id, Result) print("The response of EntitlementsApi->patch_entitlement:\n") pprint(api_response) except Exception as e: print("Exception when calling EntitlementsApi->patch_entitlement: %s\n" % e) - path: /entitlements/{id}/entitlement-request-config method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/entitlements#get-entitlement-request-config source: | $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id # Get Entitlement Request Config try { Get-BetaEntitlementRequestConfig -Id $Id # Below is a request that includes all optional parameters # Get-BetaEntitlementRequestConfig -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementRequestConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#get-entitlement-request-config source: | id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id try: # Get Entitlement Request Config api_response = api_instance.get_entitlement_request_config(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_entitlement_request_config(id) print("The response of EntitlementsApi->get_entitlement_request_config:\n") pprint(api_response) except Exception as e: print("Exception when calling EntitlementsApi->get_entitlement_request_config: %s\n" % e) - path: /entitlements/{id}/entitlement-request-config method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/entitlements#put-entitlement-request-config source: | $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID $EntitlementRequestConfig = @" { "accessRequestConfig" : { "denialCommentRequired" : false, "approvalSchemes" : [ { "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", "approverType" : "GOVERNANCE_GROUP" }, { "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", "approverType" : "GOVERNANCE_GROUP" } ], "requestCommentRequired" : true } } "@ # Replace Entitlement Request Config try { $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig Send-BetaEntitlementRequestConfig -Id $Id -EntitlementRequestConfig $Result # Below is a request that includes all optional parameters # Send-BetaEntitlementRequestConfig -Id $Id -EntitlementRequestConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaEntitlementRequestConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#put-entitlement-request-config source: | id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID 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 } } # EntitlementRequestConfig | try: # Replace Entitlement Request Config Result = entitlement_request_config.from_json(entitlement_request_config) api_response = api_instance.put_entitlement_request_config(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.put_entitlement_request_config(id, Result) print("The response of EntitlementsApi->put_entitlement_request_config:\n") pprint(api_response) except Exception as e: print("Exception when calling EntitlementsApi->put_entitlement_request_config: %s\n" % e) - path: /entitlements/aggregate/sources/{id} method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/entitlements#import-entitlements-by-source source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) # Aggregate Entitlements try { Import-BetaEntitlementsBySource -Id $Id # Below is a request that includes all optional parameters # Import-BetaEntitlementsBySource -Id $Id -CsvFile $CsvFile } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaEntitlementsBySource" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#import-entitlements-by-source source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id csv_file = None # bytearray | The CSV file containing the source entitlements to aggregate. (optional) # bytearray | The CSV file containing the source entitlements to aggregate. (optional) try: # Aggregate Entitlements api_response = api_instance.import_entitlements_by_source(id, ) # Below is a request that includes all optional parameters # api_response = api_instance.import_entitlements_by_source(id, csv_file) print("The response of EntitlementsApi->import_entitlements_by_source:\n") pprint(api_response) except Exception as e: print("Exception when calling EntitlementsApi->import_entitlements_by_source: %s\n" % e) - path: /entitlements/{id}/children method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/entitlements#list-entitlement-children source: | $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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" # String | Sort results using the standard syntax described 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"" # String | Filter results using the standard syntax described in [V3 API Standard 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) # List of entitlements children try { Get-BetaEntitlementChildren -Id $Id # Below is a request that includes all optional parameters # Get-BetaEntitlementChildren -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementChildren" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#list-entitlement-children source: | id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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, ) # Below is a request that includes all optional parameters # api_response = api_instance.list_entitlement_children(id, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_children:\n") pprint(api_response) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) - path: /entitlements/{id}/parents method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/entitlements#list-entitlement-parents source: | $Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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" # String | Sort results using the standard syntax described 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"" # String | Filter results using the standard syntax described in [V3 API Standard 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) # List of entitlements parents try { Get-BetaEntitlementParents -Id $Id # Below is a request that includes all optional parameters # Get-BetaEntitlementParents -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementParents" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#list-entitlement-parents source: | id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement Id limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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, ) # Below is a request that includes all optional parameters # api_response = api_instance.list_entitlement_parents(id, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_parents:\n") pprint(api_response) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) - path: /entitlements method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/entitlements#list-entitlements source: | $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (optional) $SegmentedForIdentity = "me" # String | 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) $ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | 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) $IncludeUnsegmented = $true # Boolean | 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 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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" # String | Sort results using the standard syntax described 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"" # String | Filter results using the standard syntax described in [V3 API Standard 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) # Gets a list of entitlements. try { Get-BetaEntitlements # Below is a request that includes all optional parameters # Get-BetaEntitlements -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlements" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#list-entitlements source: | account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (optional) # str | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (optional) segmented_for_identity = 'me' # str | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) # str | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) for_segment_ids = '041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649' # str | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) # str | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) 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() # Below is a request that includes all optional parameters # api_response = api_instance.list_entitlements(account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters) print("The response of EntitlementsApi->list_entitlements:\n") pprint(api_response) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) - path: /entitlements/reset/sources/{sourceId} method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/entitlements#reset-source-entitlements source: | $SourceId = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset # Reset Source Entitlements try { Reset-BetaSourceEntitlements -SourceId $SourceId # Below is a request that includes all optional parameters # Reset-BetaSourceEntitlements -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-BetaSourceEntitlements" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#reset-source-entitlements source: | source_id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset try: # Reset Source Entitlements api_response = api_instance.reset_source_entitlements(source_id) # Below is a request that includes all optional parameters # api_response = api_instance.reset_source_entitlements(source_id) print("The response of EntitlementsApi->reset_source_entitlements:\n") pprint(api_response) except Exception as e: print("Exception when calling EntitlementsApi->reset_source_entitlements: %s\n" % e) - path: /entitlements/bulk-update method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/entitlements#update-entitlements-in-bulk source: | $EntitlementBulkUpdateRequest = @" { "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], "jsonPatch" : [ { "op" : "replace", "path" : "/privileged", "value" : false }, { "op" : "replace", "path" : "/requestable", "value" : false } ] } "@ # Bulk update an entitlement list try { $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest Update-BetaEntitlementsInBulk -EntitlementBulkUpdateRequest $Result # Below is a request that includes all optional parameters # Update-BetaEntitlementsInBulk -EntitlementBulkUpdateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlementsInBulk" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/entitlements#update-entitlements-in-bulk source: | 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(Result) # Below is a request that includes all optional parameters # api_instance.update_entitlements_in_bulk(Result) except Exception as e: print("Exception when calling EntitlementsApi->update_entitlements_in_bulk: %s\n" % e) - path: /workgroups method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/governance-groups#create-workgroup source: | $WorkgroupDto = @" { "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" } "@ # Create a new Governance Group. try { $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto New-BetaWorkgroup -WorkgroupDto $Result # Below is a request that includes all optional parameters # New-BetaWorkgroup -WorkgroupDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkgroup" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/governance-groups#create-workgroup source: | 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(Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_workgroup(Result) print("The response of GovernanceGroupsApi->create_workgroup:\n") pprint(api_response) except Exception as e: print("Exception when calling GovernanceGroupsApi->create_workgroup: %s\n" % e) - path: /workgroups method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/governance-groups#list-workgroups source: | $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 API Standard 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" # String | Sort results using the standard syntax described 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) # List Governance Groups try { Get-BetaWorkgroups # Below is a request that includes all optional parameters # Get-BetaWorkgroups -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroups" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/governance-groups#list-workgroups 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 = 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() # Below is a request that includes all optional parameters # api_response = api_instance.list_workgroups(offset, limit, count, filters, sorters) print("The response of GovernanceGroupsApi->list_workgroups:\n") pprint(api_response) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) - path: /workgroups/{id} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/governance-groups#delete-workgroup source: | $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group # Delete a Governance Group try { Remove-BetaWorkgroup -Id $Id # Below is a request that includes all optional parameters # Remove-BetaWorkgroup -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroup" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/governance-groups#delete-workgroup source: | id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group try: # Delete a Governance Group api_instance.delete_workgroup(id) # Below is a request that includes all optional parameters # api_instance.delete_workgroup(id) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroup: %s\n" % e) - path: /workgroups/{id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/governance-groups#get-workgroup source: | $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group # Get Governance Group by Id try { Get-BetaWorkgroup -Id $Id # Below is a request that includes all optional parameters # Get-BetaWorkgroup -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroup" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/governance-groups#get-workgroup source: | id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group try: # Get Governance Group by Id api_response = api_instance.get_workgroup(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_workgroup(id) print("The response of GovernanceGroupsApi->get_workgroup:\n") pprint(api_response) except Exception as e: print("Exception when calling GovernanceGroupsApi->get_workgroup: %s\n" % e) - path: /workgroups/{id} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/governance-groups#patch-workgroup source: | $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Patch a Governance Group try { Update-BetaWorkgroup -Id $Id # Below is a request that includes all optional parameters # Update-BetaWorkgroup -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroup" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/governance-groups#patch-workgroup source: | id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group [{op=replace, path=/description, value=Governance Group new description.}] # List[JsonPatchOperation] | (optional) json_patch_operation = { "op" : "replace", "path" : "/description", "value" : "New description" } # List[JsonPatchOperation] | (optional) try: # Patch a Governance Group api_response = api_instance.patch_workgroup(id, ) # Below is a request that includes all optional parameters # api_response = api_instance.patch_workgroup(id, Result) print("The response of GovernanceGroupsApi->patch_workgroup:\n") pprint(api_response) except Exception as e: print("Exception when calling GovernanceGroupsApi->patch_workgroup: %s\n" % e) - path: /workgroups/{workgroupId}/members/bulk-delete method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/governance-groups#delete-workgroup-members source: | $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. $BulkWorkgroupMembersRequestInner = @""@ # Remove members from Governance Group try { $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner Remove-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BulkWorkgroupMembersRequestInner $Result # Below is a request that includes all optional parameters # Remove-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BulkWorkgroupMembersRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupMembers" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/governance-groups#delete-workgroup-members source: | workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be removed from a Governance Group members list. bulk_workgroup_members_request_inner = [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be removed from a Governance Group members list. try: # Remove members from Governance Group Result = bulk_workgroup_members_request_inner.from_json(bulk_workgroup_members_request_inner) api_response = api_instance.delete_workgroup_members(workgroup_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.delete_workgroup_members(workgroup_id, Result) print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") pprint(api_response) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) - path: /workgroups/bulk-delete method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/governance-groups#delete-workgroups-in-bulk source: | $WorkgroupBulkDeleteRequest = @" { "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] } "@ # Delete Governance Group(s) try { $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest Remove-BetaWorkgroupsInBulk -WorkgroupBulkDeleteRequest $Result # Below is a request that includes all optional parameters # Remove-BetaWorkgroupsInBulk -WorkgroupBulkDeleteRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupsInBulk" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/governance-groups#delete-workgroups-in-bulk source: | workgroup_bulk_delete_request = { "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] } # WorkgroupBulkDeleteRequest | try: # Delete Governance Group(s) Result = workgroup_bulk_delete_request.from_json(workgroup_bulk_delete_request) api_response = api_instance.delete_workgroups_in_bulk(Result) # Below is a request that includes all optional parameters # api_response = api_instance.delete_workgroups_in_bulk(Result) print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") pprint(api_response) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) - path: /workgroups/{workgroupId}/connections method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/governance-groups#list-connections source: | $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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" # String | Sort results using the standard syntax described 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) # List connections for Governance Group try { Get-BetaConnections -WorkgroupId $WorkgroupId # Below is a request that includes all optional parameters # Get-BetaConnections -WorkgroupId $WorkgroupId -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnections" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/governance-groups#list-connections source: | workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) try: # List connections for Governance Group api_response = api_instance.list_connections(workgroup_id, ) # Below is a request that includes all optional parameters # api_response = api_instance.list_connections(workgroup_id, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_connections:\n") pprint(api_response) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) - path: /workgroups/{workgroupId}/members method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/governance-groups#list-workgroup-members source: | $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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" # String | Sort results using the standard syntax described 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) # List Governance Group Members try { Get-BetaWorkgroupMembers -WorkgroupId $WorkgroupId # Below is a request that includes all optional parameters # Get-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroupMembers" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/governance-groups#list-workgroup-members source: | workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) try: # List Governance Group Members api_response = api_instance.list_workgroup_members(workgroup_id, ) # Below is a request that includes all optional parameters # api_response = api_instance.list_workgroup_members(workgroup_id, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_workgroup_members:\n") pprint(api_response) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) - path: /workgroups/{workgroupId}/members/bulk-add method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/governance-groups#update-workgroup-members source: | $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. $BulkWorkgroupMembersRequestInner = @""@ # Add members to Governance Group try { $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner Update-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BulkWorkgroupMembersRequestInner $Result # Below is a request that includes all optional parameters # Update-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BulkWorkgroupMembersRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroupMembers" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/governance-groups#update-workgroup-members source: | workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be added to a Governance Group members list. bulk_workgroup_members_request_inner = [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be added to a Governance Group members list. try: # Add members to Governance Group Result = bulk_workgroup_members_request_inner.from_json(bulk_workgroup_members_request_inner) api_response = api_instance.update_workgroup_members(workgroup_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.update_workgroup_members(workgroup_id, Result) print("The response of GovernanceGroupsApi->update_workgroup_members:\n") pprint(api_response) except Exception as e: print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) - path: /ai-access-request-recommendations/ignored-items method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item source: | $AccessRequestRecommendationActionItemDto = @" { "access" : { "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" }, "identityId" : "2c91808570313110017040b06f344ec9" } "@ # Notification of Ignored Access Request Recommendations try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto Add-BetaAccessRequestRecommendationsIgnoredItem -AccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters # Add-BetaAccessRequestRecommendationsIgnoredItem -AccessRequestRecommendationActionItemDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsIgnoredItem" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item source: | access_request_recommendation_action_item_dto = { "access" : { "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" }, "identityId" : "2c91808570313110017040b06f344ec9" } # AccessRequestRecommendationActionItemDto | The recommended access item to ignore for an identity. try: # Notification of Ignored Access Request Recommendations Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) api_response = api_instance.add_access_request_recommendations_ignored_item(Result) # Below is a request that includes all optional parameters # api_response = api_instance.add_access_request_recommendations_ignored_item(Result) print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item: %s\n" % e) - path: /ai-access-request-recommendations/ignored-items method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 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" # String | Sort results using the standard syntax described 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) # List of Ignored Access Request Recommendations try { Get-BetaAccessRequestRecommendationsIgnoredItems # Below is a request that includes all optional parameters # Get-BetaAccessRequestRecommendationsIgnoredItems -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsIgnoredItems" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-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) 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 of Ignored Access Request Recommendations api_response = api_instance.get_access_request_recommendations_ignored_items() # Below is a request that includes all optional parameters # api_response = api_instance.get_access_request_recommendations_ignored_items(limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n") pprint(api_response) 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: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item source: | $AccessRequestRecommendationActionItemDto = @" { "access" : { "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" }, "identityId" : "2c91808570313110017040b06f344ec9" } "@ # Notification of Requested Access Request Recommendations try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto Add-BetaAccessRequestRecommendationsRequestedItem -AccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters # Add-BetaAccessRequestRecommendationsRequestedItem -AccessRequestRecommendationActionItemDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsRequestedItem" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item source: | access_request_recommendation_action_item_dto = { "access" : { "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" }, "identityId" : "2c91808570313110017040b06f344ec9" } # AccessRequestRecommendationActionItemDto | The recommended access item that was requested for an identity. try: # Notification of Requested Access Request Recommendations Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) api_response = api_instance.add_access_request_recommendations_requested_item(Result) # Below is a request that includes all optional parameters # api_response = api_instance.add_access_request_recommendations_requested_item(Result) print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item: %s\n" % e) - path: /ai-access-request-recommendations/requested-items method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 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 = "MySorters" # String | Sort results using the standard syntax described 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) # List of Requested Access Request Recommendations try { Get-BetaAccessRequestRecommendationsRequestedItems # Below is a request that includes all optional parameters # Get-BetaAccessRequestRecommendationsRequestedItems -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsRequestedItems" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-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) 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 = '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: **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 of Requested Access Request Recommendations api_response = api_instance.get_access_request_recommendations_requested_items() # Below is a request that includes all optional parameters # api_response = api_instance.get_access_request_recommendations_requested_items(limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n") pprint(api_response) 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: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item source: | $AccessRequestRecommendationActionItemDto = @" { "access" : { "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" }, "identityId" : "2c91808570313110017040b06f344ec9" } "@ # Notification of Viewed Access Request Recommendations try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto Add-BetaAccessRequestRecommendationsViewedItem -AccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters # Add-BetaAccessRequestRecommendationsViewedItem -AccessRequestRecommendationActionItemDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItem" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item source: | access_request_recommendation_action_item_dto = { "access" : { "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" }, "identityId" : "2c91808570313110017040b06f344ec9" } # AccessRequestRecommendationActionItemDto | The recommended access that was viewed for an identity. try: # Notification of Viewed Access Request Recommendations Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) api_response = api_instance.add_access_request_recommendations_viewed_item(Result) # Below is a request that includes all optional parameters # api_response = api_instance.add_access_request_recommendations_viewed_item(Result) print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item: %s\n" % e) - path: /ai-access-request-recommendations/viewed-items method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 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 = "MySorters" # String | Sort results using the standard syntax described 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) # List of Viewed Access Request Recommendations try { Get-BetaAccessRequestRecommendationsViewedItems # Below is a request that includes all optional parameters # Get-BetaAccessRequestRecommendationsViewedItems -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsViewedItems" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-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) 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 = '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: **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 of Viewed Access Request Recommendations api_response = api_instance.get_access_request_recommendations_viewed_items() # Below is a request that includes all optional parameters # api_response = api_instance.get_access_request_recommendations_viewed_items(limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) - path: /ai-access-request-recommendations/viewed-items/bulk-create method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items source: | $AccessRequestRecommendationActionItemDto = @"{ "access" : { "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" }, "identityId" : "2c91808570313110017040b06f344ec9" }"@ # Notification of Viewed Access Request Recommendations in Bulk try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto Add-BetaAccessRequestRecommendationsViewedItems -AccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters # Add-BetaAccessRequestRecommendationsViewedItems -AccessRequestRecommendationActionItemDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItems" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items source: | [sailpoint.beta.AccessRequestRecommendationActionItemDto()] # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. access_request_recommendation_action_item_dto = { "access" : { "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" }, "identityId" : "2c91808570313110017040b06f344ec9" } # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. try: # Notification of Viewed Access Request Recommendations in Bulk Result = access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto) api_response = api_instance.add_access_request_recommendations_viewed_items(Result) # Below is a request that includes all optional parameters # api_response = api_instance.add_access_request_recommendations_viewed_items(Result) print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) - path: /ai-access-request-recommendations method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#get-access-request-recommendations source: | $IdentityId = "2c91808570313110017040b06f344ec9" # String | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") $Limit = 56 # Int32 | Max number of results to return. (optional) (default to 15) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false) $Filters = "access.name co "admin"" # String | Filter results using the standard syntax described in [V3 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 = "MySorters" # String | Sort results using the standard syntax described 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) # Identity Access Request Recommendations try { Get-BetaAccessRequestRecommendations # Below is a request that includes all optional parameters # Get-BetaAccessRequestRecommendations -IdentityId $IdentityId -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendations" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-access-request-recommendations#get-access-request-recommendations source: | 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 = '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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) try: # Identity Access Request Recommendations api_response = api_instance.get_access_request_recommendations() # Below is a request that includes all optional parameters # api_response = api_instance.get_access_request_recommendations(identity_id, limit, offset, count, include_translation_messages, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) - path: /common-access method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-common-access#create-common-access source: | $CommonAccessItemRequest = @" { "access" : { "ownerName" : "ownerName", "name" : "name", "description" : "description", "id" : "id", "type" : "ACCESS_PROFILE", "ownerId" : "ownerId" }, "status" : "CONFIRMED" } "@ # Create common access items try { $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest New-BetaCommonAccess -CommonAccessItemRequest $Result # Below is a request that includes all optional parameters # New-BetaCommonAccess -CommonAccessItemRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCommonAccess" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-common-access#create-common-access source: | 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(Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_common_access(Result) print("The response of IAICommonAccessApi->create_common_access:\n") pprint(api_response) except Exception as e: print("Exception when calling IAICommonAccessApi->create_common_access: %s\n" % e) - path: /common-access method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-common-access#get-common-access source: | $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 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" # String | Sort results using the standard syntax described 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) # Get a paginated list of common access try { Get-BetaCommonAccess # Below is a request that includes all optional parameters # Get-BetaCommonAccess -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCommonAccess" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-common-access#get-common-access 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 = 'access.type eq \"ROLE\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) try: # Get a paginated list of common access api_response = api_instance.get_common_access() # Below is a request that includes all optional parameters # api_response = api_instance.get_common_access(offset, limit, count, filters, sorters) print("The response of IAICommonAccessApi->get_common_access:\n") pprint(api_response) except Exception as e: print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) - path: /common-access/update-status method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-common-access#update-common-access-status-in-bulk source: | $CommonAccessIDStatus = @"{ "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] }"@ # Bulk update common access status try { $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus Update-BetaCommonAccessStatusInBulk -CommonAccessIDStatus $Result # Below is a request that includes all optional parameters # Update-BetaCommonAccessStatusInBulk -CommonAccessIDStatus $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCommonAccessStatusInBulk" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-common-access#update-common-access-status-in-bulk source: | [sailpoint.beta.CommonAccessIDStatus()] # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access common_access_id_status = { "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] } # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access try: # Bulk update common access status Result = common_access_id_status.from_json(common_access_id_status) api_response = api_instance.update_common_access_status_in_bulk(Result) # Below is a request that includes all optional parameters # api_response = api_instance.update_common_access_status_in_bulk(Result) print("The response of IAICommonAccessApi->update_common_access_status_in_bulk:\n") pprint(api_response) except Exception as e: print("Exception when calling IAICommonAccessApi->update_common_access_status_in_bulk: %s\n" % e) - path: /translation-catalogs/{catalog-id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-message-catalogs#get-message-catalogs source: | $CatalogId = "recommender" # String | The ID of the message catalog. # Get Message catalogs try { Get-BetaMessageCatalogs -CatalogId $CatalogId # Below is a request that includes all optional parameters # Get-BetaMessageCatalogs -CatalogId $CatalogId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMessageCatalogs" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-message-catalogs#get-message-catalogs source: | catalog_id = 'recommender' # str | The ID of the message catalog. # str | The ID of the message catalog. try: # Get Message catalogs api_response = api_instance.get_message_catalogs(catalog_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_message_catalogs(catalog_id) print("The response of IAIMessageCatalogsApi->get_message_catalogs:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIMessageCatalogsApi->get_message_catalogs: %s\n" % e) - path: /outliers/export method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#export-outliers-zip source: | $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) # IAI Identity Outliers Export try { Export-BetaOutliersZip # Below is a request that includes all optional parameters # Export-BetaOutliersZip -Type $Type } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaOutliersZip" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-outliers#export-outliers-zip source: | type = 'LOW_SIMILARITY' # str | Type of the identity outliers snapshot to filter on (optional) # str | Type of the identity outliers snapshot to filter on (optional) try: # IAI Identity Outliers Export api_response = api_instance.export_outliers_zip() # Below is a request that includes all optional parameters # api_response = api_instance.export_outliers_zip(type) print("The response of IAIOutliersApi->export_outliers_zip:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIOutliersApi->export_outliers_zip: %s\n" % e) - path: /outlier-summaries method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#get-identity-outlier-snapshots source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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" # String | Type of the identity outliers snapshot to filter on (optional) $Filters = "snapshotDate ge "2022-02-07T20:13:29.356648026Z"" # String | Filter results using the standard syntax described in [V3 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" # String | Sort results using the standard syntax described 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) # IAI Identity Outliers Summary try { Get-BetaIdentityOutlierSnapshots # Below is a request that includes all optional parameters # Get-BetaIdentityOutlierSnapshots -Limit $Limit -Offset $Offset -Type $Type -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutlierSnapshots" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-identity-outlier-snapshots 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) 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() # Below is a request that includes all optional parameters # api_response = api_instance.get_identity_outlier_snapshots(limit, offset, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) - path: /outliers method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#get-identity-outliers source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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" # String | Type of the identity outliers snapshot to filter on (optional) $Filters = "attributes.displayName sw "John" and certStatus eq "false"" # String | Filter results using the standard syntax described in [V3 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" # String | Sort results using the standard syntax described 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) # IAI Get Identity Outliers try { Get-BetaIdentityOutliers # Below is a request that includes all optional parameters # Get-BetaIdentityOutliers -Limit $Limit -Offset $Offset -Count $Count -Type $Type -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutliers" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-identity-outliers 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) 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() # Below is a request that includes all optional parameters # api_response = api_instance.get_identity_outliers(limit, offset, count, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outliers:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) - path: /outlier-summaries/latest method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#get-latest-identity-outlier-snapshots source: | $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) # IAI Identity Outliers Latest Summary try { Get-BetaLatestIdentityOutlierSnapshots # Below is a request that includes all optional parameters # Get-BetaLatestIdentityOutlierSnapshots -Type $Type } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLatestIdentityOutlierSnapshots" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-latest-identity-outlier-snapshots source: | type = 'LOW_SIMILARITY' # str | Type of the identity outliers snapshot to filter on (optional) # str | Type of the identity outliers snapshot to filter on (optional) try: # IAI Identity Outliers Latest Summary api_response = api_instance.get_latest_identity_outlier_snapshots() # Below is a request that includes all optional parameters # api_response = api_instance.get_latest_identity_outlier_snapshots(type) print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#get-outlier-contributing-feature-summary source: | $OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributing feature id # Get identity outlier contibuting feature summary try { Get-BetaOutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId # Below is a request that includes all optional parameters # Get-BetaOutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutlierContributingFeatureSummary" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 try: # Get identity outlier contibuting feature summary api_response = api_instance.get_outlier_contributing_feature_summary(outlier_feature_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_outlier_contributing_feature_summary(outlier_feature_id) print("The response of IAIOutliersApi->get_outlier_contributing_feature_summary:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#get-peer-group-outliers-contributing-features source: | $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $IncludeTranslationMessages = "include-translation-messages=" # String | Whether or not to include translation messages object in returned response (optional) $Sorters = "importance" # String | Sort results using the standard syntax described 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) # Get identity outlier's contibuting features try { Get-BetaPeerGroupOutliersContributingFeatures -OutlierId $OutlierId # Below is a request that includes all optional parameters # Get-BetaPeerGroupOutliersContributingFeatures -OutlierId $OutlierId -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliersContributingFeatures" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-outliers#get-peer-group-outliers-contributing-features source: | outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_peer_group_outliers_contributing_features(outlier_id, limit, offset, count, include_translation_messages, sorters) print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#ignore-identity-outliers source: | $RequestBody = "MyRequestBody" # String[] | $RequestBody = @""@ # IAI Identity Outliers Ignore try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody Invoke-BetaIgnoreIdentityOutliers -RequestBody $Result # Below is a request that includes all optional parameters # Invoke-BetaIgnoreIdentityOutliers -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaIgnoreIdentityOutliers" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-outliers#ignore-identity-outliers source: | request_body = ['request_body_example'] # List[str] | request_body = ['request_body_example'] # List[str] | try: # IAI Identity Outliers Ignore Result = request_body.from_json(request_body) api_instance.ignore_identity_outliers(Result) # Below is a request that includes all optional parameters # api_instance.ignore_identity_outliers(Result) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#list-outliers-contributing-feature-access-items source: | $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id $ContributingFeatureName = "radical_entitlement_count" # String | The name of contributing feature $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $AccessType = "ENTITLEMENT" # String | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) $Sorters = "displayName" # String | Sort results using the standard syntax described 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) # Gets a list of access items associated with each identity outlier contributing feature try { Get-BetaOutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName # Below is a request that includes all optional parameters # Get-BetaOutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -Limit $Limit -Offset $Offset -Count $Count -AccessType $AccessType -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutliersContributingFeatureAccessItems" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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, ) # Below is a request that includes all optional parameters # api_response = api_instance.list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, limit, offset, count, access_type, sorters) print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-outliers#un-ignore-identity-outliers source: | $RequestBody = "MyRequestBody" # String[] | $RequestBody = @""@ # IAI Identity Outliers Unignore try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody Invoke-BetaUnIgnoreIdentityOutliers -RequestBody $Result # Below is a request that includes all optional parameters # Invoke-BetaUnIgnoreIdentityOutliers -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaUnIgnoreIdentityOutliers" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-outliers#un-ignore-identity-outliers source: | request_body = ['request_body_example'] # List[str] | request_body = ['request_body_example'] # List[str] | try: # IAI Identity Outliers Unignore Result = request_body.from_json(request_body) api_instance.un_ignore_identity_outliers(Result) # Below is a request that includes all optional parameters # api_instance.un_ignore_identity_outliers(Result) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-peer-group-strategies#get-peer-group-outliers source: | $Strategy = "entitlement" # String | The strategy used to create peer groups. Currently, 'entitlement' is supported. $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # Identity Outliers List try { Get-BetaPeerGroupOutliers -Strategy $Strategy # Below is a request that includes all optional parameters # Get-BetaPeerGroupOutliers -Strategy $Strategy -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliers" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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. limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) try: # Identity Outliers List api_response = api_instance.get_peer_group_outliers(strategy, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_peer_group_outliers(strategy, limit, offset, count) print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) - path: /recommendations/request method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-recommendations#get-recommendations source: | $RecommendationRequestDto = @" { "prescribeMode" : false, "excludeInterpretations" : false, "requests" : [ { "item" : { "id" : "2c938083633d259901633d2623ec0375", "type" : "ENTITLEMENT" }, "identityId" : "2c938083633d259901633d25c68c00fa" }, { "item" : { "id" : "2c938083633d259901633d2623ec0375", "type" : "ENTITLEMENT" }, "identityId" : "2c938083633d259901633d25c68c00fa" } ], "includeTranslationMessages" : false, "includeDebugInformation" : true } "@ # Returns a Recommendation Based on Object try { $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto Get-BetaRecommendations -RecommendationRequestDto $Result # Below is a request that includes all optional parameters # Get-BetaRecommendations -RecommendationRequestDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendations" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-recommendations#get-recommendations source: | 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 a Recommendation Based on Object Result = recommendation_request_dto.from_json(recommendation_request_dto) api_response = api_instance.get_recommendations(Result) # Below is a request that includes all optional parameters # api_response = api_instance.get_recommendations(Result) print("The response of IAIRecommendationsApi->get_recommendations:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIRecommendationsApi->get_recommendations: %s\n" % e) - path: /recommendations/config method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-recommendations#get-recommendations-config source: | # Get certification recommendation config values try { Get-BetaRecommendationsConfig # Below is a request that includes all optional parameters # Get-BetaRecommendationsConfig } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendationsConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-recommendations#get-recommendations-config source: | try: # Get certification recommendation config values api_response = api_instance.get_recommendations_config() # Below is a request that includes all optional parameters # api_response = api_instance.get_recommendations_config() print("The response of IAIRecommendationsApi->get_recommendations_config:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIRecommendationsApi->get_recommendations_config: %s\n" % e) - path: /recommendations/config method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-recommendations#update-recommendations-config source: | $RecommendationConfigDto = @" { "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], "peerGroupPercentageThreshold" : 0.5, "runAutoSelectOnce" : false, "onlyTuneThreshold" : false } "@ # Update certification recommendation config values try { $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto Update-BetaRecommendationsConfig -RecommendationConfigDto $Result # Below is a request that includes all optional parameters # Update-BetaRecommendationsConfig -RecommendationConfigDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRecommendationsConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-recommendations#update-recommendations-config source: | recommendation_config_dto = { "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], "peerGroupPercentageThreshold" : 0.5, "runAutoSelectOnce" : false, "onlyTuneThreshold" : false } # RecommendationConfigDto | try: # Update certification recommendation config values Result = recommendation_config_dto.from_json(recommendation_config_dto) api_response = api_instance.update_recommendations_config(Result) # Below is a request that includes all optional parameters # api_response = api_instance.update_recommendations_config(Result) print("The response of IAIRecommendationsApi->update_recommendations_config:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIRecommendationsApi->update_recommendations_config: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#create-potential-role-provision-request source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session $MinEntitlementPopularity = 56 # Int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to $true) $RoleMiningPotentialRoleProvisionRequest = @" { "includeIdentities" : true, "roleName" : "Finance - Accounting", "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", "roleDescription" : "General access for accounting department", "directlyAssignedEntitlements" : false } "@ # Create request to provision a potential role into an actual role. try { New-BetaPotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters # New-BetaPotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -RoleMiningPotentialRoleProvisionRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPotentialRoleProvisionRequest" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 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, ) # Below is a request that includes all optional parameters # api_response = api_instance.create_potential_role_provision_request(session_id, potential_role_id, min_entitlement_popularity, include_common_access, Result) print("The response of IAIRoleMiningApi->create_potential_role_provision_request:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIRoleMiningApi->create_potential_role_provision_request: %s\n" % e) - path: /role-mining-sessions method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#create-role-mining-sessions source: | $RoleMiningSessionDto = @" { "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" } "@ # Create a role mining session try { $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto New-BetaRoleMiningSessions -RoleMiningSessionDto $Result # Below is a request that includes all optional parameters # New-BetaRoleMiningSessions -RoleMiningSessionDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRoleMiningSessions" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#create-role-mining-sessions source: | 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(Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_role_mining_sessions(Result) print("The response of IAIRoleMiningApi->create_role_mining_sessions:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIRoleMiningApi->create_role_mining_sessions: %s\n" % e) - path: /role-mining-sessions method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-role-mining-sessions source: | $Filters = "saved eq "true" and name sw "RM Session"" # String | Filter results using the standard syntax described in [V3 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" # String | Sort results using the standard syntax described 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 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # Retrieves all role mining sessions try { Get-BetaRoleMiningSessions # Below is a request that includes all optional parameters # Get-BetaRoleMiningSessions -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSessions" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-role-mining-sessions source: | 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() # Below is a request that includes all optional parameters # api_response = api_instance.get_role_mining_sessions(filters, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#download-role-mining-potential-role-zip source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role # Export (download) details for a potential role in a role mining session try { Invoke-BetaDownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId # Below is a request that includes all optional parameters # Invoke-BetaDownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaDownloadRoleMiningPotentialRoleZip" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 try: # Export (download) details for a potential role in a role mining session api_response = api_instance.download_role_mining_potential_role_zip(session_id, potential_role_id, export_id) # Below is a request that includes all optional parameters # api_response = api_instance.download_role_mining_potential_role_zip(session_id, potential_role_id, export_id) print("The response of IAIRoleMiningApi->download_role_mining_potential_role_zip:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#export-role-mining-potential-role source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session # Export (download) details for a potential role in a role mining session try { Export-BetaRoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters # Export-BetaRoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRole" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 try: # Export (download) details for a potential role in a role mining session api_response = api_instance.export_role_mining_potential_role(session_id, potential_role_id) # Below is a request that includes all optional parameters # api_response = api_instance.export_role_mining_potential_role(session_id, potential_role_id) print("The response of IAIRoleMiningApi->export_role_mining_potential_role:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#export-role-mining-potential-role-async source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session $RoleMiningPotentialRoleExportRequest = @" { "minEntitlementPopularity" : 0, "includeCommonAccess" : true } "@ # Asynchronously export details for a potential role in a role mining session and upload to S3 try { Export-BetaRoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters # Export-BetaRoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -RoleMiningPotentialRoleExportRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleAsync" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 role_mining_potential_role_export_request = { "minEntitlementPopularity" : 0, "includeCommonAccess" : true } # RoleMiningPotentialRoleExportRequest | (optional) try: # Asynchronously export details for a potential role in a role mining session and upload to S3 api_response = api_instance.export_role_mining_potential_role_async(session_id, potential_role_id, ) # Below is a request that includes all optional parameters # api_response = api_instance.export_role_mining_potential_role_async(session_id, potential_role_id, Result) print("The response of IAIRoleMiningApi->export_role_mining_potential_role_async:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_async: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#export-role-mining-potential-role-status source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role # Retrieve status of a potential role export job try { Export-BetaRoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId # Below is a request that includes all optional parameters # Export-BetaRoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleStatus" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 try: # Retrieve status of a potential role export job api_response = api_instance.export_role_mining_potential_role_status(session_id, potential_role_id, export_id) # Below is a request that includes all optional parameters # api_response = api_instance.export_role_mining_potential_role_status(session_id, potential_role_id, export_id) print("The response of IAIRoleMiningApi->export_role_mining_potential_role_status:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-all-potential-role-summaries source: | $Sorters = "createdDate" # String | Sort results using the standard syntax described 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))" # String | Filter results using the standard syntax described in [V3 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 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # Retrieves all potential role summaries try { Get-BetaAllPotentialRoleSummaries # Below is a request that includes all optional parameters # Get-BetaAllPotentialRoleSummaries -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllPotentialRoleSummaries" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-all-potential-role-summaries source: | 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() # Below is a request that includes all optional parameters # api_response = api_instance.get_all_potential_role_summaries(sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-entitlement-distribution-potential-role source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) # Retrieves entitlement popularity distribution for a potential role in a role mining session try { Get-BetaEntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters # Get-BetaEntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -IncludeCommonAccess $IncludeCommonAccess } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementDistributionPotentialRole" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 include_common_access = True # bool | Boolean determining whether common access entitlements will be included or not (optional) # bool | Boolean determining whether common access entitlements will be included or not (optional) try: # Retrieves entitlement popularity distribution for a potential role in a role mining session api_response = api_instance.get_entitlement_distribution_potential_role(session_id, potential_role_id, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_entitlement_distribution_potential_role(session_id, potential_role_id, include_common_access) print("The response of IAIRoleMiningApi->get_entitlement_distribution_potential_role:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-entitlements-potential-role source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) (default to $true) $Sorters = "popularity" # String | Sort results using the standard syntax described 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"" # String | Filter results using the standard syntax described in [V3 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 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # Retrieves entitlements for a potential role in a role mining session try { Get-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters # Get-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -IncludeCommonAccess $IncludeCommonAccess -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementsPotentialRole" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 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, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_entitlements_potential_role(session_id, potential_role_id, include_common_access, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-excluded-entitlements-potential-role source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session $Sorters = "populariity" # String | Sort results using the standard syntax described 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"" # String | Filter results using the standard syntax described in [V3 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 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # Retrieves excluded entitlements for a potential role in a role mining session try { Get-BetaExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters # Get-BetaExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaExcludedEntitlementsPotentialRole" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 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, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_excluded_entitlements_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-identities-potential-role source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session $Sorters = "name" # String | Sort results using the standard syntax described 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 = "MyFilters" # String | Filter results using the standard syntax described in [V3 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 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # Retrieves identities for a potential role in a role mining session try { Get-BetaIdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters # Get-BetaIdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitiesPotentialRole" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 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, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_identities_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-potential-role source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session # Retrieve potential role in session try { Get-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters # Get-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRole" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 try: # Retrieve potential role in session api_response = api_instance.get_potential_role(session_id, potential_role_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_potential_role(session_id, potential_role_id) print("The response of IAIRoleMiningApi->get_potential_role:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#patch-potential-role source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id $PatchPotentialRoleRequestInner = @"[{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}]"@ # Update a potential role in session try { $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner Update-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -PatchPotentialRoleRequestInner $Result # Below is a request that includes all optional parameters # Update-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -PatchPotentialRoleRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPotentialRole" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 [{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}] # List[PatchPotentialRoleRequestInner] | patch_potential_role_request_inner = [{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}] # List[PatchPotentialRoleRequestInner] | try: # Update a potential role in session Result = patch_potential_role_request_inner.from_json(patch_potential_role_request_inner) api_response = api_instance.patch_potential_role(session_id, potential_role_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.patch_potential_role(session_id, potential_role_id, Result) print("The response of IAIRoleMiningApi->patch_potential_role:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIRoleMiningApi->patch_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-potential-role-applications source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session $Filters = "applicationName sw "test"" # String | Filter results using the standard syntax described in [V3 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 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # Retrieves the applications of a potential role for a role mining session try { Get-BetaPotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters # Get-BetaPotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleApplications" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 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, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_potential_role_applications(session_id, potential_role_id, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-potential-role-entitlements source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session $Filters = "entitlementRef.name sw "test"" # String | Filter results using the standard syntax described in [V3 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 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # Retrieves the entitlements of a potential role for a role mining session try { Get-BetaPotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters # Get-BetaPotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleEntitlements" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 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, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_potential_role_entitlements(session_id, potential_role_id, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-potential-role-source-identity-usage source: | $PotentialRoleId = "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923" # String | A potential role id $SourceId = "2c9180877620c1460176267f336a106f" # String | A source id $Sorters = "-usageCount" # String | 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 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # Retrieves potential role source usage try { Get-BetaPotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId # Below is a request that includes all optional parameters # Get-BetaPotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleSourceIdentityUsage" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 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, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_potential_role_source_identity_usage(potential_role_id, source_id, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-potential-role-summaries source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $Sorters = "createdDate" # String | Sort results using the standard syntax described 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))" # String | Filter results using the standard syntax described in [V3 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 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # Retrieve session's potential role summaries try { Get-BetaPotentialRoleSummaries -SessionId $SessionId # Below is a request that includes all optional parameters # Get-BetaPotentialRoleSummaries -SessionId $SessionId -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleSummaries" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 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: # Retrieve session's potential role summaries api_response = api_instance.get_potential_role_summaries(session_id, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_potential_role_summaries(session_id, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-role-mining-potential-role source: | $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id # Retrieves a specific potential role try { Get-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters # Get-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningPotentialRole" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 try: # Retrieves a specific potential role api_response = api_instance.get_role_mining_potential_role(potential_role_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_role_mining_potential_role(potential_role_id) print("The response of IAIRoleMiningApi->get_role_mining_potential_role:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_role_mining_potential_role: %s\n" % e) - path: /role-mining-potential-roles/{potentialRoleId} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#patch-role-mining-potential-role source: | $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id $PatchPotentialRoleRequestInner = @"[{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}]"@ # Update a potential role try { $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner Update-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -PatchPotentialRoleRequestInner $Result # Below is a request that includes all optional parameters # Update-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -PatchPotentialRoleRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningPotentialRole" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#patch-role-mining-potential-role source: | potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The potential role summary id # str | The potential role summary id [{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}] # List[PatchPotentialRoleRequestInner] | patch_potential_role_request_inner = [{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}] # List[PatchPotentialRoleRequestInner] | try: # Update a potential role Result = patch_potential_role_request_inner.from_json(patch_potential_role_request_inner) api_response = api_instance.patch_role_mining_potential_role(potential_role_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.patch_role_mining_potential_role(potential_role_id, Result) print("The response of IAIRoleMiningApi->patch_role_mining_potential_role:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIRoleMiningApi->patch_role_mining_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-role-mining-session source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be retrieved. # Get a role mining session try { Get-BetaRoleMiningSession -SessionId $SessionId # Below is a request that includes all optional parameters # Get-BetaRoleMiningSession -SessionId $SessionId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSession" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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. try: # Get a role mining session api_response = api_instance.get_role_mining_session(session_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_role_mining_session(session_id) print("The response of IAIRoleMiningApi->get_role_mining_session:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_role_mining_session: %s\n" % e) - path: /role-mining-sessions/{sessionId} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#patch-role-mining-session source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be patched $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Patch a role mining session try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation Update-BetaRoleMiningSession -SessionId $SessionId -JsonPatchOperation $Result # Below is a request that includes all optional parameters # Update-BetaRoleMiningSession -SessionId $SessionId -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningSession" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#patch-role-mining-session source: | session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be patched # str | The role mining session id to be patched [{op=replace, path=/pruneThreshold, value=83}, {op=replace, path=/minNumIdentitiesInPotentialRole, value=10}, {op=replace, path=/saved, value=false}, {op=replace, path=/name, value=RM Session - 07/10/22}, {op=add, path=/name, value=RM Session - 07/10/22}] # List[JsonPatchOperation] | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. json_patch_operation = { "op" : "replace", "path" : "/description", "value" : "New description" } # List[JsonPatchOperation] | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. try: # Patch a role mining session Result = json_patch_operation.from_json(json_patch_operation) api_response = api_instance.patch_role_mining_session(session_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.patch_role_mining_session(session_id, Result) print("The response of IAIRoleMiningApi->patch_role_mining_session:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIRoleMiningApi->patch_role_mining_session: %s\n" % e) - path: /role-mining-sessions/{sessionId}/status method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-role-mining-session-status source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id # Get role mining session status state try { Get-BetaRoleMiningSessionStatus -SessionId $SessionId # Below is a request that includes all optional parameters # Get-BetaRoleMiningSessionStatus -SessionId $SessionId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSessionStatus" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 try: # Get role mining session status state api_response = api_instance.get_role_mining_session_status(session_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_role_mining_session_status(session_id) print("The response of IAIRoleMiningApi->get_role_mining_session_status:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_role_mining_session_status: %s\n" % e) - path: /role-mining-potential-roles/saved method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#get-saved-potential-roles source: | $Sorters = "modified" # String | 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 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # Retrieves all saved potential roles try { Get-BetaSavedPotentialRoles # Below is a request that includes all optional parameters # Get-BetaSavedPotentialRoles -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSavedPotentialRoles" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/iai-role-mining#get-saved-potential-roles source: | 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() # Below is a request that includes all optional parameters # api_response = api_instance.get_saved_potential_roles(sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/iai-role-mining#update-entitlements-potential-role source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session $RoleMiningPotentialRoleEditEntitlements = @" { "ids" : [ "entId1", "entId2" ], "exclude" : true } "@ # Edit entitlements for a potential role to exclude some entitlements try { $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements Update-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -RoleMiningPotentialRoleEditEntitlements $Result # Below is a request that includes all optional parameters # Update-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -RoleMiningPotentialRoleEditEntitlements $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlementsPotentialRole" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 role_mining_potential_role_edit_entitlements = { "ids" : [ "entId1", "entId2" ], "exclude" : true } # RoleMiningPotentialRoleEditEntitlements | Role mining session parameters try: # Edit entitlements for a potential role to exclude some entitlements Result = role_mining_potential_role_edit_entitlements.from_json(role_mining_potential_role_edit_entitlements) api_response = api_instance.update_entitlements_potential_role(session_id, potential_role_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.update_entitlements_potential_role(session_id, potential_role_id, Result) print("The response of IAIRoleMiningApi->update_entitlements_potential_role:\n") pprint(api_response) except Exception as e: print("Exception when calling IAIRoleMiningApi->update_entitlements_potential_role: %s\n" % e) - path: /icons/{objectType}/{objectId} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/icons#delete-icon source: | $ObjectType = "application" # String | Object type $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. # Delete an icon try { Remove-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId # Below is a request that includes all optional parameters # Remove-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIcon" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/icons#delete-icon source: | object_type = 'application' # str | Object type # str | Object type object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object id. try: # Delete an icon api_instance.delete_icon(object_type, object_id) # Below is a request that includes all optional parameters # api_instance.delete_icon(object_type, object_id) except Exception as e: print("Exception when calling IconsApi->delete_icon: %s\n" % e) - path: /icons/{objectType}/{objectId} method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/icons#set-icon source: | $ObjectType = "application" # String | Object type $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. $Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] # Update an icon try { Set-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId -Image $Image # Below is a request that includes all optional parameters # Set-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId -Image $Image } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIcon" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/icons#set-icon source: | object_type = 'application' # str | Object type # str | Object type object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object id. image = None # bytearray | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] # bytearray | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] try: # Update an icon api_response = api_instance.set_icon(object_type, object_id, image) # Below is a request that includes all optional parameters # api_response = api_instance.set_icon(object_type, object_id, image) print("The response of IconsApi->set_icon:\n") pprint(api_response) except Exception as e: print("Exception when calling IconsApi->set_icon: %s\n" % e) - path: /identities/{id} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identities#delete-identity source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id # Delete identity try { Remove-BetaIdentity -Id $Id # Below is a request that includes all optional parameters # Remove-BetaIdentity -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentity" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#delete-identity source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id try: # Delete identity api_instance.delete_identity(id) # Below is a request that includes all optional parameters # api_instance.delete_identity(id) except Exception as e: print("Exception when calling IdentitiesApi->delete_identity: %s\n" % e) - path: /identities/{id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identities#get-identity source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id # Identity Details try { Get-BetaIdentity -Id $Id # Below is a request that includes all optional parameters # Get-BetaIdentity -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentity" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#get-identity source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id try: # Identity Details api_response = api_instance.get_identity(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_identity(id) print("The response of IdentitiesApi->get_identity:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentitiesApi->get_identity: %s\n" % e) - path: /identities/{identityId}/ownership method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identities#get-identity-ownership-details source: | $IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID. # Get ownership details try { Get-BetaIdentityOwnershipDetails -IdentityId $IdentityId # Below is a request that includes all optional parameters # Get-BetaIdentityOwnershipDetails -IdentityId $IdentityId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOwnershipDetails" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#get-identity-ownership-details source: | identity_id = 'ff8081814d2a8036014d701f3fbf53fa' # str | Identity ID. # str | Identity ID. try: # Get ownership details api_response = api_instance.get_identity_ownership_details(identity_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_identity_ownership_details(identity_id) print("The response of IdentitiesApi->get_identity_ownership_details:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identities#get-role-assignment source: | $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id $AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id # Role assignment details try { Get-BetaRoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId # Below is a request that includes all optional parameters # Get-BetaRoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignment" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#get-role-assignment source: | identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id assignment_id = '1cbb0705b38c4226b1334eadd8874086' # str | Assignment Id # str | Assignment Id try: # Role assignment details api_response = api_instance.get_role_assignment(identity_id, assignment_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_role_assignment(identity_id, assignment_id) print("The response of IdentitiesApi->get_role_assignment:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentitiesApi->get_role_assignment: %s\n" % e) - path: /identities/{identityId}/role-assignments method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identities#get-role-assignments source: | $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id to get the role assignments for $RoleId = "e7697a1e96d04db1ac7b0f4544915d2c" # String | Role Id to filter the role assignments with (optional) $RoleName = "Engineer" # String | Role name to filter the role assignments with (optional) # List role assignments try { Get-BetaRoleAssignments -IdentityId $IdentityId # Below is a request that includes all optional parameters # Get-BetaRoleAssignments -IdentityId $IdentityId -RoleId $RoleId -RoleName $RoleName } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignments" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 role_id = 'e7697a1e96d04db1ac7b0f4544915d2c' # str | Role Id to filter the role assignments with (optional) # str | Role Id to filter the role assignments with (optional) role_name = 'Engineer' # str | Role name to filter the role assignments with (optional) # str | Role name to filter the role assignments with (optional) try: # List role assignments api_response = api_instance.get_role_assignments(identity_id, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_role_assignments(identity_id, role_id, role_name) print("The response of IdentitiesApi->get_role_assignments:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) - path: /identities method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identities#list-identities source: | $Filters = "id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false" # String | Filter results using the standard syntax described in [V3 API Standard 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" # String | Sort results using the standard syntax described 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) $DefaultFilter = "CORRELATED_ONLY" # String | 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # List Identities try { Get-BetaIdentities # Below is a request that includes all optional parameters # Get-BetaIdentities -Filters $Filters -Sorters $Sorters -DefaultFilter $DefaultFilter -Count $Count -Limit $Limit -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentities" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#list-identities source: | 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() # Below is a request that includes all optional parameters # api_response = api_instance.list_identities(filters, sorters, default_filter, count, limit, offset) print("The response of IdentitiesApi->list_identities:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) - path: /identities/{identityId}/reset method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identities#reset-identity source: | $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id # Reset an identity try { Reset-BetaIdentity -IdentityId $IdentityId # Below is a request that includes all optional parameters # Reset-BetaIdentity -IdentityId $IdentityId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-BetaIdentity" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#reset-identity source: | identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id try: # Reset an identity api_instance.reset_identity(identity_id) # Below is a request that includes all optional parameters # api_instance.reset_identity(identity_id) except Exception as e: print("Exception when calling IdentitiesApi->reset_identity: %s\n" % e) - path: /identities/{id}/verification/account/send method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identities#send-identity-verification-account-token source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID $SendAccountVerificationRequest = @" { "sourceName" : "Active Directory Source", "via" : "EMAIL_WORK" } "@ # Send password reset email try { $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest Send-BetaIdentityVerificationAccountToken -Id $Id -SendAccountVerificationRequest $Result # Below is a request that includes all optional parameters # Send-BetaIdentityVerificationAccountToken -Id $Id -SendAccountVerificationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityVerificationAccountToken" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#send-identity-verification-account-token source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID send_account_verification_request = { "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(id, Result) # Below is a request that includes all optional parameters # api_instance.send_identity_verification_account_token(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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identities#start-identities-invite source: | $InviteIdentitiesRequest = @" { "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], "uninvited" : false } "@ # Invite identities to register try { $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest Start-BetaIdentitiesInvite -InviteIdentitiesRequest $Result # Below is a request that includes all optional parameters # Start-BetaIdentitiesInvite -InviteIdentitiesRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentitiesInvite" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#start-identities-invite source: | invite_identities_request = { "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], "uninvited" : false } # InviteIdentitiesRequest | try: # Invite identities to register Result = invite_identities_request.from_json(invite_identities_request) api_response = api_instance.start_identities_invite(Result) # Below is a request that includes all optional parameters # api_response = api_instance.start_identities_invite(Result) print("The response of IdentitiesApi->start_identities_invite:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentitiesApi->start_identities_invite: %s\n" % e) - path: /identities/process method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identities#start-identity-processing source: | $ProcessIdentitiesRequest = @" { "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] } "@ # Process a list of identityIds try { $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest Start-BetaIdentityProcessing -ProcessIdentitiesRequest $Result # Below is a request that includes all optional parameters # Start-BetaIdentityProcessing -ProcessIdentitiesRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentityProcessing" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#start-identity-processing source: | process_identities_request = { "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] } # ProcessIdentitiesRequest | try: # Process a list of identityIds Result = process_identities_request.from_json(process_identities_request) api_response = api_instance.start_identity_processing(Result) # Below is a request that includes all optional parameters # api_response = api_instance.start_identity_processing(Result) print("The response of IdentitiesApi->start_identity_processing:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentitiesApi->start_identity_processing: %s\n" % e) - path: /identities/{identityId}/synchronize-attributes method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identities#synchronize-attributes-for-identity source: | $IdentityId = "MyIdentityId" # String | The Identity id # Attribute synchronization for single identity. try { Sync-BetahronizeAttributesForIdentity -IdentityId $IdentityId # Below is a request that includes all optional parameters # Sync-BetahronizeAttributesForIdentity -IdentityId $IdentityId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetahronizeAttributesForIdentity" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identities#synchronize-attributes-for-identity source: | identity_id = 'identity_id_example' # str | The Identity id # str | The Identity id try: # Attribute synchronization for single identity. api_response = api_instance.synchronize_attributes_for_identity(identity_id) # Below is a request that includes all optional parameters # api_response = api_instance.synchronize_attributes_for_identity(identity_id) print("The response of IdentitiesApi->synchronize_attributes_for_identity:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentitiesApi->synchronize_attributes_for_identity: %s\n" % e) - path: /identity-attributes method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#create-identity-attribute source: | $IdentityAttribute = @" { "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 } "@ # Create Identity Attribute try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute New-BetaIdentityAttribute -IdentityAttribute $Result # Below is a request that includes all optional parameters # New-BetaIdentityAttribute -IdentityAttribute $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityAttribute" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-attributes#create-identity-attribute source: | 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(Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_identity_attribute(Result) print("The response of IdentityAttributesApi->create_identity_attribute:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentityAttributesApi->create_identity_attribute: %s\n" % e) - path: /identity-attributes method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#list-identity-attributes source: | $IncludeSystem = $false # Boolean | Include 'system' attributes in the response. (optional) (default to $false) $IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. (optional) (default to $false) $SearchableOnly = $false # Boolean | Include only 'searchable' attributes in the response. (optional) (default to $false) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # List Identity Attributes try { Get-BetaIdentityAttributes # Below is a request that includes all optional parameters # Get-BetaIdentityAttributes -IncludeSystem $IncludeSystem -IncludeSilent $IncludeSilent -SearchableOnly $SearchableOnly -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttributes" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-attributes#list-identity-attributes source: | 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() # Below is a request that includes all optional parameters # api_response = api_instance.list_identity_attributes(include_system, include_silent, searchable_only, count) print("The response of IdentityAttributesApi->list_identity_attributes:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) - path: /identity-attributes/{name} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#delete-identity-attribute source: | $Name = "displayName" # String | The attribute's technical name. # Delete Identity Attribute try { Remove-BetaIdentityAttribute -Name $Name # Below is a request that includes all optional parameters # Remove-BetaIdentityAttribute -Name $Name } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttribute" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-attributes#delete-identity-attribute source: | name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. try: # Delete Identity Attribute api_instance.delete_identity_attribute(name) # Below is a request that includes all optional parameters # api_instance.delete_identity_attribute(name) except Exception as e: print("Exception when calling IdentityAttributesApi->delete_identity_attribute: %s\n" % e) - path: /identity-attributes/{name} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#get-identity-attribute source: | $Name = "displayName" # String | The attribute's technical name. # Get Identity Attribute try { Get-BetaIdentityAttribute -Name $Name # Below is a request that includes all optional parameters # Get-BetaIdentityAttribute -Name $Name } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttribute" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-attributes#get-identity-attribute source: | name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. try: # Get Identity Attribute api_response = api_instance.get_identity_attribute(name) # Below is a request that includes all optional parameters # api_response = api_instance.get_identity_attribute(name) print("The response of IdentityAttributesApi->get_identity_attribute:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentityAttributesApi->get_identity_attribute: %s\n" % e) - path: /identity-attributes/{name} method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#put-identity-attribute source: | $Name = "displayName" # String | The attribute's technical name. $IdentityAttribute = @" { "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 } "@ # Update Identity Attribute try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute Send-BetaIdentityAttribute -Name $Name -IdentityAttribute $Result # Below is a request that includes all optional parameters # Send-BetaIdentityAttribute -Name $Name -IdentityAttribute $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityAttribute" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-attributes#put-identity-attribute source: | name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. identity_attribute = { "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, Result) # Below is a request that includes all optional parameters # api_response = api_instance.put_identity_attribute(name, Result) print("The response of IdentityAttributesApi->put_identity_attribute:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentityAttributesApi->put_identity_attribute: %s\n" % e) - path: /identity-attributes/bulk-delete method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-attributes#delete-identity-attributes-in-bulk source: | $IdentityAttributeNames = @" { "ids" : [ "name", "displayName" ] } "@ # Bulk delete Identity Attributes try { $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames Remove-BetaIdentityAttributesInBulk -IdentityAttributeNames $Result # Below is a request that includes all optional parameters # Remove-BetaIdentityAttributesInBulk -IdentityAttributeNames $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttributesInBulk" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-attributes#delete-identity-attributes-in-bulk source: | identity_attribute_names = { "ids" : [ "name", "displayName" ] } # IdentityAttributeNames | try: # Bulk delete Identity Attributes Result = identity_attribute_names.from_json(identity_attribute_names) api_instance.delete_identity_attributes_in_bulk(Result) # Below is a request that includes all optional parameters # api_instance.delete_identity_attributes_in_bulk(Result) except Exception as e: print("Exception when calling IdentityAttributesApi->delete_identity_attributes_in_bulk: %s\n" % e) - path: /historical-identities/{id}/compare method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-history#compare-identity-snapshots source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id $Snapshot1 = "2007-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) $Snapshot2 = "2008-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) $AccessItemTypes = "MyAccessItemTypes" # String[] | 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 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # Gets a difference of count for each access item types for the given identity between 2 snapshots try { Compare-BetaIdentitySnapshots -Id $Id # Below is a request that includes all optional parameters # Compare-BetaIdentitySnapshots -Id $Id -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-BetaIdentitySnapshots" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-history#compare-identity-snapshots source: | id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id snapshot1 = '2007-03-01T13:00:00Z' # str | The snapshot 1 of identity (optional) # str | The snapshot 1 of identity (optional) snapshot2 = '2008-03-01T13:00:00Z' # str | The snapshot 2 of identity (optional) # str | The snapshot 2 of identity (optional) access_item_types = ['access_item_types_example'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) access_item_types = ['access_item_types_example'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) try: # Gets a difference of count for each access item types for the given identity between 2 snapshots api_response = api_instance.compare_identity_snapshots(id, ) # Below is a request that includes all optional parameters # api_response = api_instance.compare_identity_snapshots(id, snapshot1, snapshot2, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) - path: /historical-identities/{id}/compare/{accessType} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-history#compare-identity-snapshots-access-type source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id $AccessType = "accessProfile" # String | The specific type which needs to be compared $AccessAssociated = $false # Boolean | 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" # String | The snapshot 1 of identity (optional) $Snapshot2 = "2009-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # Gets a list of differences of specific accessType for the given identity between 2 snapshots try { Compare-BetaIdentitySnapshotsAccessType -Id $Id -AccessType $AccessType # Below is a request that includes all optional parameters # Compare-BetaIdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -AccessAssociated $AccessAssociated -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-BetaIdentitySnapshotsAccessType" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 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, ) # Below is a request that includes all optional parameters # api_response = api_instance.compare_identity_snapshots_access_type(id, access_type, access_associated, snapshot1, snapshot2, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-history#get-historical-identity source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id # Get latest snapshot of identity try { Get-BetaHistoricalIdentity -Id $Id # Below is a request that includes all optional parameters # Get-BetaHistoricalIdentity -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentity" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-history#get-historical-identity source: | id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id try: # Get latest snapshot of identity api_response = api_instance.get_historical_identity(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_historical_identity(id) print("The response of IdentityHistoryApi->get_historical_identity:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentityHistoryApi->get_historical_identity: %s\n" % e) - path: /historical-identities/{id}/events method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-history#get-historical-identity-events source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id $From = "2024-03-01T13:00:00Z" # String | The optional instant until which access events are returned (optional) $EventTypes = "MyEventTypes" # String[] | An optional list of event types to return. If null or empty, all events are returned (optional) $EventTypes = @"[AccessAddedEvent, AccessRemovedEvent]"@ $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) $AccessItemTypes = @"[entitlement, account]"@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # Lists all events for the given identity try { Get-BetaHistoricalIdentityEvents -Id $Id # Below is a request that includes all optional parameters # Get-BetaHistoricalIdentityEvents -Id $Id -From $From -EventTypes $EventTypes -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentityEvents" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-history#get-historical-identity-events source: | id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id var_from = '2024-03-01T13:00:00Z' # str | The optional instant until which access events are returned (optional) # str | The optional instant until which access events are returned (optional) event_types = ['[AccessAddedEvent, AccessRemovedEvent]'] # List[str] | An optional list of event types to return. If null or empty, all events are returned (optional) event_types = ['[AccessAddedEvent, AccessRemovedEvent]'] # List[str] | An optional list of event types to return. If null or empty, all events are returned (optional) access_item_types = ['[entitlement, account]'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) access_item_types = ['[entitlement, account]'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) try: # Lists all events for the given identity api_response = api_instance.get_historical_identity_events(id, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_historical_identity_events(id, var_from, event_types, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->get_historical_identity_events:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-history#get-identity-snapshot source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id $Date = "2007-03-01T13:00:00Z" # String | The specified date # Gets an identity snapshot at a given date try { Get-BetaIdentitySnapshot -Id $Id -Date $Date # Below is a request that includes all optional parameters # Get-BetaIdentitySnapshot -Id $Id -Date $Date } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshot" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 try: # Gets an identity snapshot at a given date api_response = api_instance.get_identity_snapshot(id, var_date) # Below is a request that includes all optional parameters # api_response = api_instance.get_identity_snapshot(id, var_date) print("The response of IdentityHistoryApi->get_identity_snapshot:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-history#get-identity-snapshot-summary source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id $Before = "2007-03-01T13:00:00Z" # String | The date before which snapshot summary is required (optional) $Interval = "day" # String | The interval indicating day or month. Defaults to month if not specified (optional) $TimeZone = "UTC" # String | The time zone. Defaults to UTC if not provided (optional) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # Gets the summary for the event count for a specific identity try { Get-BetaIdentitySnapshotSummary -Id $Id # Below is a request that includes all optional parameters # Get-BetaIdentitySnapshotSummary -Id $Id -Before $Before -Interval $Interval -TimeZone $TimeZone -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshotSummary" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-history#get-identity-snapshot-summary source: | id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id before = '2007-03-01T13:00:00Z' # str | The date before which snapshot summary is required (optional) # str | The date before which snapshot summary is required (optional) interval = 'interval_example' # str | The interval indicating day or month. Defaults to month if not specified (optional) # str | The interval indicating day or month. Defaults to month if not specified (optional) 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, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_identity_snapshot_summary(id, before, interval, time_zone, limit, offset, count) print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-history#get-identity-start-date source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id # Gets the start date of the identity try { Get-BetaIdentityStartDate -Id $Id # Below is a request that includes all optional parameters # Get-BetaIdentityStartDate -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityStartDate" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-history#get-identity-start-date source: | id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id try: # Gets the start date of the identity api_response = api_instance.get_identity_start_date(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_identity_start_date(id) print("The response of IdentityHistoryApi->get_identity_start_date:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentityHistoryApi->get_identity_start_date: %s\n" % e) - path: /historical-identities method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-history#list-historical-identities source: | $StartsWithQuery = "Ada" # String | This param is used for starts-with search for first, last and display name of the identity (optional) $IsDeleted = $true # Boolean | Indicates if we want to only list down deleted identities or not. (optional) $IsActive = $true # Boolean | Indicates if we want to only list active or inactive identities. (optional) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # Lists all the identities try { Get-BetaHistoricalIdentities # Below is a request that includes all optional parameters # Get-BetaHistoricalIdentities -StartsWithQuery $StartsWithQuery -IsDeleted $IsDeleted -IsActive $IsActive -Limit $Limit -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentities" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-history#list-historical-identities source: | 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() # Below is a request that includes all optional parameters # api_response = api_instance.list_historical_identities(starts_with_query, is_deleted, is_active, limit, offset) print("The response of IdentityHistoryApi->list_historical_identities:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-history#list-identity-access-items source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id $Type = "account" # String | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) $Filters = "source eq "DataScienceDataset"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq* (optional) $Sorters = "name" # String | Sort results using the standard syntax described 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, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (optional) $Query = "Dr. Arden" # String | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** (optional) $Limit = 250 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # List Access Items by Identity try { Get-BetaIdentityAccessItems -Id $Id # Below is a request that includes all optional parameters # Get-BetaIdentityAccessItems -Id $Id -Type $Type -Filters $Filters -Sorters $Sorters -Query $Query -Limit $Limit -Count $Count -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAccessItems" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-history#list-identity-access-items source: | id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id type = 'account' # str | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) # str | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) filters = 'source eq \"DataScienceDataset\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq* (optional) 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, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (optional) # str | Sort results using the standard syntax described 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, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (optional) query = 'Dr. Arden' # str | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** (optional) # str | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** (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, ) # Below is a request that includes all optional parameters # api_response = api_instance.list_identity_access_items(id, type, filters, sorters, query, limit, count, offset) print("The response of IdentityHistoryApi->list_identity_access_items:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-history#list-identity-snapshot-access-items source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Identity ID. $Date = "2007-03-01T13:00:00Z" # String | Specified date. $Type = "role" # String | Access item type. (optional) # Get Identity Access Items Snapshot try { Get-BetaIdentitySnapshotAccessItems -Id $Id -Date $Date # Below is a request that includes all optional parameters # Get-BetaIdentitySnapshotAccessItems -Id $Id -Date $Date -Type $Type } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshotAccessItems" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-history#list-identity-snapshot-access-items source: | id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | Identity ID. # str | Identity ID. var_date = '2007-03-01T13:00:00Z' # str | Specified date. # str | Specified date. type = 'account' # str | Access item type. (optional) # str | Access item type. (optional) try: # Get Identity Access Items Snapshot api_response = api_instance.list_identity_snapshot_access_items(id, var_date, ) # Below is a request that includes all optional parameters # api_response = api_instance.list_identity_snapshot_access_items(id, var_date, type) print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-history#list-identity-snapshots source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id $Start = "2007-03-01T13:00:00Z" # String | The specified start date (optional) $Interval = "day" # String | The interval indicating the range in day or month for the specified interval-name (optional) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # Lists all the snapshots for the identity try { Get-BetaIdentitySnapshots -Id $Id # Below is a request that includes all optional parameters # Get-BetaIdentitySnapshots -Id $Id -Start $Start -Interval $Interval -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshots" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-history#list-identity-snapshots source: | id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id start = '2007-03-01T13:00:00Z' # str | The specified start date (optional) # str | The specified start date (optional) interval = 'interval_example' # str | The interval indicating the range in day or month for the specified interval-name (optional) # str | The interval indicating the range in day or month for the specified interval-name (optional) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) try: # Lists all the snapshots for the identity api_response = api_instance.list_identity_snapshots(id, ) # Below is a request that includes all optional parameters # api_response = api_instance.list_identity_snapshots(id, start, interval, limit, offset, count) print("The response of IdentityHistoryApi->list_identity_snapshots:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) - path: /identity-profiles method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#create-identity-profile source: | $IdentityProfile = @" { "owner" : { "name" : "William Wilson", "id" : "2c9180835d191a86015d28455b4b232a", "type" : "IDENTITY" }, "identityExceptionReportReference" : { "reportName" : "My annual report", "taskResultId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" }, "authoritativeSource" : { "name" : "HR Active Directory", "id" : "2c9180835d191a86015d28455b4b232a", "type" : "SOURCE" }, "hasTimeBasedAttr" : true, "created" : "2023-01-03T21:16:22.432Z", "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" : "2023-01-03T21:16:22.432Z", "id" : "id12345" } "@ # Create Identity Profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile New-BetaIdentityProfile -IdentityProfile $Result # Below is a request that includes all optional parameters # New-BetaIdentityProfile -IdentityProfile $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityProfile" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-profiles#create-identity-profile source: | identity_profile = { "owner" : { "name" : "William Wilson", "id" : "2c9180835d191a86015d28455b4b232a", "type" : "IDENTITY" }, "identityExceptionReportReference" : { "reportName" : "My annual report", "taskResultId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" }, "authoritativeSource" : { "name" : "HR Active Directory", "id" : "2c9180835d191a86015d28455b4b232a", "type" : "SOURCE" }, "hasTimeBasedAttr" : true, "created" : "2023-01-03T21:16:22.432Z", "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" : "2023-01-03T21:16:22.432Z", "id" : "id12345" } # IdentityProfile | try: # Create Identity Profile Result = identity_profile.from_json(identity_profile) api_response = api_instance.create_identity_profile(Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_identity_profile(Result) print("The response of IdentityProfilesApi->create_identity_profile:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentityProfilesApi->create_identity_profile: %s\n" % e) - path: /identity-profiles method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#list-identity-profiles source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 8c190e6787aa4ed9a90bd9d5344523fb" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) $Sorters = "name,-priority" # String | Sort results using the standard syntax described 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) # List Identity Profiles try { Get-BetaIdentityProfiles # Below is a request that includes all optional parameters # Get-BetaIdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityProfiles" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 8c190e6787aa4ed9a90bd9d5344523fb' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) sorters = 'name,-priority' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) try: # List Identity Profiles api_response = api_instance.list_identity_profiles() # Below is a request that includes all optional parameters # api_response = api_instance.list_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->list_identity_profiles:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) - path: /identity-profiles/{identity-profile-id} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#delete-identity-profile source: | $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. # Delete Identity Profile try { Remove-BetaIdentityProfile -IdentityProfileId $IdentityProfileId # Below is a request that includes all optional parameters # Remove-BetaIdentityProfile -IdentityProfileId $IdentityProfileId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityProfile" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/{identity-profile-id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#get-identity-profile source: | $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. # Get Identity Profile try { Get-BetaIdentityProfile -IdentityProfileId $IdentityProfileId # Below is a request that includes all optional parameters # Get-BetaIdentityProfile -IdentityProfileId $IdentityProfileId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityProfile" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-profiles#get-identity-profile source: | identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. try: # Get Identity Profile api_response = api_instance.get_identity_profile(identity_profile_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_identity_profile(identity_profile_id) print("The response of IdentityProfilesApi->get_identity_profile:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentityProfilesApi->get_identity_profile: %s\n" % e) - path: /identity-profiles/{identity-profile-id} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#update-identity-profile source: | $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Update Identity Profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation Update-BetaIdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result # Below is a request that includes all optional parameters # Update-BetaIdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaIdentityProfile" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-profiles#update-identity-profile source: | identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. [{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}] # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. json_patch_operation = { "op" : "replace", "path" : "/description", "value" : "New description" } # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. try: # Update Identity Profile Result = json_patch_operation.from_json(json_patch_operation) api_response = api_instance.update_identity_profile(identity_profile_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.update_identity_profile(identity_profile_id, Result) print("The response of IdentityProfilesApi->update_identity_profile:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e) - path: /identity-profiles/bulk-delete method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#delete-identity-profiles source: | $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body. $RequestBody = @""@ # Delete Identity Profiles try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody Remove-BetaIdentityProfiles -RequestBody $Result # Below is a request that includes all optional parameters # Remove-BetaIdentityProfiles -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityProfiles" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-profiles#delete-identity-profiles source: | request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body. 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#export-identity-profiles source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 8c190e6787aa4ed9a90bd9d5344523fb" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) $Sorters = "name,-priority" # String | Sort results using the standard syntax described 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) # Export Identity Profiles try { Export-BetaIdentityProfiles # Below is a request that includes all optional parameters # Export-BetaIdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaIdentityProfiles" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 8c190e6787aa4ed9a90bd9d5344523fb' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) sorters = 'name,-priority' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) try: # Export Identity Profiles api_response = api_instance.export_identity_profiles() # Below is a request that includes all optional parameters # api_response = api_instance.export_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->export_identity_profiles:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#get-default-identity-attribute-config source: | $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID # Default identity attribute config try { Get-BetaDefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId # Below is a request that includes all optional parameters # Get-BetaDefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultIdentityAttributeConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-profiles#get-default-identity-attribute-config source: | identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Identity Profile ID # str | The Identity Profile ID try: # Default identity attribute config api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_default_identity_attribute_config(identity_profile_id) print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e) - path: /identity-profiles/import method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#import-identity-profiles source: | $IdentityProfileExportedObject = @"{ "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" } }"@ # Import Identity Profiles try { $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject Import-BetaIdentityProfiles -IdentityProfileExportedObject $Result # Below is a request that includes all optional parameters # Import-BetaIdentityProfiles -IdentityProfileExportedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaIdentityProfiles" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-profiles#import-identity-profiles source: | [sailpoint.beta.IdentityProfileExportedObject()] # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. identity_profile_exported_object = { "self" : { "name" : "HR Active Directory", "id" : "2c9180835d191a86015d28455b4b232a", "type" : "SOURCE" }, "version" : 1, "object" : { "owner" : { "name" : "William Wilson", "id" : "2c9180835d191a86015d28455b4b232a", "type" : "IDENTITY" }, "identityExceptionReportReference" : { "reportName" : "My annual report", "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" }, "authoritativeSource" : { "name" : "HR Active Directory", "id" : "2c9180835d191a86015d28455b4b232a", "type" : "SOURCE" }, "hasTimeBasedAttr" : true, "created" : "2015-05-28T14:07:17Z", "description" : "My custom flat file profile", "identityRefreshRequired" : true, "identityCount" : 8, "priority" : 10, "identityAttributeConfig" : { "attributeTransforms" : [ { "transformDefinition" : { "attributes" : { "attributeName" : "e-mail", "sourceName" : "MySource", "sourceId" : "2c9180877a826e68017a8c0b03da1a53" }, "type" : "accountAttribute" }, "identityAttributeName" : "email" }, { "transformDefinition" : { "attributes" : { "attributeName" : "e-mail", "sourceName" : "MySource", "sourceId" : "2c9180877a826e68017a8c0b03da1a53" }, "type" : "accountAttribute" }, "identityAttributeName" : "email" } ], "enabled" : true }, "name" : "aName", "modified" : "2015-05-28T14:07:17Z", "id" : "id12345" } } # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. try: # Import Identity Profiles Result = identity_profile_exported_object.from_json(identity_profile_exported_object) api_response = api_instance.import_identity_profiles(Result) # Below is a request that includes all optional parameters # api_response = api_instance.import_identity_profiles(Result) print("The response of IdentityProfilesApi->import_identity_profiles:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentityProfilesApi->import_identity_profiles: %s\n" % e) - path: /identity-profiles/identity-preview method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#show-generate-identity-preview source: | $IdentityPreviewRequest = @" { "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 } } "@ # Generate Identity Profile Preview try { $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest Show-BetaGenerateIdentityPreview -IdentityPreviewRequest $Result # Below is a request that includes all optional parameters # Show-BetaGenerateIdentityPreview -IdentityPreviewRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaGenerateIdentityPreview" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/identity-profiles#show-generate-identity-preview source: | 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.show_generate_identity_preview(Result) # Below is a request that includes all optional parameters # api_response = api_instance.show_generate_identity_preview(Result) print("The response of IdentityProfilesApi->show_generate_identity_preview:\n") pprint(api_response) except Exception as e: print("Exception when calling IdentityProfilesApi->show_generate_identity_preview: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/process-identities method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#sync-identity-profile source: | $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed # Process identities under profile try { Sync-BetaIdentityProfile -IdentityProfileId $IdentityProfileId # Below is a request that includes all optional parameters # Sync-BetaIdentityProfile -IdentityProfileId $IdentityProfileId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetaIdentityProfile" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: /launchers method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/launchers#create-launcher source: | $LauncherRequest = @" { "reference" : { "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", "type" : "WORKFLOW" }, "name" : "Group Create", "description" : "Create a new Active Directory Group", "disabled" : false, "type" : "INTERACTIVE_PROCESS", "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" } "@ # Create launcher try { $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest New-BetaLauncher -LauncherRequest $Result # Below is a request that includes all optional parameters # New-BetaLauncher -LauncherRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaLauncher" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/launchers#create-launcher source: | launcher_request = { "reference" : { "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", "type" : "WORKFLOW" }, "name" : "Group Create", "description" : "Create a new Active Directory Group", "disabled" : false, "type" : "INTERACTIVE_PROCESS", "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" } # LauncherRequest | Payload to create a Launcher try: # Create launcher Result = launcher_request.from_json(launcher_request) api_response = api_instance.create_launcher(Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_launcher(Result) print("The response of LaunchersApi->create_launcher:\n") pprint(api_response) except Exception as e: print("Exception when calling LaunchersApi->create_launcher: %s\n" % e) - path: /launchers method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/launchers#get-launchers source: | $Filters = "disabled eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional) $Next = "eyJuZXh0IjoxMjN9Cg==" # String | Pagination marker (optional) $Limit = 42 # Int32 | Number of Launchers to return (optional) (default to 10) # List all Launchers for tenant try { Get-BetaLaunchers # Below is a request that includes all optional parameters # Get-BetaLaunchers -Filters $Filters -Next $Next -Limit $Limit } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLaunchers" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/launchers#get-launchers source: | filters = 'disabled eq \"true\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional) next = 'eyJuZXh0IjoxMjN9Cg==' # str | Pagination marker (optional) # str | Pagination marker (optional) limit = 10 # int | Number of Launchers to return (optional) (default to 10) # int | Number of Launchers to return (optional) (default to 10) try: # List all Launchers for tenant api_response = api_instance.get_launchers() # Below is a request that includes all optional parameters # api_response = api_instance.get_launchers(filters, next, limit) print("The response of LaunchersApi->get_launchers:\n") pprint(api_response) except Exception as e: print("Exception when calling LaunchersApi->get_launchers: %s\n" % e) - path: /launchers/{launcherID} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/launchers#delete-launcher source: | $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be deleted # Delete Launcher try { Remove-BetaLauncher -LauncherID $LauncherID # Below is a request that includes all optional parameters # Remove-BetaLauncher -LauncherID $LauncherID } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaLauncher" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/launchers#delete-launcher source: | launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be deleted # str | ID of the Launcher to be deleted try: # Delete Launcher api_instance.delete_launcher(launcher_id) # Below is a request that includes all optional parameters # api_instance.delete_launcher(launcher_id) except Exception as e: print("Exception when calling LaunchersApi->delete_launcher: %s\n" % e) - path: /launchers/{launcherID} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/launchers#get-launcher source: | $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be retrieved # Get Launcher by ID try { Get-BetaLauncher -LauncherID $LauncherID # Below is a request that includes all optional parameters # Get-BetaLauncher -LauncherID $LauncherID } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLauncher" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/launchers#get-launcher source: | launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be retrieved # str | ID of the Launcher to be retrieved try: # Get Launcher by ID api_response = api_instance.get_launcher(launcher_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_launcher(launcher_id) print("The response of LaunchersApi->get_launcher:\n") pprint(api_response) except Exception as e: print("Exception when calling LaunchersApi->get_launcher: %s\n" % e) - path: /launchers/{launcherID} method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/launchers#put-launcher source: | $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be replaced $LauncherRequest = @" { "reference" : { "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", "type" : "WORKFLOW" }, "name" : "Group Create", "description" : "Create a new Active Directory Group", "disabled" : false, "type" : "INTERACTIVE_PROCESS", "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" } "@ # Replace Launcher try { $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest Send-BetaLauncher -LauncherID $LauncherID -LauncherRequest $Result # Below is a request that includes all optional parameters # Send-BetaLauncher -LauncherID $LauncherID -LauncherRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaLauncher" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/launchers#put-launcher source: | launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be replaced # str | ID of the Launcher to be replaced launcher_request = { "reference" : { "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", "type" : "WORKFLOW" }, "name" : "Group Create", "description" : "Create a new Active Directory Group", "disabled" : false, "type" : "INTERACTIVE_PROCESS", "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" } # LauncherRequest | Payload to replace Launcher try: # Replace Launcher Result = launcher_request.from_json(launcher_request) api_response = api_instance.put_launcher(launcher_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.put_launcher(launcher_id, Result) print("The response of LaunchersApi->put_launcher:\n") pprint(api_response) except Exception as e: print("Exception when calling LaunchersApi->put_launcher: %s\n" % e) - path: /beta/launchers/{launcherID}/launch method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/launchers#start-launcher source: | $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be launched # Launch a Launcher try { Start-BetaLauncher -LauncherID $LauncherID # Below is a request that includes all optional parameters # Start-BetaLauncher -LauncherID $LauncherID } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaLauncher" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/launchers#start-launcher source: | launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be launched # str | ID of the Launcher to be launched try: # Launch a Launcher api_response = api_instance.start_launcher(launcher_id) # Below is a request that includes all optional parameters # api_response = api_instance.start_launcher(launcher_id) print("The response of LaunchersApi->start_launcher:\n") pprint(api_response) except Exception as e: print("Exception when calling LaunchersApi->start_launcher: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/lifecycle-states#get-lifecycle-states source: | $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity Profile ID. $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle State ID. # Get Lifecycle State try { Get-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId # Below is a request that includes all optional parameters # Get-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLifecycleStates" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/lifecycle-states#get-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. try: # Get Lifecycle State api_response = api_instance.get_lifecycle_states(identity_profile_id, lifecycle_state_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_lifecycle_states(identity_profile_id, lifecycle_state_id) print("The response of LifecycleStatesApi->get_lifecycle_states:\n") pprint(api_response) except Exception as e: print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/lifecycle-states#update-lifecycle-states source: | $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity Profile ID. $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle State ID. $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Update Lifecycle State try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation Update-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result # Below is a request that includes all optional parameters # Update-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaLifecycleStates" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: /mfa/{method}/delete method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#delete-mfa-config source: | $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # Delete MFA method configuration try { Remove-BetaMFAConfig -Method $Method # Below is a request that includes all optional parameters # Remove-BetaMFAConfig -Method $Method } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaMFAConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-configuration#delete-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: # Delete MFA method configuration api_response = api_instance.delete_mfa_config(method) # Below is a request that includes all optional parameters # api_response = api_instance.delete_mfa_config(method) print("The response of MFAConfigurationApi->delete_mfa_config:\n") pprint(api_response) except Exception as e: print("Exception when calling MFAConfigurationApi->delete_mfa_config: %s\n" % e) - path: /mfa/duo-web/config method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#get-mfa-duo-config source: | # Configuration of Duo MFA method try { Get-BetaMFADuoConfig # Below is a request that includes all optional parameters # Get-BetaMFADuoConfig } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFADuoConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-configuration#get-mfa-duo-config source: | try: # Configuration of Duo MFA method api_response = api_instance.get_mfa_duo_config() # Below is a request that includes all optional parameters # api_response = api_instance.get_mfa_duo_config() print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") pprint(api_response) except Exception as e: print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) - path: /mfa/duo-web/config method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#set-mfa-duo-config source: | $MfaDuoConfig = @" { "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", "host" : "example.com", "configProperties" : { "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", "ikey" : "Q123WE45R6TY7890ZXCV" }, "mfaMethod" : "duo-web", "enabled" : true, "identityAttribute" : "email" } "@ # Set Duo MFA configuration try { $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig Set-BetaMFADuoConfig -MfaDuoConfig $Result # Below is a request that includes all optional parameters # Set-BetaMFADuoConfig -MfaDuoConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFADuoConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/kba/config method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#get-mfa-kba-config source: | $AllLanguages = $false # Boolean | 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) # Configuration of KBA MFA method try { Get-BetaMFAKbaConfig # Below is a request that includes all optional parameters # Get-BetaMFAKbaConfig -AllLanguages $AllLanguages } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFAKbaConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#get-mfa-okta-config source: | # Configuration of Okta MFA method try { Get-BetaMFAOktaConfig # Below is a request that includes all optional parameters # Get-BetaMFAOktaConfig } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFAOktaConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-configuration#get-mfa-okta-config source: | try: # Configuration of Okta MFA method api_response = api_instance.get_mfa_okta_config() # Below is a request that includes all optional parameters # api_response = api_instance.get_mfa_okta_config() print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") pprint(api_response) except Exception as e: print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) - path: /mfa/okta-verify/config method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#set-mfa-okta-config source: | $MfaOktaConfig = @" { "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", "host" : "example.com", "mfaMethod" : "okta-verify", "enabled" : true, "identityAttribute" : "email" } "@ # Set Okta MFA configuration try { $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig Set-BetaMFAOktaConfig -MfaOktaConfig $Result # Below is a request that includes all optional parameters # Set-BetaMFAOktaConfig -MfaOktaConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAOktaConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#set-mfakba-config source: | $KbaAnswerRequestItem = @"{ "answer" : "Your answer", "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" }"@ # Set MFA KBA configuration try { $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem Set-BetaMFAKBAConfig -KbaAnswerRequestItem $Result # Below is a request that includes all optional parameters # Set-BetaMFAKBAConfig -KbaAnswerRequestItem $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAKBAConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-configuration#set-mfakba-config source: | [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | kba_answer_request_item = { "answer" : "Your answer", "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" } # List[KbaAnswerRequestItem] | try: # Set MFA KBA configuration Result = kba_answer_request_item.from_json(kba_answer_request_item) api_response = api_instance.set_mfakba_config(Result) # Below is a request that includes all optional parameters # api_response = api_instance.set_mfakba_config(Result) print("The response of MFAConfigurationApi->set_mfakba_config:\n") pprint(api_response) except Exception as e: print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) - path: /mfa/{method}/test method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#test-mfa-config source: | $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # MFA method's test configuration try { Test-BetaMFAConfig -Method $Method # Below is a request that includes all optional parameters # Test-BetaMFAConfig -Method $Method } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaMFAConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: /mfa/token/send method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/mfa-controller#create-send-token source: | $SendTokenRequest = @" { "userAlias" : "will.albin", "deliveryType" : "EMAIL_WORK" } "@ # Create and send user token try { $Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest New-BetaSendToken -SendTokenRequest $Result # Below is a request that includes all optional parameters # New-BetaSendToken -SendTokenRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSendToken" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-controller#create-send-token source: | send_token_request = { "userAlias" : "will.albin", "deliveryType" : "EMAIL_WORK" } # SendTokenRequest | try: # Create and send user token Result = send_token_request.from_json(send_token_request) api_response = api_instance.create_send_token(Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_send_token(Result) print("The response of MFAControllerApi->create_send_token:\n") pprint(api_response) except Exception as e: print("Exception when calling MFAControllerApi->create_send_token: %s\n" % e) - path: /mfa/{method}/poll method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/mfa-controller#ping-verification-status source: | $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' $VerificationPollRequest = @" { "requestId" : "089899f13a8f4da7824996191587bab9" } "@ # Polling MFA method by VerificationPollRequest try { $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest Ping-BetaVerificationStatus -Method $Method -VerificationPollRequest $Result # Below is a request that includes all optional parameters # Ping-BetaVerificationStatus -Method $Method -VerificationPollRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-BetaVerificationStatus" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-controller#ping-verification-status source: | method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' # str | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' verification_poll_request = { "requestId" : "089899f13a8f4da7824996191587bab9" } # VerificationPollRequest | try: # Polling MFA method by VerificationPollRequest Result = verification_poll_request.from_json(verification_poll_request) api_response = api_instance.ping_verification_status(method, Result) # Below is a request that includes all optional parameters # api_response = api_instance.ping_verification_status(method, Result) print("The response of MFAControllerApi->ping_verification_status:\n") pprint(api_response) except Exception as e: print("Exception when calling MFAControllerApi->ping_verification_status: %s\n" % e) - path: /mfa/duo-web/verify method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/mfa-controller#send-duo-verify-request source: | $DuoVerificationRequest = @" { "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", "userId" : "2c9180947f0ef465017f215cbcfd004b" } "@ # Verifying authentication via Duo method try { $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest Send-BetaDuoVerifyRequest -DuoVerificationRequest $Result # Below is a request that includes all optional parameters # Send-BetaDuoVerifyRequest -DuoVerificationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaDuoVerifyRequest" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-controller#send-duo-verify-request source: | duo_verification_request = { "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", "userId" : "2c9180947f0ef465017f215cbcfd004b" } # DuoVerificationRequest | try: # Verifying authentication via Duo method Result = duo_verification_request.from_json(duo_verification_request) api_response = api_instance.send_duo_verify_request(Result) # Below is a request that includes all optional parameters # api_response = api_instance.send_duo_verify_request(Result) print("The response of MFAControllerApi->send_duo_verify_request:\n") pprint(api_response) except Exception as e: print("Exception when calling MFAControllerApi->send_duo_verify_request: %s\n" % e) - path: /mfa/kba/authenticate method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/mfa-controller#send-kba-answers source: | $KbaAnswerRequestItem = @"{ "answer" : "Your answer", "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" }"@ # Authenticate KBA provided MFA method try { $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem Send-BetaKbaAnswers -KbaAnswerRequestItem $Result # Below is a request that includes all optional parameters # Send-BetaKbaAnswers -KbaAnswerRequestItem $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaKbaAnswers" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-controller#send-kba-answers source: | [{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] | kba_answer_request_item = { "answer" : "Your answer", "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" } # List[KbaAnswerRequestItem] | try: # Authenticate KBA provided MFA method Result = kba_answer_request_item.from_json(kba_answer_request_item) api_response = api_instance.send_kba_answers(Result) # Below is a request that includes all optional parameters # api_response = api_instance.send_kba_answers(Result) print("The response of MFAControllerApi->send_kba_answers:\n") pprint(api_response) except Exception as e: print("Exception when calling MFAControllerApi->send_kba_answers: %s\n" % e) - path: /mfa/okta-verify/verify method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/mfa-controller#send-okta-verify-request source: | $OktaVerificationRequest = @" { "userId" : "example@mail.com" } "@ # Verifying authentication via Okta method try { $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest Send-BetaOktaVerifyRequest -OktaVerificationRequest $Result # Below is a request that includes all optional parameters # Send-BetaOktaVerifyRequest -OktaVerificationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaOktaVerifyRequest" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-controller#send-okta-verify-request source: | okta_verification_request = { "userId" : "example@mail.com" } # OktaVerificationRequest | try: # Verifying authentication via Okta method Result = okta_verification_request.from_json(okta_verification_request) api_response = api_instance.send_okta_verify_request(Result) # Below is a request that includes all optional parameters # api_response = api_instance.send_okta_verify_request(Result) print("The response of MFAControllerApi->send_okta_verify_request:\n") pprint(api_response) except Exception as e: print("Exception when calling MFAControllerApi->send_okta_verify_request: %s\n" % e) - path: /mfa/token/authenticate method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/mfa-controller#send-token-auth-request source: | $TokenAuthRequest = @" { "userAlias" : "will.albin", "deliveryType" : "EMAIL_WORK", "token" : "12345" } "@ # Authenticate Token provided MFA method try { $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest Send-BetaTokenAuthRequest -TokenAuthRequest $Result # Below is a request that includes all optional parameters # Send-BetaTokenAuthRequest -TokenAuthRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTokenAuthRequest" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/mfa-controller#send-token-auth-request source: | token_auth_request = { "userAlias" : "will.albin", "deliveryType" : "EMAIL_WORK", "token" : "12345" } # TokenAuthRequest | try: # Authenticate Token provided MFA method Result = token_auth_request.from_json(token_auth_request) api_response = api_instance.send_token_auth_request(Result) # Below is a request that includes all optional parameters # api_response = api_instance.send_token_auth_request(Result) print("The response of MFAControllerApi->send_token_auth_request:\n") pprint(api_response) except Exception as e: print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) - path: /managed-clients/{id}/status method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/managed-clients#get-managed-client-status source: | $Id = "aClientId" # String | ID of the Managed Client Status to get $Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get # Specified Managed Client Status. try { Get-BetaManagedClientStatus -Id $Id -Type $Type # Below is a request that includes all optional parameters # Get-BetaManagedClientStatus -Id $Id -Type $Type } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/managed-clients#get-managed-client-status source: | id = 'aClientId' # str | ID of the Managed Client Status to get # str | ID of the Managed Client Status to get type = sailpoint.beta.ManagedClientType() # ManagedClientType | Type of the Managed Client Status to get # ManagedClientType | Type of the Managed Client Status to get try: # Specified Managed Client Status. api_response = api_instance.get_managed_client_status(id, type) # Below is a request that includes all optional parameters # api_response = api_instance.get_managed_client_status(id, type) print("The response of ManagedClientsApi->get_managed_client_status:\n") pprint(api_response) except Exception as e: print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) - path: /managed-clients/{id}/status method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/managed-clients#update-managed-client-status source: | $Id = "aClientId" # String | ID of the Managed Client Status to update $ManagedClientStatus = @" { "body" : { "alertKey" : "", "id" : "5678", "clusterId" : "1234", "ccg_etag" : "ccg_etag123xyz456", "ccg_pin" : "NONE", "cookbook_etag" : "20210420125956-20210511144538", "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", "internal_ip" : "127.0.0.1", "lastSeen" : "1620843964604", "sinceSeen" : "14708", "sinceSeenMillis" : "14708", "localDev" : false, "stacktrace" : "", "status" : "NORMAL", "product" : "idn", "platform_version" : "2", "os_version" : "2345.3.1", "os_type" : "flatcar", "hypervisor" : "unknown" }, "type" : "CCG", "status" : "NORMAL", "timestamp" : "2020-01-01T00:00:00Z" } "@ # Handle status request from client try { $Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result # Below is a request that includes all optional parameters # Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaManagedClientStatus" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/managed-clients#update-managed-client-status source: | id = 'aClientId' # str | ID of the Managed Client Status to update # str | ID of the Managed Client Status to update managed_client_status = { "body" : { "alertKey" : "", "id" : "5678", "clusterId" : "1234", "ccg_etag" : "ccg_etag123xyz456", "ccg_pin" : "NONE", "cookbook_etag" : "20210420125956-20210511144538", "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", "internal_ip" : "127.0.0.1", "lastSeen" : "1620843964604", "sinceSeen" : "14708", "sinceSeenMillis" : "14708", "localDev" : false, "stacktrace" : "", "status" : "NORMAL", "product" : "idn", "platform_version" : "2", "os_version" : "2345.3.1", "os_type" : "flatcar", "hypervisor" : "unknown" }, "type" : "CCG", "status" : "NORMAL", "timestamp" : "2020-01-01T00:00:00Z" } # ManagedClientStatus | try: # Handle status request from client Result = managed_client_status.from_json(managed_client_status) api_response = api_instance.update_managed_client_status(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.update_managed_client_status(id, Result) print("The response of ManagedClientsApi->update_managed_client_status:\n") pprint(api_response) except Exception as e: print("Exception when calling ManagedClientsApi->update_managed_client_status: %s\n" % e) - path: /managed-clusters/{id}/log-config method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-client-log-configuration source: | $Id = "aClusterId" # String | ID of ManagedCluster to get log configuration for # Get managed cluster's log configuration try { Get-BetaClientLogConfiguration -Id $Id # Below is a request that includes all optional parameters # Get-BetaClientLogConfiguration -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaClientLogConfiguration" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-client-log-configuration source: | id = 'aClusterId' # str | ID of ManagedCluster to get log configuration for # str | ID of ManagedCluster to get log configuration for try: # Get managed cluster's log configuration api_response = api_instance.get_client_log_configuration(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_client_log_configuration(id) print("The response of ManagedClustersApi->get_client_log_configuration:\n") pprint(api_response) except Exception as e: print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) - path: /managed-clusters/{id}/log-config method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#put-client-log-configuration source: | $Id = "aClusterId" # String | ID of ManagedCluster to update log configuration for $ClientLogConfiguration = @" { "durationMinutes" : 120, "rootLevel" : "INFO", "clientId" : "aClientId", "expiration" : "2020-12-15T19:13:36.079Z", "logLevels" : "INFO" } "@ # Update managed cluster's log configuration try { Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result # Below is a request that includes all optional parameters # Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/managed-clusters#put-client-log-configuration source: | id = 'aClusterId' # str | ID of ManagedCluster to update log configuration for # str | ID of ManagedCluster to update log configuration for client_log_configuration = { "durationMinutes" : 120, "rootLevel" : "INFO", "clientId" : "aClientId", "expiration" : "2020-12-15T19:13:36.079Z", "logLevels" : "INFO" } # ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster try: # Update managed cluster's log configuration api_response = api_instance.put_client_log_configuration(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.put_client_log_configuration(id, Result) print("The response of ManagedClustersApi->put_client_log_configuration:\n") pprint(api_response) except Exception as e: print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) - path: /managed-clusters/{id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-cluster source: | $Id = "aClusterId" # String | ID of the ManagedCluster to get # Get a specified ManagedCluster. try { Get-BetaManagedCluster -Id $Id # Below is a request that includes all optional parameters # Get-BetaManagedCluster -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedCluster" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/managed-clusters#get-managed-cluster source: | id = 'aClusterId' # str | ID of the ManagedCluster to get # str | ID of the ManagedCluster to get try: # Get a specified ManagedCluster. api_response = api_instance.get_managed_cluster(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_managed_cluster(id) print("The response of ManagedClustersApi->get_managed_cluster:\n") pprint(api_response) except Exception as e: print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) - path: /managed-clusters method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-clusters source: | $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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" # String | Filter results using the standard syntax described in [V3 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) # Retrieve all Managed Clusters. try { Get-BetaManagedClusters # Below is a request that includes all optional parameters # Get-BetaManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClusters" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: # Retrieve all Managed Clusters. api_response = api_instance.get_managed_clusters() # Below is a request that includes all optional parameters # api_response = api_instance.get_managed_clusters(offset, limit, count, filters) print("The response of ManagedClustersApi->get_managed_clusters:\n") pprint(api_response) except Exception as e: print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) - path: /multihosts method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#create-multi-host-integration source: | $MultiHostIntegrationsCreate = @" { "owner" : { "name" : "MyName", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, "managementWorkgroup" : { "name" : "My Management Workgroup", "id" : "2c91808568c529c60168cca6f90c2222", "type" : "GOVERNANCE_GROUP" }, "cluster" : { "name" : "Corporate Cluster", "id" : "2c9180866166b5b0016167c32ef31a66", "type" : "CLUSTER" }, "connector" : "multihost-microsoft-sql-server", "connectorAttributes" : { "maxSourcesPerAggGroup" : 10, "maxAllowedSources" : 300 }, "created" : "2022-02-08T14:50:03.827Z", "name" : "My Multi-Host Integration", "description" : "This is the Multi-Host Integration.", "modified" : "2024-01-23T18:08:50.897Z" } "@ # Create Multi-Host Integration try { $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate New-BetaMultiHostIntegration -MultiHostIntegrationsCreate $Result # Below is a request that includes all optional parameters # New-BetaMultiHostIntegration -MultiHostIntegrationsCreate $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaMultiHostIntegration" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#create-multi-host-integration source: | multi_host_integrations_create = { "owner" : { "name" : "MyName", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, "managementWorkgroup" : { "name" : "My Management Workgroup", "id" : "2c91808568c529c60168cca6f90c2222", "type" : "GOVERNANCE_GROUP" }, "cluster" : { "name" : "Corporate Cluster", "id" : "2c9180866166b5b0016167c32ef31a66", "type" : "CLUSTER" }, "connector" : "multihost-microsoft-sql-server", "connectorAttributes" : { "maxSourcesPerAggGroup" : 10, "maxAllowedSources" : 300 }, "created" : "2022-02-08T14:50:03.827Z", "name" : "My Multi-Host Integration", "description" : "This is the Multi-Host Integration.", "modified" : "2024-01-23T18:08:50.897Z" } # MultiHostIntegrationsCreate | The specifics of the Multi-Host Integration to create try: # Create Multi-Host Integration Result = multi_host_integrations_create.from_json(multi_host_integrations_create) api_response = api_instance.create_multi_host_integration(Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_multi_host_integration(Result) print("The response of MultiHostIntegrationApi->create_multi_host_integration:\n") pprint(api_response) except Exception as e: print("Exception when calling MultiHostIntegrationApi->create_multi_host_integration: %s\n" % e) - path: /multihosts method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-multi-host-integrations-list source: | $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | Max number of results 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" # String | Sort results using the standard syntax described 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 = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 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**: *in* **forSubAdminId**: *in* (optional) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # List All Existing Multi-Host Integrations try { Get-BetaMultiHostIntegrationsList # Below is a request that includes all optional parameters # Get-BetaMultiHostIntegrationsList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count -ForSubadmin $ForSubadmin } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostIntegrationsList" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-multi-host-integrations-list 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 = 'id eq 2c91808b6ef1d43e016efba0ce470904' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *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: **type**: *in* **forSubAdminId**: *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) for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) try: # List All Existing Multi-Host Integrations api_response = api_instance.get_multi_host_integrations_list() # Below is a request that includes all optional parameters # api_response = api_instance.get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin) print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n") pprint(api_response) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e) - path: /multihosts/{multihostId} method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#create-sources-within-multi-host source: | $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. $MultiHostIntegrationsCreateSources = @"{ "connectorAttributes" : { "authType" : "SQLAuthentication", "url" : "jdbc:sqlserver://178.18.41.118:1433", "user" : "username", "driverClass" : "com.microsoft.sqlserver.jdbc.SQLServerDriver", "maxSourcesPerAggGroup" : 10, "maxAllowedSources" : 300 }, "name" : "My Source", "description" : "This is the corporate directory." }"@ # Create Sources Within Multi-Host Integration try { $Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources New-BetaSourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result # Below is a request that includes all optional parameters # New-BetaSourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourcesWithinMultiHost" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#create-sources-within-multi-host source: | multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration. # str | ID of the Multi-Host Integration. [sailpoint.beta.MultiHostIntegrationsCreateSources()] # List[MultiHostIntegrationsCreateSources] | The specifics of the sources to create within Multi-Host Integration. multi_host_integrations_create_sources = { "connectorAttributes" : { "authType" : "SQLAuthentication", "url" : "jdbc:sqlserver://178.18.41.118:1433", "user" : "username", "driverClass" : "com.microsoft.sqlserver.jdbc.SQLServerDriver", "maxSourcesPerAggGroup" : 10, "maxAllowedSources" : 300 }, "name" : "My Source", "description" : "This is the corporate directory." } # List[MultiHostIntegrationsCreateSources] | The specifics of the sources to create within Multi-Host Integration. try: # Create Sources Within Multi-Host Integration Result = multi_host_integrations_create_sources.from_json(multi_host_integrations_create_sources) api_instance.create_sources_within_multi_host(multihost_id, Result) # Below is a request that includes all optional parameters # api_instance.create_sources_within_multi_host(multihost_id, Result) except Exception as e: print("Exception when calling MultiHostIntegrationApi->create_sources_within_multi_host: %s\n" % e) - path: /multihosts/{multihostId} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#delete-multi-host source: | $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete. # Delete Multi-Host Integration try { Remove-BetaMultiHost -MultihostId $MultihostId # Below is a request that includes all optional parameters # Remove-BetaMultiHost -MultihostId $MultihostId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaMultiHost" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#delete-multi-host source: | multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of Multi-Host Integration to delete. # str | ID of Multi-Host Integration to delete. try: # Delete Multi-Host Integration api_instance.delete_multi_host(multihost_id) # Below is a request that includes all optional parameters # api_instance.delete_multi_host(multihost_id) except Exception as e: print("Exception when calling MultiHostIntegrationApi->delete_multi_host: %s\n" % e) - path: /multihosts/{multihostId} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-multi-host-integrations source: | $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. # Get Multi-Host Integration By ID try { Get-BetaMultiHostIntegrations -MultihostId $MultihostId # Below is a request that includes all optional parameters # Get-BetaMultiHostIntegrations -MultihostId $MultihostId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostIntegrations" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-multi-host-integrations source: | multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration. # str | ID of the Multi-Host Integration. try: # Get Multi-Host Integration By ID api_response = api_instance.get_multi_host_integrations(multihost_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_multi_host_integrations(multihost_id) print("The response of MultiHostIntegrationApi->get_multi_host_integrations:\n") pprint(api_response) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations: %s\n" % e) - path: /multihosts/{multihostId} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#update-multi-host-sources source: | $MultihostId = "anId" # String | ID of the Multi-Host Integration to update. $UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@ # Update Multi-Host Integration try { $Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner Update-BetaMultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result # Below is a request that includes all optional parameters # Update-BetaMultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaMultiHostSources" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#update-multi-host-sources source: | multihost_id = 'anId' # str | ID of the Multi-Host Integration to update. # str | ID of the Multi-Host Integration to update. [{op=add, path=/description, value=MDK Multi-Host Integration 222 description}] # List[UpdateMultiHostSourcesRequestInner] | This endpoint allows you to update a Multi-Host Integration. update_multi_host_sources_request_inner = [{op=add, path=/description, value=MDK Multi-Host Integration 222 description}] # List[UpdateMultiHostSourcesRequestInner] | This endpoint allows you to update a Multi-Host Integration. try: # Update Multi-Host Integration Result = update_multi_host_sources_request_inner.from_json(update_multi_host_sources_request_inner) api_instance.update_multi_host_sources(multihost_id, Result) # Below is a request that includes all optional parameters # api_instance.update_multi_host_sources(multihost_id, Result) except Exception as e: print("Exception when calling MultiHostIntegrationApi->update_multi_host_sources: %s\n" % e) - path: /multihosts/{multihostId}/acctAggregationGroups method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-acct-aggregation-groups source: | $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update # Get Account Aggregation Groups Within Multi-Host Integration ID try { Get-BetaAcctAggregationGroups -MultihostId $MultihostId # Below is a request that includes all optional parameters # Get-BetaAcctAggregationGroups -MultihostId $MultihostId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAcctAggregationGroups" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-acct-aggregation-groups source: | multihost_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update try: # Get Account Aggregation Groups Within Multi-Host Integration ID api_response = api_instance.get_acct_aggregation_groups(multihost_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_acct_aggregation_groups(multihost_id) print("The response of MultiHostIntegrationApi->get_acct_aggregation_groups:\n") pprint(api_response) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_acct_aggregation_groups: %s\n" % e) - path: /multihosts/{multiHostId}/entitlementAggregationGroups method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-entitlement-aggregation-groups source: | $MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update # Get Entitlement Aggregation Groups Within Multi-Host Integration ID try { Get-BetaEntitlementAggregationGroups -MultiHostId $MultiHostId # Below is a request that includes all optional parameters # Get-BetaEntitlementAggregationGroups -MultiHostId $MultiHostId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementAggregationGroups" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-entitlement-aggregation-groups source: | multi_host_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update try: # Get Entitlement Aggregation Groups Within Multi-Host Integration ID api_response = api_instance.get_entitlement_aggregation_groups(multi_host_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_entitlement_aggregation_groups(multi_host_id) print("The response of MultiHostIntegrationApi->get_entitlement_aggregation_groups:\n") pprint(api_response) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_entitlement_aggregation_groups: %s\n" % e) - path: /multihosts/{multiHostId}/sources/errors method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-multi-host-source-creation-errors source: | $MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration # List Multi-Host Source Creation Errors try { Get-BetaMultiHostSourceCreationErrors -MultiHostId $MultiHostId # Below is a request that includes all optional parameters # Get-BetaMultiHostSourceCreationErrors -MultiHostId $MultiHostId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostSourceCreationErrors" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-multi-host-source-creation-errors source: | multi_host_id = '004091cb79b04636b88662afa50a4440' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration try: # List Multi-Host Source Creation Errors api_response = api_instance.get_multi_host_source_creation_errors(multi_host_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_multi_host_source_creation_errors(multi_host_id) print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n") pprint(api_response) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e) - path: /multihosts/types method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-multihost-integration-types source: | # List Multi-Host Integration Types try { Get-BetaMultihostIntegrationTypes # Below is a request that includes all optional parameters # Get-BetaMultihostIntegrationTypes } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultihostIntegrationTypes" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-multihost-integration-types source: | try: # List Multi-Host Integration Types api_response = api_instance.get_multihost_integration_types() # Below is a request that includes all optional parameters # api_response = api_instance.get_multihost_integration_types() print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n") pprint(api_response) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e) - path: /multihosts/{multihostId}/sources method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-sources-within-multi-host source: | $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | Max number of results 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" # String | Sort results using the standard syntax described 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 = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # List Sources Within Multi-Host Integration try { Get-BetaSourcesWithinMultiHost -MultihostId $MultihostId # Below is a request that includes all optional parameters # Get-BetaSourcesWithinMultiHost -MultihostId $MultihostId -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourcesWithinMultiHost" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#get-sources-within-multi-host source: | multihost_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) 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 = 'id eq 2c91808b6ef1d43e016efba0ce470904' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) try: # List Sources Within Multi-Host Integration api_response = api_instance.get_sources_within_multi_host(multihost_id, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count) print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n") pprint(api_response) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e) - path: /multihosts/{multihostId}/sources/testConnection method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#test-connection-multi-host-sources source: | $MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration # Test Configuration For Multi-Host Integration try { Test-BetaConnectionMultiHostSources -MultihostId $MultihostId # Below is a request that includes all optional parameters # Test-BetaConnectionMultiHostSources -MultihostId $MultihostId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaConnectionMultiHostSources" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#test-connection-multi-host-sources source: | multihost_id = '2c91808568c529c60168cca6f90c1324' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration try: # Test Configuration For Multi-Host Integration api_instance.test_connection_multi_host_sources(multihost_id) # Below is a request that includes all optional parameters # api_instance.test_connection_multi_host_sources(multihost_id) except Exception as e: print("Exception when calling MultiHostIntegrationApi->test_connection_multi_host_sources: %s\n" % e) - path: /multihosts/{multihostId}/sources/{sourceId}/testConnection method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#test-source-connection-multihost source: | $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration $SourceId = "2c91808568c529f60168cca6f90c1324" # String | ID of the source within the Multi-Host Integration # Test Configuration For Multi-Host Integration's Single Source try { Test-BetaSourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId # Below is a request that includes all optional parameters # Test-BetaSourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConnectionMultihost" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/multi-host-integration#test-source-connection-multihost source: | multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration source_id = '2c91808568c529f60168cca6f90c1324' # str | ID of the source within the Multi-Host Integration # str | ID of the source within the Multi-Host Integration try: # Test Configuration For Multi-Host Integration's Single Source api_response = api_instance.test_source_connection_multihost(multihost_id, source_id) # Below is a request that includes all optional parameters # api_response = api_instance.test_source_connection_multihost(multihost_id, source_id) print("The response of MultiHostIntegrationApi->test_source_connection_multihost:\n") pprint(api_response) except Exception as e: print("Exception when calling MultiHostIntegrationApi->test_source_connection_multihost: %s\n" % e) - path: /non-employee-approvals/{id}/approve method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#approve-non-employee-request source: | $Id = "MyId" # String | Non-Employee approval item id (UUID) $NonEmployeeApprovalDecision = @" { "comment" : "comment" } "@ # Approve a Non-Employee Request try { $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision Approve-BetaNonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result # Below is a request that includes all optional parameters # Approve-BetaNonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaNonEmployeeRequest" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#approve-non-employee-request source: | id = 'id_example' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) non_employee_approval_decision = { "comment" : "comment" } # NonEmployeeApprovalDecision | try: # Approve a Non-Employee Request Result = non_employee_approval_decision.from_json(non_employee_approval_decision) api_response = api_instance.approve_non_employee_request(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.approve_non_employee_request(id, Result) print("The response of NonEmployeeLifecycleManagementApi->approve_non_employee_request:\n") pprint(api_response) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->approve_non_employee_request: %s\n" % e) - path: /non-employee-records method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#create-non-employee-record source: | $NonEmployeeRequestBody = @" { "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" } "@ # Create Non-Employee Record try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody New-BetaNonEmployeeRecord -NonEmployeeRequestBody $Result # Below is a request that includes all optional parameters # New-BetaNonEmployeeRecord -NonEmployeeRequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRecord" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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-records method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#list-non-employee-records source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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" # String | Sort results using the standard syntax described 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"" # String | Filter results using the standard syntax described in [V3 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) # List Non-Employee Records try { Get-BetaNonEmployeeRecords # Below is a request that includes all optional parameters # Get-BetaNonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecords" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#create-non-employee-request source: | $NonEmployeeRequestBody = @" { "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" } "@ # Create Non-Employee Request try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody New-BetaNonEmployeeRequest -NonEmployeeRequestBody $Result # Below is a request that includes all optional parameters # New-BetaNonEmployeeRequest -NonEmployeeRequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRequest" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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-requests method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#list-non-employee-requests source: | $RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = "approvalStatus,firstName" # String | Sort results using the standard syntax described 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"" # String | Filter results using the standard syntax described in [V3 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) # List Non-Employee Requests try { Get-BetaNonEmployeeRequests -RequestedFor $RequestedFor # Below is a request that includes all optional parameters # Get-BetaNonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequests" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#list-non-employee-requests source: | requested_for = 'me' # str | The identity for whom the request was made. *me* indicates the current user. # str | The identity for whom the request was made. *me* indicates the current user. limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = 'approvalStatus,firstName' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) filters = 'sourceId eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) try: # List Non-Employee Requests api_response = api_instance.list_non_employee_requests(requested_for, ) # Below is a request that includes all optional parameters # api_response = api_instance.list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") pprint(api_response) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) - path: /non-employee-sources method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#create-non-employee-source source: | $NonEmployeeSourceRequestBody = @" { "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" } ] } "@ # Create Non-Employee Source try { $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody New-BetaNonEmployeeSource -NonEmployeeSourceRequestBody $Result # Below is a request that includes all optional parameters # New-BetaNonEmployeeSource -NonEmployeeSourceRequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSource" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#list-non-employee-sources source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) $NonEmployeeCount = $false # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) $Sorters = "name,created" # String | Sort results using the standard syntax described 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) # List Non-Employee Sources try { Get-BetaNonEmployeeSources # Below is a request that includes all optional parameters # Get-BetaNonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSources" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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-sources/{sourceId}/schema-attributes method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes source: | $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id $NonEmployeeSchemaAttributeBody = @" { "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 } "@ # Create Non-Employee Source Schema Attribute try { $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody New-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result # Below is a request that includes all optional parameters # New-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSourceSchemaAttributes" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes source: | source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id non_employee_schema_attribute_body = { "helpText" : "The unique identifier for the account", "label" : "Account Name", "placeholder" : "Enter a unique user name for this account.", "type" : "TEXT", "technicalName" : "account.name", "required" : true } # NonEmployeeSchemaAttributeBody | try: # Create Non-Employee Source Schema Attribute Result = non_employee_schema_attribute_body.from_json(non_employee_schema_attribute_body) api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_non_employee_source_schema_attributes(source_id, Result) print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes:\n") pprint(api_response) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes source: | $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id # Delete all custom schema attributes try { Remove-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId # Below is a request that includes all optional parameters # Remove-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSourceSchemaAttributes" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes source: | source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id try: # Delete all custom schema attributes api_instance.delete_non_employee_source_schema_attributes(source_id) # Below is a request that includes all optional parameters # api_instance.delete_non_employee_source_schema_attributes(source_id) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source_schema_attributes: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes source: | $SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id # List Schema Attributes Non-Employee Source try { Get-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId # Below is a request that includes all optional parameters # Get-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSourceSchemaAttributes" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes source: | source_id = '2c918085842e69ae018432d22ccb212f' # str | The Source id # str | The Source id try: # List Schema Attributes Non-Employee Source api_response = api_instance.get_non_employee_source_schema_attributes(source_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_non_employee_source_schema_attributes(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") pprint(api_response) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) - path: /non-employee-records/{id} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-record source: | $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID) # Delete Non-Employee Record try { Remove-BetaNonEmployeeRecord -Id $Id # Below is a request that includes all optional parameters # Remove-BetaNonEmployeeRecord -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecord" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-record source: | id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) try: # Delete Non-Employee Record api_instance.delete_non_employee_record(id) # Below is a request that includes all optional parameters # api_instance.delete_non_employee_record(id) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record: %s\n" % e) - path: /non-employee-records/{id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-record source: | $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID) # Get a Non-Employee Record try { Get-BetaNonEmployeeRecord -Id $Id # Below is a request that includes all optional parameters # Get-BetaNonEmployeeRecord -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecord" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-record source: | id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) try: # Get a Non-Employee Record api_response = api_instance.get_non_employee_record(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_non_employee_record(id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n") pprint(api_response) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) - path: /non-employee-records/{id} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#patch-non-employee-record source: | $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-employee record id (UUID) $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Patch Non-Employee Record try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation Update-BetaNonEmployeeRecord -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters # Update-BetaNonEmployeeRecord -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#patch-non-employee-record source: | id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) [{op=replace, path=/endDate, value={2019-08-23T18:40:35.772Z=null}}] # List[JsonPatchOperation] | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. json_patch_operation = { "op" : "replace", "path" : "/description", "value" : "New description" } # List[JsonPatchOperation] | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. try: # Patch Non-Employee Record Result = json_patch_operation.from_json(json_patch_operation) api_response = api_instance.patch_non_employee_record(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.patch_non_employee_record(id, Result) print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n") pprint(api_response) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_record: %s\n" % e) - path: /non-employee-records/{id} method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#update-non-employee-record source: | $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-employee record id (UUID) $NonEmployeeRequestBody = @" { "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" } "@ # Update Non-Employee Record try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody Update-BetaNonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result # Below is a request that includes all optional parameters # Update-BetaNonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#update-non-employee-record source: | id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) non_employee_request_body = { "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: /non-employee-records/bulk-delete method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-record-in-bulk source: | $DeleteNonEmployeeRecordInBulkRequest = @" "@ # Delete Multiple Non-Employee Records try { $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordInBulkRequest -Json $DeleteNonEmployeeRecordInBulkRequest Remove-BetaNonEmployeeRecordInBulk -DeleteNonEmployeeRecordInBulkRequest $Result # Below is a request that includes all optional parameters # Remove-BetaNonEmployeeRecordInBulk -DeleteNonEmployeeRecordInBulkRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecordInBulk" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-record-in-bulk source: | delete_non_employee_record_in_bulk_request = sailpoint.beta.DeleteNonEmployeeRecordInBulkRequest() # DeleteNonEmployeeRecordInBulkRequest | Non-Employee bulk delete request body. try: # Delete Multiple Non-Employee Records Result = delete_non_employee_record_in_bulk_request.from_json(delete_non_employee_record_in_bulk_request) api_instance.delete_non_employee_record_in_bulk(Result) # Below is a request that includes all optional parameters # api_instance.delete_non_employee_record_in_bulk(Result) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record_in_bulk: %s\n" % e) - path: /non-employee-requests/{id} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-request source: | $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id in the UUID format # Delete Non-Employee Request try { Remove-BetaNonEmployeeRequest -Id $Id # Below is a request that includes all optional parameters # Remove-BetaNonEmployeeRequest -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRequest" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-request source: | id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee request id in the UUID format # str | Non-Employee request id in the UUID format try: # Delete Non-Employee Request api_instance.delete_non_employee_request(id) # Below is a request that includes all optional parameters # api_instance.delete_non_employee_request(id) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_request: %s\n" % e) - path: /non-employee-requests/{id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-request source: | $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id (UUID) # Get a Non-Employee Request try { Get-BetaNonEmployeeRequest -Id $Id # Below is a request that includes all optional parameters # Get-BetaNonEmployeeRequest -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequest" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-request source: | id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee request id (UUID) # str | Non-Employee request id (UUID) try: # Get a Non-Employee Request api_response = api_instance.get_non_employee_request(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_non_employee_request(id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n") pprint(api_response) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute source: | $AttributeId = "2c91808b6ef1d43e016efba0ce470904" # String | The Schema Attribute Id (UUID) $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id # Delete Non-Employee Source's Schema Attribute try { Remove-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId # Below is a request that includes all optional parameters # Remove-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSchemaAttribute" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute source: | attribute_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id try: # Delete Non-Employee Source's Schema Attribute api_instance.delete_non_employee_schema_attribute(attribute_id, source_id) # Below is a request that includes all optional parameters # api_instance.delete_non_employee_schema_attribute(attribute_id, source_id) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_schema_attribute: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute source: | $AttributeId = "2c918085842e69ae018432d22ccb212f" # String | The Schema Attribute Id (UUID) $SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id # Get Schema Attribute Non-Employee Source try { Get-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId # Below is a request that includes all optional parameters # Get-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSchemaAttribute" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute source: | attribute_id = '2c918085842e69ae018432d22ccb212f' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) source_id = '2c918085842e69ae018432d22ccb212f' # str | The Source id # str | The Source id try: # Get Schema Attribute Non-Employee Source api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_non_employee_schema_attribute(attribute_id, source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute:\n") pprint(api_response) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) - path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute source: | $AttributeId = "2c91808b6ef1d43e016efba0ce470904" # String | The Schema Attribute Id (UUID) $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Patch Non-Employee Source's Schema Attribute try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation Update-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result # Below is a request that includes all optional parameters # Update-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSchemaAttribute" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute source: | attribute_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id [{op=replace, path=/label, value={new attribute label=null}}] # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. json_patch_operation = { "op" : "replace", "path" : "/description", "value" : "New description" } # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. try: # Patch Non-Employee Source's Schema Attribute Result = json_patch_operation.from_json(json_patch_operation) api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.patch_non_employee_schema_attribute(attribute_id, source_id, Result) print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute:\n") pprint(api_response) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute: %s\n" % e) - path: /non-employee-sources/{sourceId} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#delete-non-employee-source source: | $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id # Delete Non-Employee Source try { Remove-BetaNonEmployeeSource -SourceId $SourceId # Below is a request that includes all optional parameters # Remove-BetaNonEmployeeSource -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSource" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#delete-non-employee-source source: | source_id = '2c91808b6ef1d43e016efba0ce470904' # str | Source Id # str | Source Id try: # Delete Non-Employee Source api_instance.delete_non_employee_source(source_id) # Below is a request that includes all optional parameters # api_instance.delete_non_employee_source(source_id) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source: %s\n" % e) - path: /non-employee-sources/{sourceId} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-source source: | $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id # Get a Non-Employee Source try { Get-BetaNonEmployeeSource -SourceId $SourceId # Below is a request that includes all optional parameters # Get-BetaNonEmployeeSource -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSource" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#patch-non-employee-source source: | $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Patch a Non-Employee Source try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation Update-BetaNonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result # Below is a request that includes all optional parameters # Update-BetaNonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSource" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#patch-non-employee-source source: | source_id = '2c91808b6ef1d43e016efba0ce470904' # str | Source Id # str | Source Id [{op=replace, path=/name, value={new name=null}}, {op=replace, path=/approvers, value=[2c91809f703bb37a017040a2fe8748c7, 48b1f463c9e8427db5a5071bd81914b8]}] # List[JsonPatchOperation] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. json_patch_operation = { "op" : "replace", "path" : "/description", "value" : "New description" } # List[JsonPatchOperation] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. try: # Patch a Non-Employee Source Result = json_patch_operation.from_json(json_patch_operation) api_response = api_instance.patch_non_employee_source(source_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.patch_non_employee_source(source_id, Result) print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_source:\n") pprint(api_response) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_source: %s\n" % e) - path: /non-employee-sources/{id}/non-employees/download method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#export-non-employee-records source: | $Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID) # Exports Non-Employee Records to CSV try { Export-BetaNonEmployeeRecords -Id $Id # Below is a request that includes all optional parameters # Export-BetaNonEmployeeRecords -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaNonEmployeeRecords" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#export-non-employee-records source: | id = '2c918085842e69ae018432d22ccb212f' # str | Source Id (UUID) # str | Source Id (UUID) try: # Exports Non-Employee Records to CSV api_instance.export_non_employee_records(id) # Below is a request that includes all optional parameters # api_instance.export_non_employee_records(id) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template source: | $Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID) # Exports Source Schema Template try { Export-BetaNonEmployeeSourceSchemaTemplate -Id $Id # Below is a request that includes all optional parameters # Export-BetaNonEmployeeSourceSchemaTemplate -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaNonEmployeeSourceSchemaTemplate" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template source: | id = '2c918085842e69ae018432d22ccb212f' # str | Source Id (UUID) # str | Source Id (UUID) try: # Exports Source Schema Template api_instance.export_non_employee_source_schema_template(id) # Below is a request that includes all optional parameters # api_instance.export_non_employee_source_schema_template(id) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-approval source: | $Id = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | Non-Employee approval item id (UUID) $IncludeDetail = "include-detail=false" # String | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) # Get a non-employee approval item detail try { Get-BetaNonEmployeeApproval -Id $Id # Below is a request that includes all optional parameters # Get-BetaNonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApproval" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-approval source: | id = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) include_detail = 'include-detail=false' # str | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) # str | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) try: # Get a non-employee approval item detail api_response = api_instance.get_non_employee_approval(id, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_non_employee_approval(id, include_detail) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-approval-summary source: | $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. # Get Summary of Non-Employee Approval Requests try { Get-BetaNonEmployeeApprovalSummary -RequestedFor $RequestedFor # Below is a request that includes all optional parameters # Get-BetaNonEmployeeApprovalSummary -RequestedFor $RequestedFor } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApprovalSummary" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-approval-summary source: | requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # str | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # str | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. try: # Get Summary of Non-Employee Approval Requests api_response = api_instance.get_non_employee_approval_summary(requested_for) # Below is a request that includes all optional parameters # api_response = api_instance.get_non_employee_approval_summary(requested_for) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status source: | $Id = "2c918085842e69ae018432d22ccb212f" # String | Source ID (UUID) # Bulk upload status on source try { Get-BetaNonEmployeeBulkUploadStatus -Id $Id # Below is a request that includes all optional parameters # Get-BetaNonEmployeeBulkUploadStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeBulkUploadStatus" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status source: | id = '2c918085842e69ae018432d22ccb212f' # str | Source ID (UUID) # str | Source ID (UUID) try: # Bulk upload status on source api_response = api_instance.get_non_employee_bulk_upload_status(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_non_employee_bulk_upload_status(id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n") pprint(api_response) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) - path: /non-employee-requests/summary/{requested-for} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#get-non-employee-request-summary source: | $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. # Get Summary of Non-Employee Requests try { Get-BetaNonEmployeeRequestSummary -RequestedFor $RequestedFor # Below is a request that includes all optional parameters # Get-BetaNonEmployeeRequestSummary -RequestedFor $RequestedFor } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequestSummary" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#get-non-employee-request-summary source: | requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # str | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # str | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. try: # Get Summary of Non-Employee Requests api_response = api_instance.get_non_employee_request_summary(requested_for) # Below is a request that includes all optional parameters # api_response = api_instance.get_non_employee_request_summary(requested_for) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n") pprint(api_response) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request_summary: %s\n" % e) - path: /non-employee-sources/{id}/non-employee-bulk-upload method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk source: | $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) $Data = # System.IO.FileInfo | # Imports, or Updates, Non-Employee Records try { Import-BetaNonEmployeeRecordsInBulk -Id $Id -Data $Data # Below is a request that includes all optional parameters # Import-BetaNonEmployeeRecordsInBulk -Id $Id -Data $Data } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaNonEmployeeRecordsInBulk" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#list-non-employee-approval source: | $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity for whom the request was made. *me* indicates the current user. (optional) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 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" # String | Sort results using the standard syntax described 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) # Get List of Non-Employee Approval Requests try { Get-BetaNonEmployeeApproval # Below is a request that includes all optional parameters # Get-BetaNonEmployeeApproval -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApproval" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#list-non-employee-approval source: | requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # str | The identity for whom the request was made. *me* indicates the current user. (optional) # str | The identity for whom the request was made. *me* indicates the current user. (optional) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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_approval() # Below is a request that includes all optional parameters # api_response = api_instance.list_non_employee_approval(requested_for, limit, offset, count, filters, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approval:\n") pprint(api_response) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approval: %s\n" % e) - path: /non-employee-approvals/{id}/reject method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#reject-non-employee-request source: | $Id = "MyId" # String | Non-Employee approval item id (UUID) $NonEmployeeRejectApprovalDecision = @" { "comment" : "comment" } "@ # Reject a Non-Employee Request try { $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision Deny-BetaNonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result # Below is a request that includes all optional parameters # Deny-BetaNonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaNonEmployeeRequest" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/non-employee-lifecycle-management#reject-non-employee-request source: | id = 'id_example' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) non_employee_reject_approval_decision = { "comment" : "comment" } # NonEmployeeRejectApprovalDecision | try: # Reject a Non-Employee Request Result = non_employee_reject_approval_decision.from_json(non_employee_reject_approval_decision) api_response = api_instance.reject_non_employee_request(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.reject_non_employee_request(id, Result) print("The response of NonEmployeeLifecycleManagementApi->reject_non_employee_request:\n") pprint(api_response) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->reject_non_employee_request: %s\n" % e) - path: /verified-domains method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/notifications#create-domain-dkim source: | $DomainAddress = @" { "domain" : "sailpoint.com" } "@ # Verify domain address via DKIM try { $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress New-BetaDomainDkim -DomainAddress $Result # Below is a request that includes all optional parameters # New-BetaDomainDkim -DomainAddress $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDomainDkim" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#create-domain-dkim source: | domain_address = { "domain" : "sailpoint.com" } # DomainAddress | try: # Verify domain address via DKIM Result = domain_address.from_json(domain_address) api_response = api_instance.create_domain_dkim(Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_domain_dkim(Result) print("The response of NotificationsApi->create_domain_dkim:\n") pprint(api_response) except Exception as e: print("Exception when calling NotificationsApi->create_domain_dkim: %s\n" % e) - path: /verified-domains method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/notifications#get-dkim-attributes source: | # Get DKIM Attributes try { Get-BetaDkimAttributes # Below is a request that includes all optional parameters # Get-BetaDkimAttributes } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDkimAttributes" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#get-dkim-attributes source: | try: # Get DKIM Attributes api_response = api_instance.get_dkim_attributes() # Below is a request that includes all optional parameters # api_response = api_instance.get_dkim_attributes() print("The response of NotificationsApi->get_dkim_attributes:\n") pprint(api_response) except Exception as e: print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) - path: /notification-templates method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/notifications#create-notification-template source: | $TemplateDto = @" { "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" } "@ # Create Notification Template try { $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto New-BetaNotificationTemplate -TemplateDto $Result # Below is a request that includes all optional parameters # New-BetaNotificationTemplate -TemplateDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNotificationTemplate" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#create-notification-template source: | 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(Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_notification_template(Result) print("The response of NotificationsApi->create_notification_template:\n") pprint(api_response) except Exception as e: print("Exception when calling NotificationsApi->create_notification_template: %s\n" % e) - path: /notification-templates method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/notifications#list-notification-templates source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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"" # String | Filter results using the standard syntax described in [V3 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) # List Notification Templates try { Get-BetaNotificationTemplates # Below is a request that includes all optional parameters # Get-BetaNotificationTemplates -Limit $Limit -Offset $Offset -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplates" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#list-notification-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) filters = 'medium eq \"EMAIL\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) try: # List Notification Templates api_response = api_instance.list_notification_templates() # Below is a request that includes all optional parameters # api_response = api_instance.list_notification_templates(limit, offset, filters) print("The response of NotificationsApi->list_notification_templates:\n") pprint(api_response) except Exception as e: print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) - path: /verified-from-addresses method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/notifications#create-verified-from-address source: | $EmailStatusDto = @" { "isVerifiedByDomain" : false, "verificationStatus" : "PENDING", "id" : "id", "email" : "sender@example.com" } "@ # Create Verified From Address try { $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto New-BetaVerifiedFromAddress -EmailStatusDto $Result # Below is a request that includes all optional parameters # New-BetaVerifiedFromAddress -EmailStatusDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVerifiedFromAddress" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#create-verified-from-address source: | email_status_dto = { "isVerifiedByDomain" : false, "verificationStatus" : "PENDING", "id" : "id", "email" : "sender@example.com" } # EmailStatusDto | try: # Create Verified From Address Result = email_status_dto.from_json(email_status_dto) api_response = api_instance.create_verified_from_address(Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_verified_from_address(Result) print("The response of NotificationsApi->create_verified_from_address:\n") pprint(api_response) except Exception as e: print("Exception when calling NotificationsApi->create_verified_from_address: %s\n" % e) - path: /verified-from-addresses method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/notifications#list-from-addresses source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 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" # String | Sort results using the standard syntax described 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) # List From Addresses try { Get-BetaFromAddresses # Below is a request that includes all optional parameters # Get-BetaFromAddresses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFromAddresses" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#list-from-addresses 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 = 'email eq \"john.doe@company.com\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* (optional) sorters = 'email' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) try: # List From Addresses api_response = api_instance.list_from_addresses() # Below is a request that includes all optional parameters # api_response = api_instance.list_from_addresses(limit, offset, count, filters, sorters) print("The response of NotificationsApi->list_from_addresses:\n") pprint(api_response) except Exception as e: print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) - path: /notification-templates/bulk-delete method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/notifications#delete-notification-templates-in-bulk source: | $TemplateBulkDeleteDto = @"{ "medium" : "EMAIL", "locale" : "en", "key" : "cloud_manual_work_item_summary" }"@ # Bulk Delete Notification Templates try { $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto Remove-BetaNotificationTemplatesInBulk -TemplateBulkDeleteDto $Result # Below is a request that includes all optional parameters # Remove-BetaNotificationTemplatesInBulk -TemplateBulkDeleteDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNotificationTemplatesInBulk" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#delete-notification-templates-in-bulk source: | [sailpoint.beta.TemplateBulkDeleteDto()] # List[TemplateBulkDeleteDto] | template_bulk_delete_dto = { "medium" : "EMAIL", "locale" : "en", "key" : "cloud_manual_work_item_summary" } # List[TemplateBulkDeleteDto] | try: # Bulk Delete Notification Templates Result = template_bulk_delete_dto.from_json(template_bulk_delete_dto) api_instance.delete_notification_templates_in_bulk(Result) # Below is a request that includes all optional parameters # api_instance.delete_notification_templates_in_bulk(Result) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/notifications#delete-verified-from-address source: | $Id = "MyId" # String | # Delete Verified From Address try { Remove-BetaVerifiedFromAddress -Id $Id # Below is a request that includes all optional parameters # Remove-BetaVerifiedFromAddress -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVerifiedFromAddress" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#delete-verified-from-address source: | id = 'id_example' # str | # str | try: # Delete Verified From Address api_instance.delete_verified_from_address(id) # Below is a request that includes all optional parameters # api_instance.delete_verified_from_address(id) except Exception as e: print("Exception when calling NotificationsApi->delete_verified_from_address: %s\n" % e) - path: /mail-from-attributes/{identityId} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/notifications#get-mail-from-attributes source: | $IdentityId = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # Get MAIL FROM Attributes try { Get-BetaMailFromAttributes -IdentityId $IdentityId # Below is a request that includes all optional parameters # Get-BetaMailFromAttributes -IdentityId $IdentityId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMailFromAttributes" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#get-mail-from-attributes source: | identity_id = 'bobsmith@sailpoint.com' # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status try: # Get MAIL FROM Attributes api_response = api_instance.get_mail_from_attributes(identity_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_mail_from_attributes(identity_id) print("The response of NotificationsApi->get_mail_from_attributes:\n") pprint(api_response) except Exception as e: print("Exception when calling NotificationsApi->get_mail_from_attributes: %s\n" % e) - path: /notification-templates/{id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/notifications#get-notification-template source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template # Get Notification Template By Id try { Get-BetaNotificationTemplate -Id $Id # Below is a request that includes all optional parameters # Get-BetaNotificationTemplate -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplate" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#get-notification-template source: | id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Notification Template # str | Id of the Notification Template try: # Get Notification Template By Id api_response = api_instance.get_notification_template(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_notification_template(id) print("The response of NotificationsApi->get_notification_template:\n") pprint(api_response) except Exception as e: print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e) - path: /notification-template-context method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/notifications#get-notifications-template-context source: | # Get Notification Template Context try { Get-BetaNotificationsTemplateContext # Below is a request that includes all optional parameters # Get-BetaNotificationsTemplateContext } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationsTemplateContext" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#get-notifications-template-context source: | try: # Get Notification Template Context api_response = api_instance.get_notifications_template_context() # Below is a request that includes all optional parameters # api_response = api_instance.get_notifications_template_context() print("The response of NotificationsApi->get_notifications_template_context:\n") pprint(api_response) except Exception as e: print("Exception when calling NotificationsApi->get_notifications_template_context: %s\n" % e) - path: /notification-preferences/{key} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/notifications#list-notification-preferences source: | $Key = "cloud_manual_work_item_summary" # String | The notification key. # List Notification Preferences for tenant. try { Get-BetaNotificationPreferences -Key $Key # Below is a request that includes all optional parameters # Get-BetaNotificationPreferences -Key $Key } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationPreferences" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#list-notification-preferences source: | key = 'cloud_manual_work_item_summary' # str | The notification key. # str | The notification key. try: # List Notification Preferences for tenant. api_response = api_instance.list_notification_preferences(key) # Below is a request that includes all optional parameters # api_response = api_instance.list_notification_preferences(key) print("The response of NotificationsApi->list_notification_preferences:\n") pprint(api_response) except Exception as e: print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e) - path: /notification-template-defaults method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/notifications#list-notification-template-defaults source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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"" # String | Filter results using the standard syntax described in [V3 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) # List Notification Template Defaults try { Get-BetaNotificationTemplateDefaults # Below is a request that includes all optional parameters # Get-BetaNotificationTemplateDefaults -Limit $Limit -Offset $Offset -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplateDefaults" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#list-notification-template-defaults 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 = 'key eq \"cloud_manual_work_item_summary\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) try: # List Notification Template Defaults api_response = api_instance.list_notification_template_defaults() # Below is a request that includes all optional parameters # api_response = api_instance.list_notification_template_defaults(limit, offset, filters) print("The response of NotificationsApi->list_notification_template_defaults:\n") pprint(api_response) except Exception as e: print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) - path: /mail-from-attributes method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/notifications#put-mail-from-attributes source: | $MailFromAttributesDto = @" { "identity" : "BobSmith@sailpoint.com", "mailFromDomain" : "example.sailpoint.com" } "@ # Change MAIL FROM domain try { $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto Send-BetaMailFromAttributes -MailFromAttributesDto $Result # Below is a request that includes all optional parameters # Send-BetaMailFromAttributes -MailFromAttributesDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaMailFromAttributes" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#put-mail-from-attributes source: | mail_from_attributes_dto = { "identity" : "BobSmith@sailpoint.com", "mailFromDomain" : "example.sailpoint.com" } # MailFromAttributesDto | try: # Change MAIL FROM domain Result = mail_from_attributes_dto.from_json(mail_from_attributes_dto) api_response = api_instance.put_mail_from_attributes(Result) # Below is a request that includes all optional parameters # api_response = api_instance.put_mail_from_attributes(Result) print("The response of NotificationsApi->put_mail_from_attributes:\n") pprint(api_response) except Exception as e: print("Exception when calling NotificationsApi->put_mail_from_attributes: %s\n" % e) - path: /send-test-notification method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/notifications#send-test-notification source: | $SendTestNotificationRequestDto = @" { "context" : "{}", "medium" : "EMAIL", "key" : "cloud_manual_work_item_summary" } "@ # Send Test Notification try { $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto Send-BetaTestNotification -SendTestNotificationRequestDto $Result # Below is a request that includes all optional parameters # Send-BetaTestNotification -SendTestNotificationRequestDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTestNotification" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/notifications#send-test-notification source: | 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(Result) # Below is a request that includes all optional parameters # api_instance.send_test_notification(Result) except Exception as e: print("Exception when calling NotificationsApi->send_test_notification: %s\n" % e) - path: /oauth-clients method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/o-auth-clients#create-oauth-client source: | $CreateOAuthClientRequest = @" { "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", "http://localhost:67890" ], "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 } "@ # Create OAuth Client try { $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest New-BetaOauthClient -CreateOAuthClientRequest $Result # Below is a request that includes all optional parameters # New-BetaOauthClient -CreateOAuthClientRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaOauthClient" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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", "http://localhost:67890" ], "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 method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/o-auth-clients#list-oauth-clients source: | $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 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) # List OAuth Clients try { Get-BetaOauthClients # Below is a request that includes all optional parameters # Get-BetaOauthClients -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOauthClients" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/o-auth-clients#delete-oauth-client source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id # Delete OAuth Client try { Remove-BetaOauthClient -Id $Id # Below is a request that includes all optional parameters # Remove-BetaOauthClient -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaOauthClient" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/o-auth-clients#get-oauth-client source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id # Get OAuth Client try { Get-BetaOauthClient -Id $Id # Below is a request that includes all optional parameters # Get-BetaOauthClient -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOauthClient" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/{id} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/o-auth-clients#patch-oauth-client source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Patch OAuth Client try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation Update-BetaOauthClient -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters # Update-BetaOauthClient -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaOauthClient" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/o-auth-clients#patch-oauth-client source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id [{op=replace, path=/strongAuthSupported, value=true}, {op=replace, path=/businessName, value=acme-solar}] # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported json_patch_operation = { "op" : "replace", "path" : "/description", "value" : "New description" } # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported try: # Patch OAuth Client Result = json_patch_operation.from_json(json_patch_operation) api_response = api_instance.patch_oauth_client(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.patch_oauth_client(id, Result) print("The response of OAuthClientsApi->patch_oauth_client:\n") pprint(api_response) except Exception as e: print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e) - path: /org-config method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/org-config#get-org-config source: | # Get Org configuration settings try { Get-BetaOrgConfig # Below is a request that includes all optional parameters # Get-BetaOrgConfig } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOrgConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/org-config#get-org-config source: | try: # Get Org configuration settings api_response = api_instance.get_org_config() # Below is a request that includes all optional parameters # api_response = api_instance.get_org_config() print("The response of OrgConfigApi->get_org_config:\n") pprint(api_response) except Exception as e: print("Exception when calling OrgConfigApi->get_org_config: %s\n" % e) - path: /org-config method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/org-config#patch-org-config source: | $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Patch an Org configuration property try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation Update-BetaOrgConfig -JsonPatchOperation $Result # Below is a request that includes all optional parameters # Update-BetaOrgConfig -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaOrgConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/org-config#patch-org-config source: | [{op=replace, path=/timeZone, value=America/Toronto}] # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. json_patch_operation = { "op" : "replace", "path" : "/description", "value" : "New description" } # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. try: # Patch an Org configuration property Result = json_patch_operation.from_json(json_patch_operation) api_response = api_instance.patch_org_config(Result) # Below is a request that includes all optional parameters # api_response = api_instance.patch_org_config(Result) print("The response of OrgConfigApi->patch_org_config:\n") pprint(api_response) except Exception as e: print("Exception when calling OrgConfigApi->patch_org_config: %s\n" % e) - path: /org-config/valid-time-zones method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/org-config#get-valid-time-zones source: | # Get list of time zones try { Get-BetaValidTimeZones # Below is a request that includes all optional parameters # Get-BetaValidTimeZones } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaValidTimeZones" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/org-config#get-valid-time-zones source: | try: # Get list of time zones api_response = api_instance.get_valid_time_zones() # Below is a request that includes all optional parameters # api_response = api_instance.get_valid_time_zones() print("The response of OrgConfigApi->get_valid_time_zones:\n") pprint(api_response) except Exception as e: print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) - path: /password-org-config method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/password-configuration#create-password-org-config source: | $PasswordOrgConfig = @" { "digitTokenLength" : 9, "digitTokenEnabled" : true, "digitTokenDurationMinutes" : 10, "customInstructionsEnabled" : true } "@ # Create Password Org Config try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig New-BetaPasswordOrgConfig -PasswordOrgConfig $Result # Below is a request that includes all optional parameters # New-BetaPasswordOrgConfig -PasswordOrgConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordOrgConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/password-configuration#get-password-org-config source: | # Get Password Org Config try { Get-BetaPasswordOrgConfig # Below is a request that includes all optional parameters # Get-BetaPasswordOrgConfig } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordOrgConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/password-configuration#get-password-org-config source: | try: # Get Password Org Config api_response = api_instance.get_password_org_config() # Below is a request that includes all optional parameters # api_response = api_instance.get_password_org_config() print("The response of PasswordConfigurationApi->get_password_org_config:\n") pprint(api_response) except Exception as e: print("Exception when calling PasswordConfigurationApi->get_password_org_config: %s\n" % e) - path: /password-org-config method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/password-configuration#put-password-org-config source: | $PasswordOrgConfig = @" { "digitTokenLength" : 9, "digitTokenEnabled" : true, "digitTokenDurationMinutes" : 10, "customInstructionsEnabled" : true } "@ # Update Password Org Config try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig Send-BetaPasswordOrgConfig -PasswordOrgConfig $Result # Below is a request that includes all optional parameters # Send-BetaPasswordOrgConfig -PasswordOrgConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPasswordOrgConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/password-dictionary#get-password-dictionary source: | # Get Password Dictionary try { Get-BetaPasswordDictionary # Below is a request that includes all optional parameters # Get-BetaPasswordDictionary } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordDictionary" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/password-dictionary#get-password-dictionary source: | try: # Get Password Dictionary api_response = api_instance.get_password_dictionary() # Below is a request that includes all optional parameters # api_response = api_instance.get_password_dictionary() print("The response of PasswordDictionaryApi->get_password_dictionary:\n") pprint(api_response) except Exception as e: print("Exception when calling PasswordDictionaryApi->get_password_dictionary: %s\n" % e) - path: /password-dictionary method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/password-dictionary#put-password-dictionary source: | $File = # System.IO.FileInfo | (optional) # Update Password Dictionary try { Send-BetaPasswordDictionary # Below is a request that includes all optional parameters # Send-BetaPasswordDictionary -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPasswordDictionary" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/password-management#create-digit-token source: | $PasswordDigitTokenReset = @" { "durationMinutes" : 5, "length" : 8, "userId" : "Abby.Smith" } "@ # Generate a digit token try { $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset New-BetaDigitToken -PasswordDigitTokenReset $Result # Below is a request that includes all optional parameters # New-BetaDigitToken -PasswordDigitTokenReset $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDigitToken" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/password-management#create-digit-token source: | password_digit_token_reset = { "durationMinutes" : 5, "length" : 8, "userId" : "Abby.Smith" } # PasswordDigitTokenReset | try: # Generate a digit token Result = password_digit_token_reset.from_json(password_digit_token_reset) api_response = api_instance.create_digit_token(Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_digit_token(Result) print("The response of PasswordManagementApi->create_digit_token:\n") pprint(api_response) except Exception as e: print("Exception when calling PasswordManagementApi->create_digit_token: %s\n" % e) - path: /password-change-status/{id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/password-management#get-identity-password-change-status source: | $Id = "MyId" # String | # Get Password Change Request Status try { Get-BetaIdentityPasswordChangeStatus -Id $Id # Below is a request that includes all optional parameters # Get-BetaIdentityPasswordChangeStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityPasswordChangeStatus" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/password-management#get-identity-password-change-status source: | id = 'id_example' # str | # str | try: # Get Password Change Request Status api_response = api_instance.get_identity_password_change_status(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_identity_password_change_status(id) print("The response of PasswordManagementApi->get_identity_password_change_status:\n") pprint(api_response) except Exception as e: print("Exception when calling PasswordManagementApi->get_identity_password_change_status: %s\n" % e) - path: /query-password-info method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/password-management#query-password-info source: | $PasswordInfoQueryDTO = @" { "sourceName" : "My-AD", "userName" : "Abby.Smith" } "@ # Query Password Info try { $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO Search-BetaPasswordInfo -PasswordInfoQueryDTO $Result # Below is a request that includes all optional parameters # Search-BetaPasswordInfo -PasswordInfoQueryDTO $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaPasswordInfo" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/password-management#set-identity-password source: | $PasswordChangeRequest = @" { "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==" } "@ # Set Identity's Password try { $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest Set-BetaIdentityPassword -PasswordChangeRequest $Result # Below is a request that includes all optional parameters # Set-BetaIdentityPassword -PasswordChangeRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIdentityPassword" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/password-management#set-identity-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_identity_password(Result) # Below is a request that includes all optional parameters # api_response = api_instance.set_identity_password(Result) print("The response of PasswordManagementApi->set_identity_password:\n") pprint(api_response) except Exception as e: print("Exception when calling PasswordManagementApi->set_identity_password: %s\n" % e) - path: /password-policies method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/password-policies#create-password-policy source: | $PasswordPolicyV3Dto = @" { "validateAgainstAccountName" : true, "minLength" : 8, "description" : "Information about the Password Policy", "requireStrongAuthUntrustedGeographies" : true, "enablePasswdExpiration" : true, "minNumeric" : 8, "lastUpdated" : "2000-01-23T04:56:07.000+00:00", "validateAgainstAccountId" : false, "dateCreated" : "2000-01-23T04:56:07.000+00:00", "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 } "@ # Create Password Policy try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto New-BetaPasswordPolicy -PasswordPolicyV3Dto $Result # Below is a request that includes all optional parameters # New-BetaPasswordPolicy -PasswordPolicyV3Dto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordPolicy" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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" : "2000-01-23T04:56:07.000+00:00", "validateAgainstAccountId" : false, "dateCreated" : "2000-01-23T04:56:07.000+00:00", "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 method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/password-policies#list-password-policies source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # List Password Policies try { Get-BetaPasswordPolicies # Below is a request that includes all optional parameters # Get-BetaPasswordPolicies -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicies" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/password-policies#delete-password-policy source: | $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. # Delete Password Policy by ID try { Remove-BetaPasswordPolicy -Id $Id # Below is a request that includes all optional parameters # Remove-BetaPasswordPolicy -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordPolicy" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/password-policies#get-password-policy-by-id source: | $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. # Get Password Policy by ID try { Get-BetaPasswordPolicyById -Id $Id # Below is a request that includes all optional parameters # Get-BetaPasswordPolicyById -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicyById" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/{id} method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/password-policies#set-password-policy source: | $Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update. $PasswordPolicyV3Dto = @" { "validateAgainstAccountName" : true, "minLength" : 8, "description" : "Information about the Password Policy", "requireStrongAuthUntrustedGeographies" : true, "enablePasswdExpiration" : true, "minNumeric" : 8, "lastUpdated" : "2000-01-23T04:56:07.000+00:00", "validateAgainstAccountId" : false, "dateCreated" : "2000-01-23T04:56:07.000+00:00", "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 } "@ # Update Password Policy by ID try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto Set-BetaPasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result # Below is a request that includes all optional parameters # Set-BetaPasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaPasswordPolicy" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/password-policies#set-password-policy source: | id = 'ff808081838d9e9d01838da6a03e0007' # str | The ID of password policy to update. # str | The ID of password policy to update. password_policy_v3_dto = { "validateAgainstAccountName" : true, "minLength" : 8, "description" : "Information about the Password Policy", "requireStrongAuthUntrustedGeographies" : true, "enablePasswdExpiration" : true, "minNumeric" : 8, "lastUpdated" : "2000-01-23T04:56:07.000+00:00", "validateAgainstAccountId" : false, "dateCreated" : "2000-01-23T04:56:07.000+00:00", "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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/password-sync-groups#create-password-sync-group source: | $PasswordSyncGroup = @" { "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" ] } "@ # Create Password Sync Group try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup New-BetaPasswordSyncGroup -PasswordSyncGroup $Result # Below is a request that includes all optional parameters # New-BetaPasswordSyncGroup -PasswordSyncGroup $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordSyncGroup" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/password-sync-groups#get-password-sync-groups source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # Get Password Sync Group List try { Get-BetaPasswordSyncGroups # Below is a request that includes all optional parameters # Get-BetaPasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroups" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/password-sync-groups#delete-password-sync-group source: | $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. # Delete Password Sync Group by ID try { Remove-BetaPasswordSyncGroup -Id $Id # Below is a request that includes all optional parameters # Remove-BetaPasswordSyncGroup -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordSyncGroup" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/password-sync-groups#get-password-sync-group source: | $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. # Get Password Sync Group by ID try { Get-BetaPasswordSyncGroup -Id $Id # Below is a request that includes all optional parameters # Get-BetaPasswordSyncGroup -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroup" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/{id} method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/password-sync-groups#update-password-sync-group source: | $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. $PasswordSyncGroup = @" { "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" ] } "@ # Update Password Sync Group by ID try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup Update-BetaPasswordSyncGroup -Id $Id -PasswordSyncGroup $Result # Below is a request that includes all optional parameters # Update-BetaPasswordSyncGroup -Id $Id -PasswordSyncGroup $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPasswordSyncGroup" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/password-sync-groups#update-password-sync-group source: | id = '6881f631-3bd5-4213-9c75-8e05cc3e35dd' # str | The ID of password sync group to update. # str | The ID of password sync group to update. password_sync_group = { "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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/personal-access-tokens#create-personal-access-token source: | $CreatePersonalAccessTokenRequest = @" { "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], "accessTokenValiditySeconds" : 36900, "name" : "NodeJS Integration" } "@ # Create Personal Access Token try { $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest New-BetaPersonalAccessToken -CreatePersonalAccessTokenRequest $Result # Below is a request that includes all optional parameters # New-BetaPersonalAccessToken -CreatePersonalAccessTokenRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPersonalAccessToken" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/personal-access-tokens#list-personal-access-tokens source: | $OwnerId = "2c9180867b50d088017b554662fb281e" # String | 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" # String | Filter results using the standard syntax described in [V3 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) # List Personal Access Tokens try { Get-BetaPersonalAccessTokens # Below is a request that includes all optional parameters # Get-BetaPersonalAccessTokens -OwnerId $OwnerId -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPersonalAccessTokens" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/personal-access-tokens#delete-personal-access-token source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id # Delete Personal Access Token try { Remove-BetaPersonalAccessToken -Id $Id # Below is a request that includes all optional parameters # Remove-BetaPersonalAccessToken -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPersonalAccessToken" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/{id} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/personal-access-tokens#patch-personal-access-token source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Patch Personal Access Token try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation Update-BetaPersonalAccessToken -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters # Update-BetaPersonalAccessToken -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPersonalAccessToken" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/personal-access-tokens#patch-personal-access-token source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Personal Access Token id # str | The Personal Access Token id [{op=replace, path=/name, value=New name}, {op=replace, path=/scope, value=[sp:scopes:all]}] # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope json_patch_operation = { "op" : "replace", "path" : "/description", "value" : "New description" } # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope try: # Patch Personal Access Token Result = json_patch_operation.from_json(json_patch_operation) api_response = api_instance.patch_personal_access_token(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.patch_personal_access_token(id, Result) print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n") pprint(api_response) except Exception as e: print("Exception when calling PersonalAccessTokensApi->patch_personal_access_token: %s\n" % e) - path: /public-identities-config method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/public-identities-config#get-public-identity-config source: | # Get Public Identity Config try { Get-BetaPublicIdentityConfig # Below is a request that includes all optional parameters # Get-BetaPublicIdentityConfig } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPublicIdentityConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/public-identities-config#get-public-identity-config source: | try: # Get Public Identity Config api_response = api_instance.get_public_identity_config() # Below is a request that includes all optional parameters # api_response = api_instance.get_public_identity_config() print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n") pprint(api_response) except Exception as e: print("Exception when calling PublicIdentitiesConfigApi->get_public_identity_config: %s\n" % e) - path: /public-identities-config method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/public-identities-config#update-public-identity-config source: | $PublicIdentityConfig = @" { "modified" : "2018-06-25T20:22:28.104Z", "attributes" : [ { "name" : "Country", "key" : "country" }, { "name" : "Country", "key" : "country" } ], "modifiedBy" : { "name" : "Thomas Edison", "id" : "2c9180a46faadee4016fb4e018c20639", "type" : "IDENTITY" } } "@ # Update Public Identity Config try { $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig Update-BetaPublicIdentityConfig -PublicIdentityConfig $Result # Below is a request that includes all optional parameters # Update-BetaPublicIdentityConfig -PublicIdentityConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPublicIdentityConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 Public Identity Config Result = public_identity_config.from_json(public_identity_config) api_response = api_instance.update_public_identity_config(Result) # Below is a request that includes all optional parameters # api_response = api_instance.update_public_identity_config(Result) print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n") pprint(api_response) except Exception as e: print("Exception when calling PublicIdentitiesConfigApi->update_public_identity_config: %s\n" % e) - path: /requestable-objects method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/requestable-objects#list-requestable-objects source: | $IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | 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 = "ACCESS_PROFILE" # 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 = @"ROLE,ACCESS_PROFILE"@ $Term = "Finance Role" # String | 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 = "AVAILABLE" # 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 = @"[ASSIGNED, PENDING]"@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 API Standard 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" # String | Sort results using the standard syntax described 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) # Requestable Objects List try { Get-BetaRequestableObjects # Below is a request that includes all optional parameters # Get-BetaRequestableObjects -IdentityId $IdentityId -Types $Types -Term $Term -Statuses $Statuses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRequestableObjects" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/requestable-objects#list-requestable-objects source: | identity_id = 'e7eab60924f64aa284175b9fa3309599' # str | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) # str | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) types = [sailpoint.beta.RequestableObjectType()] # List[RequestableObjectType] | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. (optional) types = [sailpoint.beta.RequestableObjectType()] # List[RequestableObjectType] | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. (optional) term = 'Finance Role' # str | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) # str | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) statuses = [sailpoint.beta.RequestableObjectRequestStatus()] # List[RequestableObjectRequestStatus] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) statuses = [sailpoint.beta.RequestableObjectRequestStatus()] # List[RequestableObjectRequestStatus] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/role-insights#create-role-insight-requests source: | # Generate insights for roles try { New-BetaRoleInsightRequests # Below is a request that includes all optional parameters # New-BetaRoleInsightRequests } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRoleInsightRequests" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/role-insights#create-role-insight-requests source: | try: # Generate insights for roles api_response = api_instance.create_role_insight_requests() # Below is a request that includes all optional parameters # api_response = api_instance.create_role_insight_requests() print("The response of RoleInsightsApi->create_role_insight_requests:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/role-insights#download-role-insights-entitlements-changes source: | $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id $Sorters = "identitiesWithAccess" # String | Sort results using the standard syntax described 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"" # String | Filter results using the standard syntax described in [V3 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) # Download entitlement insights for a role try { Invoke-BetaDownloadRoleInsightsEntitlementsChanges -InsightId $InsightId # Below is a request that includes all optional parameters # Invoke-BetaDownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaDownloadRoleInsightsEntitlementsChanges" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 sorters = 'identitiesWithAccess' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) filters = 'name sw \"r\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) try: # Download entitlement insights for a role api_response = api_instance.download_role_insights_entitlements_changes(insight_id, ) # Below is a request that includes all optional parameters # api_response = api_instance.download_role_insights_entitlements_changes(insight_id, sorters, filters) print("The response of RoleInsightsApi->download_role_insights_entitlements_changes:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-entitlement-changes-identities source: | $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id $EntitlementId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The entitlement id $HasEntitlement = $true # Boolean | Identity has this entitlement or not (optional) (default to $false) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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" # String | Sort results using the standard syntax described 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"" # String | Filter results using the standard syntax described in [V3 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) # Get identities for a suggested entitlement (for a role) try { Get-BetaEntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId # Below is a request that includes all optional parameters # Get-BetaEntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -HasEntitlement $HasEntitlement -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementChangesIdentities" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 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, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_entitlement_changes_identities(insight_id, entitlement_id, has_entitlement, offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") pprint(api_response) except Exception as e: print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) - path: /role-insights/{insightId} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insight source: | $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id # Get a single role insight try { Get-BetaRoleInsight -InsightId $InsightId # Below is a request that includes all optional parameters # Get-BetaRoleInsight -InsightId $InsightId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsight" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insight source: | insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id try: # Get a single role insight api_response = api_instance.get_role_insight(insight_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_role_insight(insight_id) print("The response of RoleInsightsApi->get_role_insight:\n") pprint(api_response) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insight: %s\n" % e) - path: /role-insights method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insights source: | $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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" # String | Sort results using the standard syntax described 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"" # String | Filter results using the standard syntax described in [V3 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) # Get role insights try { Get-BetaRoleInsights # Below is a request that includes all optional parameters # Get-BetaRoleInsights -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsights" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights 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) sorters = 'numberOfUpdates' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) filters = 'name sw \"John\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) try: # Get role insights api_response = api_instance.get_role_insights() # Below is a request that includes all optional parameters # api_response = api_instance.get_role_insights(offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_role_insights:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insights-current-entitlements source: | $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 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) # Get current entitlement for a role try { Get-BetaRoleInsightsCurrentEntitlements -InsightId $InsightId # Below is a request that includes all optional parameters # Get-BetaRoleInsightsCurrentEntitlements -InsightId $InsightId -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsCurrentEntitlements" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 filters = 'name sw \"r\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) try: # Get current entitlement for a role api_response = api_instance.get_role_insights_current_entitlements(insight_id, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_role_insights_current_entitlements(insight_id, filters) print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insights-entitlements-changes source: | $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id $Sorters = "MySorters" # String | Sort results using the standard syntax described 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"" # String | Filter results using the standard syntax described in [V3 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) # Get entitlement insights for a role try { Get-BetaRoleInsightsEntitlementsChanges -InsightId $InsightId # Below is a request that includes all optional parameters # Get-BetaRoleInsightsEntitlementsChanges -InsightId $InsightId -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsEntitlementsChanges" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 sorters = 'sorters_example' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) filters = 'name sw \"Admin\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) try: # Get entitlement insights for a role api_response = api_instance.get_role_insights_entitlements_changes(insight_id, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_role_insights_entitlements_changes(insight_id, sorters, filters) print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insights-requests source: | $Id = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insights request id # Returns metadata from prior request. try { Get-BetaRoleInsightsRequests -Id $Id # Below is a request that includes all optional parameters # Get-BetaRoleInsightsRequests -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsRequests" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 try: # Returns metadata from prior request. api_response = api_instance.get_role_insights_requests(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_role_insights_requests(id) print("The response of RoleInsightsApi->get_role_insights_requests:\n") pprint(api_response) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_requests: %s\n" % e) - path: /role-insights/summary method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/role-insights#get-role-insights-summary source: | # Get role insights summary information try { Get-BetaRoleInsightsSummary # Below is a request that includes all optional parameters # Get-BetaRoleInsightsSummary } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsSummary" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/role-insights#get-role-insights-summary source: | try: # Get role insights summary information api_response = api_instance.get_role_insights_summary() # Below is a request that includes all optional parameters # api_response = api_instance.get_role_insights_summary() print("The response of RoleInsightsApi->get_role_insights_summary:\n") pprint(api_response) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_summary: %s\n" % e) - path: /roles method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/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 } "@ # Create a Role try { $Result = ConvertFrom-JsonToRole -Json $Role New-BetaRole -Role $Result # Below is a request that includes all optional parameters # New-BetaRole -Role $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRole" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/roles#list-roles source: | $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | 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 # Int32 | 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 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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" # String | Filter results using the standard syntax described in [V3 API Standard 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" # String | Sort results using the standard syntax described 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) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | 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) $IncludeUnsegmented = $false # Boolean | 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) # List Roles try { Get-BetaRoles # Below is a request that includes all optional parameters # Get-BetaRoles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoles" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/bulk-delete method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/roles#delete-bulk-roles source: | $RoleBulkDeleteRequest = @" { "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] } "@ # Delete Role(s) try { $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest Remove-BetaBulkRoles -RoleBulkDeleteRequest $Result # Below is a request that includes all optional parameters # Remove-BetaBulkRoles -RoleBulkDeleteRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaBulkRoles" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/roles#delete-role source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role # Delete a Role try { Remove-BetaRole -Id $Id # Below is a request that includes all optional parameters # Remove-BetaRole -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaRole" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/{id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/roles#get-role source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role # Get a Role try { Get-BetaRole -Id $Id # Below is a request that includes all optional parameters # Get-BetaRole -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRole" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/roles#patch-role source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Patch a specified Role try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation Update-BetaRole -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters # Update-BetaRole -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRole" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/roles#patch-role source: | id = '2c91808a7813090a017814121e121518' # str | ID of the Role to patch # str | ID of the Role to patch [{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}] # List[JsonPatchOperation] | json_patch_operation = { "op" : "replace", "path" : "/description", "value" : "New description" } # List[JsonPatchOperation] | try: # Patch a specified Role Result = json_patch_operation.from_json(json_patch_operation) api_response = api_instance.patch_role(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.patch_role(id, Result) print("The response of RolesApi->patch_role:\n") pprint(api_response) except Exception as e: print("Exception when calling RolesApi->patch_role: %s\n" % e) - path: /roles/{id}/assigned-identities method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/roles#get-role-assigned-identities source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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" # String | Filter results using the standard syntax described in [V3 API Standard 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" # String | Sort results using the standard syntax described 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) # Identities assigned a Role try { Get-BetaRoleAssignedIdentities -Id $Id # Below is a request that includes all optional parameters # Get-BetaRoleAssignedIdentities -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignedIdentities" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: # 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/roles#get-role-entitlements source: | $Id = "2c91808a7813090a017814121919ecca" # String | ID of the containing role $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 API Standard 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" # String | Sort results using the standard syntax described 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) # List role's Entitlements try { Get-BetaRoleEntitlements -Id $Id # Below is a request that includes all optional parameters # Get-BetaRoleEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleEntitlements" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/roles#get-role-entitlements source: | id = '2c91808a7813090a017814121919ecca' # str | ID of the containing role # str | ID of the containing role limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_role_entitlements(id, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_entitlements:\n") pprint(api_response) except Exception as e: print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) - path: /sim-integrations method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#create-sim-integration source: | $SimIntegrationDetails = @" { "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" : "2023-01-03T21:16:22.432Z", "name" : "aName", "modified" : "2023-01-03T21:16:22.432Z", "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" } } "@ # Create new SIM integration try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails New-BetaSIMIntegration -SimIntegrationDetails $Result # Below is a request that includes all optional parameters # New-BetaSIMIntegration -SimIntegrationDetails $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSIMIntegration" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sim-integrations#create-sim-integration source: | 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" : "2023-01-03T21:16:22.432Z", "name" : "aName", "modified" : "2023-01-03T21:16:22.432Z", "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(Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_sim_integration(Result) print("The response of SIMIntegrationsApi->create_sim_integration:\n") pprint(api_response) except Exception as e: print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) - path: /sim-integrations method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#get-sim-integrations source: | # List the existing SIM integrations. try { Get-BetaSIMIntegrations # Below is a request that includes all optional parameters # Get-BetaSIMIntegrations } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegrations" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sim-integrations#get-sim-integrations source: | try: # List the existing SIM integrations. api_response = api_instance.get_sim_integrations() # Below is a request that includes all optional parameters # api_response = api_instance.get_sim_integrations() print("The response of SIMIntegrationsApi->get_sim_integrations:\n") pprint(api_response) except Exception as e: print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) - path: /sim-integrations/{id} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#delete-sim-integration source: | $Id = "12345" # String | The id of the integration to delete. # Delete a SIM integration try { Remove-BetaSIMIntegration -Id $Id # Below is a request that includes all optional parameters # Remove-BetaSIMIntegration -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSIMIntegration" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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. try: # Delete a SIM integration api_instance.delete_sim_integration(id) # Below is a request that includes all optional parameters # api_instance.delete_sim_integration(id) except Exception as e: print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) - path: /sim-integrations/{id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#get-sim-integration source: | $Id = "12345" # String | The id of the integration. # Get a SIM integration details. try { Get-BetaSIMIntegration -Id $Id # Below is a request that includes all optional parameters # Get-BetaSIMIntegration -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegration" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sim-integrations#get-sim-integration source: | id = '12345' # str | The id of the integration. # str | The id of the integration. try: # Get a SIM integration details. api_response = api_instance.get_sim_integration(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_sim_integration(id) print("The response of SIMIntegrationsApi->get_sim_integration:\n") pprint(api_response) except Exception as e: print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) - path: /sim-integrations/{id} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#patch-sim-attributes source: | $Id = "12345" # String | SIM integration id $JsonPatch = @" "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" "@ # Patch a SIM attribute. try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch Update-BetaSIMAttributes -Id $Id -JsonPatch $Result # Below is a request that includes all optional parameters # Update-BetaSIMAttributes -Id $Id -JsonPatch $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSIMAttributes" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sim-integrations#patch-sim-attributes source: | id = '12345' # str | SIM integration id # str | SIM integration id json_patch = "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" # JsonPatch | The JsonPatch object that describes the changes of SIM try: # Patch a SIM attribute. Result = json_patch.from_json(json_patch) api_response = api_instance.patch_sim_attributes(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.patch_sim_attributes(id, Result) print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") pprint(api_response) except Exception as e: print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) - path: /sim-integrations/{id} method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#put-sim-integration source: | $Id = "12345" # String | The id of the integration. $SimIntegrationDetails = @" { "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" : "2023-01-03T21:16:22.432Z", "name" : "aName", "modified" : "2023-01-03T21:16:22.432Z", "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" } } "@ # Update an existing SIM integration try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails Send-BetaSIMIntegration -Id $Id -SimIntegrationDetails $Result # Below is a request that includes all optional parameters # Send-BetaSIMIntegration -Id $Id -SimIntegrationDetails $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSIMIntegration" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sim-integrations#put-sim-integration source: | id = '12345' # str | The id of the integration. # str | The id of the integration. sim_integration_details = { "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" : "2023-01-03T21:16:22.432Z", "name" : "aName", "modified" : "2023-01-03T21:16:22.432Z", "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, Result) # Below is a request that includes all optional parameters # api_response = api_instance.put_sim_integration(id, Result) print("The response of SIMIntegrationsApi->put_sim_integration:\n") pprint(api_response) except Exception as e: print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) - path: /sim-integrations/{id}/beforeProvisioningRule method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#patch-before-provisioning-rule source: | $Id = "12345" # String | SIM integration id $JsonPatch = @" "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" "@ # Patch a SIM beforeProvisioningRule attribute. try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch Update-BetaBeforeProvisioningRule -Id $Id -JsonPatch $Result # Below is a request that includes all optional parameters # Update-BetaBeforeProvisioningRule -Id $Id -JsonPatch $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaBeforeProvisioningRule" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sim-integrations#patch-before-provisioning-rule source: | id = '12345' # str | SIM integration id # str | SIM integration id json_patch = "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. try: # Patch a SIM beforeProvisioningRule attribute. Result = json_patch.from_json(json_patch) api_response = api_instance.patch_before_provisioning_rule(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.patch_before_provisioning_rule(id, Result) print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") pprint(api_response) except Exception as e: print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) - path: /sod-policies method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sod-policies#create-sod-policy source: | $SodPolicy = @" { "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" } "@ # Create SOD policy try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy New-BetaSodPolicy -SodPolicy $Result # Below is a request that includes all optional parameters # New-BetaSodPolicy -SodPolicy $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSodPolicy" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sod-policies#list-sod-policies source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 API Standard 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" # String | Sort results using the standard syntax described 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) # List SOD policies try { Get-BetaSodPolicies # Below is a request that includes all optional parameters # Get-BetaSodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicies" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sod-policies#delete-sod-policy source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD Policy to delete. $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to $true) # Delete SOD policy by ID try { Remove-BetaSodPolicy -Id $Id # Below is a request that includes all optional parameters # Remove-BetaSodPolicy -Id $Id -Logical $Logical } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicy" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#delete-sod-policy source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to True) try: # Delete SOD policy by ID api_instance.delete_sod_policy(id, ) # Below is a request that includes all optional parameters # api_instance.delete_sod_policy(id, logical) except Exception as e: print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) - path: /sod-policies/{id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-policy source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. # Get SOD policy by ID try { Get-BetaSodPolicy -Id $Id # Below is a request that includes all optional parameters # Get-BetaSodPolicy -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicy" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#get-sod-policy source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. try: # Get SOD policy by ID api_response = api_instance.get_sod_policy(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_sod_policy(id) print("The response of SODPoliciesApi->get_sod_policy:\n") pprint(api_response) except Exception as e: print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) - path: /sod-policies/{id} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sod-policies#patch-sod-policy source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | The ID of the SOD policy being modified. $RequestBody = # SystemCollectionsHashtable[] | 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 $RequestBody = @"[{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}]}}]"@ # Patch a SOD policy try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody Update-BetaSodPolicy -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters # Update-BetaSodPolicy -Id $Id -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSodPolicy" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#patch-sod-policy source: | id = '2c9180835d191a86015d28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. request_body = [{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}] # List[object] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria request_body = [{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}] # List[object] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria try: # Patch a SOD policy Result = request_body.from_json(request_body) api_response = api_instance.patch_sod_policy(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.patch_sod_policy(id, Result) print("The response of SODPoliciesApi->patch_sod_policy:\n") pprint(api_response) except Exception as e: print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) - path: /sod-policies/{id} method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sod-policies#put-sod-policy source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy to update. $SodPolicy = @" { "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" } "@ # Update SOD policy by ID try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy Send-BetaSodPolicy -Id $Id -SodPolicy $Result # Below is a request that includes all optional parameters # Send-BetaSodPolicy -Id $Id -SodPolicy $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSodPolicy" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#put-sod-policy source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. sod_policy = { "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}/schedule method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sod-policies#delete-sod-policy-schedule source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. # Delete SOD policy schedule try { Remove-BetaSodPolicySchedule -Id $Id # Below is a request that includes all optional parameters # Remove-BetaSodPolicySchedule -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicySchedule" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#delete-sod-policy-schedule source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. try: # Delete SOD policy schedule api_instance.delete_sod_policy_schedule(id) # Below is a request that includes all optional parameters # api_instance.delete_sod_policy_schedule(id) except Exception as e: print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) - path: /sod-policies/{id}/schedule method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-policy-schedule source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. # Get SOD policy schedule try { Get-BetaSodPolicySchedule -Id $Id # Below is a request that includes all optional parameters # Get-BetaSodPolicySchedule -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicySchedule" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#get-sod-policy-schedule source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. try: # Get SOD policy schedule api_response = api_instance.get_sod_policy_schedule(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_sod_policy_schedule(id) print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") pprint(api_response) except Exception as e: print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) - path: /sod-policies/{id}/schedule method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sod-policies#put-policy-schedule source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy to update its schedule. $SodPolicySchedule = @" { "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" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", "modified" : "2020-01-01T00:00:00Z", "description" : "Schedule for policy xyz", "emailEmptyResults" : false } "@ # Update SOD Policy schedule try { $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule Send-BetaPolicySchedule -Id $Id -SodPolicySchedule $Result # Below is a request that includes all optional parameters # Send-BetaPolicySchedule -Id $Id -SodPolicySchedule $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPolicySchedule" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#put-policy-schedule source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. sod_policy_schedule = { "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" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", "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-violation-report/{reportResultId}/download/{fileName} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-custom-violation-report source: | $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. $FileName = "custom-name" # String | Custom Name for the file. # Download custom violation report try { Get-BetaCustomViolationReport -ReportResultId $ReportResultId -FileName $FileName # Below is a request that includes all optional parameters # Get-BetaCustomViolationReport -ReportResultId $ReportResultId -FileName $FileName } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomViolationReport" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-default-violation-report source: | $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. # Download violation report try { Get-BetaDefaultViolationReport -ReportResultId $ReportResultId # Below is a request that includes all optional parameters # Get-BetaDefaultViolationReport -ReportResultId $ReportResultId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultViolationReport" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-all-report-run-status source: | # Get multi-report run task status try { Get-BetaSodAllReportRunStatus # Below is a request that includes all optional parameters # Get-BetaSodAllReportRunStatus } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodAllReportRunStatus" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#get-sod-all-report-run-status source: | try: # Get multi-report run task status api_response = api_instance.get_sod_all_report_run_status() # Below is a request that includes all optional parameters # api_response = api_instance.get_sod_all_report_run_status() print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") pprint(api_response) except Exception as e: print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) - path: /sod-policies/sod-violation-report-status/{reportResultId} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-violation-report-run-status source: | $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. # Get violation report run status try { Get-BetaSodViolationReportRunStatus -ReportResultId $ReportResultId # Below is a request that includes all optional parameters # Get-BetaSodViolationReportRunStatus -ReportResultId $ReportResultId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportRunStatus" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-violation-report-status source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. # Get SOD violation report status try { Get-BetaSodViolationReportStatus -Id $Id # Below is a request that includes all optional parameters # Get-BetaSodViolationReportStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportStatus" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#get-sod-violation-report-status source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. try: # Get SOD violation report status api_response = api_instance.get_sod_violation_report_status(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_sod_violation_report_status(id) print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") pprint(api_response) except Exception as e: print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) - path: /sod-violation-report/run method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sod-policies#start-sod-all-policies-for-org source: | $MultiPolicyRequest = @" { "filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ] } "@ # Runs all policies for org try { Start-BetaSodAllPoliciesForOrg # Below is a request that includes all optional parameters # Start-BetaSodAllPoliciesForOrg -MultiPolicyRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodAllPoliciesForOrg" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#start-sod-all-policies-for-org source: | multi_policy_request = { "filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ] } # MultiPolicyRequest | (optional) try: # Runs all policies for org api_response = api_instance.start_sod_all_policies_for_org() # Below is a request that includes all optional parameters # api_response = api_instance.start_sod_all_policies_for_org(Result) print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") pprint(api_response) except Exception as e: print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) - path: /sod-policies/{id}/violation-report/run method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sod-policies#start-sod-policy source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The SOD policy ID to run. # Runs SOD policy violation report try { Start-BetaSodPolicy -Id $Id # Below is a request that includes all optional parameters # Start-BetaSodPolicy -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodPolicy" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sod-policies#start-sod-policy source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. try: # Runs SOD policy violation report api_response = api_instance.start_sod_policy(id) # Below is a request that includes all optional parameters # api_response = api_instance.start_sod_policy(id) print("The response of SODPoliciesApi->start_sod_policy:\n") pprint(api_response) except Exception as e: print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) - path: /sod-violations/predict method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sod-violations#start-predict-sod-violations source: | $IdentityWithNewAccess = @" { "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" } ] } "@ # Predict SOD violations for identity. try { $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess Start-BetaPredictSodViolations -IdentityWithNewAccess $Result # Below is a request that includes all optional parameters # Start-BetaPredictSodViolations -IdentityWithNewAccess $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaPredictSodViolations" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: /sp-config/export method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sp-config#export-sp-config source: | $ExportPayload = @" { "description" : "Export Job 1 Test" } "@ # Initiates configuration objects export job try { $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload Export-BetaSpConfig -ExportPayload $Result # Below is a request that includes all optional parameters # Export-BetaSpConfig -ExportPayload $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. # Download export job result. try { Get-BetaSpConfigExport -Id $Id # Below is a request that includes all optional parameters # Get-BetaSpConfigExport -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export-status source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. # Get export job status try { Get-BetaSpConfigExportStatus -Id $Id # Below is a request that includes all optional parameters # Get-BetaSpConfigExportStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. # Download import job result try { Get-BetaSpConfigImport -Id $Id # Below is a request that includes all optional parameters # Get-BetaSpConfigImport -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import-status source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. # Get import job status try { Get-BetaSpConfigImportStatus -Id $Id # Below is a request that includes all optional parameters # Get-BetaSpConfigImportStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sp-config#import-sp-config source: | $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. $Preview = $true # Boolean | 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 = @" "@ # Initiates configuration objects import job try { Import-BetaSpConfig -Data $Data # Below is a request that includes all optional parameters # Import-BetaSpConfig -Data $Data -Preview $Preview -Options $Options } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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.beta.ImportOptions() # ImportOptions | (optional) try: # Initiates configuration objects import job api_response = api_instance.import_sp_config(data, ) # Below is a request that includes all optional parameters # api_response = api_instance.import_sp_config(data, preview, options) print("The response of SPConfigApi->import_sp_config:\n") pprint(api_response) except Exception as e: print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) - path: /sp-config/config-objects method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sp-config#list-sp-config-objects source: | # Get config object details try { Get-BetaSpConfigObjects # Below is a request that includes all optional parameters # Get-BetaSpConfigObjects } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigObjects" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sp-config#list-sp-config-objects source: | try: # Get config object details api_response = api_instance.list_sp_config_objects() # Below is a request that includes all optional parameters # api_response = api_instance.list_sp_config_objects() print("The response of SPConfigApi->list_sp_config_objects:\n") pprint(api_response) except Exception as e: print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /accounts/search-attribute-config method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#create-search-attribute-config source: | $SearchAttributeConfig = @" { "displayName" : "New Mail Attribute", "name" : "newMailAttribute", "applicationAttributes" : { "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" } } "@ # Create Extended Search Attributes try { $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig New-BetaSearchAttributeConfig -SearchAttributeConfig $Result # Below is a request that includes all optional parameters # New-BetaSearchAttributeConfig -SearchAttributeConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#create-search-attribute-config source: | search_attribute_config = { "displayName" : "New Mail Attribute", "name" : "newMailAttribute", "applicationAttributes" : { "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" } } # SearchAttributeConfig | try: # Create Extended Search Attributes Result = search_attribute_config.from_json(search_attribute_config) api_response = api_instance.create_search_attribute_config(Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_search_attribute_config(Result) print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") pprint(api_response) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-search-attribute-config source: | # List Extended Search Attributes try { Get-BetaSearchAttributeConfig # Below is a request that includes all optional parameters # Get-BetaSearchAttributeConfig } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#get-search-attribute-config source: | try: # List Extended Search Attributes api_response = api_instance.get_search_attribute_config() # Below is a request that includes all optional parameters # api_response = api_instance.get_search_attribute_config() print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") pprint(api_response) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#delete-search-attribute-config source: | $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. # Delete Extended Search Attribute try { Remove-BetaSearchAttributeConfig -Name $Name # Below is a request that includes all optional parameters # Remove-BetaSearchAttributeConfig -Name $Name } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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. try: # Delete Extended Search Attribute api_instance.delete_search_attribute_config(name) # Below is a request that includes all optional parameters # api_instance.delete_search_attribute_config(name) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-single-search-attribute-config source: | $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. # Get Extended Search Attribute try { Get-BetaSingleSearchAttributeConfig -Name $Name # Below is a request that includes all optional parameters # Get-BetaSingleSearchAttributeConfig -Name $Name } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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. try: # Get Extended Search Attribute api_response = api_instance.get_single_search_attribute_config(name) # Below is a request that includes all optional parameters # api_response = api_instance.get_single_search_attribute_config(name) print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#patch-search-attribute-config source: | $Name = "promotedMailAttribute" # String | Name of the extended search attribute configuration to patch. $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Update Extended Search Attribute try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result # Below is a request that includes all optional parameters # Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/search-attribute-configuration#patch-search-attribute-config source: | name = 'promotedMailAttribute' # str | Name of the extended search attribute configuration to patch. # str | Name of the extended search attribute configuration to patch. [{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}] # List[JsonPatchOperation] | json_patch_operation = { "op" : "replace", "path" : "/description", "value" : "New description" } # List[JsonPatchOperation] | try: # Update Extended Search Attribute Result = json_patch_operation.from_json(json_patch_operation) api_response = api_instance.patch_search_attribute_config(name, Result) # Below is a request that includes all optional parameters # api_response = api_instance.patch_search_attribute_config(name, Result) print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") pprint(api_response) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) - path: /segments method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/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" } "@ # Create Segment try { $Result = ConvertFrom-JsonToSegment -Json $Segment New-BetaSegment -Segment $Result # Below is a request that includes all optional parameters # New-BetaSegment -Segment $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/segments#list-segments source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # List Segments try { Get-BetaSegments # Below is a request that includes all optional parameters # Get-BetaSegments -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/segments#delete-segment source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. # Delete Segment by ID try { Remove-BetaSegment -Id $Id # Below is a request that includes all optional parameters # Remove-BetaSegment -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/segments#get-segment source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. # Get Segment by ID try { Get-BetaSegment -Id $Id # Below is a request that includes all optional parameters # Get-BetaSegment -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/{id} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/segments#patch-segment source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. $RequestBody = # SystemCollectionsHashtable[] | 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 $RequestBody = @"[{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}}]}}}]"@ # Update Segment try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody Update-BetaSegment -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters # Update-BetaSegment -Id $Id -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/segments#patch-segment source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. request_body = [{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}] # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active request_body = [{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}] # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active try: # Update Segment Result = request_body.from_json(request_body) api_response = api_instance.patch_segment(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.patch_segment(id, Result) print("The response of SegmentsApi->patch_segment:\n") pprint(api_response) except Exception as e: print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) - path: /service-desk-integrations method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#create-service-desk-integration source: | $ServiceDeskIntegrationDto = @" { "ownerRef" : "", "cluster" : "xyzzy999", "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", "description" : "A very nice Service Desk integration", "attributes" : { "property" : "value", "key" : "value" }, "clusterRef" : "", "type" : "ServiceNowSDIM", "beforeProvisioningRule" : "" } "@ # Create new Service Desk integration try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result # Below is a request that includes all optional parameters # New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/service-desk-integration#create-service-desk-integration source: | service_desk_integration_dto = { "ownerRef" : "", "cluster" : "xyzzy999", "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", "description" : "A very nice Service Desk integration", "attributes" : { "property" : "value", "key" : "value" }, "clusterRef" : "", "type" : "ServiceNowSDIM", "beforeProvisioningRule" : "" } # ServiceDeskIntegrationDto | The specifics of a new integration to create try: # Create new Service Desk integration Result = service_desk_integration_dto.from_json(service_desk_integration_dto) api_response = api_instance.create_service_desk_integration(Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_service_desk_integration(Result) print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n") pprint(api_response) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e) - path: /service-desk-integrations method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-list source: | $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | Max number of results 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" # String | Sort results using the standard syntax described 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 = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # List existing Service Desk integrations try { Get-BetaServiceDeskIntegrationList # Below is a request that includes all optional parameters # Get-BetaServiceDeskIntegrationList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-list 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 = 'id eq 2c91808b6ef1d43e016efba0ce470904' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) try: # List existing Service Desk integrations api_response = api_instance.get_service_desk_integration_list() # Below is a request that includes all optional parameters # api_response = api_instance.get_service_desk_integration_list(offset, limit, sorters, filters, count) print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") pprint(api_response) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) - path: /service-desk-integrations/{id} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#delete-service-desk-integration source: | $Id = "anId" # String | ID of Service Desk integration to delete # Delete a Service Desk integration try { Remove-BetaServiceDeskIntegration -Id $Id # Below is a request that includes all optional parameters # Remove-BetaServiceDeskIntegration -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration source: | $Id = "anId" # String | ID of the Service Desk integration to get # Get a Service Desk integration try { Get-BetaServiceDeskIntegration -Id $Id # Below is a request that includes all optional parameters # Get-BetaServiceDeskIntegration -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/{id} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#patch-service-desk-integration source: | $Id = "anId" # String | ID of the Service Desk integration to update $PatchServiceDeskIntegrationRequest = @" "@ # Patch a Service Desk Integration try { $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result # Below is a request that includes all optional parameters # Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/service-desk-integration#patch-service-desk-integration source: | id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update patch_service_desk_integration_request = sailpoint.beta.PatchServiceDeskIntegrationRequest() # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. try: # Patch a Service Desk Integration Result = patch_service_desk_integration_request.from_json(patch_service_desk_integration_request) api_response = api_instance.patch_service_desk_integration(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.patch_service_desk_integration(id, Result) print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") pprint(api_response) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e) - path: /service-desk-integrations/{id} method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#put-service-desk-integration source: | $Id = "anId" # String | ID of the Service Desk integration to update $ServiceDeskIntegrationDto = @" { "ownerRef" : "", "cluster" : "xyzzy999", "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", "description" : "A very nice Service Desk integration", "attributes" : { "property" : "value", "key" : "value" }, "clusterRef" : "", "type" : "ServiceNowSDIM", "beforeProvisioningRule" : "" } "@ # Update a Service Desk integration try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result # Below is a request that includes all optional parameters # Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/service-desk-integration#put-service-desk-integration source: | id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update service_desk_integration_dto = { "ownerRef" : "", "cluster" : "xyzzy999", "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", "description" : "A very nice Service Desk integration", "attributes" : { "property" : "value", "key" : "value" }, "clusterRef" : "", "type" : "ServiceNowSDIM", "beforeProvisioningRule" : "" } # ServiceDeskIntegrationDto | The specifics of the integration to update try: # Update a Service Desk integration Result = service_desk_integration_dto.from_json(service_desk_integration_dto) api_response = api_instance.put_service_desk_integration(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.put_service_desk_integration(id, Result) print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n") pprint(api_response) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e) - path: /service-desk-integrations/templates/{scriptName} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-template source: | $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get # Service Desk integration template by scriptName try { Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName # Below is a request that includes all optional parameters # Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-types source: | # List Service Desk integration types try { Get-BetaServiceDeskIntegrationTypes # Below is a request that includes all optional parameters # Get-BetaServiceDeskIntegrationTypes } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTypes" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-service-desk-integration-types source: | try: # List Service Desk integration types api_response = api_instance.get_service_desk_integration_types() # Below is a request that includes all optional parameters # api_response = api_instance.get_service_desk_integration_types() print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") pprint(api_response) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) - path: /service-desk-integrations/status-check-configuration method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-status-check-details source: | # Get the time check configuration try { Get-BetaStatusCheckDetails # Below is a request that includes all optional parameters # Get-BetaStatusCheckDetails } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusCheckDetails" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/service-desk-integration#get-status-check-details source: | try: # Get the time check configuration api_response = api_instance.get_status_check_details() # Below is a request that includes all optional parameters # api_response = api_instance.get_status_check_details() print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n") pprint(api_response) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e) - path: /service-desk-integrations/status-check-configuration method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#update-status-check-details source: | $QueuedCheckConfigDetails = @" { "provisioningStatusCheckIntervalMinutes" : "30", "provisioningMaxStatusCheckDays" : "2" } "@ # Update the time check configuration try { $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result # Below is a request that includes all optional parameters # Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: /source-usages/{sourceId}/status method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-status-by-source-id source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source # Finds status of source usage try { Get-BetaStatusBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters # Get-BetaStatusBySourceId -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-usages-by-source-id source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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" # String | Sort results using the standard syntax described 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) # Returns source usage insights try { Get-BetaUsagesBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters # Get-BetaUsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#create-provisioning-policy source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id $ProvisioningPolicyDto = @" { "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" } "@ # Create Provisioning Policy try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto New-BetaProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result # Below is a request that includes all optional parameters # New-BetaProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaProvisioningPolicy" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#create-provisioning-policy source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id provisioning_policy_dto = { "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/{sourceId}/provisioning-policies method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#list-provisioning-policies source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id # Lists ProvisioningPolicies try { Get-BetaProvisioningPolicies -SourceId $SourceId # Below is a request that includes all optional parameters # Get-BetaProvisioningPolicies -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProvisioningPolicies" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/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" } "@ $ProvisionAsCsv = $false # Boolean | 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) # Creates a source in IdentityNow. try { $Result = ConvertFrom-JsonToSource -Json $Source New-BetaSource -Source $Result # Below is a request that includes all optional parameters # New-BetaSource -Source $Result -ProvisionAsCsv $ProvisionAsCsv } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSource" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#list-sources source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 API Standard 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* **modified**: *eq* **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" # String | Sort results using the standard syntax described 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) $ForSubadmin = "name" # String | 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) $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) # Lists all sources in IdentityNow. try { Get-BetaSources # Below is a request that includes all optional parameters # Get-BetaSources -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSubadmin $ForSubadmin -IncludeIDNSource $IncludeIDNSource } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSources" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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* **modified**: *eq* **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* **modified**: *eq* **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}/schemas method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#create-source-schema source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. $Schema = @" { "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], "nativeObjectType" : "User", "configuration" : { "groupMemberAttribute" : "member" }, "created" : "2019-12-24T22:32:58.104Z", "includePermissions" : false, "name" : "account", "hierarchyAttribute" : "memberOf", "modified" : "2019-12-31T20:22:28.104Z", "attributes" : [ { "name" : "sAMAccountName", "type" : "STRING", "isMultiValued" : false, "isEntitlement" : false, "isGroup" : false }, { "name" : "memberOf", "type" : "STRING", "schema" : { "type" : "CONNECTOR_SCHEMA", "id" : "2c9180887671ff8c01767b4671fc7d60", "name" : "group" }, "description" : "Group membership", "isMultiValued" : true, "isEntitlement" : true, "isGroup" : true } ], "id" : "2c9180835d191a86015d28455b4a2329", "displayAttribute" : "distinguishedName", "identityAttribute" : "sAMAccountName" } "@ # Create Schema on Source try { $Result = ConvertFrom-JsonToSchema -Json $Schema New-BetaSourceSchema -SourceId $SourceId -Schema $Result # Below is a request that includes all optional parameters # New-BetaSourceSchema -SourceId $SourceId -Schema $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceSchema" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#create-source-schema source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. model_schema = sailpoint.beta.ModelSchema() # ModelSchema | try: # Create Schema on Source Result = model_schema.from_json(model_schema) api_response = api_instance.create_source_schema(source_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_source_schema(source_id, Result) print("The response of SourcesApi->create_source_schema:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) - path: /sources/{sourceId}/schemas method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-schemas source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. $IncludeTypes = "group" # String | 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) $IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) # List Schemas on Source try { Get-BetaSourceSchemas -SourceId $SourceId # Below is a request that includes all optional parameters # Get-BetaSourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceSchemas" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#delete source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. # Delete Source by ID try { Remove-Beta -Id $Id # Below is a request that includes all optional parameters # Remove-Beta -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Beta" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#delete source: | id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. try: # Delete Source by ID api_response = api_instance.delete(id) # Below is a request that includes all optional parameters # api_response = api_instance.delete(id) print("The response of SourcesApi->delete:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->delete: %s\n" % e) - path: /sources/{id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#get-source source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. # Get Source by ID try { Get-BetaSource -Id $Id # Below is a request that includes all optional parameters # Get-BetaSource -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSource" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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} method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#put-source source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | 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" } "@ # Update Source (Full) try { $Result = ConvertFrom-JsonToSource -Json $Source Send-BetaSource -Id $Id -Source $Result # Below is a request that includes all optional parameters # Send-BetaSource -Id $Id -Source $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSource" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#update-source source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Update Source (Partial) try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation Update-BetaSource -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters # Update-BetaSource -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSource" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#update-source source: | id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. [{op=replace, path=/description, value=new description}] # List[JsonPatchOperation] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). json_patch_operation = { "op" : "replace", "path" : "/description", "value" : "New description" } # List[JsonPatchOperation] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). try: # Update Source (Partial) Result = json_patch_operation.from_json(json_patch_operation) api_response = api_instance.update_source(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.update_source(id, Result) print("The response of SourcesApi->update_source:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->update_source: %s\n" % e) - path: /sources/{sourceId}/remove-accounts method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#delete-accounts-async source: | $SourceId = "ebbf35756e1140699ce52b233121384a" # String | The source id # Remove All Accounts in a Source try { Remove-BetaAccountsAsync -SourceId $SourceId # Below is a request that includes all optional parameters # Remove-BetaAccountsAsync -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccountsAsync" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#delete-accounts-async source: | source_id = 'ebbf35756e1140699ce52b233121384a' # str | The source id # str | The source id try: # Remove All Accounts in a Source api_response = api_instance.delete_accounts_async(source_id) # Below is a request that includes all optional parameters # api_response = api_instance.delete_accounts_async(source_id) print("The response of SourcesApi->delete_accounts_async:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#delete-native-change-detection-config source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id # Delete Native Change Detection Configuration try { Remove-BetaNativeChangeDetectionConfig -SourceId $SourceId # Below is a request that includes all optional parameters # Remove-BetaNativeChangeDetectionConfig -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNativeChangeDetectionConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#delete-native-change-detection-config source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id try: # Delete Native Change Detection Configuration api_instance.delete_native_change_detection_config(source_id) # Below is a request that includes all optional parameters # api_instance.delete_native_change_detection_config(source_id) except Exception as e: print("Exception when calling SourcesApi->delete_native_change_detection_config: %s\n" % e) - path: /sources/{sourceId}/native-change-detection-config method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#get-native-change-detection-config source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id # Native Change Detection Configuration try { Get-BetaNativeChangeDetectionConfig -SourceId $SourceId # Below is a request that includes all optional parameters # Get-BetaNativeChangeDetectionConfig -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNativeChangeDetectionConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#get-native-change-detection-config source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id try: # Native Change Detection Configuration api_response = api_instance.get_native_change_detection_config(source_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_native_change_detection_config(source_id) print("The response of SourcesApi->get_native_change_detection_config:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->get_native_change_detection_config: %s\n" % e) - path: /sources/{sourceId}/native-change-detection-config method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#put-native-change-detection-config source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id $NativeChangeDetectionConfig = @" { "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], "allNonEntitlementAttributes" : false, "allEntitlements" : false, "enabled" : true } "@ # Update Native Change Detection Configuration try { $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig Send-BetaNativeChangeDetectionConfig -SourceId $SourceId -NativeChangeDetectionConfig $Result # Below is a request that includes all optional parameters # Send-BetaNativeChangeDetectionConfig -SourceId $SourceId -NativeChangeDetectionConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaNativeChangeDetectionConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#put-native-change-detection-config source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id native_change_detection_config = { "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], "allNonEntitlementAttributes" : false, "allEntitlements" : false, "enabled" : true } # NativeChangeDetectionConfig | try: # Update Native Change Detection Configuration Result = native_change_detection_config.from_json(native_change_detection_config) api_response = api_instance.put_native_change_detection_config(source_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.put_native_change_detection_config(source_id, Result) print("The response of SourcesApi->put_native_change_detection_config:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->put_native_change_detection_config: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#delete-provisioning-policy source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. $UsageType = "CREATE" # 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. # Delete Provisioning Policy by UsageType try { Remove-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType # Below is a request that includes all optional parameters # Remove-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaProvisioningPolicy" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#delete-provisioning-policy source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. usage_type = sailpoint.beta.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. 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/{sourceId}/provisioning-policies/{usageType} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#get-provisioning-policy source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. $UsageType = "CREATE" # 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. # Get Provisioning Policy by UsageType try { Get-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType # Below is a request that includes all optional parameters # Get-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProvisioningPolicy" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#get-provisioning-policy source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. usage_type = sailpoint.beta.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. 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/{sourceId}/provisioning-policies/{usageType} method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#put-provisioning-policy source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. $UsageType = "CREATE" # 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. $ProvisioningPolicyDto = @" { "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" } "@ # Update Provisioning Policy by UsageType try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto Send-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result # Below is a request that includes all optional parameters # Send-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaProvisioningPolicy" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#put-provisioning-policy source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. usage_type = sailpoint.beta.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. provisioning_policy_dto = { "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/{sourceId}/provisioning-policies/{usageType} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#update-provisioning-policy source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $UsageType = "CREATE" # 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. $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Partial update of Provisioning Policy try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation Update-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result # Below is a request that includes all optional parameters # Update-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProvisioningPolicy" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#update-provisioning-policy source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. usage_type = sailpoint.beta.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. [{op=add, path=/fields/0, value={name=email, transform={type=identityAttribute, attributes={name=email}}, attributes={}, isRequired=false, type=string, isMultiValued=false}}] # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. json_patch_operation = { "op" : "replace", "path" : "/description", "value" : "New description" } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. try: # Partial update of Provisioning Policy Result = json_patch_operation.from_json(json_patch_operation) api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) # Below is a request that includes all optional parameters # api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result) print("The response of SourcesApi->update_provisioning_policy:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) - path: /sources/{sourceId}/schemas/{schemaId} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#delete-source-schema source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. # Delete Source Schema by ID try { Remove-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId # Below is a request that includes all optional parameters # Remove-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSourceSchema" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/{sourceId}/schemas/{schemaId} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-schema source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. # Get Source Schema by ID try { Get-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId # Below is a request that includes all optional parameters # Get-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceSchema" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/{schemaId} method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#put-source-schema source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. $Schema = @" { "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], "nativeObjectType" : "User", "configuration" : { "groupMemberAttribute" : "member" }, "created" : "2019-12-24T22:32:58.104Z", "includePermissions" : false, "name" : "account", "hierarchyAttribute" : "memberOf", "modified" : "2019-12-31T20:22:28.104Z", "attributes" : [ { "name" : "sAMAccountName", "type" : "STRING", "isMultiValued" : false, "isEntitlement" : false, "isGroup" : false }, { "name" : "memberOf", "type" : "STRING", "schema" : { "type" : "CONNECTOR_SCHEMA", "id" : "2c9180887671ff8c01767b4671fc7d60", "name" : "group" }, "description" : "Group membership", "isMultiValued" : true, "isEntitlement" : true, "isGroup" : true } ], "id" : "2c9180835d191a86015d28455b4a2329", "displayAttribute" : "distinguishedName", "identityAttribute" : "sAMAccountName" } "@ # Update Source Schema (Full) try { $Result = ConvertFrom-JsonToSchema -Json $Schema Send-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result # Below is a request that includes all optional parameters # Send-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSourceSchema" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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.beta.ModelSchema() # ModelSchema | try: # Update Source Schema (Full) Result = model_schema.from_json(model_schema) api_response = api_instance.put_source_schema(source_id, schema_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.put_source_schema(source_id, schema_id, Result) print("The response of SourcesApi->put_source_schema:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) - path: /sources/{sourceId}/schemas/{schemaId} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#update-source-schema source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Update Source Schema (Partial) try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation Update-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result # Below is a request that includes all optional parameters # Update-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceSchema" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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=replace, path=/displayAttribute, value={new-display-attribute=null}}] # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. json_patch_operation = { "op" : "replace", "path" : "/description", "value" : "New description" } # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. try: # Update Source Schema (Partial) Result = json_patch_operation.from_json(json_patch_operation) api_response = api_instance.update_source_schema(source_id, schema_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.update_source_schema(source_id, schema_id, Result) print("The response of SourcesApi->update_source_schema:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) - path: /sources/{sourceId}/correlation-config method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#get-correlation-config source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id # Get Source Correlation Configuration try { Get-BetaCorrelationConfig -SourceId $SourceId # Below is a request that includes all optional parameters # Get-BetaCorrelationConfig -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCorrelationConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#get-correlation-config source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id try: # Get Source Correlation Configuration api_response = api_instance.get_correlation_config(source_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_correlation_config(source_id) print("The response of SourcesApi->get_correlation_config:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->get_correlation_config: %s\n" % e) - path: /sources/{sourceId}/correlation-config method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#put-correlation-config source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id $CorrelationConfig = @" { "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" } "@ # Update Source Correlation Configuration try { $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig Send-BetaCorrelationConfig -SourceId $SourceId -CorrelationConfig $Result # Below is a request that includes all optional parameters # Send-BetaCorrelationConfig -SourceId $SourceId -CorrelationConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaCorrelationConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#put-correlation-config source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id correlation_config = { "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(source_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.put_correlation_config(source_id, Result) print("The response of SourcesApi->put_correlation_config:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->put_correlation_config: %s\n" % e) - path: /sources/{sourceId}/schemas/accounts method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-accounts-schema source: | $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id # Downloads source accounts schema template try { Get-BetaSourceAccountsSchema -SourceId $SourceId # Below is a request that includes all optional parameters # Get-BetaSourceAccountsSchema -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceAccountsSchema" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#get-source-accounts-schema source: | source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id try: # Downloads source accounts schema template api_instance.get_source_accounts_schema(source_id) # Below is a request that includes all optional parameters # api_instance.get_source_accounts_schema(source_id) except Exception as e: print("Exception when calling SourcesApi->get_source_accounts_schema: %s\n" % e) - path: /sources/{sourceId}/schemas/accounts method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#import-source-accounts-schema source: | $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id $File = # System.IO.FileInfo | (optional) # Uploads source accounts schema template try { Import-BetaSourceAccountsSchema -SourceId $SourceId # Below is a request that includes all optional parameters # Import-BetaSourceAccountsSchema -SourceId $SourceId -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceAccountsSchema" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#import-source-accounts-schema source: | source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id file = None # bytearray | (optional) # bytearray | (optional) try: # Uploads source accounts schema template api_response = api_instance.import_source_accounts_schema(source_id, ) # Below is a request that includes all optional parameters # api_response = api_instance.import_source_accounts_schema(source_id, file) print("The response of SourcesApi->import_source_accounts_schema:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->import_source_accounts_schema: %s\n" % e) - path: /sources/{id}/attribute-sync-config method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-attr-sync-config source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id # Attribute Sync Config try { Get-BetaSourceAttrSyncConfig -Id $Id # Below is a request that includes all optional parameters # Get-BetaSourceAttrSyncConfig -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceAttrSyncConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#get-source-attr-sync-config source: | id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id try: # Attribute Sync Config api_response = api_instance.get_source_attr_sync_config(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_source_attr_sync_config(id) print("The response of SourcesApi->get_source_attr_sync_config:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->get_source_attr_sync_config: %s\n" % e) - path: /sources/{id}/attribute-sync-config method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#put-source-attr-sync-config source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id $AttrSyncSourceConfig = @" { "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" } } "@ # Update Attribute Sync Config try { $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig Send-BetaSourceAttrSyncConfig -Id $Id -AttrSyncSourceConfig $Result # Below is a request that includes all optional parameters # Send-BetaSourceAttrSyncConfig -Id $Id -AttrSyncSourceConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSourceAttrSyncConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#put-source-attr-sync-config source: | id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id attr_sync_source_config = { "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, Result) # Below is a request that includes all optional parameters # api_response = api_instance.put_source_attr_sync_config(id, Result) print("The response of SourcesApi->put_source_attr_sync_config:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->put_source_attr_sync_config: %s\n" % e) - path: /sources/{id}/connectors/source-config method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-config source: | $Id = "MyId" # String | The Source id $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) # Gets source config with language translations try { Get-BetaSourceConfig -Id $Id # Below is a request that includes all optional parameters # Get-BetaSourceConfig -Id $Id -Locale $Locale } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#get-source-config source: | id = 'id_example' # str | The Source id # str | The Source id locale = 'locale_example' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) try: # Gets source config with language translations api_response = api_instance.get_source_config(id, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_source_config(id, locale) print("The response of SourcesApi->get_source_config:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->get_source_config: %s\n" % e) - path: /sources/{sourceId}/entitlement-request-config method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-entitlement-request-config source: | $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id # Get Source Entitlement Request Configuration try { Get-BetaSourceEntitlementRequestConfig -SourceId $SourceId # Below is a request that includes all optional parameters # Get-BetaSourceEntitlementRequestConfig -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceEntitlementRequestConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#get-source-entitlement-request-config source: | source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id try: # Get Source Entitlement Request Configuration api_response = api_instance.get_source_entitlement_request_config(source_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_source_entitlement_request_config(source_id) print("The response of SourcesApi->get_source_entitlement_request_config:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->get_source_entitlement_request_config: %s\n" % e) - path: /sources/{sourceId}/entitlement-request-config method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#update-source-entitlement-request-config source: | $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id $SourceEntitlementRequestConfig = @" { "accessRequestConfig" : { "denialCommentRequired" : false, "approvalSchemes" : [ { "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", "approverType" : "GOVERNANCE_GROUP" }, { "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", "approverType" : "GOVERNANCE_GROUP" } ], "requestCommentRequired" : true } } "@ # Update Source Entitlement Request Configuration try { $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig Update-BetaSourceEntitlementRequestConfig -SourceId $SourceId -SourceEntitlementRequestConfig $Result # Below is a request that includes all optional parameters # Update-BetaSourceEntitlementRequestConfig -SourceId $SourceId -SourceEntitlementRequestConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceEntitlementRequestConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#update-source-entitlement-request-config source: | source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id source_entitlement_request_config = { "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(source_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.update_source_entitlement_request_config(source_id, Result) print("The response of SourcesApi->update_source_entitlement_request_config:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->update_source_entitlement_request_config: %s\n" % e) - path: /sources/{sourceId}/schemas/entitlements method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#get-source-entitlements-schema source: | $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) # Downloads source entitlements schema template try { Get-BetaSourceEntitlementsSchema -SourceId $SourceId # Below is a request that includes all optional parameters # Get-BetaSourceEntitlementsSchema -SourceId $SourceId -SchemaName $SchemaName } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceEntitlementsSchema" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#get-source-entitlements-schema source: | source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id schema_name = '?schemaName=group' # str | Name of entitlement schema (optional) # str | Name of entitlement schema (optional) try: # Downloads source entitlements schema template api_instance.get_source_entitlements_schema(source_id, ) # Below is a request that includes all optional parameters # api_instance.get_source_entitlements_schema(source_id, schema_name) except Exception as e: print("Exception when calling SourcesApi->get_source_entitlements_schema: %s\n" % e) - path: /sources/{sourceId}/schemas/entitlements method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#import-source-entitlements-schema source: | $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) $File = # System.IO.FileInfo | (optional) # Uploads source entitlements schema template try { Import-BetaSourceEntitlementsSchema -SourceId $SourceId # Below is a request that includes all optional parameters # Import-BetaSourceEntitlementsSchema -SourceId $SourceId -SchemaName $SchemaName -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceEntitlementsSchema" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#import-source-entitlements-schema source: | 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_source_entitlements_schema(source_id, ) # Below is a request that includes all optional parameters # api_response = api_instance.import_source_entitlements_schema(source_id, schema_name, file) print("The response of SourcesApi->import_source_entitlements_schema:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->import_source_entitlements_schema: %s\n" % e) - path: /sources/{sourceId}/load-accounts method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#import-accounts source: | $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id $File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) $DisableOptimization = "true" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) # Account Aggregation try { Import-BetaAccounts -SourceId $SourceId # Below is a request that includes all optional parameters # Import-BetaAccounts -SourceId $SourceId -File $File -DisableOptimization $DisableOptimization } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaAccounts" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#import-accounts source: | source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id file = None # bytearray | The CSV file containing the source accounts to aggregate. (optional) # bytearray | The CSV file containing the source accounts to aggregate. (optional) disable_optimization = 'disable_optimization_example' # str | Use this flag to reprocess every account whether or not the data has changed. (optional) # str | Use this flag to reprocess every account whether or not the data has changed. (optional) try: # Account Aggregation api_response = api_instance.import_accounts(source_id, ) # Below is a request that includes all optional parameters # api_response = api_instance.import_accounts(source_id, file, disable_optimization) print("The response of SourcesApi->import_accounts:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->import_accounts: %s\n" % e) - path: /sources/{sourceId}/load-entitlements method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#import-entitlements source: | $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id $File = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) # Entitlement Aggregation try { Import-BetaEntitlements -SourceId $SourceId # Below is a request that includes all optional parameters # Import-BetaEntitlements -SourceId $SourceId -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaEntitlements" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#import-entitlements source: | source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id file = None # bytearray | The CSV file containing the source entitlements to aggregate. (optional) # bytearray | The CSV file containing the source entitlements to aggregate. (optional) try: # Entitlement Aggregation api_response = api_instance.import_entitlements(source_id, ) # Below is a request that includes all optional parameters # api_response = api_instance.import_entitlements(source_id, file) print("The response of SourcesApi->import_entitlements:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->import_entitlements: %s\n" % e) - path: /sources/{sourceId}/upload-connector-file method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#import-source-connector-file source: | $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id $File = # System.IO.FileInfo | (optional) # Upload connector file to source try { Import-BetaSourceConnectorFile -SourceId $SourceId # Below is a request that includes all optional parameters # Import-BetaSourceConnectorFile -SourceId $SourceId -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceConnectorFile" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#import-source-connector-file source: | source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id file = None # bytearray | (optional) # bytearray | (optional) try: # Upload connector file to source api_response = api_instance.import_source_connector_file(source_id, ) # Below is a request that includes all optional parameters # api_response = api_instance.import_source_connector_file(source_id, file) print("The response of SourcesApi->import_source_connector_file:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->import_source_connector_file: %s\n" % e) - path: /sources/{sourceId}/load-uncorrelated-accounts method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#import-uncorrelated-accounts source: | $SourceId = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id $File = # System.IO.FileInfo | (optional) # Process Uncorrelated Accounts try { Import-BetaUncorrelatedAccounts -SourceId $SourceId # Below is a request that includes all optional parameters # Import-BetaUncorrelatedAccounts -SourceId $SourceId -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaUncorrelatedAccounts" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#import-uncorrelated-accounts source: | source_id = '75dbec1ebe154d5785da27b95e1dd5d7' # str | Source Id # str | Source Id file = None # bytearray | (optional) # bytearray | (optional) try: # Process Uncorrelated Accounts api_response = api_instance.import_uncorrelated_accounts(source_id, ) # Below is a request that includes all optional parameters # api_response = api_instance.import_uncorrelated_accounts(source_id, file) print("The response of SourcesApi->import_uncorrelated_accounts:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->import_uncorrelated_accounts: %s\n" % e) - path: /sources/{sourceId}/connector/peek-resource-objects method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#peek-resource-objects source: | $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source $ResourceObjectsRequest = @" { "maxCount" : 100, "objectType" : "group" } "@ # Peek source connector's resource objects try { $Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest Receive-BetaResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result # Below is a request that includes all optional parameters # Receive-BetaResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Receive-BetaResourceObjects" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#peek-resource-objects source: | source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source resource_objects_request = { "maxCount" : 100, "objectType" : "group" } # ResourceObjectsRequest | try: # Peek source connector's resource objects Result = resource_objects_request.from_json(resource_objects_request) api_response = api_instance.peek_resource_objects(source_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.peek_resource_objects(source_id, Result) print("The response of SourcesApi->peek_resource_objects:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->peek_resource_objects: %s\n" % e) - path: /sources/{sourceId}/connector/ping-cluster method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#ping-cluster source: | $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source # Ping cluster for source connector try { Ping-BetaCluster -SourceId $SourceId # Below is a request that includes all optional parameters # Ping-BetaCluster -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-BetaCluster" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#ping-cluster source: | source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source try: # Ping cluster for source connector api_response = api_instance.ping_cluster(source_id) # Below is a request that includes all optional parameters # api_response = api_instance.ping_cluster(source_id) print("The response of SourcesApi->ping_cluster:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->ping_cluster: %s\n" % e) - path: /sources/{sourceId}/synchronize-attributes method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#sync-attributes-for-source source: | $SourceId = "MySourceId" # String | The Source id # Synchronize single source attributes. try { Sync-BetaAttributesForSource -SourceId $SourceId # Below is a request that includes all optional parameters # Sync-BetaAttributesForSource -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetaAttributesForSource" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#sync-attributes-for-source source: | source_id = 'source_id_example' # str | The Source id # str | The Source id try: # Synchronize single source attributes. api_response = api_instance.sync_attributes_for_source(source_id) # Below is a request that includes all optional parameters # api_response = api_instance.sync_attributes_for_source(source_id) print("The response of SourcesApi->sync_attributes_for_source:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#test-source-configuration source: | $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source # Test configuration for source connector try { Test-BetaSourceConfiguration -SourceId $SourceId # Below is a request that includes all optional parameters # Test-BetaSourceConfiguration -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConfiguration" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#test-source-configuration source: | source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source try: # Test configuration for source connector api_response = api_instance.test_source_configuration(source_id) # Below is a request that includes all optional parameters # api_response = api_instance.test_source_configuration(source_id) print("The response of SourcesApi->test_source_configuration:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#test-source-connection source: | $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source. # Check connection for source connector. try { Test-BetaSourceConnection -SourceId $SourceId # Below is a request that includes all optional parameters # Test-BetaSourceConnection -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConnection" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#test-source-connection source: | source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source. # str | The ID of the Source. try: # Check connection for source connector. api_response = api_instance.test_source_connection(source_id) # Below is a request that includes all optional parameters # api_response = api_instance.test_source_connection(source_id) print("The response of SourcesApi->test_source_connection:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->test_source_connection: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/bulk-update method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/sources#update-provisioning-policies-in-bulk source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $ProvisioningPolicyDto = @"{ "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" }"@ # Bulk Update Provisioning Policies try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto Update-BetaProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result # Below is a request that includes all optional parameters # Update-BetaProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProvisioningPoliciesInBulk" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/sources#update-provisioning-policies-in-bulk source: | source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. [sailpoint.beta.ProvisioningPolicyDto()] # List[ProvisioningPolicyDto] | provisioning_policy_dto = { "name" : "example provisioning policy for inactive identities", "description" : "this provisioning policy creates access based on an identity going inactive", "fields" : [ { "isRequired" : false, "transform" : { "type" : "rule", "attributes" : { "name" : "Create Unique LDAP Attribute" } }, "isMultiValued" : false, "name" : "userName", "attributes" : { "template" : "${firstname}.${lastname}${uniqueCounter}", "cloudMaxUniqueChecks" : "50", "cloudMaxSize" : "20", "cloudRequired" : "true" }, "type" : "string" }, { "isRequired" : false, "transform" : { "type" : "rule", "attributes" : { "name" : "Create Unique LDAP Attribute" } }, "isMultiValued" : false, "name" : "userName", "attributes" : { "template" : "${firstname}.${lastname}${uniqueCounter}", "cloudMaxUniqueChecks" : "50", "cloudMaxSize" : "20", "cloudRequired" : "true" }, "type" : "string" } ], "usageType" : "CREATE" } # List[ProvisioningPolicyDto] | try: # Bulk Update Provisioning Policies Result = provisioning_policy_dto.from_json(provisioning_policy_dto) api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result) print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") pprint(api_response) except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#get-sed-batch-stats source: | $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id # Submit Sed Batch Stats Request try { Get-BetaSedBatchStats -BatchId $BatchId # Below is a request that includes all optional parameters # Get-BetaSedBatchStats -BatchId $BatchId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatchStats" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#get-sed-batches source: | # List Sed Batch Request try { Get-BetaSedBatches # Below is a request that includes all optional parameters # Get-BetaSedBatches } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatches" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#get-sed-batches source: | try: # List Sed Batch Request api_response = api_instance.get_sed_batches() # Below is a request that includes all optional parameters # api_response = api_instance.get_sed_batches() print("The response of SuggestedEntitlementDescriptionApi->get_sed_batches:\n") pprint(api_response) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batches: %s\n" % e) - path: /suggested-entitlement-description-batches method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#submit-sed-batch-request source: | $SedBatchRequest = @" { "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] } "@ # Submit Sed Batch Request try { Submit-BetaSedBatchRequest # Below is a request that includes all optional parameters # Submit-BetaSedBatchRequest -SedBatchRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedBatchRequest" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: /suggested-entitlement-descriptions method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#list-seds source: | $Limit = limit=25 # Int64 | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) $Filters = "displayName co "Read and Write"" # String | Filter results using the standard syntax described in [V3 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" # String | Sort results using the standard syntax described 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 = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) $CountOnly = $false # Boolean | If `true` 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 Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) $RequestedByAnyone = $false # Boolean | 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) $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) # List Suggested Entitlement Descriptions try { Get-BetaSeds # Below is a request that includes all optional parameters # Get-BetaSeds -Limit $Limit -Filters $Filters -Sorters $Sorters -Count $Count -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSeds" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#list-seds source: | limit = limit=25 # int | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) # int | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) filters = 'displayName co \"Read and Write\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) sorters = 'sorters=displayName' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) count = count=true # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) count_only = count-only=true # bool | If `true` 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 Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) # bool | If `true` 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 Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) requested_by_anyone = requested-by-anyone=true # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) show_pending_status_only = show-pending-status-only=true # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) try: # List Suggested Entitlement Descriptions api_response = api_instance.list_seds() # Below is a request that includes all optional parameters # api_response = api_instance.list_seds(limit, filters, sorters, count, count_only, requested_by_anyone, show_pending_status_only) print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") pprint(api_response) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) - path: /suggested-entitlement-descriptions method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#patch-sed source: | $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id $SedPatch = @"{ "op" : "replace", "path" : "status", "value" : "approved" }"@ # Patch Suggested Entitlement Description try { $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch Update-BetaSed -Id $Id -SedPatch $Result # Below is a request that includes all optional parameters # Update-BetaSed -Id $Id -SedPatch $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSed" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#patch-sed source: | id = 'ebab396f-0af1-4050-89b7-dafc63ec70e7' # str | id is sed id # str | id is sed id [sailpoint.beta.SedPatch()] # List[SedPatch] | Sed Patch Request sed_patch = { "op" : "replace", "path" : "status", "value" : "approved" } # List[SedPatch] | Sed Patch Request try: # Patch Suggested Entitlement Description Result = sed_patch.from_json(sed_patch) api_response = api_instance.patch_sed(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.patch_sed(id, Result) print("The response of SuggestedEntitlementDescriptionApi->patch_sed:\n") pprint(api_response) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->patch_sed: %s\n" % e) - path: /suggested-entitlement-description-approvals method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#submit-sed-approval source: | $SedApproval = @"{ "items" : "016629d1-1d25-463f-97f3-c6686846650" }"@ # Submit Bulk Approval Request try { $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval Submit-BetaSedApproval -SedApproval $Result # Below is a request that includes all optional parameters # Submit-BetaSedApproval -SedApproval $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedApproval" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/suggested-entitlement-description#submit-sed-approval source: | [sailpoint.beta.SedApproval()] # List[SedApproval] | Sed Approval sed_approval = { "items" : "016629d1-1d25-463f-97f3-c6686846650" } # List[SedApproval] | Sed Approval try: # Submit Bulk Approval Request Result = sed_approval.from_json(sed_approval) api_response = api_instance.submit_sed_approval(Result) # Below is a request that includes all optional parameters # api_response = api_instance.submit_sed_approval(Result) print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") pprint(api_response) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) - path: /suggested-entitlement-description-assignments method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#submit-sed-assignment source: | $SedAssignment = @" { "assignee" : { "type" : "SOURCE_OWNER", "value" : "016629d1-1d25-463f-97f3-c6686846650" }, "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] } "@ # Submit Sed Assignment Request try { $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment Submit-BetaSedAssignment -SedAssignment $Result # Below is a request that includes all optional parameters # Submit-BetaSedAssignment -SedAssignment $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedAssignment" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: /tagged-objects/{type}/{id} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#delete-tagged-object source: | $Type = "ACCESS_PROFILE" # String | The type of object to delete tags from. $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from. # Delete Object Tags try { Remove-BetaTaggedObject -Type $Type -Id $Id # Below is a request that includes all optional parameters # Remove-BetaTaggedObject -Type $Type -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTaggedObject" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/{type}/{id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#get-tagged-object source: | $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. # Get Tagged Object try { Get-BetaTaggedObject -Type $Type -Id $Id # Below is a request that includes all optional parameters # Get-BetaTaggedObject -Type $Type -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObject" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/{type}/{id} method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#put-tagged-object source: | $Type = "ACCESS_PROFILE" # String | The type of tagged object to update. $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update. $TaggedObject = @" { "objectRef" : { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, "tags" : [ "BU_FINANCE", "PCI" ] } "@ # Update Tagged Object try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject Send-BetaTaggedObject -Type $Type -Id $Id -TaggedObject $Result # Below is a request that includes all optional parameters # Send-BetaTaggedObject -Type $Type -Id $Id -TaggedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTaggedObject" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/bulk-remove method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#delete-tags-to-many-object source: | $BulkTaggedObject = @" { "objectRefs" : [ { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" } ], "operation" : "MERGE", "tags" : [ "BU_FINANCE", "PCI" ] } "@ # Remove Tags from Multiple Objects try { $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject Remove-BetaTagsToManyObject -BulkTaggedObject $Result # Below is a request that includes all optional parameters # Remove-BetaTagsToManyObject -BulkTaggedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagsToManyObject" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/tagged-objects#delete-tags-to-many-object source: | bulk_tagged_object = { "objectRefs" : [ { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" } ], "operation" : "MERGE", "tags" : [ "BU_FINANCE", "PCI" ] } # BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. try: # Remove Tags from Multiple Objects Result = bulk_tagged_object.from_json(bulk_tagged_object) api_instance.delete_tags_to_many_object(Result) # Below is a request that includes all optional parameters # api_instance.delete_tags_to_many_object(Result) except Exception as e: print("Exception when calling TaggedObjectsApi->delete_tags_to_many_object: %s\n" % e) - path: /tagged-objects method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#list-tagged-objects source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 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) # List Tagged Objects try { Get-BetaTaggedObjects # Below is a request that includes all optional parameters # Get-BetaTaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObjects" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#set-tag-to-object source: | $TaggedObject = @" { "objectRef" : { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, "tags" : [ "BU_FINANCE", "PCI" ] } "@ # Add Tag to Object try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject Set-BetaTagToObject -TaggedObject $Result # Below is a request that includes all optional parameters # Set-BetaTagToObject -TaggedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagToObject" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/{type} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#list-tagged-objects-by-type source: | $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 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) # List Tagged Objects by Type try { Get-BetaTaggedObjectsByType -Type $Type # Below is a request that includes all optional parameters # Get-BetaTaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObjectsByType" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/bulk-add method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/tagged-objects#set-tags-to-many-objects source: | $BulkTaggedObject = @" { "objectRefs" : [ { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" } ], "operation" : "MERGE", "tags" : [ "BU_FINANCE", "PCI" ] } "@ # Tag Multiple Objects try { $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject Set-BetaTagsToManyObjects -BulkTaggedObject $Result # Below is a request that includes all optional parameters # Set-BetaTagsToManyObjects -BulkTaggedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagsToManyObjects" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/tagged-objects#set-tags-to-many-objects source: | bulk_tagged_object = { "objectRefs" : [ { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" }, { "name" : "William Wilson", "id" : "2c91808568c529c60168cca6f90c1313", "type" : "IDENTITY" } ], "operation" : "MERGE", "tags" : [ "BU_FINANCE", "PCI" ] } # BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. try: # Tag Multiple Objects Result = bulk_tagged_object.from_json(bulk_tagged_object) api_response = api_instance.set_tags_to_many_objects(Result) # Below is a request that includes all optional parameters # api_response = api_instance.set_tags_to_many_objects(Result) print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") pprint(api_response) except Exception as e: print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) - path: /tags method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/tags#create-tag source: | $Tag = @" { "created" : "2022-05-04T14:48:49Z", "tagCategoryRefs" : [ { "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" } ], "name" : "PCI", "modified" : "2022-07-14T16:31:11Z", "id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f" } "@ # Create Tag try { $Result = ConvertFrom-JsonToTag -Json $Tag New-BetaTag -Tag $Result # Below is a request that includes all optional parameters # New-BetaTag -Tag $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTag" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/tags#create-tag source: | tag = { "created" : "2022-05-04T14:48:49Z", "tagCategoryRefs" : [ { "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" } ], "name" : "PCI", "modified" : "2022-07-14T16:31:11Z", "id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f" } # Tag | try: # Create Tag Result = tag.from_json(tag) api_response = api_instance.create_tag(Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_tag(Result) print("The response of TagsApi->create_tag:\n") pprint(api_response) except Exception as e: print("Exception when calling TagsApi->create_tag: %s\n" % e) - path: /tags method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/tags#list-tags source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 "27462f54-61c7-4140-b5da-d5dbe27fc6db"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified** (optional) # List Tags try { Get-BetaTags # Below is a request that includes all optional parameters # Get-BetaTags -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTags" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/tags#list-tags 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 \"27462f54-61c7-4140-b5da-d5dbe27fc6db\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified** (optional) try: # List Tags api_response = api_instance.list_tags() # Below is a request that includes all optional parameters # api_response = api_instance.list_tags(limit, offset, count, filters, sorters) print("The response of TagsApi->list_tags:\n") pprint(api_response) except Exception as e: print("Exception when calling TagsApi->list_tags: %s\n" % e) - path: /tags/{id} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/tags#delete-tag-by-id source: | $Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to delete. # Delete Tag try { Remove-BetaTagById -Id $Id # Below is a request that includes all optional parameters # Remove-BetaTagById -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagById" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/tags#delete-tag-by-id source: | id = '329d96cf-3bdb-40a9-988a-b5037ab89022' # str | The ID of the object reference to delete. # str | The ID of the object reference to delete. try: # Delete Tag api_instance.delete_tag_by_id(id) # Below is a request that includes all optional parameters # api_instance.delete_tag_by_id(id) except Exception as e: print("Exception when calling TagsApi->delete_tag_by_id: %s\n" % e) - path: /tags/{id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/tags#get-tag-by-id source: | $Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to retrieve. # Get Tag By Id try { Get-BetaTagById -Id $Id # Below is a request that includes all optional parameters # Get-BetaTagById -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTagById" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/tags#get-tag-by-id source: | id = '329d96cf-3bdb-40a9-988a-b5037ab89022' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. try: # Get Tag By Id api_response = api_instance.get_tag_by_id(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_tag_by_id(id) print("The response of TagsApi->get_tag_by_id:\n") pprint(api_response) except Exception as e: print("Exception when calling TagsApi->get_tag_by_id: %s\n" % e) - path: /task-status/pending-tasks method: HEAD xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/task-management#get-pending-task-headers source: | $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # Retrieve Pending Task List Headers try { Get-BetaPendingTaskHeaders # Below is a request that includes all optional parameters # Get-BetaPendingTaskHeaders -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingTaskHeaders" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/task-management#get-pending-task-headers 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) try: # Retrieve Pending Task List Headers api_instance.get_pending_task_headers() # Below is a request that includes all optional parameters # api_instance.get_pending_task_headers(offset, limit, count) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/task-management#get-pending-tasks source: | $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # Retrieve Pending Task Status List try { Get-BetaPendingTasks # Below is a request that includes all optional parameters # Get-BetaPendingTasks -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingTasks" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/task-management#get-pending-tasks 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) try: # Retrieve Pending Task Status List api_response = api_instance.get_pending_tasks() # Below is a request that includes all optional parameters # api_response = api_instance.get_pending_tasks(offset, limit, count) print("The response of TaskManagementApi->get_pending_tasks:\n") pprint(api_response) except Exception as e: print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) - path: /task-status/{id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/task-management#get-task-status source: | $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. # Get Task Status by ID try { Get-BetaTaskStatus -Id $Id # Below is a request that includes all optional parameters # Get-BetaTaskStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaskStatus" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/task-management#get-task-status source: | id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. try: # Get Task Status by ID api_response = api_instance.get_task_status(id) # Below is a request that includes all optional parameters # api_response = api_instance.get_task_status(id) print("The response of TaskManagementApi->get_task_status:\n") pprint(api_response) except Exception as e: print("Exception when calling TaskManagementApi->get_task_status: %s\n" % e) - path: /task-status/{id} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/task-management#update-task-status source: | $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Update Task Status by ID try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation Update-BetaTaskStatus -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters # Update-BetaTaskStatus -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaTaskStatus" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/task-management#update-task-status source: | id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. [sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] | The JSONPatch payload used to update the object. json_patch_operation = { "op" : "replace", "path" : "/description", "value" : "New description" } # List[JsonPatchOperation] | The JSONPatch payload used to update the object. try: # Update Task Status by ID Result = json_patch_operation.from_json(json_patch_operation) api_response = api_instance.update_task_status(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.update_task_status(id, Result) print("The response of TaskManagementApi->update_task_status:\n") pprint(api_response) except Exception as e: print("Exception when calling TaskManagementApi->update_task_status: %s\n" % e) - path: /task-status method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/task-management#get-task-status-list source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 API Standard 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" # String | Sort results using the standard syntax described 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) # Retrieve Task Status List try { Get-BetaTaskStatusList # Below is a request that includes all optional parameters # Get-BetaTaskStatusList -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaskStatusList" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/task-management#get-task-status-list 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 = 'completionStatus eq \"Success\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) sorters = '-created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) try: # Retrieve Task Status List api_response = api_instance.get_task_status_list() # Below is a request that includes all optional parameters # api_response = api_instance.get_task_status_list(limit, offset, count, filters, sorters) print("The response of TaskManagementApi->get_task_status_list:\n") pprint(api_response) except Exception as e: print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) - path: /tenant method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/tenant#get-tenant source: | # Get Tenant Information. try { Get-BetaTenant # Below is a request that includes all optional parameters # Get-BetaTenant } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenant" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/tenant#get-tenant source: | try: # Get Tenant Information. api_response = api_instance.get_tenant() # Below is a request that includes all optional parameters # api_response = api_instance.get_tenant() print("The response of TenantApi->get_tenant:\n") pprint(api_response) except Exception as e: print("Exception when calling TenantApi->get_tenant: %s\n" % e) - path: /transforms method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/transforms#create-transform source: | $Transform = @" { "name" : "Timestamp To Date", "attributes" : { "input" : { "type" : "accountAttribute", "attributes" : { "attributeName" : "first_name", "sourceName" : "Source" } }, "accountSortAttribute" : "created", "accountReturnFirstLink" : false, "requiresPeriodicRefresh" : false, "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", "attributeName" : "DEPARTMENT", "accountSortDescending" : false, "sourceName" : "Workday", "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" }, "type" : "dateFormat" } "@ # Create transform try { $Result = ConvertFrom-JsonToTransform -Json $Transform New-BetaTransform -Transform $Result # Below is a request that includes all optional parameters # New-BetaTransform -Transform $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTransform" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/transforms#list-transforms source: | $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 # Int32 | Max number of results 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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" # String | Name of the transform to retrieve from the list. (optional) $Filters = "name eq "Uppercase"" # String | Filter results using the standard syntax described in [V3 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) # List transforms try { Get-BetaTransforms # Below is a request that includes all optional parameters # Get-BetaTransforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTransforms" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/transforms#delete-transform source: | $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete # Delete a transform try { Remove-BetaTransform -Id $Id # Below is a request that includes all optional parameters # Remove-BetaTransform -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTransform" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/transforms#get-transform source: | $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve # Transform by ID try { Get-BetaTransform -Id $Id # Below is a request that includes all optional parameters # Get-BetaTransform -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTransform" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/{id} method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/transforms#update-transform source: | $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update $Transform = @" { "name" : "Timestamp To Date", "attributes" : { "input" : { "type" : "accountAttribute", "attributes" : { "attributeName" : "first_name", "sourceName" : "Source" } }, "accountSortAttribute" : "created", "accountReturnFirstLink" : false, "requiresPeriodicRefresh" : false, "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", "attributeName" : "DEPARTMENT", "accountSortDescending" : false, "sourceName" : "Workday", "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" }, "type" : "dateFormat" } "@ # Update a transform try { Update-BetaTransform -Id $Id # Below is a request that includes all optional parameters # Update-BetaTransform -Id $Id -Transform $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaTransform" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/transforms#update-transform source: | id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to update # str | ID of the transform to update transform = { "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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/triggers#complete-trigger-invocation source: | $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the invocation to complete. $CompleteInvocation = @" { "output" : { "approved" : false }, "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", "error" : "Access request is denied." } "@ # Complete Trigger Invocation try { $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation Complete-BetaTriggerInvocation -Id $Id -CompleteInvocation $Result # Below is a request that includes all optional parameters # Complete-BetaTriggerInvocation -Id $Id -CompleteInvocation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaTriggerInvocation" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#complete-trigger-invocation source: | id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the invocation to complete. # str | The ID of the invocation to complete. complete_invocation = { "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, Result) # Below is a request that includes all optional parameters # api_instance.complete_trigger_invocation(id, Result) except Exception as e: print("Exception when calling TriggersApi->complete_trigger_invocation: %s\n" % e) - path: /trigger-subscriptions method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/triggers#create-subscription source: | $SubscriptionPostRequest = @" { "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 } "@ # Create a Subscription try { $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest New-BetaSubscription -SubscriptionPostRequest $Result # Below is a request that includes all optional parameters # New-BetaSubscription -SubscriptionPostRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSubscription" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#create-subscription source: | 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(Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_subscription(Result) print("The response of TriggersApi->create_subscription:\n") pprint(api_response) except Exception as e: print("Exception when calling TriggersApi->create_subscription: %s\n" % e) - path: /trigger-subscriptions method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/triggers#list-subscriptions source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 API Standard 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" # String | Sort results using the standard syntax described 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) # List Subscriptions try { Get-BetaSubscriptions # Below is a request that includes all optional parameters # Get-BetaSubscriptions -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSubscriptions" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#list-subscriptions 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 \"12cff757-c0c0-413b-8ad7-2a47956d1e89\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) sorters = 'triggerName' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) try: # List Subscriptions api_response = api_instance.list_subscriptions() # Below is a request that includes all optional parameters # api_response = api_instance.list_subscriptions(limit, offset, count, filters, sorters) print("The response of TriggersApi->list_subscriptions:\n") pprint(api_response) except Exception as e: print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) - path: /trigger-subscriptions/{id} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/triggers#delete-subscription source: | $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID # Delete a Subscription try { Remove-BetaSubscription -Id $Id # Below is a request that includes all optional parameters # Remove-BetaSubscription -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSubscription" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#delete-subscription source: | id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID try: # Delete a Subscription api_instance.delete_subscription(id) # Below is a request that includes all optional parameters # api_instance.delete_subscription(id) except Exception as e: print("Exception when calling TriggersApi->delete_subscription: %s\n" % e) - path: /trigger-subscriptions/{id} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/triggers#patch-subscription source: | $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription to patch $SubscriptionPatchRequestInner = @""@ # Patch a Subscription try { $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner Update-BetaSubscription -Id $Id -SubscriptionPatchRequestInner $Result # Below is a request that includes all optional parameters # Update-BetaSubscription -Id $Id -SubscriptionPatchRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#patch-subscription source: | id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | ID of the Subscription to patch # str | ID of the Subscription to patch [sailpoint.beta.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] | subscription_patch_request_inner = [sailpoint.beta.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] | try: # Patch a Subscription Result = subscription_patch_request_inner.from_json(subscription_patch_request_inner) api_response = api_instance.patch_subscription(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.patch_subscription(id, Result) print("The response of TriggersApi->patch_subscription:\n") pprint(api_response) except Exception as e: print("Exception when calling TriggersApi->patch_subscription: %s\n" % e) - path: /trigger-subscriptions/{id} method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/triggers#update-subscription source: | $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID $SubscriptionPutRequest = @" { "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 } "@ # Update a Subscription try { $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest Update-BetaSubscription -Id $Id -SubscriptionPutRequest $Result # Below is a request that includes all optional parameters # Update-BetaSubscription -Id $Id -SubscriptionPutRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#update-subscription source: | id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID subscription_put_request = { "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, Result) # Below is a request that includes all optional parameters # api_response = api_instance.update_subscription(id, Result) print("The response of TriggersApi->update_subscription:\n") pprint(api_response) except Exception as e: print("Exception when calling TriggersApi->update_subscription: %s\n" % e) - path: /trigger-invocations/status method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/triggers#list-trigger-invocation-status source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 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" # String | Sort results using the standard syntax described 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) # List Latest Invocation Statuses try { Get-BetaTriggerInvocationStatus # Below is a request that includes all optional parameters # Get-BetaTriggerInvocationStatus -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTriggerInvocationStatus" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#list-trigger-invocation-status 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 = 'triggerId eq \"idn:access-request-dynamic-approver\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) sorters = 'created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) try: # List Latest Invocation Statuses api_response = api_instance.list_trigger_invocation_status() # Below is a request that includes all optional parameters # api_response = api_instance.list_trigger_invocation_status(limit, offset, count, filters, sorters) print("The response of TriggersApi->list_trigger_invocation_status:\n") pprint(api_response) except Exception as e: print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) - path: /triggers method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/triggers#list-triggers source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 API Standard 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" # String | Sort results using the standard syntax described 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) # List Triggers try { Get-BetaTriggers # Below is a request that includes all optional parameters # Get-BetaTriggers -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTriggers" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#list-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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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() # Below is a request that includes all optional parameters # api_response = api_instance.list_triggers(limit, offset, count, filters, sorters) print("The response of TriggersApi->list_triggers:\n") pprint(api_response) except Exception as e: print("Exception when calling TriggersApi->list_triggers: %s\n" % e) - path: /trigger-invocations/test method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/triggers#start-test-trigger-invocation source: | $TestInvocation = @" { "input" : { "identityId" : "201327fda1c44704ac01181e963d463c" }, "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], "triggerId" : "idn:access-request-post-approval", "contentJson" : { "workflowId" : 1234 } } "@ # Start a Test Invocation try { $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation Start-BetaTestTriggerInvocation -TestInvocation $Result # Below is a request that includes all optional parameters # Start-BetaTestTriggerInvocation -TestInvocation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaTestTriggerInvocation" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#start-test-trigger-invocation source: | 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(Result) # Below is a request that includes all optional parameters # api_response = api_instance.start_test_trigger_invocation(Result) print("The response of TriggersApi->start_test_trigger_invocation:\n") pprint(api_response) except Exception as e: print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) - path: /trigger-subscriptions/validate-filter method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/triggers#test-subscription-filter source: | $ValidateFilterInputDto = @" { "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", "input" : { "identityId" : "201327fda1c44704ac01181e963d463c" } } "@ # Validate a Subscription Filter try { $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto Test-BetaSubscriptionFilter -ValidateFilterInputDto $Result # Below is a request that includes all optional parameters # Test-BetaSubscriptionFilter -ValidateFilterInputDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSubscriptionFilter" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/triggers#test-subscription-filter source: | validate_filter_input_dto = { "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", "input" : { "identityId" : "201327fda1c44704ac01181e963d463c" } } # ValidateFilterInputDto | try: # Validate a Subscription Filter Result = validate_filter_input_dto.from_json(validate_filter_input_dto) api_response = api_instance.test_subscription_filter(Result) # Below is a request that includes all optional parameters # api_response = api_instance.test_subscription_filter(Result) print("The response of TriggersApi->test_subscription_filter:\n") pprint(api_response) except Exception as e: print("Exception when calling TriggersApi->test_subscription_filter: %s\n" % e) - path: /ui-metadata/tenant method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/ui-metadata#get-tenant-ui-metadata source: | # Get a tenant UI metadata try { Get-BetaTenantUiMetadata # Below is a request that includes all optional parameters # Get-BetaTenantUiMetadata } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantUiMetadata" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/ui-metadata#get-tenant-ui-metadata source: | try: # Get a tenant UI metadata api_response = api_instance.get_tenant_ui_metadata() # Below is a request that includes all optional parameters # api_response = api_instance.get_tenant_ui_metadata() print("The response of UIMetadataApi->get_tenant_ui_metadata:\n") pprint(api_response) except Exception as e: print("Exception when calling UIMetadataApi->get_tenant_ui_metadata: %s\n" % e) - path: /ui-metadata/tenant method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/ui-metadata#set-tenant-ui-metadata source: | $TenantUiMetadataItemUpdateRequest = @" { "usernameEmptyText" : "Please provide your work email address...", "usernameLabel" : "Email", "iframeWhiteList" : "http://example.com http://example2.com" } "@ # Update tenant UI metadata try { $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest Set-BetaTenantUiMetadata -TenantUiMetadataItemUpdateRequest $Result # Below is a request that includes all optional parameters # Set-BetaTenantUiMetadata -TenantUiMetadataItemUpdateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTenantUiMetadata" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/ui-metadata#set-tenant-ui-metadata source: | tenant_ui_metadata_item_update_request = { "usernameEmptyText" : "Please provide your work email address...", "usernameLabel" : "Email", "iframeWhiteList" : "http://example.com http://example2.com" } # TenantUiMetadataItemUpdateRequest | try: # Update tenant UI metadata Result = tenant_ui_metadata_item_update_request.from_json(tenant_ui_metadata_item_update_request) api_response = api_instance.set_tenant_ui_metadata(Result) # Below is a request that includes all optional parameters # api_response = api_instance.set_tenant_ui_metadata(Result) print("The response of UIMetadataApi->set_tenant_ui_metadata:\n") pprint(api_response) except Exception as e: print("Exception when calling UIMetadataApi->set_tenant_ui_metadata: %s\n" % e) - path: /vendor-connector-mappings method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/vendor-connector-mappings#create-vendor-connector-mapping source: | $VendorConnectorMapping = @" { "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" } } "@ # Create Vendor Connector Mapping try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping New-BetaVendorConnectorMapping -VendorConnectorMapping $Result # Below is a request that includes all optional parameters # New-BetaVendorConnectorMapping -VendorConnectorMapping $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVendorConnectorMapping" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/vendor-connector-mappings#delete-vendor-connector-mapping source: | $VendorConnectorMapping = @" { "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" } } "@ # Delete Vendor Connector Mapping try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping Remove-BetaVendorConnectorMapping -VendorConnectorMapping $Result # Below is a request that includes all optional parameters # Remove-BetaVendorConnectorMapping -VendorConnectorMapping $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVendorConnectorMapping" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/vendor-connector-mappings#get-vendor-connector-mappings source: | # List Vendor Connector Mappings try { Get-BetaVendorConnectorMappings # Below is a request that includes all optional parameters # Get-BetaVendorConnectorMappings } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaVendorConnectorMappings" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/vendor-connector-mappings#get-vendor-connector-mappings source: | try: # List Vendor Connector Mappings api_response = api_instance.get_vendor_connector_mappings() # Below is a request that includes all optional parameters # api_response = api_instance.get_vendor_connector_mappings() print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") pprint(api_response) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-items#approve-approval-item source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. # Approve an Approval Item try { Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId # Below is a request that includes all optional parameters # Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItem" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-items#approve-approval-items-in-bulk source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item # Bulk approve Approval Items try { Approve-BetaApprovalItemsInBulk -Id $Id # Below is a request that includes all optional parameters # Approve-BetaApprovalItemsInBulk -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItemsInBulk" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-items#complete-work-item source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item # Complete a Work Item try { Complete-BetaWorkItem -Id $Id # Below is a request that includes all optional parameters # Complete-BetaWorkItem -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/work-items#complete-work-item source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item try: # Complete a Work Item api_response = api_instance.complete_work_item(id) # Below is a request that includes all optional parameters # api_response = api_instance.complete_work_item(id) 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} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-item source: | $Id = "MyId" # String | ID of the work item. $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) # Get a Work Item try { Get-BetaWorkItem -Id $Id # Below is a request that includes all optional parameters # Get-BetaWorkItem -Id $Id -OwnerId $OwnerId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItem" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/work-items#get-work-item source: | id = 'id_example' # str | ID of the work item. # str | ID of the work item. owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) try: # Get a Work Item api_response = api_instance.get_work_item(id, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_work_item(id, owner_id) print("The response of WorkItemsApi->get_work_item:\n") pprint(api_response) except Exception as e: print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) - path: /work-items/{id}/forward method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-items#forward-work-item source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $WorkItemForward = @" { "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", "comment" : "I'm going on vacation.", "sendNotifications" : true } "@ # Forward a Work Item try { $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward Invoke-BetaForwardWorkItem -Id $Id -WorkItemForward $Result # Below is a request that includes all optional parameters # Invoke-BetaForwardWorkItem -Id $Id -WorkItemForward $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardWorkItem" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/work-items#forward-work-item source: | id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item work_item_forward = { "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, Result) # Below is a request that includes all optional parameters # api_instance.forward_work_item(id, Result) except Exception as e: print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e) - path: /work-items/completed method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-items#get-completed-work-items source: | $OwnerId = "MyOwnerId" # String | 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 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) # Completed Work Items try { Get-BetaCompletedWorkItems # Below is a request that includes all optional parameters # Get-BetaCompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedWorkItems" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/work-items#get-completed-work-items source: | owner_id = 'owner_id_example' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-items#get-count-completed-work-items source: | $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) # Count Completed Work Items try { Get-BetaCountCompletedWorkItems # Below is a request that includes all optional parameters # Get-BetaCountCompletedWorkItems -OwnerId $OwnerId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountCompletedWorkItems" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/work-items#get-count-completed-work-items source: | owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) try: # Count Completed Work Items api_response = api_instance.get_count_completed_work_items() # Below is a request that includes all optional parameters # api_response = api_instance.get_count_completed_work_items(owner_id) print("The response of WorkItemsApi->get_count_completed_work_items:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-items#get-count-work-items source: | $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) # Count Work Items try { Get-BetaCountWorkItems # Below is a request that includes all optional parameters # Get-BetaCountWorkItems -OwnerId $OwnerId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountWorkItems" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/work-items#get-count-work-items source: | owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) try: # Count Work Items api_response = api_instance.get_count_work_items() # Below is a request that includes all optional parameters # api_response = api_instance.get_count_work_items(owner_id) print("The response of WorkItemsApi->get_count_work_items:\n") pprint(api_response) except Exception as e: print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) - path: /work-items/summary method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-items-summary source: | $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) # Work Items Summary try { Get-BetaWorkItemsSummary # Below is a request that includes all optional parameters # Get-BetaWorkItemsSummary -OwnerId $OwnerId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItemsSummary" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/work-items#get-work-items-summary source: | owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) try: # Work Items Summary api_response = api_instance.get_work_items_summary() # Below is a request that includes all optional parameters # api_response = api_instance.get_work_items_summary(owner_id) print("The response of WorkItemsApi->get_work_items_summary:\n") pprint(api_response) except Exception as e: print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) - path: /work-items method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-items#list-work-items source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) # List Work Items try { Get-BetaWorkItems # Below is a request that includes all optional parameters # Get-BetaWorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItems" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) try: # List Work Items api_response = api_instance.list_work_items() # Below is a request that includes all optional parameters # api_response = api_instance.list_work_items(limit, offset, count, owner_id) print("The response of WorkItemsApi->list_work_items:\n") pprint(api_response) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-items#reject-approval-item source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. # Reject an Approval Item try { Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId # Below is a request that includes all optional parameters # Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItem" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-items#reject-approval-items-in-bulk source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item # Bulk reject Approval Items try { Deny-BetaApprovalItemsInBulk -Id $Id # Below is a request that includes all optional parameters # Deny-BetaApprovalItemsInBulk -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItemsInBulk" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-items#submit-account-selection source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName # Submit Account Selections try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody Submit-BetaAccountSelection -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters # Submit-BetaAccountSelection -Id $Id -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaAccountSelection" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#create-reassignment-configuration source: | $ConfigurationItemRequest = @" { "endDate" : "2022-07-30T17:00:00Z", "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", "configType" : "ACCESS_REQUESTS", "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", "startDate" : "2022-07-21T11:13:12.345Z" } "@ # Create a Reassignment Configuration try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest New-BetaReassignmentConfiguration -ConfigurationItemRequest $Result # Below is a request that includes all optional parameters # New-BetaReassignmentConfiguration -ConfigurationItemRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaReassignmentConfiguration" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/work-reassignment#create-reassignment-configuration source: | configuration_item_request = { "endDate" : "2022-07-30T17:00:00Z", "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", "configType" : "ACCESS_REQUESTS", "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", "startDate" : "2022-07-21T11:13:12.345Z" } # ConfigurationItemRequest | try: # Create a Reassignment Configuration Result = configuration_item_request.from_json(configuration_item_request) api_response = api_instance.create_reassignment_configuration(Result) # Below is a request that includes all optional parameters # api_response = api_instance.create_reassignment_configuration(Result) print("The response of WorkReassignmentApi->create_reassignment_configuration:\n") pprint(api_response) except Exception as e: print("Exception when calling WorkReassignmentApi->create_reassignment_configuration: %s\n" % e) - path: /reassignment-configurations method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#list-reassignment-configurations source: | $Limit = 20 # Int32 | Max number of results to return. (optional) (default to 20) $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # List Reassignment Configurations try { Get-BetaReassignmentConfigurations # Below is a request that includes all optional parameters # Get-BetaReassignmentConfigurations -Limit $Limit -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigurations" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/work-reassignment#list-reassignment-configurations source: | limit = 20 # int | Max number of results to return. (optional) (default to 20) # int | Max number of results to return. (optional) (default to 20) offset = 10 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) try: # List Reassignment Configurations api_response = api_instance.list_reassignment_configurations() # Below is a request that includes all optional parameters # api_response = api_instance.list_reassignment_configurations(limit, offset) print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") pprint(api_response) except Exception as e: print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) - path: /reassignment-configurations/{identityId}/{configType} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#delete-reassignment-configuration source: | $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | # Delete Reassignment Configuration try { Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType # Below is a request that includes all optional parameters # Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaReassignmentConfiguration" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/work-reassignment#delete-reassignment-configuration source: | identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id config_type = sailpoint.beta.ConfigTypeEnum() # ConfigTypeEnum | # ConfigTypeEnum | try: # Delete Reassignment Configuration api_instance.delete_reassignment_configuration(identity_id, config_type) # Below is a request that includes all optional parameters # api_instance.delete_reassignment_configuration(identity_id, config_type) 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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-evaluate-reassignment-configuration source: | $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type $ExclusionFilters = "MyExclusionFilters" # String[] | 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) $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ # Evaluate Reassignment Configuration try { Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType # Below is a request that includes all optional parameters # Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -ExclusionFilters $ExclusionFilters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEvaluateReassignmentConfiguration" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/work-reassignment#get-evaluate-reassignment-configuration source: | identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id config_type = sailpoint.beta.ConfigTypeEnum() # ConfigTypeEnum | Reassignment work type # ConfigTypeEnum | Reassignment work type exclusion_filters = ['SELF_REVIEW_DELEGATION'] # List[str] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) exclusion_filters = ['SELF_REVIEW_DELEGATION'] # List[str] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) try: # Evaluate Reassignment Configuration api_response = api_instance.get_evaluate_reassignment_configuration(identity_id, config_type, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_evaluate_reassignment_configuration(identity_id, config_type, exclusion_filters) print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") pprint(api_response) except Exception as e: print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) - path: /reassignment-configurations/types method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-reassignment-config-types source: | # List Reassignment Config Types try { Get-BetaReassignmentConfigTypes # Below is a request that includes all optional parameters # Get-BetaReassignmentConfigTypes } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigTypes" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/work-reassignment#get-reassignment-config-types source: | try: # List Reassignment Config Types api_response = api_instance.get_reassignment_config_types() # Below is a request that includes all optional parameters # api_response = api_instance.get_reassignment_config_types() print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") pprint(api_response) except Exception as e: print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) - path: /reassignment-configurations/{identityId} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-reassignment-configuration source: | $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id # Get Reassignment Configuration try { Get-BetaReassignmentConfiguration -IdentityId $IdentityId # Below is a request that includes all optional parameters # Get-BetaReassignmentConfiguration -IdentityId $IdentityId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfiguration" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/work-reassignment#get-reassignment-configuration source: | identity_id = '2c91808781a71ddb0181b9090b5c504f' # str | unique identity id # str | unique identity id try: # Get Reassignment Configuration api_response = api_instance.get_reassignment_configuration(identity_id) # Below is a request that includes all optional parameters # api_response = api_instance.get_reassignment_configuration(identity_id) print("The response of WorkReassignmentApi->get_reassignment_configuration:\n") pprint(api_response) except Exception as e: print("Exception when calling WorkReassignmentApi->get_reassignment_configuration: %s\n" % e) - path: /reassignment-configurations/{identityId} method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#put-reassignment-config source: | $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id $ConfigurationItemRequest = @" { "endDate" : "2022-07-30T17:00:00Z", "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", "configType" : "ACCESS_REQUESTS", "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", "startDate" : "2022-07-21T11:13:12.345Z" } "@ # Update Reassignment Configuration try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest Send-BetaReassignmentConfig -IdentityId $IdentityId -ConfigurationItemRequest $Result # Below is a request that includes all optional parameters # Send-BetaReassignmentConfig -IdentityId $IdentityId -ConfigurationItemRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaReassignmentConfig" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/work-reassignment#put-reassignment-config source: | identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id configuration_item_request = { "endDate" : "2022-07-30T17:00:00Z", "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", "configType" : "ACCESS_REQUESTS", "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", "startDate" : "2022-07-21T11:13:12.345Z" } # ConfigurationItemRequest | try: # Update Reassignment Configuration Result = configuration_item_request.from_json(configuration_item_request) api_response = api_instance.put_reassignment_config(identity_id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.put_reassignment_config(identity_id, Result) print("The response of WorkReassignmentApi->put_reassignment_config:\n") pprint(api_response) except Exception as e: print("Exception when calling WorkReassignmentApi->put_reassignment_config: %s\n" % e) - path: /reassignment-configurations/tenant-config method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-tenant-config-configuration source: | # Get Tenant-wide Reassignment Configuration settings try { Get-BetaTenantConfigConfiguration # Below is a request that includes all optional parameters # Get-BetaTenantConfigConfiguration } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantConfigConfiguration" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/work-reassignment#get-tenant-config-configuration source: | try: # Get Tenant-wide Reassignment Configuration settings api_response = api_instance.get_tenant_config_configuration() # Below is a request that includes all optional parameters # api_response = api_instance.get_tenant_config_configuration() print("The response of WorkReassignmentApi->get_tenant_config_configuration:\n") pprint(api_response) except Exception as e: print("Exception when calling WorkReassignmentApi->get_tenant_config_configuration: %s\n" % e) - path: /reassignment-configurations/tenant-config method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#put-tenant-configuration source: | $TenantConfigurationRequest = @" { "configDetails" : { "disabled" : true } } "@ # Update Tenant-wide Reassignment Configuration settings try { $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest Send-BetaTenantConfiguration -TenantConfigurationRequest $Result # Below is a request that includes all optional parameters # Send-BetaTenantConfiguration -TenantConfigurationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTenantConfiguration" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/work-reassignment#put-tenant-configuration source: | tenant_configuration_request = { "configDetails" : { "disabled" : true } } # TenantConfigurationRequest | try: # Update Tenant-wide Reassignment Configuration settings Result = tenant_configuration_request.from_json(tenant_configuration_request) api_response = api_instance.put_tenant_configuration(Result) # Below is a request that includes all optional parameters # api_response = api_instance.put_tenant_configuration(Result) print("The response of WorkReassignmentApi->put_tenant_configuration:\n") pprint(api_response) except Exception as e: print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) - path: /workflow-executions/{id}/cancel method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/workflows#cancel-workflow-execution source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID # Cancel Workflow Execution by ID try { Suspend-BetaWorkflowExecution -Id $Id # Below is a request that includes all optional parameters # Suspend-BetaWorkflowExecution -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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 method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/workflows#create-workflow source: | $CreateWorkflowRequest = @" {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')]}}} "@ # Create Workflow try { $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest New-BetaWorkflow -CreateWorkflowRequest $Result # Below is a request that includes all optional parameters # New-BetaWorkflow -CreateWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#create-workflow source: | create_workflow_request = {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} # CreateWorkflowRequest | 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 method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflows source: | # List Workflows try { Get-BetaWorkflows # Below is a request that includes all optional parameters # Get-BetaWorkflows } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#list-workflows source: | try: # List Workflows api_response = api_instance.list_workflows() # Below is a request that includes all optional parameters # api_response = api_instance.list_workflows() print("The response of WorkflowsApi->list_workflows:\n") pprint(api_response) except Exception as e: print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) - path: /workflows/{id} method: DELETE xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/workflows#delete-workflow source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow # Delete Workflow By Id try { Remove-BetaWorkflow -Id $Id # Below is a request that includes all optional parameters # Remove-BetaWorkflow -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow # Get Workflow By Id try { Get-BetaWorkflow -Id $Id # Below is a request that includes all optional parameters # Get-BetaWorkflow -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: /workflows/{id} method: PATCH xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/workflows#patch-workflow source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Patch Workflow try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters # Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#patch-workflow source: | id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow [{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}] # List[JsonPatchOperation] | json_patch_operation = { "op" : "replace", "path" : "/description", "value" : "New description" } # List[JsonPatchOperation] | try: # Patch Workflow Result = json_patch_operation.from_json(json_patch_operation) api_response = api_instance.patch_workflow(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.patch_workflow(id, Result) print("The response of WorkflowsApi->patch_workflow:\n") pprint(api_response) except Exception as e: print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) - path: /workflows/{id} method: PUT xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/workflows#update-workflow source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow $WorkflowBody = @" { "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" : "description", "id" : "idn:identity-attributes-changed", "filter.$" : "$.changes[?(@.attribute == 'manager')]" }, "type" : "EVENT" }, "enabled" : false } "@ # Update Workflow try { $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody Update-BetaWorkflow -Id $Id -WorkflowBody $Result # Below is a request that includes all optional parameters # Update-BetaWorkflow -Id $Id -WorkflowBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#update-workflow source: | id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow workflow_body = { "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" : "description", "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.update_workflow(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.update_workflow(id, Result) print("The response of WorkflowsApi->update_workflow:\n") pprint(api_response) except Exception as e: print("Exception when calling WorkflowsApi->update_workflow: %s\n" % e) - path: /workflow-executions/{id} method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. # Get Workflow Execution try { Get-BetaWorkflowExecution -Id $Id # Below is a request that includes all optional parameters # Get-BetaWorkflowExecution -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution-history source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution # Get Workflow Execution History try { Get-BetaWorkflowExecutionHistory -Id $Id # Below is a request that includes all optional parameters # Get-BetaWorkflowExecutionHistory -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-executions source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # List Workflow Executions try { Get-BetaWorkflowExecutions -Id $Id # Below is a request that includes all optional parameters # Get-BetaWorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) try: # List Workflow Executions api_response = api_instance.get_workflow_executions(id, ) # Below is a request that includes all optional parameters # api_response = api_instance.get_workflow_executions(id, limit, offset, count, filters) print("The response of WorkflowsApi->get_workflow_executions:\n") pprint(api_response) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) - path: /workflow-library method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/workflows#list-complete-workflow-library source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # List Complete Workflow Library try { Get-BetaCompleteWorkflowLibrary # Below is a request that includes all optional parameters # Get-BetaCompleteWorkflowLibrary -Limit $Limit -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-actions source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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"" # String | Filter results using the standard syntax described in [V3 API Standard 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) # List Workflow Library Actions try { Get-BetaWorkflowLibraryActions # Below is a request that includes all optional parameters # Get-BetaWorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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: PowerShell label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-operators source: | # List Workflow Library Operators try { Get-BetaWorkflowLibraryOperators # Below is a request that includes all optional parameters # Get-BetaWorkflowLibraryOperators } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#list-workflow-library-operators source: | try: # List Workflow Library Operators api_response = api_instance.list_workflow_library_operators() # Below is a request that includes all optional parameters # api_response = api_instance.list_workflow_library_operators() print("The response of WorkflowsApi->list_workflow_library_operators:\n") pprint(api_response) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) - path: /workflow-library/triggers method: GET xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-triggers source: | $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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"" # String | Filter results using the standard syntax described in [V3 API Standard 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) # List Workflow Library Triggers try { Get-BetaWorkflowLibraryTriggers # Below is a request that includes all optional parameters # Get-BetaWorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/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/execute/external/{id} method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/workflows#post-external-execute-workflow source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow $PostExternalExecuteWorkflowRequest = @" "@ # Execute Workflow via External Trigger try { Submit-BetaExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters # Submit-BetaExternalExecuteWorkflow -Id $Id -PostExternalExecuteWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#post-external-execute-workflow source: | id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow post_external_execute_workflow_request = sailpoint.beta.PostExternalExecuteWorkflowRequest() # PostExternalExecuteWorkflowRequest | (optional) try: # Execute Workflow via External Trigger api_response = api_instance.post_external_execute_workflow(id, ) # Below is a request that includes all optional parameters # api_response = api_instance.post_external_execute_workflow(id, Result) print("The response of WorkflowsApi->post_external_execute_workflow:\n") pprint(api_response) except Exception as e: print("Exception when calling WorkflowsApi->post_external_execute_workflow: %s\n" % e) - path: /workflows/{id}/external/oauth-clients method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/workflows#post-workflow-external-trigger source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow # Generate External Trigger OAuth Client try { Submit-BetaWorkflowExternalTrigger -Id $Id # Below is a request that includes all optional parameters # Submit-BetaWorkflowExternalTrigger -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#post-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.post_workflow_external_trigger(id) # Below is a request that includes all optional parameters # api_response = api_instance.post_workflow_external_trigger(id) print("The response of WorkflowsApi->post_workflow_external_trigger:\n") pprint(api_response) except Exception as e: print("Exception when calling WorkflowsApi->post_workflow_external_trigger: %s\n" % e) - path: /workflows/execute/external/{id}/test method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/workflows#test-external-execute-workflow source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow $TestExternalExecuteWorkflowRequest = @" "@ # Test Workflow via External Trigger try { Test-BetaExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters # Test-BetaExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#test-external-execute-workflow source: | id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow test_external_execute_workflow_request = sailpoint.beta.TestExternalExecuteWorkflowRequest() # TestExternalExecuteWorkflowRequest | (optional) try: # Test Workflow via External Trigger api_response = api_instance.test_external_execute_workflow(id, ) # Below is a request that includes all optional parameters # api_response = api_instance.test_external_execute_workflow(id, Result) print("The response of WorkflowsApi->test_external_execute_workflow:\n") pprint(api_response) except Exception as e: print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) - path: /workflows/{id}/test method: POST xCodeSample: - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/workflows#test-workflow source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow $TestWorkflowRequest = @" {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}]}} "@ # Test Workflow By Id try { $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result # Below is a request that includes all optional parameters # Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" Write-Host $_.ErrorDetails } - lang: Python label: SDK_tools/sdk/python/beta/methods/workflows#test-workflow source: | id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow test_workflow_request = {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} # TestWorkflowRequest | try: # Test Workflow By Id Result = test_workflow_request.from_json(test_workflow_request) api_response = api_instance.test_workflow(id, Result) # Below is a request that includes all optional parameters # api_response = api_instance.test_workflow(id, Result) print("The response of WorkflowsApi->test_workflow:\n") pprint(api_response) except Exception as e: print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e)