patch
Updates a Group.
Synopsis
Implements the API documented at https://cloud.google.com/identity/docs/reference/rest/v1/groups/patch Examples:
- Make group a security group: gsm groupsCi patch –email group@example.org –updateMask labels –labels “cloudidentity.googleapis.com/groups.security,cloudidentity.googleapis.com/groups.discussion_forum”
gsm groupsCi patch [flags]
Options
--email string Email address of the group.
This may be used instead of the name to do a lookup of the group resource name.
Note that this will cause an additional API call.
--fields string Fields allows partial responses to be retrieved.
See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
-h, --help help for patch
--labels strings 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": ""}.
An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
--name string The resource name of the Group.
Must be of the form groups/{group_id}.
--updateMask string The fully-qualified names of fields to update.
May only contain the following fields:
- patch:
- displayName
- description
- updateSecuritySettings
- memberRestriction.query (default)
A comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
Options inherited from parent commands
--compressOutput By default, GSM outputs "pretty" (indented) objects. By setting this flag, GSM's output will be compressed. This may or may not improve performance in scripts.
--config string config file (default is $HOME/.config/gsm/.gsm.yaml)
--delay int This delay (plus a random jitter between 0 and 50) will be applied after every command to avoid reaching quota and rate limits. Set to 0 to disable.
--dwdSubject string Specify a subject used for DWD impersonation (overrides value in config file)
--log string Set the path of the log file. Default is either ~/gsm.log or defined in your config file
--maxElapsedTime int This is the maximum total time that will be spent retrying a request in minutes. (default 15)
--maxRetryInterval int This is the maximum interval that will be used between retry attempts in seconds. (default 320)
--redirectPort int This is the TCP port on which GSM will create web server if you authenticate with a user account for the first time. This is necessary for the OAuth flow. See https://developers.google.com/identity/protocols/oauth2/native-app#redirect-uri_loopback (default 8081)
--retryOn ints Specify the HTTP error code(s) that GSM should retry on. Note that GSM will always retry on HTTP 403 errors that indicate a quota / rate limit error
--streamOutput Setting this flag will cause GSM to output slice values to stdout one by one, instead of one large object
SEE ALSO
- gsm groupsCi - Manage Google Groups with the Cloud Identity API
- gsm groupsCi patch batch - Batch patches groups using a CSV file as input.