gcloud beta identity groups update - update a group
gcloud beta identity groups update EMAIL [--dynamic-user-query=DYNAMIC_USER_QUERY] [--labels=LABELS] [--add-posix-group=POSIX_GROUP | --clear-posix-groups | --remove-posix-groups=[POSIX_GROUP,...]] [--clear-description | --description=DESCRIPTION] [--clear-display-name | --display-name=DISPLAY_NAME] [GCLOUD_WIDE_FLAG ...]
(BETA) Update a group.
To update a group:
$ gcloud beta identity groups update eng-discuss@foo.com \ --display-name="New Engineer Discuss" \ --description="Group for engineering discussions"
To create a POSIX group from an existing Google Group:
$ gcloud beta identity groups update eng-discuss@foo.com \ --add-posix-group=name=eng,gid=1005
To remove POSIX information from a Google Group:
$ gcloud beta identity groups update eng-discuss@foo.com \ --remove-posix-groups=eng
The email address of the group to be updated.
- --dynamic-user-query=DYNAMIC_USER_QUERY
Query that determines the memberships of the dynamic group.
Example of a query: --dynamic-user-query="user.organizations.exists(org,org.title=='SWE')"
- --labels=LABELS
One or more label entries that apply to the group. Currently supported labels contain a key with an empty value.
Google Groups are the default type of group and have a label with a key of 'cloudidentity.googleapis.com/groups.discussion_forum' and an empty value.
Existing Google Groups can have an additional label with a key of 'cloudidentity.googleapis.com/groups.security' and an empty value added to them. This is an immutable change and the security label cannot be removed once added.
Dynamic groups have a label with a key of 'cloudidentity.googleapis.com/groups.dynamic'.
Identity-mapped groups for Cloud Search have a label with a key of 'system/groups/external' and an empty value.
Examples: {"cloudidentity.googleapis.com/groups.discussion_forum": ""} or {"system/groups/external": ""}.
- At most one of these can be specified:
- --add-posix-group=POSIX_GROUP
Group id (gid) and a name for a POSIX group that you want to add to the specified Cloud Identity group. You can specify multiple POSIX groups to add with multiple instances of this flag.
For example, use '--add-posix-group=gid=1005,name=eng' to add a single group, or '--add-posix-group=gid=1005,name=eng --add-posix-group=gid=1006,name=docs' to add multiple groups.
- --clear-posix-groups
Clear all POSIX groups from the specified Cloud Identity group.
- --remove-posix-groups=[POSIX_GROUP,...]
Remove POSIX groups from the specified Cloud Identity group. You can specify multiple POSIX groups by either name or gid by using a comma-separated list.
For example, use '--remove-posix-groups=1005,1006' to remove POSIX groups with group ids '1005' and '1006', or use '--remove-posix-groups=eng,docs' to remove POSIX groups named 'eng' and 'docs'.
- At most one of these can be specified:
- --clear-description
Clear existing description on group being updated.
- --description=DESCRIPTION
Replace existing description on group being updated.
- At most one of these can be specified:
- --clear-display-name
Clear existing display name on group being updated.
- --display-name=DISPLAY_NAME
Replace existing display name on group being updated.
These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, --help, --impersonate-service-account, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
This command uses the cloudidentity/v1beta1 API. The full documentation for this API can be found at: https://cloud.google.com/identity/
This command is currently in beta and might change without notice. These variants are also available:
$ gcloud identity groups update
$ gcloud alpha identity groups update