Skip to main content
Defines a list of access grants for the topic, which are used to control access. The values of this parameter must match the name of an access grant in the model file’s access_grants parameter. Refer to the Controllilng data access guide for more information and examples. You can also conditionally allow access by using pipes (|) and ampersands (&) to create OR and AND conditions.

​
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>]

​
Properties

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

​
Examples

Define one required access grant
required_access_grants: [marketing]
Grant access if conditions are met for either access grant
required_access_grants: [marketing|sales]
Grant access if conditions are met for marketing OR sales AND product
required_access_grants: [marketing|sales&product]