access_filters

Limits access to rows in a dataset based on user attributes.

When enabled, users will be limited to rows in the topic that match their user attribute value. Refer to the Controlling data access guide for more information.

Omni expects every user to have a non-null value for any assigned access filter. Errors will arise if the user attribute value is null.

Syntax

access_filters:
  - field: "<view_name>.<field_name>"
    user_attribute: "<user_attribute_reference>"
    values_for_unfiltered: ["<value>", ...]
    enable_sql_like_wildcards: true/false

The enable_sql_like_wildcard parameter switches the access_filter comparison operator from = to LIKE but does not automatically add wildcards to your attribute value. To achieve pattern matching, you must manually include the % wildcard characters within the user attribute value itself (e.g., setting the attribute to [e-mail]%). This allows for granular control, enabling exact matches for some users and partial matches for others using the same filter configuration.

Properties

access_filters · object[] · required

An array of access filter configurations that limit row access based on user attributes.

Hide access_filters properties

field · string · required

The field to use as a filter, specified in the format view_name.field_name.

user_attribute · string · required

The reference of the user attribute to filter on.

values_for_unfiltered · string[]

User attribute values that allow unrestricted access. Users with these values will not have the access filter applied.

enable_sql_like_wildcards · boolean · default: "false"

Determines if exact match or % wildcard syntax should be applied.

Examples

Filter by brand_name

access_filters:
  - field: products.brand
    user_attribute: brand_name
    values_for_unfiltered: [all_brands]
    enable_sql_like_wildcards: true