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.suggested_entitlement_description.models.searchcriteria import Searchcriteria

searchcriteria = Searchcriteria(
indices=["entitlements"],
filters={"status":{"type":"TERMS","terms":["active","inactive"]}},
query=sailpoint.suggested_entitlement_description.models.searchcriteria_query.searchcriteria_query(
query = 'status:active', ),
query_type='TEXT',
text_query=sailpoint.suggested_entitlement_description.models.searchcriteria_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]