insert
Adds a user or group to the specified group.
Synopsis
Implements the API documented at https://developers.google.com/admin-sdk/directory/reference/rest/v1/members/insert
gsm members insert [flags]
Options
--delivery_settings string Defines mail delivery preferences of member.
Acceptable values are:
ALL_MAIL - All messages, delivered as soon as they arrive.
DAILY - No more than one message a day.
DIGEST - Up to 25 messages bundled into a single message.
DISABLED - Remove subscription.
NONE - No messages.
--email string The member's email address. A member can be a user or another group.
This property is required when adding a member to a group.
The email must be unique and cannot be an alias of another group.
If the email address is changed, the API automatically reflects the email address changes.
--fields string Fields allows partial responses to be retrieved.
See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
--groupKey string Identifies the group in the API request.
The value can be the group's email address, group alias, or the unique group ID.
-h, --help help for insert
--role string The member's role in a group. The API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1. For more information about a member's role, see the administration help center.
Acceptable values are:
MANAGER - This role is only available if the Google Groups for Business is enabled using the Admin console. A MANAGER role can do everything done by an OWNER role except make a member an OWNER or delete the group. A group can have multiple MANAGER members.
MEMBER - This role can subscribe to a group, view discussion archives, and view the group's membership list. For more information about member roles, see the administration help center.
OWNER - This role can send messages to the group, add or remove members, change member roles, change group's settings, and delete the group. An OWNER must be a member of the group. A group can have more than one OWNER. (default "MEMBER")
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 members - Manage group members (Part of Admin SDK)
- gsm members insert batch - Batch inserts members using a CSV file as input.
- gsm members insert recursive - Adds users to a group by referencing one or more organizational units and/or groups.