> ## 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.

# hidden_unless_access_grants - Composite topics

> Hides the composite topic from users who don't satisfy the listed access grants, without blocking data access.

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](/modeling/topics/parameters/hidden) topic is removed.

<Warning>
  `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`](/modeling/composite-topics/parameters/required-access-grants) to block data access.
</Warning>

## Syntax

```yaml theme={null}
hidden_unless_access_grants: [<grant_name>]

# OR condition
hidden_unless_access_grants: [<grant_one>|<grant_two>]

# AND/OR conditions
hidden_unless_access_grants: [<grant_one>|<grant_two>&<grant_three>]

# Opt out of the model's default_topic_hidden_unless_access_grants.
# The composite topic is never hidden by this rule.
hidden_unless_access_grants: []
```

## Properties

<ParamField path="hidden_unless_access_grants" type="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`](/modeling/models/access-grants) parameter. Use `|` for `OR` conditions and `&` for `AND` conditions within the same array element, using the same syntax as [`required_access_grants`](/modeling/composite-topics/parameters/required-access-grants).
</ParamField>

## Behavior

If omitted, the model's [`default_topic_hidden_unless_access_grants`](/modeling/models/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

```yaml title="Hide a composite topic unless a single access grant is satisfied" theme={null}
topics: [orders, campaigns]
hidden_unless_access_grants: [is_analyst]
```

```yaml title="Opt out of the model's default_topic_hidden_unless_access_grants" theme={null}
topics: [orders, campaigns]
hidden_unless_access_grants: []
```
