batch

Batch retrieves users using a CSV file as input.

Synopsis

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

gsm users get batch [flags]

Options

      --batchThreads int             Specify the number of threads that should be used for batch commands (overrides value in config file. Max 16)
      --customFieldMask int          A comma-separated list of schema names.
                                     All fields from these schemas are fetched. This should only be set when projection=custom
      --customFieldMask_ALL string   Same as customFieldMask but value is applied to all lines in the CSV file
      --delimiter string             Delimiter to use for CSV columns. Must be exactly one character. Default is ';'
      --fields int                   Fields allows partial responses to be retrieved.
                                     See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
      --fields_ALL string            Same as fields but value is applied to all lines in the CSV file
  -h, --help                         help for batch
      --path string                  Path of the import file (CSV)
      --projection int               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.
      --projection_ALL string        Same as projection but value is applied to all lines in the CSV file
      --skipHeader                   Whether to skip the first row (header)
      --userKey int                  Identifies the user in the API request.
                                     The value can be the user's primary email address, alias email address, or unique user ID.
      --viewType int                 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.
      --viewType_ALL string          Same as viewType but value is applied to all lines in the CSV file

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 get - Retrieves a user.