starting point for adding python sdk docs

This commit is contained in:
darrell-thobe-sp
2025-02-20 12:59:19 -05:00
parent 3b9e39ca19
commit c18583ede4
2726 changed files with 370294 additions and 5 deletions

View File

@@ -0,0 +1,56 @@
---
id: workflow-trigger-attributes
title: WorkflowTriggerAttributes
pagination_label: WorkflowTriggerAttributes
sidebar_label: WorkflowTriggerAttributes
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'WorkflowTriggerAttributes', 'WorkflowTriggerAttributes']
slug: /tools/sdk/python/v3/models/workflow-trigger-attributes
tags: ['SDK', 'Software Development Kit', 'WorkflowTriggerAttributes', 'WorkflowTriggerAttributes']
---
# WorkflowTriggerAttributes
Workflow Trigger Attributes.
## Properties
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]
**attribute_to_filter** | **str** | The attribute to filter on | [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]
**weekly_days** | **[]str** | Scheduled days of the week for execution | [optional]
**weekly_times** | **[]str** | Scheduled execution times | [optional]
}
## Example
```python
from sailpoint.v3.models.workflow_trigger_attributes import WorkflowTriggerAttributes
workflow_trigger_attributes = WorkflowTriggerAttributes(
id='idn:identity-attributes-changed',
filter_='$.changes[?(@.attribute == 'manager')]',
description='Run a search and notify the results',
attribute_to_filter='LifecycleState',
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',
weekly_days=Monday,
weekly_times=Monday
)
```
[[Back to top]](#)