Gcp/admin
@swamp/gcp/adminv2026.07.24.1
01README
Google Cloud admin infrastructure models
02Release Notes
- Updated: activities
03Models
activities.tsv2026.07.24.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| userKey | string | Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique Google Workspace profile ID or their primary email address. Must not be a deleted user. For a deleted user, call `users.list` in Directory API with `showDeleted=true`, then use the returned `ID` as the `userKey`. |
| applicationName | string | Application name for which the events are to be retrieved. |
fn get(identifier: string)
Get a activities
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the activities |
fn sync(identifier?: string)
Sync activities state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific activities by name (e.g. one discovered by list) |
fn list(actorIpAddress?: string, applicationInfoFilter?: string, customerId?: string, endTime?: string, eventName?: string, filters?: string, groupIdFilter?: string, includeSensitiveData?: boolean, maxResults?: number, networkInfoFilter?: string, orgUnitID?: string, resourceDetailsFilter?: string, startTime?: string, statusFilter?: string, maxPages?: number)
List activities resources
| Argument | Type | Description |
|---|---|---|
| actorIpAddress? | string | The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions. |
| applicationInfoFilter? | string | Optional. Used to filter on the `oAuthClientId` field present in [`ApplicationInfo`](#applicationinfo) message. **Usage** ``` GET...&applicationInfoFilter=oAuthClientId="clientId" GET...&applicationInfoFilter=oAuthClientId=%22clientId%22 ``` |
| customerId? | string | The unique ID of the customer to retrieve data for. |
| endTime? | string | Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: - *Date of the API's request for a report*: When the API created and retrieved the report. - *Report's start time*: The beginning of the timespan shown in the report. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error. - *Report's end time*: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the `endTime` is not specified, the report returns all activities from the `startTime` until the current time or the most recent 180 days if the `startTime` is more than 180 days in the past. For Gmail requests, `startTime` and `endTime` must be provided and the difference must not be greater than 30 days. |
| eventName? | string | The name of the event being queried by the API. Each `eventName` is related to a specific Google Workspace service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings `type` structure has all of the Calendar `eventName` activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings `type` and `eventName` parameters. For more information about `eventName` query strings and parameters, see the list of event names for various applications above in `applicationName`. |
| filters? | string | The `filters` query string is a comma-separated list composed of event parameters manipulated by relational operators. Event parameters are in the form `{parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...` These event parameters are associated with a specific `eventName`. An empty report is returned if the request's parameter doesn't belong to the `eventName`. For more information about the available `eventName` fields for each application and their associated parameters, go to the [ApplicationName](#applicationname) table, then click through to the Activity Events page in the Appendix for the application you want. In the following Drive activity examples, the returned list consists of all `edit` events where the `doc_id` parameter value matches the conditions defined by the relational operator. In the first example, the request returns all edited documents with a `doc_id` value equal to `12345`. In the second example, the report returns any edited documents where the `doc_id` value is not equal to `98765`. The `<>` operator is URL-encoded in the request's query string (`%3C%3E`): ``` GET...&eventName=edit&filters=doc_id==12345 GET...&eventName=edit&filters=doc_id%3C%3E98765 ``` A `filters` query supports these relational operators: * `==`—'equal to'. * `<>`—'not equal to'. Must be URL-encoded (%3C%3E). * `<`—'less than'. Must be URL-encoded (%3C). * `<=`—'less than or equal to'. Must be URL-encoded (%3C=). * `>`—'greater than'. Must be URL-encoded (%3E). * `>=`—'greater than or equal to'. Must be URL-encoded (%3E=). **Note:** The API doesn't accept multiple values of the same parameter. If a parameter is supplied more than once in the API request, the API only accepts the last value of that parameter. In addition, if an invalid parameter is supplied in the API request, the API ignores that parameter and returns the response corresponding to the remaining valid parameters. If no parameters are requested, all parameters are returned. |
| groupIdFilter? | string | Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: "id:abc123,id:xyz456" *Important:* To filter by groups, you must explicitly add the groups to your filtering groups allowlist. For more information about adding groups to filtering groups allowlist, see [Filter results by Google Group](https://support.google.com/a/answer/11482175) |
| includeSensitiveData? | boolean | Optional. When set to `true`, this field allows sensitive user-generated content to be included in the returned audit logs. This parameter is supported only for Rules (DLP) and Chat applications; using it with any other application will result in a permission error. |
| maxResults? | number | Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two pages. The response's `nextPageToken` property has the token to the second page. The `maxResults` query string is optional in the request. The default value is 1000. |
| networkInfoFilter? | string | Optional. Used to filter on the `regionCode` field present in [`NetworkInfo`](#networkinfo) message. **Usage** ``` GET...&networkInfoFilter=regionCode="IN" GET...&networkInfoFilter=regionCode=%22IN%22 ``` |
| orgUnitID? | string | ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results. |
| resourceDetailsFilter? | string | Optional. The `resourceDetailsFilter` query string is an AND separated list composed of [Resource Details](#resourcedetails) fields manipulated by relational operators. Resource Details Filters are in the form `{resourceDetails.field1}{relational operator}{field1 value} AND {resourceDetails.field2}{relational operator}{field2 value}...` All the inner fields are traversed using the `.` operator, as shown in the following example: ``` resourceDetails.id = "resourceId" AND resourceDetails.appliedLabels.id = "appliedLabelId" AND resourceDetails.appliedLabels.fieldValue.id = "fieldValueId" ``` `resourceDetailsFilter` query supports these relational operators: * `=`—\'equal to\'. * `!=`—\'not equal to\'. * `:`—\'exists\'. This is used for filtering on repeated fields. [`FieldValue`](#fieldvalue) types that are repeated in nature uses `exists` operator for filtering. The following [`FieldValue`](#fieldvalue) types are repeated: * [`TextListValue`](#textlistvalue) * [`SelectionListValue`](#selectionlistvalue) * [`UserListValue`](#userlistvalue) For example, in the following filter, [`SelectionListValue`](#selectionlistvalue), is a repeated field. The filter checks whether [`SelectionListValue`](#selectionlistvalue) contains `selection_id`: ``` resourceDetails.id = "resourceId" AND resourceDetails.appliedLabels.id = "appliedLabelId" AND resourceDetails.appliedLabels.fieldValue.id = "fieldValueId" AND resourceDetails.appliedLabels.fieldValue.type = "SELECTION_LIST_VALUE" AND resourceDetails.appliedLabels.fieldValue.selectionListValue.id: "id" ``` **Usage** ``` GET...&resourceDetailsFilter=resourceDetails.id = "resourceId" AND resourceDetails.appliedLabels.id = "appliedLabelId" GET...&resourceDetailsFilter=resourceDetails.id=%22resourceId%22%20AND%20resourceDetails.appliedLabels.id=%22appliedLabelId%22 ``` **Note the following**: * You must URL encode the query string before sending the request. * The API supports a maximum of 5 fields separated by the AND operator. - When filtering on deeper levels (e.g., [`AppliedLabel`](#appliedlabel), [`FieldValue`](#fieldvalue)), the IDs of all preceding levels in the hierarchy must be included in the filter. For example: Filtering on [`FieldValue`](#fieldvalue) requires [`AppliedLabel`](#appliedlabel) ID and resourceDetails ID to be present. *Sample Query*: ``` resourceDetails.id = "resourceId" AND resourceDetails.appliedLabels.id = "appliedLabelId" AND resourceDetails.appliedLabels.fieldValue.id = "fieldValueId" ``` * Filtering on inner [`FieldValue`](#fieldvalue) types like `longTextValue` and `textValue` requires `resourceDetails.appliedLabels.fieldValue.type` to be present. * Only Filtering on a single [`AppliedLabel`](#appliedlabel) id and [`FieldValue`](#fieldvalue) id is supported. |
| startTime? | string | Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from `startTime` until `endTime`. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error. For Gmail requests, `startTime` and `endTime` must be provided and the difference must not be greater than 30 days. |
| statusFilter? | string | Optional. Used to filter on the `statusCode` field present in [`Status`](#status) message. **Usage** ``` GET...&statusFilter=statusCode="200" GET...&statusFilter=statusCode=%22200%22 ``` |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn watch(address?: any, expiration?: any, id?: any, kind?: any, params?: any, payload?: any, resourceId?: any, resourceUri?: any, token?: any, type?: any)
watch
| Argument | Type | Description |
|---|---|---|
| address? | any | |
| expiration? | any | |
| id? | any | |
| kind? | any | |
| params? | any | |
| payload? | any | |
| resourceId? | any | |
| resourceUri? | any | |
| token? | any | |
| type? | any |
applications.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
fn get(identifier: string)
Get a applications
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the applications |
fn sync(identifier?: string)
Sync applications state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific applications by name (e.g. one discovered by list) |
fn list(customerId?: string, maxResults?: number, maxPages?: number)
List applications resources
| Argument | Type | Description |
|---|---|---|
| customerId? | string | Immutable ID of the Google Workspace account. |
| maxResults? | number | Maximum number of results to return. Default is 100. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
asps.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| userKey | string | Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. |
fn get(identifier: string)
Get a asps
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the asps |
fn delete(identifier: string)
Delete the asps
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the asps |
fn sync(identifier?: string)
Sync asps state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific asps by name (e.g. one discovered by list) |
fn list(maxPages?: number)
List asps resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
chromeosdevices.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| activeTimeRanges? | array | Duration of usage in milliseconds. |
| annotatedAssetId? | string | The asset identifier as noted by an administrator or specified during enrollment. |
| annotatedLocation? | string | The address or location of the device as noted by the administrator. Maximum length is `200` characters. Empty values are allowed. |
| annotatedUser? | string | The user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed. |
| autoUpdateThrough? | string | Output only. The timestamp after which the device will stop receiving Chrome updates or support. |
| backlightInfo? | array | Output only. Current brightness of the backlight, between 0 and max_brightness. |
| bluetoothAdapterInfo? | array | Output only. The MAC address of the adapter. |
| bootMode? | string | The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch). |
| chromeOsType? | enum | Output only. Chrome OS type of the device. |
| cpuInfo? | array | The CPU architecture. |
| cpuStatusReports? | array | CPU label |
| deprovisionReason? | enum | (Read-only) Deprovision reason. |
| deviceFiles? | array | Date and time the file was created |
| deviceId? | string | The unique ID of the Chrome device. |
| deviceLicenseType? | enum | Output only. Device license type. |
| diskSpaceUsage? | object | Output only. The total capacity value, in bytes. |
| diskVolumeReports? | array | Free disk space [in bytes] |
| dockMacAddress? | string | (Read-only) Built-in MAC address for the docking station that the device connected to. Factory sets Media access control address (MAC address) assigned for use by a dock. It is reserved specifically for MAC pass through device policy. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices. |
| etag? | string | ETag of the resource. |
| ethernetMacAddress? | string | The device's MAC address on the ethernet network interface. |
| ethernetMacAddress0? | string | (Read-only) MAC address used by the Chromebook’s internal ethernet port, and for onboard network (ethernet) interface. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices. |
| extendedSupportEligible? | boolean | Output only. Whether or not the device requires the extended support opt in. |
| extendedSupportEnabled? | boolean | Output only. Whether extended support policy is enabled on the device. |
| extendedSupportStart? | string | Output only. Date of the device when extended support policy for automatic updates starts. |
| fanInfo? | array | Output only. Fan speed in RPM. |
| firmwareVersion? | string | The Chrome device's firmware version. |
| firstEnrollmentTime? | string | Date and time for the first time the device was enrolled. |
| kind? | string | The type of resource. For the Chromeosdevices resource, the value is `admin#directory#chromeosdevice`. |
| lastDeprovisionTimestamp? | string | (Read-only) Date and time for the last deprovision of the device. |
| lastEnrollmentTime? | string | Date and time the device was last enrolled (Read-only) |
| lastKnownNetwork? | array | The IP address. |
| lastSync? | string | Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only) |
| macAddress? | string | The device's wireless MAC address. If the device does not have this information, it is not included in the response. |
| manufactureDate? | string | (Read-only) The date the device was manufactured in yyyy-mm-dd format. |
| meid? | string | The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices.html#export_meid). |
| model? | string | The device's model information. If the device does not have this information, this property is not included in the response. |
| notes? | string | Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed. |
| orderNumber? | string | The device's order number. Only devices directly purchased from Google have an order number. |
| orgUnitId? | string | The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). |
| orgUnitPath? | string | The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). |
| osUpdateStatus? | object | Date and time of the last reboot. |
| osVersion? | string | The Chrome device's operating system version. |
| osVersionCompliance? | enum | Output only. Device policy compliance status of the OS version. |
| platformVersion? | string | The Chrome device's platform version. |
| recentUsers? | array | The user's email address. This is only present if the user type is `USER_TYPE_MANAGED`. |
| screenshotFiles? | array | Date and time the file was created |
| serialNumber? | string | The Chrome device serial number entered when the device was enabled. This value is the same as the Admin console's *Serial Number* in the *Chrome OS Devices* tab. |
| status? | string | The status of the device. |
| supportEndDate? | string | Final date the device will be supported (Read-only) |
| systemRamFreeReports? | array | Date and time the report was received. |
| systemRamTotal? | string | Total RAM on the device [in bytes] (Read-only) |
| tpmVersionInfo? | object | TPM family. We use the TPM 2.0 style encoding, e.g.: TPM 1.2: "1.2" -> 312e3200 TPM 2.0: "2.0" -> 322e3000 |
| willAutoRenew? | boolean | Determines if the device will auto renew its support after the support end date. This is a read-only property. |
| customerId | string | The unique ID for the customer's Google Workspace account. 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](https://developers.google.com/workspace/admin/directory/v1/reference/users). |
fn get(identifier: string)
Get a chromeosdevices
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the chromeosdevices |
fn update(identifier?: string)
Update chromeosdevices attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific chromeosdevices by name (e.g. one discovered by list) |
fn sync(identifier?: string)
Sync chromeosdevices state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific chromeosdevices by name (e.g. one discovered by list) |
fn list(includeChildOrgunits?: boolean, maxResults?: number, orderBy?: string, orgUnitPath?: string, projection?: string, query?: string, sortOrder?: string, maxPages?: number)
List chromeosdevices resources
| Argument | Type | Description |
|---|---|---|
| includeChildOrgunits? | boolean | Return devices from all child orgunits, as well as the specified org unit. If this is set to true, 'orgUnitPath' must be provided. |
| maxResults? | number | Maximum number of results to return. Value should not exceed 300. |
| orderBy? | string | Device property to use for sorting results. |
| orgUnitPath? | string | The full path of the organizational unit (minus the leading `/`) or its unique ID. |
| projection? | string | Determines whether the response contains the full list of properties or only a subset. |
| query? | string | Search string in the format given at [List query operators](https://developers.google.com/workspace/admin/directory/v1/list-query-operators). |
| sortOrder? | string | Whether to return results in ascending or descending order. Must be used with the `orderBy` parameter. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn action(action?: any, deprovisionReason?: any)
action
| Argument | Type | Description |
|---|---|---|
| action? | any | |
| deprovisionReason? | any |
fn move_devices_to_ou(deviceIds?: any)
move devices to ou
| Argument | Type | Description |
|---|---|---|
| deviceIds? | any |
customer_devices_chromeos_commands.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| customerId | string | Immutable. ID of the Google Workspace account. |
| deviceId | string | Immutable. ID of Chrome OS Device. |
fn get(identifier: string)
Get a commands
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the commands |
fn sync(identifier?: string)
Sync commands state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific commands by name (e.g. one discovered by list) |
customers.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| alternateEmail? | string | The customer's secondary contact email address. This email address cannot be on the same domain as the `customerDomain` |
| customerCreationTime? | string | The customer's creation time (Readonly) |
| customerDomain? | string | The customer's primary domain name string. Do not include the `www` prefix when creating a new customer. |
| etag? | string | ETag of the resource. |
| id? | string | The unique ID for the customer's Google Workspace account. (Readonly) |
| kind? | string | Identifies the resource as a customer. Value: `admin#directory#customer` |
| language? | string | The customer's ISO 639-2 language code. See the [Language Codes](https://developers.google.com/workspace/admin/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`. |
| phoneNumber? | string | The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. |
| postalAddress? | object | A customer's physical address. The address can be composed of one to three lines. |
fn get(identifier: string)
Get a customers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the customers |
fn update(identifier?: string)
Update customers attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific customers by name (e.g. one discovered by list) |
fn sync(identifier?: string)
Sync customers state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific customers by name (e.g. one discovered by list) |
customers_chrome_printers.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| description? | string | Editable. Description of printer. |
| displayName? | string | Editable. Name of printer. |
| id? | string | Id of the printer. (During printer creation leave empty) |
| makeAndModel? | string | Editable. Make and model of printer. e.g. Lexmark MS610de Value must be in format as seen in ListPrinterModels response. |
| name? | string | Identifier. The resource name of the Printer object, in the format customers/{customer-id}/printers/{printer-id} (During printer creation leave empty) |
| orgUnitId? | string | Organization Unit that owns this printer (Only can be set during Printer creation) |
| uri? | string | Editable. Printer URI. |
| useDriverlessConfig? | boolean | Editable. flag to use driverless configuration or not. If it's set to be true, make_and_model can be ignored |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a printers
fn get(identifier: string)
Get a printers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the printers |
fn update(identifier?: string)
Update printers attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific printers by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the printers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the printers |
fn sync(identifier?: string)
Sync printers state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific printers by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, orgUnitId?: string, pageSize?: number, maxPages?: number)
List printers resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Search query. Search syntax is shared between this api and Admin Console printers pages. |
| orderBy? | string | The order to sort results by. Must be one of display_name, description, make_and_model, or create_time. Default order is ascending, but descending order can be returned by appending "desc" to the order_by field. For instance, "description desc" will return the printers sorted by description in descending order. |
| orgUnitId? | string | Organization Unit that we want to list the printers for. When org_unit is not present in the request then all printers of the customer are returned (or filtered). When org_unit is present in the request then only printers available to this OU will be returned (owned or inherited). You may see if printer is owned or inherited for this OU by looking at Printer.org_unit_id. |
| pageSize? | number | The maximum number of objects to return. The service may return fewer than this value. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn batch_create_printers(requests?: any)
batch create printers
| Argument | Type | Description |
|---|---|---|
| requests? | any |
fn batch_delete_printers(printerIds?: any)
batch delete printers
| Argument | Type | Description |
|---|---|---|
| printerIds? | any |
fn list_printer_models()
list printer models
customers_chrome_printservers.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| description? | string | Editable. Description of the print server (as shown in the Admin console). |
| displayName? | string | Editable. Display name of the print server (as shown in the Admin console). |
| id? | string | Immutable. ID of the print server. Leave empty when creating. |
| name? | string | Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}` |
| orgUnitId? | string | ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits). |
| uri? | string | Editable. Print server URI. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a printServers
fn get(identifier: string)
Get a printServers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the printServers |
fn update(identifier?: string)
Update printServers attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific printServers by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the printServers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the printServers |
fn sync(identifier?: string)
Sync printServers state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific printServers by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, orgUnitId?: string, pageSize?: number, maxPages?: number)
List printServers resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Search query in [Common Expression Language syntax](https://github.com/google/cel-spec). Supported filters are `display_name`, `description`, and `uri`. Example: `printServer.displayName=='marketing-queue'`. |
| orderBy? | string | Sort order for results. Supported values are `display_name`, `description`, or `create_time`. Default order is ascending, but descending order can be returned by appending \"desc\" to the `order_by` field. For instance, `orderBy=='description desc'` returns the print servers sorted by description in descending order. |
| orgUnitId? | string | If `org_unit_id` is present in the request, only print servers owned or inherited by the organizational unit (OU) are returned. If the `PrintServer` resource's `org_unit_id` matches the one in the request, the OU owns the server. If `org_unit_id` is not specified in the request, all print servers are returned or filtered against. |
| pageSize? | number | The maximum number of objects to return (default `100`, max `100`). The service might return fewer than this value. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn batch_create_print_servers(requests?: any)
batch create print servers
| Argument | Type | Description |
|---|---|---|
| requests? | any |
fn batch_delete_print_servers(printServerIds?: any)
batch delete print servers
| Argument | Type | Description |
|---|---|---|
| printServerIds? | any |
customerusagereports.tsv2026.07.21.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
fn get(identifier: string)
Get a customerUsageReports
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the customerUsageReports |
fn sync(identifier?: string)
Sync customerUsageReports state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific customerUsageReports by name (e.g. one discovered by list) |
domainaliases.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| creationTime? | string | The creation time of the domain alias. (Read-only). |
| domainAliasName? | string | The domain alias name. |
| parentDomainName? | string | The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer. |
| verified? | boolean | Indicates the verification state of a domain alias. (Read-only) |
| customer | string | Immutable ID of the Google Workspace account. |
fn create()
Create a domainAliases
fn get(identifier: string)
Get a domainAliases
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the domainAliases |
fn delete(identifier: string)
Delete the domainAliases
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the domainAliases |
fn sync(identifier?: string)
Sync domainAliases state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific domainAliases by name (e.g. one discovered by list) |
fn list(parentDomainName?: string, maxPages?: number)
List domainAliases resources
| Argument | Type | Description |
|---|---|---|
| parentDomainName? | string | Name of the parent domain for which domain aliases are to be fetched. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
domains.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| creationTime? | string | Creation time of the domain. Expressed in [Unix time](https://en.wikipedia.org/wiki/Epoch_time) format. (Read-only). |
| domainAliases? | array | The creation time of the domain alias. (Read-only). |
| domainName | string | The domain name of the customer. |
| isPrimary? | boolean | Indicates if the domain is a primary domain (Read-only). |
| verified? | boolean | Indicates the verification state of a domain. (Read-only). |
| customer | string | Immutable ID of the Google Workspace account. |
fn create()
Create a domains
fn get(identifier: string)
Get a domains
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the domains |
fn delete(identifier: string)
Delete the domains
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the domains |
fn sync(identifier?: string)
Sync domains state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific domains by name (e.g. one discovered by list) |
fn list(maxPages?: number)
List domains resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
entityusagereports.tsv2026.07.21.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| entityType | string | Represents the type of entity for the report. |
| entityKey | string | Represents the key of the object to filter the data with. It is a string which can take the value `all` to get activity events for all users, or any other value for an app-specific entity. For details on how to obtain the `entityKey` for a particular `entityType`, see the Entities Usage parameters reference guides. |
fn get(identifier: string)
Get a entityUsageReports
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the entityUsageReports |
fn sync(identifier?: string)
Sync entityUsageReports state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific entityUsageReports by name (e.g. one discovered by list) |
groups.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| adminCreated? | boolean | Read-only. Value is `true` if this group was created by an administrator rather than a user. |
| aliases? | array | Read-only. The list of a group's alias email addresses. To add, update, or remove a group's aliases, use the `groups.aliases` methods. If edited in a group's POST or PUT request, the edit is ignored. |
| description? | string | An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters. |
| directMembersCount? | string | The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group. |
| string | The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details. | |
| id? | string | Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`. |
| name? | string | The group's display name. |
| nonEditableAliases? | array | Read-only. The list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored. |
fn create()
Create a groups
fn get(identifier: string)
Get a groups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the groups |
fn update(identifier?: string)
Update groups attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific groups by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the groups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the groups |
fn sync(identifier?: string)
Sync groups state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific groups by name (e.g. one discovered by list) |
fn list(customer?: string, domain?: string, maxResults?: number, orderBy?: string, query?: string, sortOrder?: string, userKey?: string, maxPages?: number)
List groups resources
| Argument | Type | Description |
|---|---|---|
| customer? | string | The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use 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](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. |
| domain? | string | The domain name. Use this field to get groups from only one domain. To return all domains for a customer account, use the `customer` query parameter instead. |
| maxResults? | number | Maximum number of results to return. Max allowed value is 200. |
| orderBy? | string | Column to use for sorting results |
| query? | string | Query string search. Contains one or more search clauses, each with a field, operator, and value. For complete documentation, go to [Search for groups](https://developers.google.com/workspace/admin/directory/v1/guides/search-groups). |
| sortOrder? | string | Whether to return results in ascending or descending order. Only of use when orderBy is also used |
| 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. Cannot be used with the `customer` parameter. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
groups_aliases.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| alias? | string | |
| id? | string | |
| primaryEmail? | string | |
| groupKey | string | Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. |
fn create()
Create a aliases
fn get(identifier: string)
Get a aliases
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the aliases |
fn delete(identifier: string)
Delete the aliases
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the aliases |
fn sync(identifier?: string)
Sync aliases state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific aliases by name (e.g. one discovered by list) |
members.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| delivery_settings? | string | Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods. |
| email? | string | The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes. |
| id? | string | The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`. |
| role? | string | The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094). |
| status? | string | Status of member (Immutable) |
| type? | string | The type of group member. |
| groupKey | string | Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. |
fn create()
Create a members
fn get(identifier: string)
Get a members
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the members |
fn update(identifier?: string)
Update members attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific members by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the members
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the members |
fn sync(identifier?: string)
Sync members state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific members by name (e.g. one discovered by list) |
fn list(includeDerivedMembership?: boolean, maxResults?: number, roles?: string, maxPages?: number)
List members resources
| Argument | Type | Description |
|---|---|---|
| includeDerivedMembership? | boolean | Whether to list indirect memberships. Default: false. |
| maxResults? | number | Maximum number of results to return. Max allowed value is 200. |
| roles? | string | The `roles` query parameter allows you to retrieve group members by role. Allowed values are `OWNER`, `MANAGER`, and `MEMBER`. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn has_member()
has member
mobiledevices.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| customerId | string | The unique ID for the customer's Google Workspace account. 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](https://developers.google.com/workspace/admin/directory/v1/reference/users). |
fn get(identifier: string)
Get a mobiledevices
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the mobiledevices |
fn delete(identifier: string)
Delete the mobiledevices
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the mobiledevices |
fn sync(identifier?: string)
Sync mobiledevices state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific mobiledevices by id (e.g. one discovered by list) |
fn list(maxResults?: number, orderBy?: string, projection?: string, query?: string, sortOrder?: string, maxPages?: number)
List mobiledevices resources
| Argument | Type | Description |
|---|---|---|
| maxResults? | number | Maximum number of results to return. Max allowed value is 100. |
| orderBy? | string | Device property to use for sorting results. |
| projection? | string | Restrict information returned to a set of selected fields. |
| query? | string | Search string in the format given at https://developers.google.com/workspace/admin/directory/v1/search-operators |
| sortOrder? | string | Whether to return results in ascending or descending order. Must be used with the `orderBy` parameter. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn action(action?: any)
action
| Argument | Type | Description |
|---|---|---|
| action? | any |
orgunits.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| description? | string | Description of the organizational unit. |
| name | string | The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required. |
| orgUnitId? | string | The unique ID of the organizational unit. |
| orgUnitPath? | string | The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#update_user). |
| parentOrgUnitId? | string | The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set. |
| parentOrgUnitPath? | string | The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set. |
| customerId | string | The unique ID for the customer's Google Workspace account. 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](https://developers.google.com/workspace/admin/directory/v1/reference/users). |
fn create()
Create a orgunits
fn get(identifier: string)
Get a orgunits
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the orgunits |
fn update(identifier?: string)
Update orgunits attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific orgunits by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the orgunits
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the orgunits |
fn sync(identifier?: string)
Sync orgunits state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific orgunits by name (e.g. one discovered by list) |
fn list(orgUnitPath?: string, type?: string, maxPages?: number)
List orgunits resources
| Argument | Type | Description |
|---|---|---|
| orgUnitPath? | string | The full path to the organizational unit or its unique ID. Returns the children of the specified organizational unit. |
| type? | string | Whether to return all sub-organizations or just immediate children. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
privileges.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| customer | string | The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use 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](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. |
fn get(identifier: string)
Get a privileges
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the privileges |
fn sync(identifier?: string)
Sync privileges state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific privileges by name (e.g. one discovered by list) |
fn list(maxPages?: number)
List privileges resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
resources_buildings.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| address? | object | Unstructured address lines describing the lower levels of an address. |
| buildingId? | string | Unique identifier for the building. The maximum length is 100 characters. |
| buildingName? | string | The building name as seen by users in Calendar. Must be unique for the customer. For example, "NYC-CHEL". The maximum length is 100 characters. |
| coordinates? | object | Latitude in decimal degrees. |
| description? | string | A brief description of the building. For example, "Chelsea Market". |
| etags? | string | ETag of the resource. |
| floorNames? | array | The display names for all floors in this building. The floors are expected to be sorted in ascending order, from lowest floor to highest floor. For example, ["B2", "B1", "L", "1", "2", "2M", "3", "PH"] Must contain at least one entry. |
| customer | string | The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID. |
| coordinatesSource? | string | Source from which Building.coordinates are derived. |
fn create()
Create a buildings
fn get(identifier: string)
Get a buildings
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the buildings |
fn update(identifier?: string)
Update buildings attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific buildings by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the buildings
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the buildings |
fn sync(identifier?: string)
Sync buildings state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific buildings by name (e.g. one discovered by list) |
fn list(maxResults?: number, maxPages?: number)
List buildings resources
| Argument | Type | Description |
|---|---|---|
| maxResults? | number | Maximum number of results to return. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
resources_calendars.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| buildingId? | string | Unique ID for the building a resource is located in. |
| capacity? | number | Capacity of a resource, number of seats in a room. |
| etags? | string | ETag of the resource. |
| featureInstances? | string | Instances of features for the calendar resource. |
| floorName? | string | Name of the floor a resource is located on. |
| floorSection? | string | Name of the section within a floor a resource is located in. |
| generatedResourceName? | string | The read-only auto-generated name of the calendar resource which includes metadata about the resource such as building name, floor, capacity, etc. For example, "NYC-2-Training Room 1A (16)". |
| resourceCategory? | string | The category of the calendar resource. Either CONFERENCE_ROOM or OTHER. Legacy data is set to CATEGORY_UNKNOWN. |
| resourceDescription? | string | Description of the resource, visible only to admins. |
| resourceEmail? | string | The read-only email for the calendar resource. Generated as part of creating a new calendar resource. |
| resourceId | string | The unique ID for the calendar resource. |
| resourceName | string | The name of the calendar resource. For example, "Training Room 1A". |
| resourceType? | string | The type of the calendar resource, intended for non-room resources. |
| userVisibleDescription? | string | Description of the resource, visible to users and admins. |
| customer | string | The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID. |
fn create()
Create a calendars
fn get(identifier: string)
Get a calendars
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the calendars |
fn update(identifier?: string)
Update calendars attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific calendars by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the calendars
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the calendars |
fn sync(identifier?: string)
Sync calendars state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific calendars by name (e.g. one discovered by list) |
fn list(maxResults?: number, orderBy?: string, query?: string, maxPages?: number)
List calendars resources
| Argument | Type | Description |
|---|---|---|
| maxResults? | number | Maximum number of results to return. |
| orderBy? | string | Field(s) to sort results by in either ascending or descending order. Supported fields include `resourceId`, `resourceName`, `capacity`, `buildingId`, and `floorName`. If no order is specified, defaults to ascending. Should be of the form "field [asc|desc], field [asc|desc], ...". For example `buildingId, capacity desc` would return results sorted first by `buildingId` in ascending order then by `capacity` in descending order. |
| query? | string | String query used to filter results. Contains one or more search clauses, each with a field, operator, and value. A field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match, '!=' for mismatch and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a *. Logical operators NOT and AND are supported (in this order of precedence). Supported fields include `generatedResourceName`, `name`, `buildingId`, `floor_name`, `capacity`, `featureInstances.feature.name`, `resourceEmail`, `resourceCategory`. For example `buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone`. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
resources_features.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| etags? | string | ETag of the resource. |
| name | string | The name of the feature. |
| customer | string | The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID. |
fn create()
Create a features
fn get(identifier: string)
Get a features
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the features |
fn update(identifier?: string)
Update features attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific features by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the features
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the features |
fn sync(identifier?: string)
Sync features state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific features by name (e.g. one discovered by list) |
fn list(maxResults?: number, maxPages?: number)
List features resources
| Argument | Type | Description |
|---|---|---|
| maxResults? | number | Maximum number of results to return. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn rename(newName?: any)
rename
| Argument | Type | Description |
|---|---|---|
| newName? | any |
roleassignments.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| assignedTo? | string | The unique ID of the entity this role is assigned to—either the `user_id` of a user, the `group_id` of a group, or the `uniqueId` of a service account as defined in [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/reference/rest/v1/projects.serviceAccounts). |
| condition? | string | Optional. The condition associated with this role assignment. Note: Feature is available to Enterprise Standard, Enterprise Plus, Google Workspace for Education Plus and Cloud Identity Premium customers. A `RoleAssignment` with the `condition` field set will only take effect when the resource being accessed meets the condition. If `condition` is empty, the role (`role_id`) is applied to the actor (`assigned_to`) at the scope (`scope_type`) unconditionally. Currently, the following conditions are supported: - To make the `RoleAssignment` only applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` - To make the `RoleAssignment` not applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` Currently, the condition strings have to be verbatim and they only work with the following [pre-built administrator roles](https://support.google.com/a/answer/2405986): - Groups Editor - Groups Reader The condition follows [Cloud IAM condition syntax](https://cloud.google.com/iam/docs/conditions-overview). - To make the `RoleAssignment` not applicable to [Locked Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.locked']) && resource.type == 'cloudidentity.googleapis.com/Group'` This condition can also be used in conjunction with a Security-related condition. |
| orgUnitId? | string | If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to. |
| roleAssignmentId? | string | ID of this roleAssignment. |
| roleId? | string | The ID of the role that is assigned. |
| scopeType? | string | The scope in which this role is assigned. |
| customer | string | Immutable ID of the Google Workspace account. |
fn create()
Create a roleAssignments
fn get(identifier: string)
Get a roleAssignments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the roleAssignments |
fn delete(identifier: string)
Delete the roleAssignments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the roleAssignments |
fn sync(identifier?: string)
Sync roleAssignments state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific roleAssignments by name (e.g. one discovered by list) |
fn list(includeIndirectRoleAssignments?: boolean, maxResults?: number, roleId?: string, userKey?: string, maxPages?: number)
List roleAssignments resources
| Argument | Type | Description |
|---|---|---|
| includeIndirectRoleAssignments? | boolean | When set to `true`, fetches indirect role assignments (i.e. role assignment via a group) as well as direct ones. Defaults to `false`. You must specify `user_key` or the indirect role assignments will not be included. |
| maxResults? | number | Maximum number of results to return. |
| roleId? | string | Immutable ID of a role. If included in the request, returns only role assignments containing this role ID. |
| userKey? | string | The primary email address, alias email address, or unique user or group ID. If included in the request, returns role assignments only for this user or group. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
roles.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| isSuperAdminRole? | boolean | Returns `true` if the role is a super admin role. |
| isSystemRole? | boolean | Returns `true` if this is a pre-defined system role. |
| roleDescription? | string | A short description of the role. |
| roleId? | string | ID of the role. |
| roleName | string | Name of the role. |
| rolePrivileges? | array | The name of the privilege. |
| customer | string | Immutable ID of the Google Workspace account. |
fn create()
Create a roles
fn get(identifier: string)
Get a roles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the roles |
fn update(identifier?: string)
Update roles attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific roles by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the roles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the roles |
fn sync(identifier?: string)
Sync roles state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific roles by name (e.g. one discovered by list) |
fn list(maxResults?: number, maxPages?: number)
List roles resources
| Argument | Type | Description |
|---|---|---|
| maxResults? | number | Maximum number of results to return. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
schemas.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| displayName | string | Display name for the schema. |
| fields? | array | Display Name of the field. |
| schemaId? | string | The unique identifier of the schema (Read-only) |
| schemaName | string | The schema's name. Each `schema_name` must be unique within a customer. Reusing a name results in a `409: Entity already exists` error. |
| customerId | string | Immutable ID of the Google Workspace account. |
fn create()
Create a schemas
fn get(identifier: string)
Get a schemas
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the schemas |
fn update(identifier?: string)
Update schemas attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific schemas by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the schemas
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the schemas |
fn sync(identifier?: string)
Sync schemas state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific schemas by name (e.g. one discovered by list) |
fn list(maxPages?: number)
List schemas resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
tokens.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| userKey | string | Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. |
fn get(identifier: string)
Get a tokens
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tokens |
fn delete(identifier: string)
Delete the tokens
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tokens |
fn sync(identifier?: string)
Sync tokens state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific tokens by name (e.g. one discovered by list) |
fn list(maxPages?: number)
List tokens resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
transfers.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| applicationDataTransfers? | array | The application's ID. |
| id? | string | Read-only. The transfer's ID. |
| newOwnerUserId? | string | ID of the user to whom the data is being transferred. |
| oldOwnerUserId? | string | ID of the user whose data is being transferred. |
| overallTransferStatusCode? | string | Read-only. Overall transfer status. |
| requestTime? | string | Read-only. The time at which the data transfer was requested. |
fn create()
Create a transfers
fn get(identifier: string)
Get a transfers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the transfers |
fn sync(identifier?: string)
Sync transfers state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific transfers by name (e.g. one discovered by list) |
fn list(customerId?: string, maxResults?: number, newOwnerUserId?: string, oldOwnerUserId?: string, status?: string, maxPages?: number)
List transfers resources
| Argument | Type | Description |
|---|---|---|
| customerId? | string | Immutable ID of the Google Workspace account. |
| maxResults? | number | Maximum number of results to return. Default is 100. |
| newOwnerUserId? | string | Destination user's profile ID. |
| oldOwnerUserId? | string | Source user's profile ID. |
| status? | string | Status of the transfer. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
users.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| addresses? | string | The list of the user's addresses. The maximum allowed data size for this field is 10KB. |
| archived? | boolean | Indicates if user is archived. |
| changePasswordAtNextLogin? | boolean | Indicates if the user is forced to change their password at next login. This setting doesn't apply when [the user signs in via a third-party identity provider](https://support.google.com/a/answer/60224). |
| creationTime? | string | User's G Suite account creation time. (Read-only) |
| customSchemas? | record | Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`. |
| deletionTime? | string | |
| emails? | string | The list of the user's email addresses. The maximum allowed data size for this field is 10KB. This excludes `publicKeyEncryptionCertificates`. |
| externalIds? | string | The list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2KB. |
| gender? | string | The user's gender. The maximum allowed data size for this field is 1KB. |
| guestAccountInfo? | object | Immutable. The guest's external email. |
| hashFunction? | string | Stores the hash format of the `password` property. The following `hashFunction` values are allowed: * `MD5` - Accepts simple hex-encoded values. * `SHA-1` - Accepts simple hex-encoded values. * `crypt` - Compliant with the [C crypt library](https://en.wikipedia.org/wiki/Crypt_%28C%29). Supports the DES, MD5 (hash prefix `$1$`), SHA-256 (hash prefix `$5$`), and SHA-512 (hash prefix `$6$`) hash algorithms. If rounds are specified as part of the prefix, they must be 10,000 or fewer. |
| id? | string | The unique ID for the user. A user `id` can be used as a user request URI's `userKey`. |
| ims? | string | The list of the user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2KB. |
| includeInGlobalAddressList? | boolean | Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988). |
| ipWhitelisted? | boolean | If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration. |
| isGuestUser? | boolean | Immutable. Indicates if the inserted user is a guest. |
| keywords? | string | The list of the user's keywords. The maximum allowed data size for this field is 1KB. |
| languages? | string | The user's languages. The maximum allowed data size for this field is 1KB. |
| lastLoginTime? | string | User's last login time. (Read-only) |
| locations? | string | The user's locations. The maximum allowed data size for this field is 10KB. |
| name? | object | The user's display name. Limit: 256 characters. |
| notes? | string | Notes for the user. |
| orgUnitPath? | string | The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (`/`). |
| organizations? | string | The list of organizations the user belongs to. The maximum allowed data size for this field is 10KB. |
| password | string | User's password |
| phones? | string | The list of the user's phone numbers. The maximum allowed data size for this field is 1KB. |
| posixAccounts? | string | The list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user. |
| primaryEmail | string | The user's primary email address. This property is required in a request to create a user account. The `primaryEmail` must be unique and cannot be an alias of another user. |
| recoveryEmail? | string | Recovery email of the user. |
| recoveryPhone? | string | Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: *+16506661212*. |
| relations? | string | The list of the user's relationships to other users. The maximum allowed data size for this field is 2KB. |
| sshPublicKeys? | string | A list of SSH public keys. |
| suspended? | boolean | Indicates if user is suspended. |
| websites? | string | The user's websites. The maximum allowed data size for this field is 2KB. |
| resolveConflictAccount? | string | Optional. If set to `true`, the option selected for [handling unmanaged user accounts](https://support.google.com/a/answer/11112794) will apply. Default: `false` |
fn create()
Create a users
fn get(identifier: string)
Get a users
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the users |
fn update(identifier?: string)
Update users attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific users by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the users
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the users |
fn sync(identifier?: string)
Sync users state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific users by name (e.g. one discovered by list) |
fn list(customFieldMask?: string, customer?: string, domain?: string, event?: string, maxResults?: number, orderBy?: string, projection?: string, query?: string, showDeleted?: string, sortOrder?: string, viewType?: string, maxPages?: number)
List users resources
| Argument | Type | Description |
|---|---|---|
| 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 Google Workspace account. In case of a multi-domain account, to fetch all users for a customer, use 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](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. |
| domain? | string | The domain name. Use this field to get users 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. |
| event? | string | Event on which subscription is intended (if subscribing) |
| maxResults? | number | Maximum number of results to return. |
| orderBy? | string | Property to use for sorting results. |
| projection? | string | What subset of fields to fetch for this user. |
| query? | string | Query string for searching user fields. For more information on constructing user queries, see [Search for Users](https://developers.google.com/workspace/admin/directory/v1/guides/search-users). |
| showDeleted? | string | If set to `true`, retrieves the list of deleted users. (Default: `false`) |
| sortOrder? | string | Whether to return results in ascending or descending order, ignoring case. |
| viewType? | string | Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin). |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn create_guest(customer?: any, primaryGuestEmail?: any)
create guest
| Argument | Type | Description |
|---|---|---|
| customer? | any | |
| primaryGuestEmail? | any |
fn make_admin(status?: any)
make admin
| Argument | Type | Description |
|---|---|---|
| status? | any |
fn sign_out()
sign out
fn undelete(orgUnitPath?: any)
undelete
| Argument | Type | Description |
|---|---|---|
| orgUnitPath? | any |
fn watch(address?: any, expiration?: any, id?: any, kind?: any, params?: any, payload?: any, resourceId?: any, resourceUri?: any, token?: any, type?: any)
watch
| Argument | Type | Description |
|---|---|---|
| address? | any | |
| expiration? | any | |
| id? | any | |
| kind? | any | |
| params? | any | |
| payload? | any | |
| resourceId? | any | |
| resourceUri? | any | |
| token? | any | |
| type? | any |
users_aliases.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| alias? | string | |
| id? | string | |
| primaryEmail? | string | |
| userKey | string | Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. |
fn create()
Create a aliases
fn get(identifier: string)
Get a aliases
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the aliases |
fn delete(identifier: string)
Delete the aliases
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the aliases |
fn sync(identifier?: string)
Sync aliases state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific aliases by name (e.g. one discovered by list) |
fn watch(address?: any, expiration?: any, id?: any, kind?: any, params?: any, payload?: any, resourceId?: any, resourceUri?: any, token?: any, type?: any)
watch
| Argument | Type | Description |
|---|---|---|
| address? | any | |
| expiration? | any | |
| id? | any | |
| kind? | any | |
| params? | any | |
| payload? | any | |
| resourceId? | any | |
| resourceUri? | any | |
| token? | any | |
| type? | any |
users_photos.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| etag? | string | ETag of the resource. |
| height? | number | Height of the photo in pixels. |
| id? | string | The ID the API uses to uniquely identify the user. |
| kind? | string | The type of the API resource. For Photo resources, this is `admin#directory#user#photo`. |
| mimeType? | string | The MIME type of the photo. Allowed values are `JPEG`, `PNG`, `GIF`, `BMP`, `TIFF`, and web-safe base64 encoding. |
| photoData? | string | The user photo's upload data in [web-safe Base64](https://en.wikipedia.org/wiki/Base64#URL_applications) format in bytes. This means: * The slash (/) character is replaced with the underscore (_) character. * The plus sign (+) character is replaced with the hyphen (-) character. * The equals sign (=) character is replaced with the asterisk (*). * For padding, the period (.) character is used instead of the RFC-4648 baseURL definition which uses the equals sign (=) for padding. This is done to simplify URL-parsing. * Whatever the size of the photo being uploaded, the API downsizes it to 96x96 pixels. |
| primaryEmail? | string | The user's primary email address. |
| width? | number | Width of the photo in pixels. |
fn get(identifier: string)
Get a photos
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the photos |
fn update(identifier?: string)
Update photos attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific photos by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the photos
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the photos |
fn sync(identifier?: string)
Sync photos state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific photos by name (e.g. one discovered by list) |
userusagereport.tsv2026.07.21.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| userKey | string | Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique Google Workspace profile ID or their primary email address. Must not be a deleted user. For a deleted user, call `users.list` in Directory API with `showDeleted=true`, then use the returned `ID` as the `userKey`. |
fn get(identifier: string)
Get a userUsageReport
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the userUsageReport |
fn sync(identifier?: string)
Sync userUsageReport state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific userUsageReport by name (e.g. one discovered by list) |
verificationcodes.tsv2026.07.21.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| userKey | string | Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. |
fn get(identifier: string)
Get a verificationCodes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the verificationCodes |
fn sync(identifier?: string)
Sync verificationCodes state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific verificationCodes by name (e.g. one discovered by list) |
fn list(maxPages?: number)
List verificationCodes resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn generate()
generate
fn invalidate()
invalidate
04Previous Versions
2026.07.21.4
- Added: applications, transfers, asps, chromeosdevices, customer_devices_chromeos_commands, customers, customers_chrome_printservers, customers_chrome_printers, domainaliases, domains, groups, groups_aliases, members, mobiledevices, orgunits, privileges, resources_buildings, resources_calendars, resources_features, roleassignments, roles, schemas, tokens, users, users_aliases, users_photos, verificationcodes
2026.07.21.1
- Updated: transfers, chromeosdevices, customers, domainaliases, domains, groups_aliases, members, resources_buildings, resources_calendars, roleassignments, roles, users, users_aliases
2026.07.20.2
- Added: applications, transfers, asps, chromeosdevices, customer_devices_chromeos_commands, customers, customers_chrome_printservers, customers_chrome_printers, domainaliases, domains, groups, groups_aliases, members, mobiledevices, orgunits, privileges, resources_buildings, resources_calendars, resources_features, roleassignments, roles, schemas, tokens, users, users_aliases, users_photos, verificationcodes
Added 1, removed 4 models
2026.07.20.1
- Updated: activities, customerusagereports, entityusagereports, userusagereport
Added 4, removed 1 models
2026.07.19.2
- Updated: asps, chromeosdevices, customer_devices_chromeos_commands, mobiledevices, privileges, tokens, verificationcodes, activities, entityusagereports, userusagereport
2026.07.19.1
- Updated: applications, transfers, asps, chromeosdevices, customer_devices_chromeos_commands, customers, customers_chrome_printservers, customers_chrome_printers, domainaliases, domains, groups, groups_aliases, members, mobiledevices, orgunits, privileges, resources_buildings, resources_calendars, resources_features, roleassignments, roles, schemas, tokens, users, users_aliases, users_photos, verificationcodes, activities, customerusagereports, entityusagereports, userusagereport
2026.07.18.2
- Updated: asps, chromeosdevices, customer_devices_chromeos_commands, customers, customers_chrome_printservers, customers_chrome_printers, domainaliases, domains, groups, groups_aliases, members, mobiledevices, orgunits, privileges, resources_buildings, resources_calendars, resources_features, roleassignments, roles, schemas, tokens, users, users_aliases, users_photos, verificationcodes
2026.07.17.2
- Updated: customers_chrome_printservers, customers_chrome_printers, groups, orgunits, resources_features, users
2026.07.17.1
- Updated: resources_buildings, users
2026.06.08.2
- Updated: applications, transfers, asps, chromeosdevices, customer_devices_chromeos_commands, customers, customers_chrome_printservers, customers_chrome_printers, domainaliases, domains, groups, groups_aliases, members, mobiledevices, orgunits, privileges, resources_buildings, resources_calendars, resources_features, roleassignments, roles, schemas, tokens, users, users_aliases, users_photos, verificationcodes, activities, customerusagereports, entityusagereports, userusagereport
2026.06.07.1
- Updated: applications, transfers, asps, chromeosdevices, customer_devices_chromeos_commands, customers, customers_chrome_printservers, customers_chrome_printers, domainaliases, domains, groups, groups_aliases, members, mobiledevices, orgunits, privileges, resources_buildings, resources_calendars, resources_features, roleassignments, roles, schemas, tokens, users, users_aliases, users_photos, verificationcodes, activities, customerusagereports, entityusagereports, userusagereport
2026.06.05.1
- Added: applications, transfers, asps, chromeosdevices, customer_devices_chromeos_commands, customers, customers_chrome_printservers, customers_chrome_printers, domainaliases, domains, groups, groups_aliases, members, mobiledevices, orgunits, privileges, resources_buildings, resources_calendars, resources_features, roleassignments, roles, schemas, tokens, users, users_aliases, users_photos, verificationcodes
Added 1, removed 4 models
2026.05.25.1
- Updated: activities, customerusagereports, entityusagereports, userusagereport
Modified 1 models
2026.05.24.1
- Updated: activities, customerusagereports, entityusagereports, userusagereport
2026.05.21.2
- Updated: activities, customerusagereports, entityusagereports, userusagereport
2026.05.21.1
2026.05.19.2
2026.05.19.1
2026.04.23.1
05Stats
A
100 / 100
Downloads
3
Archive size
282.3 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
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels