Groups

This page describes IAM groups in Lenses.

Groups are a collection of users, service accounts and roles.

Assigning Users to Groups

Users can be assign to Groups in two ways:

1. Manual

2. Linked from the groups provided by your SSO provider

This behaviour can be toggled in the organizational settings of your profile. To control the default set the following in the config.yaml for HQ.

users_group_membership_management_mode: [manual|sso]

Groups can be defined with the following metadata:

1. Colour

2. Description

Each group has a resource that unique identifies it across an HQ installation.

Create a Group

To Create Group go to IAM->Groups->New Group, create the group, assign members, service accounts and roles.

IAM Groups

You can also manage Users via the CLI and YAML, for integration in your CI/CD pipelines.

terminal

➜  hq groups
Manage Groups.

Usage:
  hq groups [command]

Aliases:
  groups, grp

Available Commands:
  create      Creates a new Group.
  delete      Deletes a group.
  get         Gets a group by its name.
  list        Lists all groups
  metadata    Manages group metadata.
  update      Updates a group.