Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omni.co/llms.txt

Use this file to discover all available pages before exploring further.

Defines a list of default required access grant for all topics contained in a model, unless other grants are applied at the topic level. Access grants control data access for topics in a model based on user attributes. Refer to the Controlling data access guide for an example of overriding a default topic access grant.

Syntax

default_topic_required_access_grants: [access_grant_one, access_grant_two, ...]
The values provided to this parameter must be the names of access grants defined in the model’s access_grants parameter.
Topics created from CSV/Excel uploads are automatically exempt from model-level default access grants. They receive empty access grants ([]) at creation time, making them accessible to all users including embed users. This ensures that uploaded CSVs remain accessible without additional configuration.

Examples

Defines finance as the required access grant for topics
default_topic_required_access_grants: [finance]

access_grants:
  nw_region:
    user_attribute: region
    allowed_values: [washington, idaho, oregon, wyoming, alaska]
  finance:
    user_attribute: omni_user_groups
    allowed_values: [Finance]
  marketing:
    user_attribute: omni_user_groups
    allowed_values: [Marketing]