Skip to content
API Reference
Admin

Groups

Create Groups, manage their membership, and assign Roles that every member inherits

A Group is a named collection of Users in a Zone. Assign a Role to a Group and every member inherits it; reference a Group in an access policy and every member is covered by the rule.

Managing Groups requires the Admin organization Role, or the Manager Role on the custom Zone you are working in. See Roles & Permissions.

  1. Open the Groups page

    In Keycard Console, open People and select the Groups tab.

    The Groups tab of the People page, listing Groups with their identifiers and member counts The Groups tab of the People page, listing Groups with their identifiers and member counts
  2. Create the Group

    Click Create group, enter a Name, and click Create group.

    The New group dialog with a name entered The New group dialog with a name entered

    The identifier is derived from the name: Data Analysts becomes data-analysts. It must be unique within the Zone, and it is the value your policies match on. To change it, open the Group and click the gear icon to edit Group settings.

Only Users can be Group members. A User can belong to any number of Groups.

  1. Open PeopleGroups and click the Group to open its detail page.
  2. On the Members tab, click Add members and select the Users to add.
  3. To remove someone, use the button on their row.
The Members tab of a Group, listing its members and the Add members button The Members tab of a Group, listing its members and the Add members button

A User’s Groups are also shown on their detail page under People, on the Groups tab. You can add someone to a Group from there too, with Add to group.

The Groups tab of a User's detail page, listing the Groups they belong to The Groups tab of a User's detail page, listing the Groups they belong to

A Group can hold the same Roles a User can: either an organization Role or a custom Zone Role. Members inherit every Role assigned to the Group.

  1. Open PeopleGroups and click the Group to open its detail page.
  2. Select the Access tab.
  3. Choose the Organization role and any Zone access.
The Access tab of a Group, showing organization role, zone access, and the Cedar snippet for policy access The Access tab of a Group, showing organization role, zone access, and the Cedar snippet for policy access

The Policy access section on the same tab gives you the Cedar snippet that matches this Group, ready to paste into a policy.

Match a Group in Cedar with the in operator, using its identifier:

permit (
principal in Keycard::Group::"data-analysts",
action,
resource == Keycard::Resource::"<resource-identifier>"
);

Membership is resolved when the request is evaluated, so adding or removing a member changes access without a policy update and without the User signing in again. See Group-based policies.

Deleting a Group removes its memberships and its Role assignments. Members keep any Role assigned to them directly, and lose the Roles they held only through the Group. Policies referencing the deleted identifier stay valid but stop matching anyone.

  1. Open the Group’s detail page.
  2. Click the button in the header, choose Delete group, and confirm.