hcp iam groups update

Command: hcp iam groups update

The hcp iam groups update command updates a group.

Update can be used to update the display name or description of an existing group.

Usage

$ hcp iam groups update GROUP_NAME [Optional Flags]

Examples

Update a group's description:

$ hcp iam groups update example-group \
  --description="updated description" \
  --display-name="new display name"

Positional arguments

• GROUP_NAME - The name of the group to update. The name may be specified as either:

  • The group's resource name. Formatted as iam/organization/ORG_ID/group/GROUP_NAME
  • The resource name suffix, GROUP_NAME.

Flags

• --description=NEW_DESCRIPTION - New description for the group.

• --display-name=NEW_DISPLAY_NAME - New display name for the group.