required_access_grants (for joins)

This page refers to the required_access_grants parameter that is part of a join.

required_access_grants can also be part of an Explore, described on the required_access_grants (for Explores) parameter documentation page.

required_access_grants can also be part of a view, described on the required_access_grants (for views) parameter documentation page.

required_access_grants can also be part of a dimension, dimension group, measure, filter, or parameter, described on the required_access_grants parameter documentation page.

Usage

explore: explore_name {
  join: view_name {
    required_access_grants: [access_grant_name, access_grant_name, ...]
  }
}

Hierarchy Model File explore join required_access_grants

Default Value None Accepts Square brackets containing a comma-separated list of access grant names

Definition

required_access_grants pairs with the model-level access_grant parameter to limit access of a join to only those users who have been assigned a specific user attribute value.

required_access_grants works like this:

1. You define an access grant using the access_grant parameter. As part of the definition, you associate the access grant with a user attribute. You also specify which user attribute values provide access to the access grant.
2. Next, you use required_access_grants to restrict a join to only users who have access to every access grant listed.

This LookML requires that users have access to both the can_view_financial_data and the view_payroll access grants to see the payroll join:

join: payroll {
  ...
  required_access_grants: [can_view_financial_data, view_payroll]
}

Users who don't have access to all of the access grants assigned to the join will not see any of the fields added to an Explore through the restricted join. They will not see those fields in the field picker while exploring. If users view a Look that includes fields they don't have access to, they see a warning message saying, "<view.field> no longer exists on <view>, or you do not have access to it, and it will be ignored." The warning message is suppressed on dashboard tiles.

For more information on how to define an access grant, see the access_grant parameter documentation page.

Example

Expose the payroll join to only those users who have access to the pr_dept access grant:

explore: financial {
  join: payroll {
    ...
    required_access_grants: [pr_dept]
  }
}

Additional considerations

Viewing restricted joins with calculated fields on saved Looks and dashboards

Since users who do not have access to a restricted join cannot see the fields added by the join, this can change the data they see in a saved Look or dashboard tile.

For example, a measure that uses a dimension from a restricted join will not have access to the data for that dimension, so the measure aggregation occurs without that data. Thus, users who do not have access to the restricted join will see different data for the measure than users who do have access to the restricted join.

Table calculations based on a field in a restricted join display an error for users who do not have access to the restricted join, since the table calculation does not have access to the field in the restricted join.

Restricting access to underlying LookML structures

Restricting access to a join does not restrict access to its underlying LookML structures. An unrestricted view or field that is part of other joins will still be available if those joins are unrestricted. Use the required_access_grants parameter at the view or field level to restrict those items individually.