required_access_grants - Composite topics

Defines a list of access grants for the composite topic, which are used to control access. These grants apply in addition to the grants on each member topic. The values of this parameter must match the name of an access grant in the model file’s access_grants parameter. Refer to the Controlling data access guide for more information and examples.

Syntax

required_access_grants: [<grant_name>]

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

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

# Opt out of the model's default_topic_required_access_grants.
# Access is controlled by the member topics' grants only.
required_access_grants: []

Properties

string[]

An array of access grant names that control access to the composite topic. Each value must match an access grant defined in the model file. Use | for OR conditions and & for AND conditions within the same array element.

Behavior

These grants apply in addition to each member topic’s grants. They can restrict access to the composite topic, but they can’t grant access to member topic data a user is otherwise denied. If omitted, the model’s default_topic_required_access_grants applies, even when every member topic opts out of it. Set required_access_grants: [] to exclude the composite topic from the default.

Examples

The examples in this section use the following model and topics. In each table, the columns are user groups, where Both is a user in Finance and Marketing.

Model file

access_grants:
  finance:
    user_attribute: omni_user_groups
    allowed_values: [Finance]
  marketing:
    user_attribute: omni_user_groups
    allowed_values: [Marketing]

campaigns requires the marketing grant. orders has no grants.

campaigns.topic

required_access_grants: [marketing]

Restrict the composite topic

The composite topic requires finance.

orders_and_marketing.composite_topic

topics: [orders, campaigns]
required_access_grants: [finance]

With the marketing grant from campaigns, a user needs both finance and marketing to query it.

Topic	Finance	Marketing	Both
`orders`	✅	✅	✅
`campaigns`	❌	✅	✅
`orders_and_marketing`	❌	❌	✅

Grant access if either condition is met

Use a pipe (|) to require one of several grants. The composite topic requires finance or marketing.

orders_and_marketing.composite_topic

topics: [orders, campaigns]
required_access_grants: [finance|marketing]

With the marketing grant from campaigns, a user needs marketing to query it.

Topic	Finance	Marketing	Both
`orders`	✅	✅	✅
`campaigns`	❌	✅	✅
`orders_and_marketing`	❌	✅	✅

Opt out of the model default

The model default is finance, and both member topics opt out of it.

Model file

default_topic_required_access_grants: [finance]

orders.topic

required_access_grants: []

campaigns.topic

required_access_grants: [marketing]

Two composite topics use the same member topics. orders_and_marketing sets required_access_grants: [], so it requires only marketing.

orders_and_marketing.composite_topic

topics: [orders, campaigns]
required_access_grants: []

campaign_performance does not set required_access_grants, so the model default applies and it requires finance and marketing.

campaign_performance.composite_topic

topics: [orders, campaigns]

Topic	Finance	Marketing	Both
`orders`	✅	✅	✅
`campaigns`	❌	✅	✅
`orders_and_marketing`	❌	✅	✅
`campaign_performance`	❌	❌	✅

Getting started

Manage content

Analyze & build

Visualize & present

Deliver content

Model data

Manage integrations

required_access_grants - Composite topics

Syntax

Properties

Behavior

Examples

Restrict the composite topic

Grant access if either condition is met

Opt out of the model default

​Syntax

​Properties

​Behavior

​Examples

​Restrict the composite topic

​Grant access if either condition is met

​Opt out of the model default

Syntax

Properties

Behavior

Examples

Restrict the composite topic

Grant access if either condition is met

Opt out of the model default