default_topic_hidden_unless_access_grants - Model files

Defines a default list of access grants for all topics contained in a model, unless other grants are applied at the topic level. A topic is hidden from a user in the Omni UI unless the user satisfies these access grants. Refer to hidden_unless_access_grants for details on how this visibility rule works.

This parameter only controls whether a topic is visible in the Omni UI. It does not control data access. Refer to the Controlling data access guide for parameters that restrict data access.

Syntax

default_topic_hidden_unless_access_grants: [access_grant_one, access_grant_two, ...]

Properties

string[]

A list of default access grants that control whether all topics in the model are hidden, including composite topics that don’t set their own hidden_unless_access_grants. These values must be the names of access grants defined in the model’s access_grants parameter.A topic or composite topic can opt out of the default with hidden_unless_access_grants: [].

Topics created from CSV/Excel uploads are automatically exempt from this default. They receive empty access grants ([]) at creation time, so the default can’t hide an uploaded topic from the user who uploaded it.

Examples

Hides all topics unless a user has the is_analyst grant

default_topic_hidden_unless_access_grants: [is_analyst]

access_grants:
  is_analyst:
    user_attribute: omni_user_groups
    allowed_values: [Analyst]

A topic that opts out of the default so all users can see it

topics:
  clean_topic:
    hidden_unless_access_grants: []

Getting started

Manage content

Analyze & build

Visualize & present

Deliver content

Model data

Manage integrations

default_topic_hidden_unless_access_grants - Model files

Syntax

Properties

Examples

​Syntax

​Properties

​Examples

Syntax

Properties

Examples