developer.sailpoint.com/docs/tools/sdk/python/Reference/V2024/Models/SearchCriteria.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-criteria	SearchCriteria	SearchCriteria	SearchCriteria	pythonsdk	python Python sdk SearchCriteria V2024SearchCriteria	/tools/sdk/python/v2024/models/search-criteria	SDK Software Development Kit SearchCriteria V2024SearchCriteria

SearchCriteria

Represents the search criteria for querying entitlements.

Properties

Name	Type	Description	Notes
indices	[]str	A list of indices to search within. Must contain exactly one item, typically "entitlements".	[required]
filters	map[string]SearchCriteriaFiltersValue	A map of filters applied to the search. Keys are filter names, and values are filter definitions.	[optional]
query	SearchCriteriaQuery		[optional]
query_type	str	Specifies the type of query. Must be "TEXT" if textQuery is used.	[optional]
text_query	SearchCriteriaTextQuery		[optional]
include_nested	bool	Whether to include nested objects in the search results.	[optional] [default to False]
sort	[]str	Specifies the sorting order for the results.	[optional]
search_after	[]str	Used for pagination to fetch results after a specific point.	[optional]
}

Example

from sailpoint.v2024.models.search_criteria import SearchCriteria

search_criteria = SearchCriteria(
indices=[entitlements],
filters={status={type=TERMS, terms=[active, inactive]}},
query=sailpoint.v2024.models.search_criteria_query.SearchCriteria_query(),
query_type='TEXT',
text_query=sailpoint.v2024.models.search_criteria_text_query.SearchCriteria_textQuery(
                    terms = [admin, user], 
                    fields = [role, name], 
                    match_any = True, ),
include_nested=True,
sort=[name:asc, createdAt:desc],
search_after=[12345, 67890]
)

[Back to top]