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.

Each grant targets a user attribute. Users will be granted access if their corresponding user attribute has any of the values specified in the grant. Access grants are only applied to direct access and queries, meaning they don’t impact references within the model. For example, if a user can’t see field a but can see field b, and b references a, the user can still access and query using field b. Once defined, access grants can be set for topics and fields with the required_access_grants parameter.

​
Syntax

access_grants:
  access_grant_name:
    user_attribute: "<user_attribute_reference>"
    allowed_values: ["<value_one>", "<value_two>", ...]
    access_boostable: true/false

​
Properties

​
access_grant_name
string
required
A name that uniquely identifies the grant.

​
Examples

Grant access for California and Pennsylvania regions
access_grants:
  region_access:
    user_attribute: "region"
    allowed_values: ["California", "Pennsylvania"]
    access_boostable: false
Grant access for user group
access_grants:
  blob_sales_access:
    user_attribute: "omni_user_groups"
    allowed_values: ["Blob Sales"]
    access_boostable: false