Workflow Triggers
When building a workflow, you'll always start with a trigger.
A trigger is the event that tells the workflow to start. The workflow uses data provided by the input to calculate the results of each action and operator.
All available triggers are listed below, along with a sample input, if applicable, that can be used to test a workflow.
You can also define filters to limit when a trigger fires, such as limiting the Source Account Created trigger to only begin the workflow when the account was created on a specific source.
Access Request Decision
An access request was approved or denied.
This trigger only fires if you have the Access Request service.
Open "Access Request Decision" JSON Sample
Note
clientMetadata
is determined by the user that invoked create-access-request
and can contain any value at runtime that was specified in the access request.
Account Aggregation Completed
An account aggregation completed.
Open "Account Aggregation Completed" JSON Sample
Accounts Collected for Aggregation
Identity Security Cloud has gathered the accounts on a source and is prepared to aggregate them.
Open "Accounts Collected for Aggregation" JSON Sample
Certification Triggers
Workflow triggers related to parts of a certification.
Campaign Activated
A certification campaign was activated.
This trigger only fires if you have the Certifications service.
Open "Campaign Activated" JSON Sample
Campaign Ended
A certification campaign ended.
This trigger only fires if you have the Certifications service.
Open "Campaign Ended" JSON Sample
Campaign Generated
A certification campaign finished generating.
This trigger only fires if you have the Certifications service.
Open "Campaign Generated" JSON Sample
Certification Signed Off
A certification reviewer signed off on their certifications.
This trigger only fires if you have the Certifications service.
Open "Certification Signed Off" JSON Sample
External Trigger
A third-party system triggered a workflow based on configurations made on that system and within your SaaS platform.
Because the input provided to the workflow by the external trigger varies depending on the external site and API, it's not possible to use the variable selector in future steps to choose variables from this trigger.
However, you can still select variables using JSONPath for use in future steps by adding the trigger field to your JSONPath expression using the Goessner implementation.
For example, if your external system provides the following input to your workflow when the trigger is fired:
{
"name":"Sherri",
"email":"sherri@email.com"
}
You can use the following JSONPath expression to select the value of the name field in a future action:
$.trigger.name
To use an external trigger, you must generate an access token using the information provided in the trigger. You can find an overview of generating an access token below.
Generating an Access Token for an External Trigger
After adding an External Trigger to your workflow:
-
Select New Access Token.
-
Copy the Client ID, Client URL, and the Client Secret to a secure location and save them. The Client Secret can't be retrieved once this page is closed.
-
Use the contents of the text field under Generate OAuth Token to create an OAuth 2.0 token so that your external system can authenticate into your SaaS platform and trigger your workflow.
-
Use the contents of the text box under Provide Workflow Input to configure your external system to correctly trigger your workflow. Replace the {"sampleJSON":"sampleJSON"} object with the input you want to use in your workflow.
Once you've completed these steps or saved this information in a secure location, you can close the overlay and continue building your workflow.
If you lose the access token for this step and need to generate a new one, you can select this step and choose New Access Token. The previous token will be overwritten.
Form Submitted
A form was submitted by a user.
This trigger fires when a form is submitted or when a form is submitted with specific attribute values.
To use a Form Submitted trigger, complete the following fields:
Field | Description |
---|---|
Description | Enter a description of the trigger. |
Basic/Advanced | Choose whether to use the Basic or Advanced configuration options. Basic allows configuration of a trigger using one form. Advanced allows you to use JSONPath to filter when a trigger fires based on multiple forms, form elements, or values within a form. |
If you selected Basic: | |
Form to Filter | Select which form to use to trigger the workflow. |
Form Element to Filter | Select the technical key of the element you want to filter for, limiting the conditions under which this trigger starts the workflow. |
Operator | Select an operator to act on the selected form element. The available operators will change based on your selection. |
Attribute Value | Enter the value that should appear in the field you selected. When the submitted form meets these criteria, the workflow is triggered. |
If you selected Advanced: | |
Filter | A JSONPath expression to narrow down the circumstances under which your workflow will be triggered. |
Examples:
Example | Filter |
---|---|
Trigger the workflow when the selected form is submitted and the department equals sales AND the manager equals amanda.ross. | $[?(@.formDefinitionId == '<formId>' && @.formData.department == "sales" && @.formData.manager == "amanda.ross")] |
Trigger the workflow when the selected form is submitted and either the department equals sales OR finance. | $[?(@.formDefinitionId == '<formId>' && @.formData.department == "sales" && @.formData.department == "finance")] |
Trigger the workflow when either of the selected forms is submitted. | $[?(@.formDefinitionId == '<formId1>' && @.formDefinitionId == '<formId2>' )] |
Below is an example of the JSON for this trigger.
Note
The data inside “formData” is dynamic and will depend on the selected form.
Open "Form Submitted" JSON Sample
Identity Triggers
Changes made to identities and their attributes.
Identity Attributes Changed
One or more attributes was changed on an identity.
To use an identity attributes changed trigger, complete the following fields:
Field | Description |
---|---|
Description | Enter a description of the trigger. |
Basic/Advanced | Choose whether to use the Basic or Advanced configuration options. Basic allows configuration of a trigger using one attribute. Advanced allows you to use JSONPath to filter when a trigger fires based on multiple attributes. |
If you selected Basic: | |
Attribute to Filter | Select the technical key of the attribute you want to filter for, limiting the conditions under which this trigger starts the workflow. |
If you selected Advanced: | |
Filter | Enter a JSONPath expression to narrow down the circumstances under which your workflow will be triggered. |
Open "Identity Attributes Changed" JSON Sample
Identity Created
An identity was created.
To use an identity created trigger, complete the following fields:
Field | Description |
---|---|
Description | Enter a description of the trigger. |
Basic/Advanced | Choose whether to use the Basic or Advanced configuration options. Basic allows configuration of a trigger using one attribute. Advanced allows you to use JSONPath to filter when a trigger fires based on multiple attributes. |
If you selected Basic: | |
Attribute to Filter | Select the technical key of the attribute you want to filter for, limiting the conditions under which this trigger starts the workflow. |
Operator | Select an operator to act on the selected attribute. The available operators will change based on your selection. |
Attribute Value | Enter the value that should appear in the field you selected. When a new identity is created with an attribute that meets this criteria, the workflow is triggered. |
If you selected Advanced: | |
Filter | Enter a JSONPath expression to narrow down the circumstances under which your workflow will be triggered. |
Open "Identity Created" JSON Sample
Identity Deleted
An identity was deleted from Identity Security Cloud. Note that this does not mean that the user no longer has accounts on any sources, only that their accounts do not correlate to an identity.
Open "Identity Deleted" JSON Sample
Interactive Trigger
A user launched an Interactive Process.
This trigger only fires when manually initiated from the Launcher associated with this trigger.
Field | Description |
---|---|
Create Launcher | Select Create Launcher to create a Launcher that shares a name and description with the current workflow. An entitlement is automatically created for this Launcher. After your workflow has been configured, you can change the Launcher associated with this trigger from the Launchers page. |
Native Change Account Triggers
Changes made to accounts external to Identity Security Cloud.
Native Change Account Created
A new account external to Identity Security Cloud was created. Note you must have at least one source configured for Native Change Detection (NCD) before you will receive events from this trigger.
Open "Native Change Account Created" JSON Sample
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
|
Native Change Account Deleted
An account external to Identity Security Cloud was deleted. Note you must have at least one source configured for Native Change Detection (NCD) before you will receive events from this trigger.
Open "Native Change Account Deleted" JSON Sample
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 |
|
Native Change Account Updated
An account external to Identity Security Cloud was updated. Note you must have at least one source configured for Native Change Detection (NCD) before you will receive events from this trigger.
Open "Native Change Account Updated" JSON Sample
Outlier Detected
An outlier was detected using Data Intelligence.
Open "Outlier Detected" JSON Sample
Provisioning Completed
A provisioning action completed on a source.
This trigger only fires if you have the Provisioning service.
Open "Provisioning Completed" JSON Sample
Scheduled Search
A scheduled search completed and results are available.
Open "Scheduled Search" JSON Sample
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
|
Scheduled Trigger
A scheduled trigger was initiated based on the configured CRON schedule.
To use a scheduled trigger, complete the following fields:
Field | Description |
---|---|
Frequency | Set a regular schedule for the trigger to fire, based on a CRON expression. Choose between Daily, Weekly, Monthly, Yearly, or Cron Schedule. |
Time Zone | Use the dropdowns to select your time zone. |
To set the Frequency of the scheduled trigger, choose from the following options:
Field | Description |
---|---|
If you selected Daily: | |
Times | Select one or more times for the workflow to start each day. |
If you selected Weekly: | |
Days | Select one or more days each week to start the workflow. |
Times | Select one or more times to start this workflow each day. The workflow will start on each selected time for all days selected. |
For Monthly or Yearly, if you selected a Schedule Type of By Date: | |
Months | Select one or more months for the workflow to start. This is for Yearly only. |
Days | Select one or more dates of the month for the workflow to start. |
Times | Choose one or more times that this workflow should start each day. The workflow will start on each selected time for all days selected. |
For Monthly or Yearly, if you selected a Schedule Type of Relative dates: | |
Months | Select one or more months for the workflow to start. This is for Yearly only. |
Dates | Select one or more relative dates for the workflow to start for the selected months. |
Times | Choose one or more times that this workflow should start each day. The workflow will start on each selected time for all days selected. |
If you selected Cron Schedule: | |
Cron String | Enter the CRON expression for the schedule your workflow should follow. NOTE: Cron strings support down to hours only, minutes are not currently supported. |
A preview of the workflow schedule displays at the bottom of the configuration panel and updates as you make your selections.
The input for the scheduled trigger is a CRON expression and isn't represented in JSON.
Source Triggers
Triggers related to sources and their accounts.
Source Account Created
A new account was detected during an account aggregation.
Open "Source Account Created" JSON Sample
Source Account Deleted
An account was removed from a source, and this deletion was detected during an account aggregation.
Open "Source Account Deleted" JSON Sample
Source Account Updated
One or more account attributes changes were detected during an account aggregation.
Open "Source Account Updated" JSON Sample
Source Created
A new source was successfully created.
Open "Source Created" JSON Sample
Source Deleted
A source was successfully deleted.
Open "Source Deleted" JSON Sample
Source Updated
Configuration changes were successfully made to a source.
Open "Source Updated" JSON Sample
VA Cluster Status Change Event
A virtual appliance cluster changed status.
Open "VA Cluster Status Change Event" JSON Sample
To learn more about the process of building a workflow, either in the visual builder or using JSON, visit Creating and Managing Workflows.
Once you've selected a trigger for your workflow, you can add actions and operators.
Documentation Feedback
Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.