list
Retrieve all groups of a domain or of a user given a userKey (paginated).
Synopsis
Implements the API documented at https://developers.google.com/admin-sdk/directory/reference/rest/v1/groups/list
gsm groups list [flags]
Options
--customer string The unique ID for the customer's Workspace account.
In case of a multi-domain account, to fetch all groups for a customer, fill this field instead of domain.
As an account administrator, you can also use the my_customer alias to represent your account's customerId.
The customerId is also returned as part of the Users resource. (default "my_customer")
--domain string The domain name.
Use this field to get fields from only one domain.
To return all domains for a customer account, use the customer query parameter instead.
--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 list
--orderBy string Column to use for sorting results
Acceptable values are:
email - Email of the group.
--query string Query string search. Should be of the form "".
Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-groups
--sortOrder string Whether to return results in ascending or descending order. Only of use when orderBy is also used
Acceptable values are:
ASCENDING - Ascending order.
DESCENDING - Descending order.
--userKey string Email or immutable ID of the user if only those groups are to be listed, the given user is a member of.
If it's an ID, it should match with the ID of the user object.
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 groups - Implements the groups API (Part of Admin SDK).