From c167bc85ad8fa8bb052c1d4bca829ed7fd852c0e Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Fri, 27 Jun 2025 18:21:46 +0000 Subject: [PATCH] Update python SDK docs: 15933190197 --- .../Reference/V3/Methods/SODPoliciesApi.md | 55 +++++++------- .../Models/AccessCriteriaCriteriaListInner.md | 2 +- .../V3/Models/AccessCriteriaRequest.md | 35 +++++++++ .../AccessCriteriaRequestCriteriaListInner.md | 35 +++++++++ .../ConflictingAccessCriteriaRequest.md | 39 ++++++++++ .../python/Reference/V3/Models/SodPolicy.md | 4 +- .../Reference/V3/Models/SodPolicyRead.md | 75 +++++++++++++++++++ ...licyReadAllOfConflictingAccessCriteria.md} | 20 ++--- .../Reference/V3/Models/SodPolicyRequest.md | 75 +++++++++++++++++++ ...cyRequestAllOfConflictingAccessCriteria.md | 39 ++++++++++ .../v3/python_code_examples_overlay.yaml | 31 ++++---- 11 files changed, 354 insertions(+), 56 deletions(-) create mode 100644 docs/tools/sdk/python/Reference/V3/Models/AccessCriteriaRequest.md create mode 100644 docs/tools/sdk/python/Reference/V3/Models/AccessCriteriaRequestCriteriaListInner.md create mode 100644 docs/tools/sdk/python/Reference/V3/Models/ConflictingAccessCriteriaRequest.md create mode 100644 docs/tools/sdk/python/Reference/V3/Models/SodPolicyRead.md rename docs/tools/sdk/python/Reference/V3/Models/{SodPolicyConflictingAccessCriteria.md => SodPolicyReadAllOfConflictingAccessCriteria.md} (52%) create mode 100644 docs/tools/sdk/python/Reference/V3/Models/SodPolicyRequest.md create mode 100644 docs/tools/sdk/python/Reference/V3/Models/SodPolicyRequestAllOfConflictingAccessCriteria.md diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SODPoliciesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SODPoliciesApi.md index e8161d217..d11470888 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SODPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SODPoliciesApi.md @@ -71,15 +71,15 @@ Requires role of ORG_ADMIN. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - Body | sod_policy | [**SodPolicy**](../models/sod-policy) | True | + Body | sod_policy_request | [**SodPolicyRequest**](../models/sod-policy-request) | True | ### Return type -[**SodPolicy**](../models/sod-policy) +[**SodPolicyRead**](../models/sod-policy-read) ### Responses Code | Description | Data Type | Response headers | ------------- | ------------- | ------------- |------------------| -201 | SOD policy created | SodPolicy | - | +201 | SOD policy created | SodPolicyRead | - | 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 | - | @@ -95,13 +95,14 @@ Code | Description | Data Type | Response headers | ```python from sailpoint.v3.api.sod_policies_api import SODPoliciesApi from sailpoint.v3.api_client import ApiClient -from sailpoint.v3.models.sod_policy import SodPolicy +from sailpoint.v3.models.sod_policy_read import SodPolicyRead +from sailpoint.v3.models.sod_policy_request import SodPolicyRequest from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - sod_policy = '''{ + sod_policy_request = '''{ "conflictingAccessCriteria" : { "leftCriteria" : { "name" : "money-in", @@ -156,14 +157,14 @@ with ApiClient(configuration) as api_client: "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", "state" : "ENFORCED", "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | + }''' # SodPolicyRequest | try: # Create sod policy - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + new_sod_policy_request = SodPolicyRequest.from_json(sod_policy_request) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy_request=new_sod_policy_request) # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy_request) print("The response of SODPoliciesApi->create_sod_policy:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: @@ -475,12 +476,12 @@ Param Type | Name | Data Type | Required | Description Path | id | **str** | True | The ID of the SOD Policy to retrieve. ### Return type -[**SodPolicy**](../models/sod-policy) +[**SodPolicyRead**](../models/sod-policy-read) ### Responses Code | Description | Data Type | Response headers | ------------- | ------------- | ------------- |------------------| -200 | SOD policy ID. | SodPolicy | - | +200 | SOD policy ID. | SodPolicyRead | - | 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 | - | @@ -497,7 +498,7 @@ Code | Description | Data Type | Response headers | ```python from sailpoint.v3.api.sod_policies_api import SODPoliciesApi from sailpoint.v3.api_client import ApiClient -from sailpoint.v3.models.sod_policy import SodPolicy +from sailpoint.v3.models.sod_policy_read import SodPolicyRead from sailpoint.configuration import Configuration configuration = Configuration() @@ -715,12 +716,12 @@ Param Type | Name | Data Type | Required | Description Query | sorters | **str** | (optional) | Sort results using the standard syntax described 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** ### Return type -[**List[SodPolicy]**](../models/sod-policy) +[**List[SodPolicyRead]**](../models/sod-policy-read) ### Responses Code | Description | Data Type | Response headers | ------------- | ------------- | ------------- |------------------| -200 | List of all SOD policies. | List[SodPolicy] | - | +200 | List of all SOD policies. | List[SodPolicyRead] | - | 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 | - | @@ -736,7 +737,7 @@ Code | Description | Data Type | Response headers | ```python from sailpoint.v3.api.sod_policies_api import SODPoliciesApi from sailpoint.v3.api_client import ApiClient -from sailpoint.v3.models.sod_policy import SodPolicy +from sailpoint.v3.models.sod_policy_read import SodPolicyRead from sailpoint.configuration import Configuration configuration = Configuration() @@ -781,12 +782,12 @@ Path | id | **str** | True | The ID of the SOD policy being modified. Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | 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 ### Return type -[**SodPolicy**](../models/sod-policy) +[**SodPolicyRead**](../models/sod-policy-read) ### Responses Code | Description | Data Type | Response headers | ------------- | ------------- | ------------- |------------------| -200 | Indicates the PATCH operation succeeded, and returns the SOD policy's new representation. | SodPolicy | - | +200 | Indicates the PATCH operation succeeded, and returns the SOD policy's new representation. | SodPolicyRead | - | 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 | - | @@ -804,7 +805,7 @@ Code | Description | Data Type | Response headers | from sailpoint.v3.api.sod_policies_api import SODPoliciesApi from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.json_patch_operation import JsonPatchOperation -from sailpoint.v3.models.sod_policy import SodPolicy +from sailpoint.v3.models.sod_policy_read import SodPolicyRead from sailpoint.configuration import Configuration configuration = Configuration() @@ -938,15 +939,15 @@ Requires role of ORG_ADMIN. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | id | **str** | True | The ID of the SOD policy to update. - Body | sod_policy | [**SodPolicy**](../models/sod-policy) | True | + Body | sod_policy_read | [**SodPolicyRead**](../models/sod-policy-read) | True | ### Return type -[**SodPolicy**](../models/sod-policy) +[**SodPolicyRead**](../models/sod-policy-read) ### Responses Code | Description | Data Type | Response headers | ------------- | ------------- | ------------- |------------------| -200 | SOD Policy by ID | SodPolicy | - | +200 | SOD Policy by ID | SodPolicyRead | - | 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 | - | @@ -963,14 +964,14 @@ Code | Description | Data Type | Response headers | ```python from sailpoint.v3.api.sod_policies_api import SODPoliciesApi from sailpoint.v3.api_client import ApiClient -from sailpoint.v3.models.sod_policy import SodPolicy +from sailpoint.v3.models.sod_policy_read import SodPolicyRead from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = '''{ + sod_policy_read = '''{ "conflictingAccessCriteria" : { "leftCriteria" : { "name" : "money-in", @@ -1025,14 +1026,14 @@ with ApiClient(configuration) as api_client: "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", "state" : "ENFORCED", "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | + }''' # SodPolicyRead | try: # Update sod policy by id - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + new_sod_policy_read = SodPolicyRead.from_json(sod_policy_read) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy_read=new_sod_policy_read) # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy_read) print("The response of SODPoliciesApi->put_sod_policy:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessCriteriaCriteriaListInner.md b/docs/tools/sdk/python/Reference/V3/Models/AccessCriteriaCriteriaListInner.md index 2598d28b9..7ab139246 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AccessCriteriaCriteriaListInner.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessCriteriaCriteriaListInner.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'AccessCriteriaCriteriaListInner', 'Ac Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **Enum** [ 'ENTITLEMENT' ] | Type of the propery to which this reference applies to | [optional] +**type** | **Enum** [ 'ENTITLEMENT' ] | Type of the property to which this reference applies to | [optional] **id** | **str** | ID of the object to which this reference applies to | [optional] **name** | **str** | Human-readable display name of the object to which this reference applies to | [optional] } diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessCriteriaRequest.md b/docs/tools/sdk/python/Reference/V3/Models/AccessCriteriaRequest.md new file mode 100644 index 000000000..cf7b032cd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessCriteriaRequest.md @@ -0,0 +1,35 @@ +--- +id: access-criteria-request +title: AccessCriteriaRequest +pagination_label: AccessCriteriaRequest +sidebar_label: AccessCriteriaRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessCriteriaRequest', 'AccessCriteriaRequest'] +slug: /tools/sdk/python/v3/models/access-criteria-request +tags: ['SDK', 'Software Development Kit', 'AccessCriteriaRequest', 'AccessCriteriaRequest'] +--- + +# AccessCriteriaRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Business name for the access construct list | [optional] +**criteria_list** | [**[]AccessCriteriaRequestCriteriaListInner**](access-criteria-request-criteria-list-inner) | List of criteria. There is a min of 1 and max of 50 items in the list. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_criteria_request import AccessCriteriaRequest + +access_criteria_request = AccessCriteriaRequest( +name='money-in', +criteria_list=[{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessCriteriaRequestCriteriaListInner.md b/docs/tools/sdk/python/Reference/V3/Models/AccessCriteriaRequestCriteriaListInner.md new file mode 100644 index 000000000..cb02a4a95 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessCriteriaRequestCriteriaListInner.md @@ -0,0 +1,35 @@ +--- +id: access-criteria-request-criteria-list-inner +title: AccessCriteriaRequestCriteriaListInner +pagination_label: AccessCriteriaRequestCriteriaListInner +sidebar_label: AccessCriteriaRequestCriteriaListInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessCriteriaRequestCriteriaListInner', 'AccessCriteriaRequestCriteriaListInner'] +slug: /tools/sdk/python/v3/models/access-criteria-request-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'AccessCriteriaRequestCriteriaListInner', 'AccessCriteriaRequestCriteriaListInner'] +--- + +# AccessCriteriaRequestCriteriaListInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ENTITLEMENT' ] | Type of the property to which this reference applies to | [optional] +**id** | **str** | ID of the object to which this reference applies to | [optional] +} + +## Example + +```python +from sailpoint.v3.models.access_criteria_request_criteria_list_inner import AccessCriteriaRequestCriteriaListInner + +access_criteria_request_criteria_list_inner = AccessCriteriaRequestCriteriaListInner( +type='ENTITLEMENT', +id='2c91808568c529c60168cca6f90c1313' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ConflictingAccessCriteriaRequest.md b/docs/tools/sdk/python/Reference/V3/Models/ConflictingAccessCriteriaRequest.md new file mode 100644 index 000000000..3d0bc6fe3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ConflictingAccessCriteriaRequest.md @@ -0,0 +1,39 @@ +--- +id: conflicting-access-criteria-request +title: ConflictingAccessCriteriaRequest +pagination_label: ConflictingAccessCriteriaRequest +sidebar_label: ConflictingAccessCriteriaRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConflictingAccessCriteriaRequest', 'ConflictingAccessCriteriaRequest'] +slug: /tools/sdk/python/v3/models/conflicting-access-criteria-request +tags: ['SDK', 'Software Development Kit', 'ConflictingAccessCriteriaRequest', 'ConflictingAccessCriteriaRequest'] +--- + +# ConflictingAccessCriteriaRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**left_criteria** | [**AccessCriteriaRequest**](access-criteria-request) | | [optional] +**right_criteria** | [**AccessCriteriaRequest**](access-criteria-request) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.conflicting_access_criteria_request import ConflictingAccessCriteriaRequest + +conflicting_access_criteria_request = ConflictingAccessCriteriaRequest( +left_criteria=sailpoint.v3.models.access_criteria_request.AccessCriteriaRequest( + name = 'money-in', + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}], ), +right_criteria=sailpoint.v3.models.access_criteria_request.AccessCriteriaRequest( + name = 'money-in', + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SodPolicy.md b/docs/tools/sdk/python/Reference/V3/Models/SodPolicy.md index cf8848242..d8e2dfdf4 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/SodPolicy.md +++ b/docs/tools/sdk/python/Reference/V3/Models/SodPolicy.md @@ -33,7 +33,6 @@ Name | Type | Description | Notes **violation_owner_assignment_config** | [**ViolationOwnerAssignmentConfig**](violation-owner-assignment-config) | | [optional] **scheduled** | **bool** | defines whether a policy has been scheduled or not | [optional] [default to False] **type** | **Enum** [ 'GENERAL', 'CONFLICTING_ACCESS_BASED' ] | whether a policy is query based or conflicting access based | [optional] [default to 'GENERAL'] -**conflicting_access_criteria** | [**SodPolicyConflictingAccessCriteria**](sod-policy-conflicting-access-criteria) | | [optional] } ## Example @@ -66,8 +65,7 @@ violation_owner_assignment_config=sailpoint.v3.models.violation_owner_assignment id = '2c9180a46faadee4016fb4e018c20639', name = 'Support', ), ), scheduled=True, -type='GENERAL', -conflicting_access_criteria= +type='GENERAL' ) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Models/SodPolicyRead.md b/docs/tools/sdk/python/Reference/V3/Models/SodPolicyRead.md new file mode 100644 index 000000000..46331120c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SodPolicyRead.md @@ -0,0 +1,75 @@ +--- +id: sod-policy-read +title: SodPolicyRead +pagination_label: SodPolicyRead +sidebar_label: SodPolicyRead +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodPolicyRead', 'SodPolicyRead'] +slug: /tools/sdk/python/v3/models/sod-policy-read +tags: ['SDK', 'Software Development Kit', 'SodPolicyRead', 'SodPolicyRead'] +--- + +# SodPolicyRead + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Policy id | [optional] [readonly] +**name** | **str** | Policy Business Name | [optional] +**created** | **datetime** | The time when this SOD policy is created. | [optional] [readonly] +**modified** | **datetime** | The time when this SOD policy is modified. | [optional] [readonly] +**description** | **str** | Optional description of the SOD policy | [optional] +**owner_ref** | [**SodPolicyOwnerRef**](sod-policy-owner-ref) | | [optional] +**external_policy_reference** | **str** | Optional External Policy Reference | [optional] +**policy_query** | **str** | Search query of the SOD policy | [optional] +**compensating_controls** | **str** | Optional compensating controls(Mitigating Controls) | [optional] +**correction_advice** | **str** | Optional correction advice | [optional] +**state** | **Enum** [ 'ENFORCED', 'NOT_ENFORCED' ] | whether the policy is enforced or not | [optional] +**tags** | **[]str** | tags for this policy object | [optional] +**creator_id** | **str** | Policy's creator ID | [optional] [readonly] +**modifier_id** | **str** | Policy's modifier ID | [optional] [readonly] +**violation_owner_assignment_config** | [**ViolationOwnerAssignmentConfig**](violation-owner-assignment-config) | | [optional] +**scheduled** | **bool** | defines whether a policy has been scheduled or not | [optional] [default to False] +**type** | **Enum** [ 'GENERAL', 'CONFLICTING_ACCESS_BASED' ] | whether a policy is query based or conflicting access based | [optional] [default to 'GENERAL'] +**conflicting_access_criteria** | [**SodPolicyReadAllOfConflictingAccessCriteria**](sod-policy-read-all-of-conflicting-access-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.sod_policy_read import SodPolicyRead + +sod_policy_read = SodPolicyRead( +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +name='policy-xyz', +created='2020-01-01T00:00Z', +modified='2020-01-01T00:00Z', +description='This policy ensures compliance of xyz', +owner_ref=sailpoint.v3.models.sod_policy_owner_ref.SodPolicy_ownerRef( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +external_policy_reference='XYZ policy', +policy_query='@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)', +compensating_controls='Have a manager review the transaction decisions for their "out of compliance" employee', +correction_advice='Based on the role of the employee, managers should remove access that is not required for their job function.', +state='ENFORCED', +tags=[TAG1, TAG2], +creator_id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +modifier_id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +violation_owner_assignment_config=sailpoint.v3.models.violation_owner_assignment_config.ViolationOwnerAssignmentConfig( + assignment_rule = 'MANAGER', + owner_ref = sailpoint.v3.models.violation_owner_assignment_config_owner_ref.ViolationOwnerAssignmentConfig_ownerRef( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), ), +scheduled=True, +type='GENERAL', +conflicting_access_criteria= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SodPolicyConflictingAccessCriteria.md b/docs/tools/sdk/python/Reference/V3/Models/SodPolicyReadAllOfConflictingAccessCriteria.md similarity index 52% rename from docs/tools/sdk/python/Reference/V3/Models/SodPolicyConflictingAccessCriteria.md rename to docs/tools/sdk/python/Reference/V3/Models/SodPolicyReadAllOfConflictingAccessCriteria.md index 32a10ed8d..005f7c36d 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/SodPolicyConflictingAccessCriteria.md +++ b/docs/tools/sdk/python/Reference/V3/Models/SodPolicyReadAllOfConflictingAccessCriteria.md @@ -1,15 +1,15 @@ --- -id: sod-policy-conflicting-access-criteria -title: SodPolicyConflictingAccessCriteria -pagination_label: SodPolicyConflictingAccessCriteria -sidebar_label: SodPolicyConflictingAccessCriteria +id: sod-policy-read-all-of-conflicting-access-criteria +title: SodPolicyReadAllOfConflictingAccessCriteria +pagination_label: SodPolicyReadAllOfConflictingAccessCriteria +sidebar_label: SodPolicyReadAllOfConflictingAccessCriteria sidebar_class_name: pythonsdk -keywords: ['python', 'Python', 'sdk', 'SodPolicyConflictingAccessCriteria', 'SodPolicyConflictingAccessCriteria'] -slug: /tools/sdk/python/v3/models/sod-policy-conflicting-access-criteria -tags: ['SDK', 'Software Development Kit', 'SodPolicyConflictingAccessCriteria', 'SodPolicyConflictingAccessCriteria'] +keywords: ['python', 'Python', 'sdk', 'SodPolicyReadAllOfConflictingAccessCriteria', 'SodPolicyReadAllOfConflictingAccessCriteria'] +slug: /tools/sdk/python/v3/models/sod-policy-read-all-of-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodPolicyReadAllOfConflictingAccessCriteria', 'SodPolicyReadAllOfConflictingAccessCriteria'] --- -# SodPolicyConflictingAccessCriteria +# SodPolicyReadAllOfConflictingAccessCriteria ## Properties @@ -23,9 +23,9 @@ Name | Type | Description | Notes ## Example ```python -from sailpoint.v3.models.sod_policy_conflicting_access_criteria import SodPolicyConflictingAccessCriteria +from sailpoint.v3.models.sod_policy_read_all_of_conflicting_access_criteria import SodPolicyReadAllOfConflictingAccessCriteria -sod_policy_conflicting_access_criteria = SodPolicyConflictingAccessCriteria( +sod_policy_read_all_of_conflicting_access_criteria = SodPolicyReadAllOfConflictingAccessCriteria( left_criteria=sailpoint.v3.models.access_criteria.AccessCriteria( name = 'money-in', criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}], ), diff --git a/docs/tools/sdk/python/Reference/V3/Models/SodPolicyRequest.md b/docs/tools/sdk/python/Reference/V3/Models/SodPolicyRequest.md new file mode 100644 index 000000000..4c742ae5e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SodPolicyRequest.md @@ -0,0 +1,75 @@ +--- +id: sod-policy-request +title: SodPolicyRequest +pagination_label: SodPolicyRequest +sidebar_label: SodPolicyRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodPolicyRequest', 'SodPolicyRequest'] +slug: /tools/sdk/python/v3/models/sod-policy-request +tags: ['SDK', 'Software Development Kit', 'SodPolicyRequest', 'SodPolicyRequest'] +--- + +# SodPolicyRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Policy id | [optional] [readonly] +**name** | **str** | Policy Business Name | [optional] +**created** | **datetime** | The time when this SOD policy is created. | [optional] [readonly] +**modified** | **datetime** | The time when this SOD policy is modified. | [optional] [readonly] +**description** | **str** | Optional description of the SOD policy | [optional] +**owner_ref** | [**SodPolicyOwnerRef**](sod-policy-owner-ref) | | [optional] +**external_policy_reference** | **str** | Optional External Policy Reference | [optional] +**policy_query** | **str** | Search query of the SOD policy | [optional] +**compensating_controls** | **str** | Optional compensating controls(Mitigating Controls) | [optional] +**correction_advice** | **str** | Optional correction advice | [optional] +**state** | **Enum** [ 'ENFORCED', 'NOT_ENFORCED' ] | whether the policy is enforced or not | [optional] +**tags** | **[]str** | tags for this policy object | [optional] +**creator_id** | **str** | Policy's creator ID | [optional] [readonly] +**modifier_id** | **str** | Policy's modifier ID | [optional] [readonly] +**violation_owner_assignment_config** | [**ViolationOwnerAssignmentConfig**](violation-owner-assignment-config) | | [optional] +**scheduled** | **bool** | defines whether a policy has been scheduled or not | [optional] [default to False] +**type** | **Enum** [ 'GENERAL', 'CONFLICTING_ACCESS_BASED' ] | whether a policy is query based or conflicting access based | [optional] [default to 'GENERAL'] +**conflicting_access_criteria** | [**SodPolicyRequestAllOfConflictingAccessCriteria**](sod-policy-request-all-of-conflicting-access-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.sod_policy_request import SodPolicyRequest + +sod_policy_request = SodPolicyRequest( +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +name='policy-xyz', +created='2020-01-01T00:00Z', +modified='2020-01-01T00:00Z', +description='This policy ensures compliance of xyz', +owner_ref=sailpoint.v3.models.sod_policy_owner_ref.SodPolicy_ownerRef( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +external_policy_reference='XYZ policy', +policy_query='@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)', +compensating_controls='Have a manager review the transaction decisions for their "out of compliance" employee', +correction_advice='Based on the role of the employee, managers should remove access that is not required for their job function.', +state='ENFORCED', +tags=[TAG1, TAG2], +creator_id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +modifier_id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +violation_owner_assignment_config=sailpoint.v3.models.violation_owner_assignment_config.ViolationOwnerAssignmentConfig( + assignment_rule = 'MANAGER', + owner_ref = sailpoint.v3.models.violation_owner_assignment_config_owner_ref.ViolationOwnerAssignmentConfig_ownerRef( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), ), +scheduled=True, +type='GENERAL', +conflicting_access_criteria= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SodPolicyRequestAllOfConflictingAccessCriteria.md b/docs/tools/sdk/python/Reference/V3/Models/SodPolicyRequestAllOfConflictingAccessCriteria.md new file mode 100644 index 000000000..ef0875dc6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SodPolicyRequestAllOfConflictingAccessCriteria.md @@ -0,0 +1,39 @@ +--- +id: sod-policy-request-all-of-conflicting-access-criteria +title: SodPolicyRequestAllOfConflictingAccessCriteria +pagination_label: SodPolicyRequestAllOfConflictingAccessCriteria +sidebar_label: SodPolicyRequestAllOfConflictingAccessCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SodPolicyRequestAllOfConflictingAccessCriteria', 'SodPolicyRequestAllOfConflictingAccessCriteria'] +slug: /tools/sdk/python/v3/models/sod-policy-request-all-of-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodPolicyRequestAllOfConflictingAccessCriteria', 'SodPolicyRequestAllOfConflictingAccessCriteria'] +--- + +# SodPolicyRequestAllOfConflictingAccessCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**left_criteria** | [**AccessCriteriaRequest**](access-criteria-request) | | [optional] +**right_criteria** | [**AccessCriteriaRequest**](access-criteria-request) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.sod_policy_request_all_of_conflicting_access_criteria import SodPolicyRequestAllOfConflictingAccessCriteria + +sod_policy_request_all_of_conflicting_access_criteria = SodPolicyRequestAllOfConflictingAccessCriteria( +left_criteria=sailpoint.v3.models.access_criteria_request.AccessCriteriaRequest( + name = 'money-in', + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}], ), +right_criteria=sailpoint.v3.models.access_criteria_request.AccessCriteriaRequest( + name = 'money-in', + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}], ) +) + +``` +[[Back to top]](#) + diff --git a/static/code-examples/v3/python_code_examples_overlay.yaml b/static/code-examples/v3/python_code_examples_overlay.yaml index 599b9c30e..0868d34ba 100644 --- a/static/code-examples/v3/python_code_examples_overlay.yaml +++ b/static/code-examples/v3/python_code_examples_overlay.yaml @@ -7265,13 +7265,14 @@ source: | from sailpoint.v3.api.sod_policies_api import SODPoliciesApi from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.v3.models.sod_policy_read import SodPolicyRead + from sailpoint.v3.models.sod_policy_request import SodPolicyRequest from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - sod_policy = '''{ + sod_policy_request = '''{ "conflictingAccessCriteria" : { "leftCriteria" : { "name" : "money-in", @@ -7326,13 +7327,13 @@ "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", "state" : "ENFORCED", "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | + }''' # SodPolicyRequest | try: # Create sod policy - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + new_sod_policy_request = SodPolicyRequest.from_json(sod_policy_request) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy_request=new_sod_policy_request) # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy_request) print("The response of SODPoliciesApi->create_sod_policy:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: @@ -7463,7 +7464,7 @@ source: | from sailpoint.v3.api.sod_policies_api import SODPoliciesApi from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.v3.models.sod_policy_read import SodPolicyRead from sailpoint.configuration import Configuration configuration = Configuration() @@ -7563,7 +7564,7 @@ source: | from sailpoint.v3.api.sod_policies_api import SODPoliciesApi from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.v3.models.sod_policy_read import SodPolicyRead from sailpoint.configuration import Configuration configuration = Configuration() @@ -7594,7 +7595,7 @@ from sailpoint.v3.api.sod_policies_api import SODPoliciesApi from sailpoint.v3.api_client import ApiClient from sailpoint.v3.models.json_patch_operation import JsonPatchOperation - from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.v3.models.sod_policy_read import SodPolicyRead from sailpoint.configuration import Configuration configuration = Configuration() @@ -7683,14 +7684,14 @@ source: | from sailpoint.v3.api.sod_policies_api import SODPoliciesApi from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.v3.models.sod_policy_read import SodPolicyRead from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. - sod_policy = '''{ + sod_policy_read = '''{ "conflictingAccessCriteria" : { "leftCriteria" : { "name" : "money-in", @@ -7745,13 +7746,13 @@ "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", "state" : "ENFORCED", "externalPolicyReference" : "XYZ policy" - }''' # SodPolicy | + }''' # SodPolicyRead | try: # Update sod policy by id - new_sod_policy = SodPolicy.from_json(sod_policy) - results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + new_sod_policy_read = SodPolicyRead.from_json(sod_policy_read) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy_read=new_sod_policy_read) # Below is a request that includes all optional parameters - # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy_read) print("The response of SODPoliciesApi->put_sod_policy:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: