LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 20:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update python SDK docs: 15933190197

Browse Source
This commit is contained in:
developer-relations-sp
2025-06-27 18:21:46 +00:00
parent 5bc5addcbe
commit c167bc85ad
11 changed files with 354 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/tools/sdk/python/Reference/V3/Models/AccessCriteriaCriteriaListInner.md
View File

@@ -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]
}

35
docs/tools/sdk/python/Reference/V3/Models/AccessCriteriaRequest.md Normal file
View File

@@ -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]](#)

35
docs/tools/sdk/python/Reference/V3/Models/AccessCriteriaRequestCriteriaListInner.md Normal file
View File

@@ -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]](#)

39
docs/tools/sdk/python/Reference/V3/Models/ConflictingAccessCriteriaRequest.md Normal file
View File

@@ -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]](#)

4
docs/tools/sdk/python/Reference/V3/Models/SodPolicy.md
View File

@@ -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'
)
```

75
docs/tools/sdk/python/Reference/V3/Models/SodPolicyRead.md Normal file
View File

@@ -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]](#)

20
docs/tools/sdk/python/Reference/V3/Models/SodPolicyConflictingAccessCriteria.md → docs/tools/sdk/python/Reference/V3/Models/SodPolicyReadAllOfConflictingAccessCriteria.md
View File

@@ -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}], ),

75
docs/tools/sdk/python/Reference/V3/Models/SodPolicyRequest.md Normal file
View File

@@ -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]](#)

39
docs/tools/sdk/python/Reference/V3/Models/SodPolicyRequestAllOfConflictingAccessCriteria.md Normal file
View File

@@ -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]](#)