Skip to main content

FilterAggregation

An additional filter to constrain the results of the search query.

Properties

NameTypeDescriptionNotes
namestrThe name of the filter aggregate to be included in the result.[required]
typeSearchFilterType[optional] [default to SearchFilterType.TERM]
var_fieldstrThe search field to apply the filter to. Prefix the field name with '@' to reference a nested object.[required]
valuestrThe value to filter on.[required]
}

Example

from sailpoint.v2024.models.filter_aggregation import FilterAggregation

filter_aggregation = FilterAggregation(
name='Entitlements',
type='TERM',
var_field='access.type',
value='ENTITLEMENT'
)

[Back to top]