Skip to main content

WorkflowTriggerAttributes

Workflow Trigger Attributes.

Properties

NameTypeDescriptionNotes
idstrThe unique ID of the trigger[required]
filter_strJSON path expression that will limit which events the trigger will fire on[optional]
descriptionstrAdditonal context about the external trigger[optional]
attribute_to_filterstrThe attribute to filter on[optional]
form_definition_idstrForm definition's unique identifier.[optional]
namestrA unique name for the external trigger[optional]
client_idstrOAuth Client ID to authenticate with this trigger[optional]
urlstrURL to invoke this workflow[optional]
cron_stringstrA valid CRON expression[optional]
frequencyEnum [ 'daily', 'weekly', 'monthly', 'yearly', 'cronSchedule' ]Frequency of execution[required]
time_zonestrTime zone identifier[optional]
weekly_days[]strScheduled days of the week for execution[optional]
weekly_times[]strScheduled execution times[optional]
yearly_times[]strScheduled execution times[optional]
}

Example

from sailpoint.v2024.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',
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',
weekly_days=Monday,
weekly_times=Monday,
yearly_times=1969-12-31T09:00:00.000Z
)

[Back to top]