searchDirectoryPeople

Provides a list of domain profiles and domain contacts in the authenticated user’s domain directory that match the search query.

Synopsis

Implements the API documented at https://developers.google.com/people/api/rest/v1/people/searchDirectoryPeople

gsm people searchDirectoryPeople [flags]

Options

      --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 searchDirectoryPeople
      --mergeSources strings   Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.
      --query string           Prefix query that matches fields in the person.
                               Does NOT use the readMask for determining what fields to match.
      --readMask string        A field mask to restrict which fields on each person are returned.
                               Multiple fields can be specified by separating them with commas.
                               Valid values are:
                               addresses
                               ageRanges
                               biographies
                               birthdays
                               calendarUrls
                               clientData
                               coverPhotos
                               emailAddresses
                               events
                               externalIds
                               genders
                               imClients
                               interests
                               locales
                               locations
                               memberships
                               metadata
                               miscKeywords
                               names
                               nicknames
                               occupations
                               organizations
                               phoneNumbers
                               photos
                               relations
                               sipAddresses
                               skills
                               urls
                               userDefined
      --sources string         A mask of what source types to return.
                               DIRECTORY_SOURCE_TYPE_DOMAIN_CONTACT  - Workspace domain shared contact.
                               DIRECTORY_SOURCE_TYPE_DOMAIN_PROFILE  - Workspace domain profile.
                               READ_SOURCE_TYPE_PROFILE              - Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.
                               READ_SOURCE_TYPE_CONTACT              - Returns SourceType.CONTACT.
                               READ_SOURCE_TYPE_DOMAIN_CONTACT       - Returns SourceType.DOMAIN_CONTACT.

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 people - Manage people’s contacts (Part of People API)