Files
developer.sailpoint.com/docs/tools/sdk/python/Reference/V2025/Models/CreateScheduledSearchRequest.md
2025-04-01 09:23:12 -04:00

2.8 KiB

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags
id title pagination_label sidebar_label sidebar_class_name keywords slug tags
v2025-create-scheduled-search-request CreateScheduledSearchRequest CreateScheduledSearchRequest CreateScheduledSearchRequest pythonsdk
python
Python
sdk
CreateScheduledSearchRequest
V2025CreateScheduledSearchRequest
/tools/sdk/python/v2025/models/create-scheduled-search-request
SDK
Software Development Kit
CreateScheduledSearchRequest
V2025CreateScheduledSearchRequest

CreateScheduledSearchRequest

Properties

Name Type Description Notes
name str The name of the scheduled search. [optional]
description str The description of the scheduled search. [optional]
saved_search_id str The ID of the saved search that will be executed. [required]
created datetime The date the scheduled search was initially created. [optional] [readonly]
modified datetime The last date the scheduled search was modified. [optional] [readonly]
schedule Schedule2 [required]
recipients []SearchScheduleRecipientsInner A list of identities that should receive the scheduled search report via email. [required]
enabled bool Indicates if the scheduled search is enabled. [optional] [default to False]
email_empty_results bool Indicates if email generation should occur when search returns no results. [optional] [default to False]
display_query_details bool Indicates if the generated email should include the query and search results preview (which could include PII). [optional] [default to False]
}

Example

from sailpoint.v2025.models.create_scheduled_search_request import CreateScheduledSearchRequest

create_scheduled_search_request = CreateScheduledSearchRequest(
name='Daily disabled accounts',
description='Daily disabled accounts',
saved_search_id='554f1511-f0a1-4744-ab14-599514d3e57c',
created='2018-06-25T20:22:28.104Z',
modified='2018-06-25T20:22:28.104Z',
schedule=sailpoint.v2025.models.schedule_2.Schedule_2(
                    type = 'WEEKLY', 
                    months = null, 
                    days = null, 
                    hours = null, 
                    expiration = '2018-06-25T20:22:28.104Z', 
                    time_zone_id = 'America/Chicago', ),
recipients=[
                    sailpoint.v2025.models.search_schedule_recipients_inner.SearchSchedule_recipients_inner(
                        type = 'IDENTITY', 
                        id = '2c9180867624cbd7017642d8c8c81f67', )
                    ],
enabled=False,
email_empty_results=False,
display_query_details=False
)

[Back to top]