Skip to main content
← back to extensions

Gcp/people

@swamp/gcp/peoplev2026.10.23.1· AGPL-3.0-or-later(was none)· 2d agoBEHAVIORS
01README

Google Cloud people infrastructure models

02Release Notes
  • Updated: contactgroups, othercontacts, people, people_connections
03Behaviors4
contactgroups.tsv2026.10.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
contactGroup?objectThe client specified key of the client data.
readGroupFields?stringOptional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
updateGroupFields?stringOptional. A field mask to restrict which fields on the group are updated. Multiple fields can be specified by separating them with commas. Defaults to `name` if not set or set to empty. Updated fields are replaced. Valid values are: * clientData * name
fn create()
Create a contactGroups
fn get(identifier: string)
Get a contactGroups
ArgumentTypeDescription
identifierstringThe name of the contactGroups
fn update(identifier?: string)
Update contactGroups attributes
ArgumentTypeDescription
identifier?stringTarget a specific contactGroups by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the contactGroups
ArgumentTypeDescription
identifierstringThe name of the contactGroups
fn sync(identifier?: string)
Sync contactGroups state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific contactGroups by name (e.g. one discovered by list)
fn list(groupFields?: string, pageSize?: number, syncToken?: string, maxPages?: number)
List contactGroups resources
ArgumentTypeDescription
groupFields?stringOptional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
pageSize?numberOptional. The maximum number of resources to return. Valid values are between 1 and 1000, inclusive. Defaults to 30 if not set or set to 0.
syncToken?stringOptional. A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn batch_get(groupFields?: any, maxMembers?: any, resourceNames?: any)
batch get
ArgumentTypeDescription
groupFields?any
maxMembers?any
resourceNames?any

Resources

state(infinite)— A contact group.
othercontacts.tsv2026.10.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
fn get(identifier: string)
Get a otherContacts
ArgumentTypeDescription
identifierstringThe name of the otherContacts
fn sync(identifier?: string)
Sync otherContacts state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific otherContacts by name (e.g. one discovered by list)
fn list(pageSize?: number, readMask?: string, requestSyncToken?: boolean, sources?: string, syncToken?: string, maxPages?: number)
List otherContacts resources
ArgumentTypeDescription
pageSize?numberOptional. The number of "Other contacts" to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
readMask?stringRequired. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. What values are valid depend on what ReadSourceType is used. If READ_SOURCE_TYPE_CONTACT is used, valid values are: * emailAddresses * metadata * names * phoneNumbers * photos If READ_SOURCE_TYPE_PROFILE is used, 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
requestSyncToken?booleanOptional. Whether the response should return `next_sync_token` on the last page of results. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `otherContacts.list`.
sources?stringOptional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set. Possible values for this field are: * READ_SOURCE_TYPE_CONTACT * READ_SOURCE_TYPE_CONTACT,READ_SOURCE_TYPE_PROFILE Specifying READ_SOURCE_TYPE_PROFILE without specifying READ_SOURCE_TYPE_CONTACT is not permitted.
syncToken?stringOptional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `otherContacts.list` must match the first call that provided the sync token. More details about sync behavior at `otherContacts.list`.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn copy_other_contact_to_my_contacts_group(copyMask?: any, readMask?: any, sources?: any)
copy other contact to my contacts group
ArgumentTypeDescription
copyMask?any
readMask?any
sources?any
fn search(pageSize?: any, query?: any, readMask?: any)
search
ArgumentTypeDescription
pageSize?any
query?any
readMask?any

Resources

state(infinite)— Information about a person merged from various data sources such as the authe...
people.tsv2026.10.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
fn get(identifier: string)
Get a people
ArgumentTypeDescription
identifierstringThe name of the people
fn delete(identifier: string)
Delete the people
ArgumentTypeDescription
identifierstringThe name of the people
fn sync(identifier?: string)
Sync people state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific people by name (e.g. one discovered by list)
fn batch_create_contacts(contacts?: any, readMask?: any, sources?: any)
batch create contacts
ArgumentTypeDescription
contacts?any
readMask?any
sources?any
fn batch_delete_contacts(resourceNames?: any)
batch delete contacts
ArgumentTypeDescription
resourceNames?any
fn batch_update_contacts(contacts?: any, readMask?: any, sources?: any, updateMask?: any)
batch update contacts
ArgumentTypeDescription
contacts?any
readMask?any
sources?any
updateMask?any
fn create_contact(addresses?: any, ageRange?: any, ageRanges?: any, biographies?: any, birthdays?: any, braggingRights?: any, calendarUrls?: any, clientData?: any, coverPhotos?: any, emailAddresses?: any, etag?: any, events?: any, externalIds?: any, fileAses?: any, genders?: any, imClients?: any, interests?: any, locales?: any, locations?: any, memberships?: any, metadata?: any, miscKeywords?: any, names?: any, nicknames?: any, occupations?: any, organizations?: any, phoneNumbers?: any, photos?: any, relations?: any, relationshipInterests?: any, relationshipStatuses?: any, residences?: any, resourceName?: any, sipAddresses?: any, skills?: any, taglines?: any, urls?: any, userDefined?: any, personFields?: any, sources?: any)
create contact
ArgumentTypeDescription
addresses?any
ageRange?any
ageRanges?any
biographies?any
birthdays?any
braggingRights?any
calendarUrls?any
clientData?any
coverPhotos?any
emailAddresses?any
etag?any
events?any
externalIds?any
fileAses?any
genders?any
imClients?any
interests?any
locales?any
locations?any
memberships?any
metadata?any
miscKeywords?any
names?any
nicknames?any
occupations?any
organizations?any
phoneNumbers?any
photos?any
relations?any
relationshipInterests?any
relationshipStatuses?any
residences?any
resourceName?any
sipAddresses?any
skills?any
taglines?any
urls?any
userDefined?any
personFields?any
sources?any
fn get_batch_get(personFields?: any, requestMask_includeField?: any, resourceNames?: any, sources?: any)
get batch get
ArgumentTypeDescription
personFields?any
requestMask_includeField?any
resourceNames?any
sources?any
fn list_directory_people(mergeSources?: any, pageSize?: any, pageToken?: any, readMask?: any, requestSyncToken?: any, sources?: any, syncToken?: any)
list directory people
ArgumentTypeDescription
mergeSources?any
pageSize?any
pageToken?any
readMask?any
requestSyncToken?any
sources?any
syncToken?any
fn search_contacts(pageSize?: any, query?: any, readMask?: any, sources?: any)
search contacts
ArgumentTypeDescription
pageSize?any
query?any
readMask?any
sources?any
fn search_directory_people(mergeSources?: any, pageSize?: any, pageToken?: any, query?: any, readMask?: any, sources?: any)
search directory people
ArgumentTypeDescription
mergeSources?any
pageSize?any
pageToken?any
query?any
readMask?any
sources?any
fn update_contact(addresses?: any, ageRange?: any, ageRanges?: any, biographies?: any, birthdays?: any, braggingRights?: any, calendarUrls?: any, clientData?: any, coverPhotos?: any, emailAddresses?: any, etag?: any, events?: any, externalIds?: any, fileAses?: any, genders?: any, imClients?: any, interests?: any, locales?: any, locations?: any, memberships?: any, metadata?: any, miscKeywords?: any, names?: any, nicknames?: any, occupations?: any, organizations?: any, phoneNumbers?: any, photos?: any, relations?: any, relationshipInterests?: any, relationshipStatuses?: any, residences?: any, resourceName?: any, sipAddresses?: any, skills?: any, taglines?: any, urls?: any, userDefined?: any, personFields?: any, sources?: any, updatePersonFields?: any)
update contact
ArgumentTypeDescription
addresses?any
ageRange?any
ageRanges?any
biographies?any
birthdays?any
braggingRights?any
calendarUrls?any
clientData?any
coverPhotos?any
emailAddresses?any
etag?any
events?any
externalIds?any
fileAses?any
genders?any
imClients?any
interests?any
locales?any
locations?any
memberships?any
metadata?any
miscKeywords?any
names?any
nicknames?any
occupations?any
organizations?any
phoneNumbers?any
photos?any
relations?any
relationshipInterests?any
relationshipStatuses?any
residences?any
resourceName?any
sipAddresses?any
skills?any
taglines?any
urls?any
userDefined?any
personFields?any
sources?any
updatePersonFields?any
fn update_contact_photo(personFields?: any, photoBytes?: any, sources?: any)
update contact photo
ArgumentTypeDescription
personFields?any
photoBytes?any
sources?any

Resources

state(infinite)— Information about a person merged from various data sources such as the authe...
people_connections.tsv2026.10.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
resourceNamestringRequired. The resource name to return connections for. Only `people/me` is valid.
fn get(identifier: string)
Get a connections
ArgumentTypeDescription
identifierstringThe name of the connections
fn sync(identifier?: string)
Sync connections state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific connections by name (e.g. one discovered by list)
fn list(pageSize?: number, personFields?: string, requestMask_includeField?: string, requestSyncToken?: boolean, sortOrder?: string, sources?: string, syncToken?: string, maxPages?: number)
List connections resources
ArgumentTypeDescription
pageSize?numberOptional. The number of connections to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.
personFields?stringRequired. 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
requestMask_includeField?stringRequired. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.
requestSyncToken?booleanOptional. Whether the response should return `next_sync_token` on the last page of results. It can be used to get incremental changes since the last request by setting it on the request `sync_token`. More details about sync behavior at `people.connections.list`.
sortOrder?stringOptional. The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`.
sources?stringOptional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.
syncToken?stringOptional. A sync token, received from a previous response `next_sync_token` Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `people.connections.list` must match the first call that provided the sync token. More details about sync behavior at `people.connections.list`.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— Information about a person merged from various data sources such as the authe...
04Previous Versions19
2026.10.13.1
  • Updated: contactgroups, othercontacts, people, people_connections
2026.10.06.1
  • Updated: contactgroups, othercontacts, people

Modified 1 behaviors

2026.09.07.2
  • Updated: people
2026.08.12.2
  • Updated: contactgroups, othercontacts, people, people_connections
2026.07.29.1
  • Updated: contactgroups, othercontacts, people, people_connections
2026.07.21.3
  • Updated: contactgroups, othercontacts, people, people_connections
2026.07.21.1
  • Updated: contactgroups
2026.07.20.1
  • Updated: contactgroups, othercontacts, people, people_connections
2026.07.19.2
  • Updated: people_connections
2026.07.19.1
  • Updated: contactgroups, othercontacts, people, people_connections
2026.07.18.1
  • Updated: contactgroups, othercontacts, people, people_connections
2026.06.08.2
  • Updated: contactgroups, othercontacts, people, people_connections
2026.06.07.1
  • Updated: contactgroups, othercontacts, people, people_connections
2026.05.25.2
  • Updated: contactgroups, othercontacts

Modified 1 behaviors

2026.05.24.1
  • Updated: contactgroups, othercontacts, people, people_connections
2026.05.21.2
  • Updated: contactgroups, othercontacts, people, people_connections
2026.05.21.1
2026.05.19.2
2026.05.19.1

Modified 1 behaviors

05Stats
A
100 / 100
Downloads
31
Archive size
60.6 KB
Verified by Swamp
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Docs keep secrets in a vault1/1earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository2/2earned
Repository
https://github.com/swamp-club/swamp-extensions
06Platforms
07Labels
#gcp#google-cloud#people#cloud#infrastructure