Skip to main content

SearchCriteria

Represents the search criteria for querying entitlements.

Properties

NameTypeDescriptionNotes
indices[]strA list of indices to search within. Must contain exactly one item, typically "entitlements".[required]
filtersmap[string]SearchCriteriaFiltersValueA map of filters applied to the search. Keys are filter names, and values are filter definitions.[optional]
querySearchCriteriaQuery[optional]
query_typestrSpecifies the type of query. Must be "TEXT" if textQuery is used.[optional]
text_querySearchCriteriaTextQuery[optional]
include_nestedboolWhether to include nested objects in the search results.[optional] [default to False]
sort[]strSpecifies the sorting order for the results.[optional]
search_after[]strUsed for pagination to fetch results after a specific point.[optional]
}

Example

from sailpoint.beta.models.search_criteria import SearchCriteria

search_criteria = SearchCriteria(
indices=[entitlements],
filters={status={type=TERMS, terms=[active, inactive]}},
query=sailpoint.beta.models.search_criteria_query.SearchCriteria_query(),
query_type='TEXT',
text_query=sailpoint.beta.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]