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

Update to python SDK docs: 14177794305

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-31 17:39:57 +00:00
parent 37441b7d71
commit f74e868985
20 changed files with 60 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -36,7 +36,7 @@ id='5ec18cef39020d6fd7a60ad3970aba61',
name='Identity Attribute Campaign Filter',
description='Campaign filter to certify data based on an identity attribute's specified property.',
owner='SailPoint Support',
mode=INCLUSION,
mode='INCLUSION',
criteria_list=[{type=IDENTITY_ATTRIBUTE, property=displayName, value=support, operation=CONTAINS, negateResult=false, shortCircuit=false, recordChildMatches=false, id=null, suppressMatchedItems=false, children=null}],
is_system_filter=False
)

20
docs/tools/sdk/python/Reference/V3/Models/CampaignFilterDetailsCriteriaListInner.md
View File

@@ -17,9 +17,15 @@ tags: ['SDK', 'Software Development Kit', 'CampaignFilterDetailsCriteriaListInne
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | [**CriteriaType**](criteria-type) | | [required]
**operation** | [**Operation**](operation) | | [required]
**operation** | [**Operation**](operation) | | [optional]
**var_property** | **str** | Specified key from the type of criteria. | [required]
**value** | **str** | Value for the specified key from the type of criteria. | [required]
**negate_result** | **bool** | If true, the filter will negate the result of the criteria. | [optional] [default to False]
**short_circuit** | **bool** | If true, the filter will short circuit the evaluation of the criteria. | [optional] [default to False]
**record_child_matches** | **bool** | If true, the filter will record child matches for the criteria. | [optional] [default to False]
**id** | **str** | The unique ID of the criteria. | [optional]
**suppress_matched_items** | **bool** | If this value is true, then matched items will not only be excluded from the campaign, they will also not have archived certification items created. Such items will not appear in the exclusion report. | [optional] [default to False]
**children** | **[]object** | List of child criteria. | [optional]
}
## Example
@@ -29,9 +35,17 @@ from sailpoint.v3.models.campaign_filter_details_criteria_list_inner import Camp
campaign_filter_details_criteria_list_inner = CampaignFilterDetailsCriteriaListInner(
type='IDENTITY_ATTRIBUTE',
operation=,
operation='EQUALS',
var_property='displayName',
value='Allie'
value='Allie',
negate_result=False,
short_circuit=False,
record_child_matches=False,
id='5ec18cef39020d6fd7a60ad3970aba61',
suppress_matched_items=False,
children=[
None
]
)
```

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

@@ -35,5 +35,7 @@ Type of the criteria in the filter. The `COMPOSITE` filter can contain multiple
* `INVALID_CERTIFIABLE_ENTITY` (value: `'INVALID_CERTIFIABLE_ENTITY'`)
* `INVALID_CERTIFIABLE_BUNDLE` (value: `'INVALID_CERTIFIABLE_BUNDLE'`)
[[Back to top]](#)

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

@@ -18,7 +18,7 @@ Attributes related to an external trigger
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | A unique name for the external trigger | [optional]
**description** | **str** | Additonal context about the external trigger | [optional]
**description** | **str** | Additional context about the external trigger | [optional]
**client_id** | **str** | OAuth Client ID to authenticate with this trigger | [optional]
**url** | **str** | URL to invoke this workflow | [optional]
}

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

@@ -32,7 +32,7 @@ items=[
name = 'Identity Attribute Campaign Filter',
description = 'Campaign filter to certify data based on an identity attribute's specified property.',
owner = 'SailPoint Support',
mode = INCLUSION,
mode = 'INCLUSION',
criteria_list = [{type=IDENTITY_ATTRIBUTE, property=displayName, value=support, operation=CONTAINS, negateResult=false, shortCircuit=false, recordChildMatches=false, id=null, suppressMatchedItems=false, children=null}],
is_system_filter = False, )
],

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

@@ -17,9 +17,9 @@ Attributes related to a scheduled trigger
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cron_string** | **str** | A valid CRON expression | [optional]
**frequency** | **Enum** [ 'daily', 'weekly', 'monthly', 'yearly', 'cronSchedule' ] | Frequency of execution | [required]
**time_zone** | **str** | Time zone identifier | [optional]
**cron_string** | **str** | A valid CRON expression | [optional]
**weekly_days** | **[]str** | Scheduled days of the week for execution | [optional]
**weekly_times** | **[]str** | Scheduled execution times | [optional]
**yearly_times** | **[]str** | Scheduled execution times | [optional]
@@ -31,9 +31,9 @@ Name | Type | Description | Notes
from sailpoint.v3.models.scheduled_attributes import ScheduledAttributes
scheduled_attributes = ScheduledAttributes(
cron_string='0 9 * * 1',
frequency='daily',
time_zone='America/Chicago',
cron_string='0 9 * * 1',
weekly_days=Monday,
weekly_times=Monday,
yearly_times=1969-12-31T09:00:00.000Z

6
docs/tools/sdk/python/Reference/V3/Models/WorkflowTriggerAttributes.md
View File

@@ -19,15 +19,15 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the trigger | [required]
**filter_** | **str** | JSON path expression that will limit which events the trigger will fire on | [optional]
**description** | **str** | Additonal context about the external trigger | [optional]
**description** | **str** | Additional context about the external trigger | [optional]
**attribute_to_filter** | **str** | The attribute to filter on | [optional]
**form_definition_id** | **str** | Form definition's unique identifier. | [optional]
**name** | **str** | A unique name for the external trigger | [optional]
**client_id** | **str** | OAuth Client ID to authenticate with this trigger | [optional]
**url** | **str** | URL to invoke this workflow | [optional]
**cron_string** | **str** | A valid CRON expression | [optional]
**frequency** | **Enum** [ 'daily', 'weekly', 'monthly', 'yearly', 'cronSchedule' ] | Frequency of execution | [required]
**time_zone** | **str** | Time zone identifier | [optional]
**cron_string** | **str** | A valid CRON expression | [optional]
**weekly_days** | **[]str** | Scheduled days of the week for execution | [optional]
**weekly_times** | **[]str** | Scheduled execution times | [optional]
**yearly_times** | **[]str** | Scheduled execution times | [optional]
@@ -47,9 +47,9 @@ form_definition_id='Admin_Access_Request_Form',
name='search-and-notify',
client_id='87e239b2-b85b-4bde-b9a7-55bf304ddcdc',
url='https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d',
cron_string='0 9 * * 1',
frequency='daily',
time_zone='America/Chicago',
cron_string='0 9 * * 1',
weekly_days=Monday,
weekly_times=Monday,
yearly_times=1969-12-31T09:00:00.000Z