developer.sailpoint.com/docs/tools/sdk/python/Reference/Beta/Methods/SODPoliciesApi.md

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

id	title	pagination_label	sidebar_label	sidebar_class_name	keywords	slug	tags
beta-sod-policies	SOD_Policies	SOD_Policies	SOD_Policies	pythonsdk	python Python sdk SOD_Policies BetaSOD_Policies	/tools/sdk/python/beta/methods/sod-policies	SDK Software Development Kit SOD_Policies BetaSOD_Policies

sailpoint.beta.SODPoliciesApi

Use this API to implement and manage "separation of duties" (SOD) policies. With SOD policy functionality in place, administrators can organize the access in their tenants to prevent individuals from gaining conflicting or excessive access.

"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.

To create SOD policies in Identity Security Cloud, administrators use 'Search' and then access 'Policies'. To create a policy, they must configure two lists of access items. Each access item can only be added to one of the two lists. They can search for the entitlements they want to add to these access lists.

>Note: You can have a maximum of 500 policies of any type (including general policies) in your organization. In each access-based SOD policy, you can have a maximum of 50 entitlements in each access list.

Once a SOD policy is in place, if an identity has access items on both lists, 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.

To create a subscription to a SOD policy in Identity Security Cloud, administrators use 'Search' and then access 'Layers'. They can create a subscription to the policy and schedule it to run at a regular interval.

Refer to Managing Policies for more information about SOD policies.

Refer to Subscribe to a SOD Policy for more information about SOD policy subscriptions.

All URIs are relative to https://sailpoint.api.identitynow.com/beta

Method	HTTP request	Description
create_sod_policy	POST /sod-policies	Create SOD policy
delete_sod_policy	DELETE /sod-policies/{id}	Delete SOD policy by ID
delete_sod_policy_schedule	DELETE /sod-policies/{id}/schedule	Delete SOD policy schedule
get_custom_violation_report	GET /sod-violation-report/{reportResultId}/download/{fileName}	Download custom violation report
get_default_violation_report	GET /sod-violation-report/{reportResultId}/download	Download violation report
get_sod_all_report_run_status	GET /sod-violation-report	Get multi-report run task status
get_sod_policy	GET /sod-policies/{id}	Get SOD policy by ID
get_sod_policy_schedule	GET /sod-policies/{id}/schedule	Get SOD policy schedule
get_sod_violation_report_run_status	GET /sod-policies/sod-violation-report-status/{reportResultId}	Get violation report run status
get_sod_violation_report_status	GET /sod-policies/{id}/violation-report	Get SOD violation report status
list_sod_policies	GET /sod-policies	List SOD policies
patch_sod_policy	PATCH /sod-policies/{id}	Patch a SOD policy
put_policy_schedule	PUT /sod-policies/{id}/schedule	Update SOD Policy schedule
put_sod_policy	PUT /sod-policies/{id}	Update SOD policy by ID
start_sod_all_policies_for_org	POST /sod-violation-report/run	Runs all policies for org
start_sod_policy	POST /sod-policies/{id}/violation-report/run	Runs SOD policy violation report

create-sod-policy

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: Create SOD policy This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	sod_policy	SodPolicy	True

Return type

SodPolicy

Responses

Code	Description	Data Type	Response headers
201	SOD policy created	SodPolicy	-
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.	ListAccessModelMetadataAttribute401Response	-
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	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.	ListAccessModelMetadataAttribute429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.models.sod_policy import SodPolicy
from sailpoint.beta.rest import ApiException
from pprint import pprint

    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)

[Back to top]

delete-sod-policy

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: Delete SOD policy by ID This deletes a specified SOD policy. Requires role of ORG_ADMIN.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	id	str	True	The ID of the SOD Policy to delete.
Query	logical	bool	(optional) (default to True)	Indicates whether this is a soft delete (logical true) or a hard delete.

Return type

(empty response body)

Responses

Code	Description	Data Type	Response headers
204	No content.		-
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.	ListAccessModelMetadataAttribute401Response	-
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.	ListAccessModelMetadataAttribute429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.rest import ApiException
from pprint import pprint

    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)

[Back to top]

delete-sod-policy-schedule

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: Delete SOD policy schedule This deletes schedule for a specified SOD policy. Requires role of ORG_ADMIN.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	id	str	True	The ID of the SOD policy the schedule must be deleted for.

Return type

(empty response body)

Responses

Code	Description	Data Type	Response headers
204	No content.		-
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.	ListAccessModelMetadataAttribute401Response	-
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.	ListAccessModelMetadataAttribute429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.rest import ApiException
from pprint import pprint

    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)

[Back to top]

get-custom-violation-report

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: Download custom violation report This allows to download a specified named violation report for a given report reference. Requires role of ORG_ADMIN.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	report_result_id	str	True	The ID of the report reference to download.
Path	file_name	str	True	Custom Name for the file.

Return type

bytearray

Responses

Code	Description	Data Type	Response headers
200	Returns the zip file with given custom name that contains the violation report file.	bytearray	-
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.	ListAccessModelMetadataAttribute401Response	-
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.	ListAccessModelMetadataAttribute429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

• Content-Type: Not defined
• Accept: application/zip, application/json

Example

import sailpoint.beta
from sailpoint.beta.rest import ApiException
from pprint import pprint

    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)

[Back to top]

get-default-violation-report

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: Download violation report This allows to download a violation report for a given report reference. Requires role of ORG_ADMIN.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	report_result_id	str	True	The ID of the report reference to download.

Return type

bytearray

Responses

Code	Description	Data Type	Response headers
200	Returns the PolicyReport.zip that contains the violation report file.	bytearray	-
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.	ListAccessModelMetadataAttribute401Response	-
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.	ListAccessModelMetadataAttribute429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

• Content-Type: Not defined
• Accept: application/zip, application/json

Example

import sailpoint.beta
from sailpoint.beta.rest import ApiException
from pprint import pprint

    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)

[Back to top]

get-sod-all-report-run-status

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: Get multi-report run task status This endpoint gets the status for a violation report for all policy run. Requires role of ORG_ADMIN.

API Spec

Parameters

This endpoint does not need any parameter.

Return type

ReportResultReference

Responses

Code	Description	Data Type	Response headers
200	Status of the violation report run task for all policy run.	ReportResultReference	-
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.	ListAccessModelMetadataAttribute401Response	-
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	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.	ListAccessModelMetadataAttribute429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.models.report_result_reference import ReportResultReference
from sailpoint.beta.rest import ApiException
from pprint import pprint


    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)

[Back to top]

get-sod-policy

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: Get SOD policy by ID This gets specified SOD policy. Requires role of ORG_ADMIN.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	id	str	True	The ID of the object reference to retrieve.

Return type

SodPolicy

Responses

Code	Description	Data Type	Response headers
200	SOD policy ID.	SodPolicy	-
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.	ListAccessModelMetadataAttribute401Response	-
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.	ListAccessModelMetadataAttribute429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.models.sod_policy import SodPolicy
from sailpoint.beta.rest import ApiException
from pprint import pprint

    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)

[Back to top]

get-sod-policy-schedule

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: Get SOD policy schedule This endpoint gets a specified SOD policy's schedule. Requires the role of ORG_ADMIN.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	id	str	True	The ID of the object reference to retrieve.

Return type

SodPolicySchedule

Responses

Code	Description	Data Type	Response headers
200	SOD policy ID.	SodPolicySchedule	-
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.	ListAccessModelMetadataAttribute401Response	-
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	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.	ListAccessModelMetadataAttribute429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.models.sod_policy_schedule import SodPolicySchedule
from sailpoint.beta.rest import ApiException
from pprint import pprint

    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)

[Back to top]

get-sod-violation-report-run-status

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: Get violation report run status This gets the status for a violation report run task that has already been invoked. Requires role of ORG_ADMIN.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	report_result_id	str	True	The ID of the report reference to retrieve.

Return type

ReportResultReference

Responses

Code	Description	Data Type	Response headers
200	Status of the violation report run task.	ReportResultReference	-
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.	ListAccessModelMetadataAttribute401Response	-
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.	ListAccessModelMetadataAttribute429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.models.report_result_reference import ReportResultReference
from sailpoint.beta.rest import ApiException
from pprint import pprint

    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)

[Back to top]

get-sod-violation-report-status

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: Get SOD violation report status This gets the status for a violation report run task that has already been invoked. Requires role of ORG_ADMIN.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	id	str	True	The ID of the object reference to retrieve.

Return type

ReportResultReference

Responses

Code	Description	Data Type	Response headers
200	Status of the violation report run task.	ReportResultReference	-
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.	ListAccessModelMetadataAttribute401Response	-
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.	ListAccessModelMetadataAttribute429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.models.report_result_reference import ReportResultReference
from sailpoint.beta.rest import ApiException
from pprint import pprint

    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)

[Back to top]

list-sod-policies

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: List SOD policies This gets list of all SOD policies. Requires role of ORG_ADMIN

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Query	limit	int	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query	offset	int	(optional) (default to 0)	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
Query	count	bool	(optional) (default to False)	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.
Query	filters	str	(optional)	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: id: eq, in name: eq, in state: eq, in
Query	sorters	str	(optional)	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: id, name, created, modified, description

Return type

List[SodPolicy]

Responses

Code	Description	Data Type	Response headers
200	List of all SOD policies.	List[SodPolicy]	-
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.	ListAccessModelMetadataAttribute401Response	-
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	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.	ListAccessModelMetadataAttribute429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.models.sod_policy import SodPolicy
from sailpoint.beta.rest import ApiException
from pprint import pprint

    limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
    offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
    count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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)

[Back to top]

patch-sod-policy

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: Patch a SOD policy Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the JSON Patch standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	id	str	True	The ID of the SOD policy being modified.
Body	request_body	[]object	True	A list of SOD Policy update operations according to the JSON Patch standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria

Return type

SodPolicy

Responses

Code	Description	Data Type	Response headers
200	Indicates the PATCH operation succeeded, and returns the SOD policy's new representation.	SodPolicy	-
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.	ListAccessModelMetadataAttribute401Response	-
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.	ListAccessModelMetadataAttribute429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

• Content-Type: application/json-patch+json
• Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.models.sod_policy import SodPolicy
from sailpoint.beta.rest import ApiException
from pprint import pprint

    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)

[Back to top]

put-policy-schedule

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: Update SOD Policy schedule This updates schedule for a specified SOD policy. Requires role of ORG_ADMIN.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	id	str	True	The ID of the SOD policy to update its schedule.
Body	sod_policy_schedule	SodPolicySchedule	True

Return type

SodPolicySchedule

Responses

Code	Description	Data Type	Response headers
200	SOD policy by ID.	SodPolicySchedule	-
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.	ListAccessModelMetadataAttribute401Response	-
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	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.	ListAccessModelMetadataAttribute429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.models.sod_policy_schedule import SodPolicySchedule
from sailpoint.beta.rest import ApiException
from pprint import pprint

    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)

[Back to top]

put-sod-policy

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: Update SOD policy by ID This updates a specified SOD policy. Requires role of ORG_ADMIN.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	id	str	True	The ID of the SOD policy to update.
Body	sod_policy	SodPolicy	True

Return type

SodPolicy

Responses

Code	Description	Data Type	Response headers
200	SOD Policy by ID	SodPolicy	-
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.	ListAccessModelMetadataAttribute401Response	-
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.	ListAccessModelMetadataAttribute429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.models.sod_policy import SodPolicy
from sailpoint.beta.rest import ApiException
from pprint import pprint

    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)

[Back to top]

start-sod-all-policies-for-org

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: Runs all policies for org Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. Requires role of ORG_ADMIN.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	multi_policy_request	MultiPolicyRequest	(optional)

Return type

ReportResultReference

Responses

Code	Description	Data Type	Response headers
200	Reference to the violation report run task.	ReportResultReference	-
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.	ListAccessModelMetadataAttribute401Response	-
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	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.	ListAccessModelMetadataAttribute429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.models.multi_policy_request import MultiPolicyRequest
from sailpoint.beta.models.report_result_reference import ReportResultReference
from sailpoint.beta.rest import ApiException
from pprint import pprint

    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)

[Back to top]

start-sod-policy

:::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API. ::: Runs SOD policy violation report This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. Requires role of ORG_ADMIN.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	id	str	True	The SOD policy ID to run.

Return type

ReportResultReference

Responses

Code	Description	Data Type	Response headers
200	Reference to the violation report run task.	ReportResultReference	-
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.	ListAccessModelMetadataAttribute401Response	-
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.	ListAccessModelMetadataAttribute429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.models.report_result_reference import ReportResultReference
from sailpoint.beta.rest import ApiException
from pprint import pprint

    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)

[Back to top]