Group policy

Understanding and setting up group policies in Verily Workbench

Purpose: This document explains the purpose of a group policy in Verily Workbench and how to apply one to a workspace or data collection.


Introduction

What is a group policy?

A group policy limits the eligible access of workspace and data sharing to members of all selected groups. A group policy does not grant access, but can be used as an additional layer of access control. Like other policy types, a group policy can’t be removed once it’s been applied, and carries over to any duplicates.

A "group" in a group policy can include Workbench groups, pods, or organizations.

Why apply a group policy?

A group policy will help you limit sharing of your workspace or data collection, ensuring that only approved users have access.

What restrictions does a group policy enforce?

If a group policy is applied to a workspace or data collection, a user must be a member of all groups specified in the group policy to view and/or edit it.

Venn diagram showing how groups in a workspace and a data collection create a group policy encompassing all defined groups.
Collaborators will need to be a member of all groups if a group policy is defined in a workspace and in a data collection that is imported to a workspace.

Getting started

Apply a group policy to a new workspace or data collection

In the Workbench UI, create a new workspace or data collection.

You'll be able to add a group policy in the Set policies step. Select Limit discoverability to people who are members of all selected groups. Click on the Groups dropdown to see the group(s) you can add to the group policy.

Screenshot of Create a new workspace dialog that shows the step where you can add a group policy.
Add group(s) to a group policy for a new workspace.

To confirm the members of the group(s) you want to add, run the wb group list-users CLI command. If you need to create a new group, see Creating and managing groups for details.

Select the group(s) you'd like to add to the group policy and proceed to the last step to create your workspace or data collection.

Apply a group policy to an existing workspace or data collection

Click the Edit button in the upper right corner of your workspace or data collection in the Workbench UI.

In the Edit dialog, click on the Groups dropdown to add groups to the group policy. Click Update to save your changes.

Screenshot of Edit workspace dialog, showing dropdown for groups to add to group policy.
Add a group to a group policy on an existing workspace.

View your group policy

You can confirm the policy has been successfully applied by clicking the "active" link next to Policies. A dialog will open showing the allowed group(s).

Screenshot of Policies dialog that shows the group policy in place for a workspace.
View the group policy applied to your workspace or data collection.

Expected behavior

If you duplicate a workspace or data collection, the duplicate will inherit any policies applied to the original.

You can't remove a group policy once it's been applied to a workspace or data collection. However, group admins can add and remove people from groups at any time.

If you share a workspace or data collection with a group policy applied, the user you're sharing to must be in the selected group(s). Otherwise, they won't be able to view it.

Screenshot of Share data collection dialog, showing an alert that the data collection has a group policy.
Even if you share a data collection to another user, that user must be part of all groups specified in the collection's group policy.

Screenshot of alert on Workspaces page informing user that they don't have access to a workspace because of group policy constraints.
This alert appears at the top of the Your workspaces page if workspaces have been shared with you, but you're not a member of the group(s) specified in the group policy.

Last Modified: 13 November 2024