list

Retrieves a paginated list of either deleted users or all users in a domain.

Synopsis

Implements the API documented at https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list

gsm users list [flags]

Options

      --customFieldMask string   A comma-separated list of schema names.
                                 All fields from these schemas are fetched. This should only be set when projection=custom
      --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.
                                 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.
                                 Either the customer or the domain parameter must be provided. (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.
                                 Either the customer or the domain parameter must be provided.
      --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           Property to use for sorting results.
                                 Acceptable values are:
                                 email       - Primary email of the user.
                                 familyName  - User's family name.
                                 givenName   - User's given name.
      --projection string        What subset of fields to fetch for this user.
                                 
                                 Acceptable values are:
                                 basic   - Do not include any custom fields for the user. (default)
                                 custom  - Include custom fields from schemas requested in customFieldMask.
                                 full    - Include all fields associated with this user.
      --query string             Query string for searching user fields.
                                 For more information on constructing user queries, see https://developers.google.com/admin-sdk/directory/v1/guides/search-users
      --showDeleted              If set to true, retrieves the list of deleted users.
      --sortOrder string         Whether to return results in ascending or descending order.
                                 Acceptable values are:
                                 ASCENDING   - Ascending order.
                                 DESCENDING  - Descending order.
      --viewType string          Whether to fetch the administrator-only or domain-wide public view of the user.
                                 For more information, see https://developers.google.com/admin-sdk/directory/v1/guides/manage-users#retrieve_users_non_admin.
                                 
                                 Acceptable values are:
                                 admin_view     - Results include both administrator-only and domain-public fields for the user. (default)
                                 domain_public  - Results only include fields for the user that are publicly visible to other users in the domain.
                                                  Contact sharing must be enabled for the domain.

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 users - Manage Users (Park of Admin SDK)