developer.sailpoint.com/docs/tools/sdk/python/Reference/V2024/Models/Search.md

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

id	title	pagination_label	sidebar_label	sidebar_class_name	keywords	slug	tags
v2024-search	Search	Search	Search	pythonsdk	python Python sdk Search V2024Search	/tools/sdk/python/v2024/models/search	SDK Software Development Kit Search V2024Search

Search

Properties

Name	Type	Description	Notes
indices	[]Index	The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched.	[optional]
query_type	QueryType		[optional] [default to QueryType.SAILPOINT]
query_version	str		[optional]
query	Query		[optional]
query_dsl	object	The search query using the Elasticsearch Query DSL syntax.	[optional]
text_query	TextQuery		[optional]
type_ahead_query	TypeAheadQuery		[optional]
include_nested	bool	Indicates whether nested objects from returned search results should be included.	[optional] [default to True]
query_result_filter	QueryResultFilter		[optional]
aggregation_type	AggregationType		[optional] [default to AggregationType.DSL]
aggregations_version	str		[optional]
aggregations_dsl	object	The aggregation search query using Elasticsearch Aggregations syntax.	[optional]
aggregations	SearchAggregationSpecification		[optional]
sort	[]str	The fields to be used to sort the search results. Use + or - to specify the sort direction.	[optional]
search_after	[]str	Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging. For example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example ["displayName", "id"]. If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is "John Doe", then using that displayName and ID will start a new search after this identity. The searchAfter value will look like ["John Doe","2c91808375d8e80a0175e1f88a575221"]	[optional]
filters	map[string]Filter	The filters to be applied for each filtered field name.	[optional]
}

Example

from sailpoint.v2024.models.search import Search

search = Search(
indices=[identities],
query_type='SAILPOINT',
query_version=,
query=sailpoint.v2024.models.query.Query(
                    query = 'name:a*', 
                    fields = '[firstName,lastName,email]', 
                    time_zone = 'America/Chicago', 
                    inner_hit = sailpoint.v2024.models.inner_hit.InnerHit(
                        query = 'source.name:\"Active Directory\"', 
                        type = 'access', ), ),
query_dsl={match={name=john.doe}},
text_query=sailpoint.v2024.models.text_query.TextQuery(
                    terms = [The quick brown fox, 3141592, 7], 
                    fields = [displayName, employeeNumber, roleCount], 
                    match_any = False, 
                    contains = True, ),
type_ahead_query=sailpoint.v2024.models.type_ahead_query.TypeAheadQuery(
                    query = 'Work', 
                    field = 'source.name', 
                    nested_type = 'access', 
                    max_expansions = 10, 
                    size = 100, 
                    sort = 'desc', 
                    sort_by_value = True, ),
include_nested=True,
query_result_filter=sailpoint.v2024.models.query_result_filter.QueryResultFilter(
                    includes = [name, displayName], 
                    excludes = [stacktrace], ),
aggregation_type='DSL',
aggregations_version=,
aggregations_dsl={},
aggregations=,
sort=[displayName, +id],
search_after=[John Doe, 2c91808375d8e80a0175e1f88a575221],
filters={}
)

[Back to top]