Files
developer.sailpoint.com/docs/extensibility/event-triggers/available/scheduled-search.md
darrell-thobe-sp 2cd5ccfc81 Prettified Code!
2024-04-18 10:31:05 +00:00

3.1 KiB

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, description, slug, tags
id title pagination_label sidebar_label sidebar_class_name keywords description slug tags
saved-search-completed Scheduled Search Scheduled Search Scheduled Search scheduledSearch
event
trigger
saved
scheduled
search
complete
available
Fires after a scheduled search completes. /extensibility/event-triggers/triggers/scheduled-search
Event Triggers
Available Event Triggers
Fire and Forget

Event Context

Flow

Users can subscribe to saved searches and receive an email of a report generated from the saved search. For example, a user can save a search query called "Identities with upcoming end dates" and create a subscription to receive a daily report showing identities with an end date within 10 days from the current date. This event trigger can also notify an external HTTP application that a report generated from a saved search subscription is available to be processed.

'Scheduled search' events occur based on the schedules set for saved search subscriptions. For example, if you have a scheduled saved search for Monday, Tuesday, Wednesday, Thursday, Friday at 6:00 GMT, your HTTP endpoint will also receive a notification at those times. This can be set using the schedule object in the create scheduled search endpoint.

To receive this event when a saved search query does not have any results, set emailEmptyResults to TRUE. You can also set the expiration date in the expiration field within the schedule object. Your HTTP endpoint will stop receiving these events when the scheduled search expires.

Some uses cases for this trigger include the following:

  • Perform quality control, such as continuously checking for Separation of Duties (SOD) violations.
  • Respond to upcoming joiner-mover-leaver scenarios, such as deprovisioning access before an employee's separation date.

This is an example input from this trigger:

{
  "fileName": "Modified.zip",
  "ownerEmail": "test@sailpoint.com",
  "ownerName": "Cloud Support",
  "query": "modified:[now-7y/d TO now]",
  "searchName": "Modified Activity",
  "searchResults": {
    "Account": {
      "count": 3,
      "noun": "accounts",
      "preview": [[]]
    },
    "Entitlement": {
      "count": 2,
      "noun": "entitlements",
      "preview": [[]]
    },
    "Identity": {
      "count": 2,
      "noun": "identities",
      "preview": [[]]
    }
  },
  "signedS3Url": "https://sptcbu-org-data-useast1.s3.amazonaws.com/arsenal-john/reports/Events%20Export.2020-05-06%2018%2759%20GMT.3e580592-86e4-4953-8aea-49e6ef20a086.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200506T185919Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=AKIAV5E54XOGTS4Q4L7A%2F20200506%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2e732bb97a12a1fd8a215613e3c31fcdae8ba1fb6a25916843ab5b51d2ddefbc"
}