Skip to main content
Hides the composite 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 composite topic is removed from the Omni UI, including the workbook topic picker, the same way a hidden topic is removed.
hidden_unless_access_grants only curates which composite topics a user can see in the Omni UI - it does not control data access. Use required_access_grants to block data access.

​
Syntax

​
Properties

​
string[]
An array of access grant names that control whether the composite 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.

​
Behavior

If omitted, the model’s default_topic_hidden_unless_access_grants applies. Set hidden_unless_access_grants: [] to exclude the composite topic from the default. A composite topic that is hidden, whether because of its own hidden_unless_access_grants, the model default, or hidden: true, is also removed from the workbook topic picker.

​
Examples

Hide a composite topic unless a single access grant is satisfied
Opt out of the model's default_topic_hidden_unless_access_grants