Skip to main content
Hides the topic from users who don’t satisfy the listed access grants, without blocking data access. For a user who doesn’t satisfy the listed grants, the topic is removed from the Omni UI, the same way hidden: true removes a topic. Unlike hidden, a user who satisfies the grants sees the topic normally. Existing queries and dashboard tiles built on the topic continue to work for users who don’t satisfy the grants.
hidden_unless_access_grants only curates which topics a user can see in the Omni UI - it does not control data access. A user who knows the topic name can still query it through the API, and the topic’s underlying views and fields remain queryable on their own. Use required_access_grants to block data access.

​
Syntax

​
Properties

​
string[]
An array of access grant names that control whether the topic is offered to a user. Each value must match an access grant defined in the model file’s access_grants parameter.Use | for OR conditions and & for AND conditions within the same array element, using the same syntax as required_access_grants. A grant name that doesn’t match an existing access grant hides the topic from everyone.

​
Composite topics and model defaults

Composite topics have their own version of this parameter; see hidden_unless_access_grants for composite topics. To apply a default hidden_unless_access_grants rule to every topic in a model, use default_topic_hidden_unless_access_grants.

​
Examples

Hide a topic unless a single access grant is satisfied
Hide a topic unless one of two access grants is satisfied
Hide a topic unless marketing OR sales AND product is satisfied