--- id: sod-violations title: SODViolations pagination_label: SODViolations sidebar_label: SODViolations sidebar_class_name: powershellsdk keywords: ['powershell', 'PowerShell', 'sdk', 'SODViolations', 'SODViolations'] slug: /tools/sdk/powershell/v3/methods/sod-violations tags: ['SDK', 'Software Development Kit', 'SODViolations', 'SODViolations'] --- # SODViolations Use this API to check for current "separation of duties" (SOD) policy violations as well as potential future SOD policy violations. With SOD violation functionality in place, administrators can get information about current SOD policy violations and predict whether an access change will trigger new violations, which helps to prevent them from occurring at all. "Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. Any changes to major system configurations should be approved by someone other than the person requesting the change. Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. Once a SOD policy is in place, if an identity has conflicting access items, a SOD violation will trigger. These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. The other users can then better help to enforce these SOD policies. Administrators can use the SOD violations APIs to check a set of identities for any current SOD violations, and they can use them to check whether adding an access item would potentially trigger a SOD violation. This second option is a good way to prevent SOD violations from triggering at all. Refer to [Handling Policy Violations](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html) for more information about SOD policy violations. All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**Start-PredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity. [**Start-ViolationCheck**](#start-violation-check) | **POST** `/sod-violations/check` | Check SOD violations ## start-predict-sod-violations This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. [API Spec](https://developer.sailpoint.com/docs/api/v3/start-predict-sod-violations) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Body | IdentityWithNewAccess | [**IdentityWithNewAccess**](../models/identity-with-new-access) | True | ### Return type [**ViolationPrediction**](../models/violation-prediction) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- 200 | Violation Contexts | ViolationPrediction 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto 429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### Example ```powershell $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-PredictSodViolations -IdentityWithNewAccess $Result # Below is a request that includes all optional parameters # Start-PredictSodViolations -IdentityWithNewAccess $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-PredictSodViolations" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) ## start-violation-check This API initiates a SOD policy verification asynchronously. [API Spec](https://developer.sailpoint.com/docs/api/v3/start-violation-check) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Body | IdentityWithNewAccess1 | [**IdentityWithNewAccess1**](../models/identity-with-new-access1) | True | ### Return type [**SodViolationCheck**](../models/sod-violation-check) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- 202 | Request ID with a timestamp. | SodViolationCheck 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto 429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### Example ```powershell $IdentityWithNewAccess1 = @"{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}"@ # Check SOD violations try { $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 Start-ViolationCheck -IdentityWithNewAccess1 $Result # Below is a request that includes all optional parameters # Start-ViolationCheck -IdentityWithNewAccess1 $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck" Write-Host $_.ErrorDetails } ``` [[Back to top]](#)