category: IT Services provider: Google commonfields: id: GSuiteAdmin version: -1 configuration: - display: User's Service Account JSON name: user_service_account_json type: 4 hidden: true required: false - display: Admin Email name: admin_email_creds type: 9 displaypassword: User's Service Account JSON required: false - display: Admin Email name: admin_email type: 0 additionalinfo: An admin email is required for the Test validation to run. If not configured, then each command can receive an optional admin_email argument. hidden: true required: false - display: Customer ID name: customer_id type: 0 additionalinfo: A unique identifier of the customer's Google account. required: false - display: Trust any certificate (not secure) name: insecure type: 8 required: false - display: Use system proxy settings name: proxy type: 8 required: false description: G Suite or Google Workspace Admin is an integration to perform an action on IT infrastructure, create users, update settings, and more administrative tasks. display: Google Workspace Admin name: GSuiteAdmin script: commands: - arguments: - description: The unique ID of the customer's Google Workspace Admin account. name: customer_id - description: Email ID of the G Suite domain admin who acts on behalf of an end-user. name: admin_email - description: Whether to show all metadata fields, or only the basic metadata fields (e.g., deviceId, model, type, and status). Default is FULL. name: projection auto: PREDEFINED predefined: - BASIC - FULL - name: query description: Search string using the format given at https://developers.google.com/admin-sdk/directory/v1/search-operators. - auto: PREDEFINED name: order_by description: Device property to use for sorting results. Default is STATUS. predefined: - DEVICE_ID - EMAIL - LAST_SYNC - MODEL - NAME - OS - STATUS - TYPE - auto: PREDEFINED name: sort_order description: Whether to return results in ascending or descending order. Must be used with the order_by parameter. Default is ASCENDING. predefined: - ASCENDING - DESCENDING - name: limit description: The maximum number of records to return from the collection. Default is 50. - name: page_token description: The token of the page. - name: page_size description: The number of requested results per page. Default is 50. Maximum allowed value is 100. description: Retrieves a paginated list that includes company-owned mobile devices. name: gsuite-mobiledevice-list outputs: - type: String contextPath: GSuite.MobileDevices.PageToken.NextPageToken description: The token of the next page. - type: Object contextPath: GSuite.MobileDevices.MobileListObjects description: A list of mobile device objects. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.kind description: The type of the API resource. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.etag description: ETag of the resource. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.resourceId description: The unique ID the API service uses to identify the mobile device. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.deviceId description: The serial number for a Google Sync mobile device. For Android and iOS devices, this is a software-generated unique identifier. - type: List contextPath: GSuite.MobileDevices.MobileListObjects.name description: A list of the owner's usernames. - type: List contextPath: GSuite.MobileDevices.MobileListObjects.email description: A list of the owner's email addresses. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.model description: The mobile device's model name. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.os description: The mobile device's operating system. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.type description: The type of mobile device. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.status description: The mobile device's status. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.hardwareId description: The IMEI/MEID unique identifier for Android hardware. - type: Date contextPath: GSuite.MobileDevices.MobileListObjects.firstSync description: The date and time the mobile device was initially synchronized with the policy settings in the Admin console. - type: Date contextPath: GSuite.MobileDevices.MobileListObjects.lastSync description: The date and time the mobile device was last synchronized with the policy settings in the Admin console. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.userAgent description: Gives information about the mobile device such as the operating system version. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.serialNumber description: The mobile device's serial number. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.imei description: The mobile device's IMEI number. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.meid description: The mobile device's MEID number. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.wifiMacAddress description: The mobile device's MAC address on Wi-Fi networks. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.networkOperator description: Mobile device mobile or network operator. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.defaultLanguage description: The default locale used on the mobile device. - type: Boolean contextPath: GSuite.MobileDevices.MobileListObjects.managedAccountIsOnOwnerProfile description: Boolean indicating if this account is on the owner/primary profile. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.deviceCompromisedStatus description: The compromised device status. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.buildNumber description: The mobile device's operating system build number. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.kernelVersion description: The mobile device's kernel version. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.basebandVersion description: The mobile device's baseband version. - type: Boolean contextPath: GSuite.MobileDevices.MobileListObjects.unknownSourcesStatus description: Unknown sources enabled or disabled on the mobile device. - type: Boolean contextPath: GSuite.MobileDevices.MobileListObjects.adbStatus description: Whether adb (USB debugging) is enabled on the mobile device. - type: Boolean contextPath: GSuite.MobileDevices.MobileListObjects.developerOptionsStatus description: Whether developer options are enabled on the mobile device. - type: List contextPath: GSuite.MobileDevices.MobileListObjects.otherAccountsInfo description: A list of accounts added on the device. - type: Boolean contextPath: GSuite.MobileDevices.MobileListObjects.supportsWorkProfile description: Work profile supported on the mobile device. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.manufacturer description: Mobile device manufacturer. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.releaseVersion description: Mobile device release version. - type: Date contextPath: GSuite.MobileDevices.MobileListObjects.securityPatchLevel description: Mobile device security patch level. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.brand description: Mobile device brand. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.bootloaderVersion description: Mobile device bootloader version. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.hardware description: Mobile device hardware. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.encryptionStatus description: Mobile device encryption status. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.devicePasswordStatus description: Mobile device password status. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.privilege description: DM agent permission. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.applications.packageName description: The application's package name. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.applications.displayName description: The application's display name. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.applications.versionName description: The application's version name. - type: String contextPath: GSuite.MobileDevices.MobileListObjects.applications.versionCode description: The application's version code. - type: List contextPath: GSuite.MobileDevices.MobileListObjects.applications.permission description: The list of permissions of this application. - arguments: - description: The unique ID of the customer's Google Workspace Admin account. name: customer_id - description: Email ID of the G Suite domain admin who acts on behalf of an end-user. name: admin_email - description: Whether to show all metadata fields, or only the basic metadata fields (e.g., deviceId, serialNumber, status, and user). name: projection auto: PREDEFINED predefined: - BASIC - FULL - name: query description: "Search string in the format given at https://developers.google.com/admin-sdk/directory/v1/list-query-operators." - auto: PREDEFINED name: order_by description: Device property to use for sorting results. predefined: - ANNOTATED_LOCATION - ANNOTATED_USER - LAST_SYNC - NOTES - SERIAL_NUMBER - STATUS - auto: PREDEFINED name: sort_order description: Whether to return results in ascending or descending order. Must be used with the order_by parameter. predefined: - ASCENDING - DESCENDING - name: org_unit_path description: The full path of the organizational unit (without the leading /) or its unique ID. - auto: PREDEFINED name: include_child_org_units description: Whether to return devices from all child organizational units. If this is set to true, 'org_unit_path' must be provided. predefined: - yes - no - name: limit description: The maximum number of records to return from the collection. Default is 50. - name: page description: The page number. - name: page_size description: The number of requested results per page. Default is 50. Maximum allowed value is 100. description: Retrieves a paginated list of company-owned ChromeOS devices. name: gsuite-chromeosdevice-list outputs: - contextPath: GSuite.ChromeOSDevices.PageToken.NextPageToken description: The token of the next page. type: String - contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects description: A list of ChromeOS device objects. type: List - contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.deviceId description: The unique ID of the ChromeOS device. type: String - contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.serialNumber description: The ChromeOS device serial number entered when the device was enabled. type: String - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.status description: Status of the ChromeOS device. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.lastSync description: The date and time the ChromeOS device was last synchronized with the policy settings in the Admin console. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.supportEndDate description: The final date the ChromeOS device will be supported. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.annotatedUser description: The user of the ChromeOS device as noted by the administrator. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.annotatedLocation description: The address or location of the ChromeOS device as noted by the administrator. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.notes description: Notes about this ChromeOS device added by the administrator. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.model description: The ChromeOS device's model information. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.meid description: The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a ChromeOS device. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.orderNumber description: The ChromeOS device's order number. - type: Boolean contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.willAutoRenew description: Determines if the ChromeOS device will auto renew its support after the support end date. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.osVersion description: The ChromeOS device's operating system version. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.platformVersion description: The ChromeOS device's platform version. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.firmwareVersion description: The ChromeOS device's firmware version. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.macAddress description: The ChromeOS device's wireless MAC address. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.bootMode description: The boot mode for the ChromeOS device. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.lastEnrollmentTime description: The date and time the ChromeOS device was last enrolled. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.kind description: The type of resource. - type: List contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.recentUsers description: A list of recent ChromeOS device users, in descending order, by last login time. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.recentUsers.type description: The type of the user. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.recentUsers.email description: The user's email address. - type: List contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.activeTimeRanges description: A list of active time ranges. - type: Integer contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.activeTimeRanges.activeTime description: Duration of usage in milliseconds. - type: Integer contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.activeTimeRanges.date description: Date of usage. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.ethernetMacAddress description: The ChromeOS device's MAC address on the ethernet network interface. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.annotatedAssetId description: The asset identifier as noted by an administrator or specified during enrollment. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.etag description: ETag of the resource. - type: List contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.diskVolumeReports description: Reports of disk space and other info about mounted/connected volumes. - type: List contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.diskVolumeReports.volumeInfo description: Disk volumes. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.diskVolumeReports.volumeInfo.volumeId description: Volume ID. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.diskVolumeReports.volumeInfo.storageTotal description: Total disk space [in bytes]. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.diskVolumeReports.volumeInfo.storageFree description: Free disk space [in bytes]. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.systemRamTotal description: Total RAM on the ChromeOS device in bytes. - type: List contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuStatusReports description: Reports of CPU utilization and temperature. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuStatusReports.reportTime description: Date and time the report was received. - type: List contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuStatusReports.cpuUtilizationPercentageInfo description: The CPU utilization percentage. - type: List contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuStatusReports.cpuTemperatureInfo description: A list of CPU temperature samples. - type: Integer contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuStatusReports.cpuTemperatureInfo.temperature description: Temperature in Celsius degrees. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuStatusReports.cpuTemperatureInfo.label description: CPU label. - type: List contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuInfo description: Information regarding CPU specs in the device. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuInfo.model description: The CPU model name. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuInfo.architecture description: The CPU architecture. - type: Integer contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuInfo.maxClockSpeedKhz description: The maximum CPU clock speed in kHz. - type: List contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuInfo.logicalCpus description: Information for the logical CPUs. - type: Integer contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuInfo.logicalCpus.maxScalingFrequencyKhz description: Maximum frequency the CPU is allowed to run at, by policy. - type: Integer contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuInfo.logicalCpus.currentScalingFrequencyKhz description: Current frequency the CPU is running at. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuInfo.logicalCpus.idleDuration description: Idle time since last boot. - type: List contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuInfo.logicalCpus.cStates description: The power consumption state of the CPU. For more information, see the documentation published by the CPU maker. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuInfo.logicalCpus.cStates.displayName description: Name of the state. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.cpuInfo.logicalCpus.cStates.sessionDuration description: Time spent in the state since the last reboot. - type: List contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.deviceFiles description: A list of device files to download. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.deviceFiles.name description: File name. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.deviceFiles.type description: File type. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.deviceFiles.downloadUrl description: File download URL. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.deviceFiles.createTime description: Date and time the file was created. - type: List contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.systemRamFreeReports description: Reports of amounts of available RAM memory. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.systemRamFreeReports.reportTime description: Date and time the report was received. - type: List contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.systemRamFreeReports.systemRamFreeInfo description: Report of free RAM memory. - type: List contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.lastKnownNetwork description: Contains last known network. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.lastKnownNetwork.ipAddress description: The IP address. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.lastKnownNetwork.wanIpAddress description: The WAN IP address. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.autoUpdateExpiration description: The timestamp after which the device will stop receiving Chrome updates or support. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.ethernetMacAddress0 description: 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. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.dockMacAddress description: 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. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.manufactureDate description: The date the device was manufactured in yyyy-mm-dd format. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.orgUnitPath description: 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, /. - type: Object contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.tpmVersionInfo description: Trusted Platform Module (TPM). - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.tpmVersionInfo.family description: TPM family, using the TPM 2.0 style encoding. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.tpmVersionInfo.specLevel description: TPM specification level. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.tpmVersionInfo.manufacturer description: TPM manufacturer code. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.tpmVersionInfo.tpmModel description: TPM model number. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.tpmVersionInfo.firmwareVersion description: TPM firmware version. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.tpmVersionInfo.vendorSpecific description: Vendor-specific information such as vendor ID. - type: List contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.screenshotFiles description: A list of screenshot files to download. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.screenshotFiles.name description: File name. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.screenshotFiles.type description: File type. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.screenshotFiles.downloadUrl description: File download URL. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.screenshotFiles.createTime description: Date and time the file was created. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.orgUnitId description: 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. - type: Object contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.osUpdateStatus description: The status of the operating system updates for the device. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.osUpdateStatus.state description: The update state of an operating system update. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.osUpdateStatus.targetOsVersion description: New platform version of the operating system image being downloaded and applied. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.osUpdateStatus.targetKioskAppVersion description: New required platform version from the pending updated kiosk app. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.osUpdateStatus.updateTime description: Date and time of the last successful operating system update. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.osUpdateStatus.updateCheckTime description: Date and time of the last update check. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.osUpdateStatus.rebootTime description: Date and time of the last reboot. - type: String contextPath: GSuite.ChromeOSDevices.ChromeOSListObjects.firstEnrollmentTime description: Date and time for the first time the device was enrolled. - arguments: - description: The unique ID of the customer's Google Workspace Admin account. name: customer_id - description: Email ID of the G Suite domain admin who acts on behalf of an end-user. name: admin_email - description: The unique ID of the device. name: resource_id required: true - description: The action to be performed on the ChromeOS device. name: action required: true auto: PREDEFINED predefined: - deprovision - disable - reenable - pre_provisioned_disable - pre_provisioned_reenable - description: Reason for deprovision. This field is required only when the action used is deprovision. name: deprovision_reason auto: PREDEFINED predefined: - different_model_replacement - retiring_device - same_model_replacement - upgrade_transfer description: Executes an action that affects a ChromeOS device. This includes de-provisioning, disabling, and re-enabling devices. name: gsuite-chromeosdevice-action - arguments: - description: The unique ID of the customer's G Suite account. name: customer_id - description: The unique ID used to identify the mobile device. name: resource_id required: true - description: |- The action to be performed on the device. Available Options: admin_account_wipe - Remotely wipes only G Suite data from the device. admin_remote_wipe - Remotely wipes all data on the device. approve - Approves the device. block - Blocks access to G Suite data on the device. cancel_remote_wipe_then_activate - Cancels a remote wipe of the device and then reactivates it. cancel_remote_wipe_then_block - Cancels a remote wipe of the device and then blocks it. name: action required: true auto: PREDEFINED predefined: - admin_account_wipe - admin_remote_wipe - approve - block - cancel_remote_wipe_then_activate - cancel_remote_wipe_then_block - description: Email ID of the G Suite domain admin who acts on behalf of an end-user. name: admin_email description: Takes an action that affects a mobile device. For example, remotely wiping a device. name: gsuite-mobile-update - arguments: - description: The unique ID of the customer's G Suite account. name: customer_id - description: The unique ID used to identify the mobile device. name: resource_id required: true - description: Email ID of the G Suite domain admin who acts on behalf of an end-user. name: admin_email description: Removes a mobile device. Note that this does not break the device's sync, it simply removes it from the list of devices connected to the domain. If the device still has a valid login/authentication, it will be added back on it's next successful sync. name: gsuite-mobile-delete - arguments: - description: Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. name: user_key required: true - description: The alias email address. name: alias required: true - description: Email ID of the G Suite domain admin who acts on behalf of an end-user. name: admin_email description: Adds an alias. name: gsuite-user-alias-add outputs: - contextPath: GSuite.UserAlias.kind description: The type of the API resource. type: String - contextPath: GSuite.UserAlias.id description: The unique ID for the user. type: String - contextPath: GSuite.UserAlias.etag description: ETag of the resource. type: String - contextPath: GSuite.UserAlias.alias description: The alias email address. type: String - arguments: - description: The user's first name. name: first_name required: true - description: The user's last name. name: last_name required: true - description: Stores the password for the user account. A password can contain any combination of ASCII characters. A minimum of 8 characters is required. The maximum length is 100 characters. The password will be sent in MD5 hash format. name: password required: true - description: The user's primary email address. The primary_email must be unique and cannot be an alias of another user. name: primary_email required: true - description: User's Country. name: country - auto: PREDEFINED description: The address type. name: address_type predefined: - home - other - work - description: The ZIP or postal code, if applicable. name: postal_code - auto: PREDEFINED description: Set to true, If this is the user's primary address. name: is_address_primary predefined: - 'true' - 'false' - description: For extended addresses, such as an address that includes a sub-region. name: extended_address - description: The abbreviated province or state. name: region - description: The street address, such as 1600 Amphitheatre Parkway. Whitespace within the string is ignored; however, newlines are significant. name: street_address - description: The user's secondary email address. name: secondary_email_address - auto: PREDEFINED description: The type of the secondary email account. name: secondary_email_type predefined: - home - other - work - auto: PREDEFINED description: User's gender. name: gender predefined: - female - male - other - unknown - auto: PREDEFINED description: If true, the user's IP address is on allow list. name: is_ip_white_listed predefined: - 'true' - 'false' - auto: PREDEFINED description: Content type of note, either plain text or HTML. If not provided, considered as plain text. name: notes_content_type predefined: - text_plain - text_html - description: Contents of notes. name: notes_value - description: A human-readable phone number. It may be in any telephone number format. name: phone_number - auto: PREDEFINED description: The type of phone number. name: phone_number_type predefined: - assistant - callback - car - company_main - grand_central - home - home_fax - isdn - main - mobile - other - other_fax - pager - radio - telex - tty_tdd - work - work_fax - work_mobile - work_pager - auto: PREDEFINED description: Indicates if this is the user's primary phone number. A user may only have one primary phone number. name: is_phone_number_primary predefined: - 'true' - 'false' - description: Recovery email of the user. name: recovery_email - description: 'Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212.' name: recovery_phone - auto: PREDEFINED description: Indicates if the user is suspended. name: suspended predefined: - 'true' - 'false' - description: Email ID of the G Suite domain admin who acts on behalf of an end-user. name: admin_email description: Creates a user. name: gsuite-user-create outputs: - contextPath: GSuite.User.id description: The unique ID for the user. type: String - contextPath: GSuite.User.primaryEmail description: The user's primary email address. type: String - contextPath: GSuite.User.firstName description: The user's first name. type: String - contextPath: GSuite.User.lastName description: The user's last name. type: String - contextPath: GSuite.User.customerId description: The unique ID for the customer's G Suite account. type: String - contextPath: GSuite.User.gender description: Gender. type: String - contextPath: GSuite.User.suspended description: Indicates if the user is suspended. type: Boolean - contextPath: GSuite.User.notesValue description: Contents of notes. type: String - contextPath: GSuite.User.notesContentType description: Content type of notes. type: String - contextPath: GSuite.User.isAdmin description: Indicates a user with super administrator privileges. type: Boolean - contextPath: GSuite.User.creationTime description: The time the user's account was created. type: Date - contextPath: GSuite.User.phones.value description: A human-readable phone number. It may be in any telephone number format. type: String - contextPath: GSuite.User.phones.type description: The type of phone number. type: String - contextPath: GSuite.User.phones.primary description: Indicates if this is the user's primary phone number. type: Boolean - contextPath: GSuite.User.addresses.type description: The address type. type: String - contextPath: GSuite.User.addresses.country description: Country. type: String - contextPath: GSuite.User.addresses.postalCode description: The ZIP or postal code. type: String - contextPath: GSuite.User.addresses.region description: The abbreviated province or state. type: String - contextPath: GSuite.User.addresses.streetAddress description: The street address. type: String - contextPath: GSuite.User.addresses.extendedAddress description: For extended addresses, such as an address that includes a sub-region. type: String - contextPath: GSuite.User.addresses.primary description: If this is the user's primary address. type: Boolean - contextPath: GSuite.User.emails.address description: The user's secondary email. type: String - contextPath: GSuite.User.emails.type description: The secondary email type. type: String - contextPath: GSuite.User.ipWhitelisted description: If true, the user's IP address is addded to allow list. type: Boolean - contextPath: GSuite.User.recoveryEmail description: Recovery email of the user. type: String - contextPath: GSuite.User.isDelegatedAdmin description: Indicates if the user is a delegated administrator. type: Boolean - contextPath: GSuite.User.recoveryPhone description: Recovery phone of the user. type: String - contextPath: GSuite.User.orgUnitPath description: 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 (/). type: String - contextPath: GSuite.User.isMailboxSetup description: Indicates if the user's Google mailbox is created. type: Boolean - contextPath: GSuite.User.kind description: The type of the API resource. type: Boolean - contextPath: GSuite.User.etag description: ETag of the resource. type: Boolean - contextPath: GSuite.User.hashFunction description: Stores the hash format of the password property. type: String - arguments: - description: The group's email address. name: group_email required: true - description: The group's display name. name: group_name - description: An extended description to help users determine the purpose of a group. name: group_description - description: Email ID of the G Suite domain admin who acts on behalf of an end-user. name: admin_email description: Creates a group with a group name and its description. name: gsuite-group-create outputs: - contextPath: GSuite.Group.kind description: The type of the API resource. type: String - contextPath: GSuite.Group.id description: The unique ID of a group. type: String - contextPath: GSuite.Group.etag description: ETag of the resource. type: String - contextPath: GSuite.Group.email description: The group's email address. type: String - contextPath: GSuite.Group.name description: The group's display name. type: String - contextPath: GSuite.Group.directMembersCount description: The number of users that are direct members of the group. type: String - contextPath: GSuite.Group.description description: An extended description to help users determine the purpose of a group. type: String - contextPath: GSuite.Group.adminCreated description: Value is true if this group was created by an administrator rather than a user. type: Boolean - contextPath: GSuite.Group.aliases description: List of a group's alias email addresses. type: String - contextPath: GSuite.Group.nonEditableAliases description: List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. type: String - arguments: - description: Immutable ID of the G Suite account. name: customer_id - description: Immutable ID of a role. If included, it returns only role assignments containing this role ID. name: role_id - description: The user's primary email address, alias email address, or unique user ID. If included in the request, returns role assignments only for this user. name: user_key - description: Token to specify the next page in the list. name: page_token - description: Maximum number of results to return. Acceptable values are 1 to 200, inclusive. name: max_results - description: Email ID of the G Suite domain admin who acts on behalf of an end-user. name: admin_email description: Retrieves a paginated list of all role assignments. name: gsuite-role-assignment-list outputs: - contextPath: GSuite.RoleAssignment.kind description: The type of the API resource. type: String - contextPath: GSuite.RoleAssignment.etag description: ETag of the resource. type: String - contextPath: GSuite.RoleAssignment.roleAssignmentId description: ID of this role assignment. type: Number - contextPath: GSuite.RoleAssignment.roleId description: The ID of the role that is assigned. type: Number - contextPath: GSuite.RoleAssignment.assignedTo description: The unique ID of the user this role is assigned to. type: String - contextPath: GSuite.RoleAssignment.scopeType description: The scope in which this role is assigned. type: String - contextPath: GSuite.RoleAssignment.orgUnitId description: If the role is restricted to an organization unit, this contains the ID of the organization unit to which the exercise of this role is restricted to. type: String - contextPath: GSuite.PageToken.RoleAssignment.nextPageToken description: Token to specify the next page in the list. type: String - arguments: - description: Immutable ID of the G Suite account. name: customer_id - description: The ID of the role to be assigned to the user. name: role_id required: true - description: The unique ID of the user this role is assigned to. name: assigned_to required: true - description: The scope in which this role is assigned. name: scope_type required: true auto: PREDEFINED predefined: - CUSTOMER - ORG_UNIT - description: |- 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. name: org_unit_id - description: |- Email ID of the G Suite domain admin who acts on behalf of an end-user. name: admin_email description: Creates a role assignment. name: gsuite-role-assignment-create outputs: - contextPath: GSuite.RoleAssignment.kind description: The type of the API resource. type: String - contextPath: GSuite.RoleAssignment.etag description: ETag of the resource. type: String - contextPath: GSuite.RoleAssignment.roleAssignmentId description: ID of this role assignment. type: Number - contextPath: GSuite.RoleAssignment.roleId description: The ID of the role that is assigned. type: Number - contextPath: GSuite.RoleAssignment.assignedTo description: The unique ID of the user this role is assigned to. type: String - contextPath: GSuite.RoleAssignment.scopeType description: The scope in which this role is assigned. type: String - contextPath: GSuite.RoleAssignment.orgUnitId description: If the role is restricted to an organization unit, this contains the ID of the organization unit to which the exercise of this role is restricted to. type: String - arguments: - description: Immutable ID of the G Suite account. name: customer_id - description: Name of the role. name: role_name required: true - description: The set of privileges that are granted to this role. Comma-separated list of privilege names and service ids of the form "PrivilegeName1:ServiceId1,PrivilegeName2:ServiceId2". name: role_privileges required: true - description: A short description of the role. name: role_description - description: Email ID of the G Suite domain admin who acts on behalf of an end-user. name: admin_email description: Creates a new role. name: gsuite-role-create outputs: - contextPath: GSuite.Role.kind description: The type of the API resource. This is always admin#directory#role. type: String - contextPath: GSuite.Role.etag description: ETag of the resource. type: String - contextPath: GSuite.Role.roleId description: ID of the role. type: Number - contextPath: GSuite.Role.roleName description: Name of the role. type: String - contextPath: GSuite.Role.roleDescription description: A short description of the role. type: String - contextPath: GSuite.Role.rolePrivileges.privilegeName description: The name of the privilege. type: String - contextPath: GSuite.Role.rolePrivileges.serviceId description: The obfuscated ID of the service this privilege is for. type: String - contextPath: GSuite.Role.isSystemRole description: Whether this is a pre-defined system role. type: Boolean - contextPath: GSuite.Role.isSuperAdminRole description: Whether the role is a super admin role. type: Boolean - arguments: - description: The Client ID of the application the token is issued to. name: client_id required: true - description: Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. name: user_key required: true - description: Email ID of the G Suite domain admin who acts on behalf of an end-user. name: admin_email description: |- Delete all access tokens issued by a user for an application. name: gsuite-token-revoke - arguments: - description: Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. name: user_key required: true description: |- Signs a user out of all web and device sessions and reset their sign-in cookies. name: gsuite-user-signout compliantpolicies: - User Soft Remediation - arguments: - description: Immutable ID of the G Suite account. name: customer_id - description: Destination user's profile ID. name: new_owner_user_id - description: Source user's profile ID. name: old_owner_user_id - description: Status of the transfer. name: status - description: |- Email ID of the G Suite domain admin who acts on behalf of an end-user. name: admin_email - description: |- Maximum number of results to return. Default is 100. Acceptable values are 1 to 500, inclusive. name: max_results - description: Token to specify the next page in the list. name: page_token description: "Lists the transfers for a customer by source user, destination user, or status." name: gsuite-datatransfer-list outputs: - contextPath: GSuite.DataTransfer.kind description: Identifies the resource as a DataTransfer request. type: String - contextPath: GSuite.DataTransfer.etag description: ETag of the resource. type: String - contextPath: GSuite.DataTransfer.id description: The transfer's ID. type: String - contextPath: GSuite.DataTransfer.oldOwnerUserId description: ID of the user whose data is being transferred. type: String - contextPath: GSuite.DataTransfer.newOwnerUserId description: ID of the user to whom the data is being transferred. type: String - contextPath: GSuite.DataTransfer.overallTransferStatusCode description: Overall transfer status. type: String - contextPath: GSuite.DataTransfer.requestTime description: The time at which the data transfer was requested. type: Date - contextPath: GSuite.DataTransfer.applicationDataTransfers.applicationTransferStatus description: Current status of transfer for this application. type: String - contextPath: GSuite.DataTransfer.applicationDataTransfers.applicationId description: The application's ID. type: Number - contextPath: GSuite.DataTransfer.applicationDataTransfers.applicationTransferParams.key description: The type of the transfer parameter. type: String - contextPath: GSuite.DataTransfer.applicationDataTransfers.applicationTransferParams.value description: The value of the corresponding transfer parameter. type: Unknown - contextPath: GSuite.PageToken.DataTransfer.nextPageToken description: Continuation token which will be used to specify next page in list API. type: String - arguments: - description: 'Email ID of the G Suite domain admin who acts on behalf of an end-user.' name: admin_email - description: Immutable ID of the G Suite account. name: customer_id - description: The schema's name. name: schema_name required: true - description: Display name for the schema. name: schema_display_name required: true - description: |- Raw JSON containing fields of the schema. Acceptable values for fieldType are BOOL, DATE, DOUBLE, EMAIL, INT64, PHONE, and STRING. Acceptable values for readAccessType are ADMINS_AND_SELF- Only administrators and the associated user can see values, and ALL_DOMAIN_USERS- Any user in your domain can see values. E.g. { "fields": [ { "fieldType": string, "fieldName": string, "displayName": string, "multiValued": boolean, "readAccessType": string, "indexed": boolean, "numericIndexingSpec": { "minValue": double, "maxValue": double } } ] }. name: field_raw_json - description: |- JSON file entry ID containing fields of the schema. Acceptable values for fieldType are BOOL, DATE, DOUBLE, EMAIL, INT64, PHONE, and STRING. Acceptable values for readAccessType are ADMINS_AND_SELF- Only administrators and the associated user can see values, and ALL_DOMAIN_USERS- Any user in your domain can see values. E.g. { "fields": [ { "fieldType": string, "fieldName": string, "displayName": string, "multiValued": boolean, "readAccessType": string, "indexed": boolean, "numericIndexingSpec": { "minValue": double, "maxValue": double } } ] }. name: field_json_entry_id description: "Creates a custom user schema to add custom fields to user profiles.\nNote: field_raw_json has higher precedence when both field_raw_json and field_json_entry_id are provided." name: gsuite-custom-user-schema-create outputs: - contextPath: GSuite.UserSchema.kind description: The type of the API resource. type: String - contextPath: GSuite.UserSchema.etag description: The ETag of the resource. type: String - contextPath: GSuite.UserSchema.schemaId description: The unique identifier of the schema. type: String - contextPath: GSuite.UserSchema.schemaName description: The schema's name. type: String - contextPath: GSuite.UserSchema.displayName description: Display Name for the schema. type: String - contextPath: GSuite.UserSchema.fields.kind description: The kind of resource this is. type: String - contextPath: GSuite.UserSchema.fields.fieldId description: The unique identifier of the field. type: String - contextPath: GSuite.UserSchema.fields.etag description: The ETag of the field. type: String - contextPath: GSuite.UserSchema.fields.fieldType description: The type of the field. type: String - contextPath: GSuite.UserSchema.fields.fieldName description: The name of the field. type: String - contextPath: GSuite.UserSchema.fields.displayName description: Display name of the field. type: String - contextPath: GSuite.UserSchema.fields.multiValued description: A boolean specifying whether this is a multi-valued field or not. type: Boolean - contextPath: GSuite.UserSchema.fields.readAccessType description: Specifies who can view values of this field. type: Boolean - contextPath: GSuite.UserSchema.fields.indexed description: Specifies whether the field is indexed or not. type: Boolean - contextPath: GSuite.UserSchema.fields.numericIndexingSpecMinValue description: Minimum value of this field. type: Number - contextPath: GSuite.UserSchema.fields.numericIndexingSpecMaxValue description: Maximum value of this field. type: Number - arguments: - description: 'Email ID of the G Suite domain admin who acts on behalf of an end-user.' name: admin_email - description: Immutable ID of the G Suite account. name: customer_id - description: The schema's name. name: schema_name - description: Immutable ID of the schema. name: schema_id - description: Display name for the schema. name: schema_display_name - description: |- Raw JSON containing fields of the schema. Acceptable values for fieldType are BOOL, DATE, DOUBLE, EMAIL, INT64, PHONE, and STRING. Acceptable values for readAccessType are ADMINS_AND_SELF- Only administrators and the associated user can see values, and ALL_DOMAIN_USERS- Any user in your domain can see values. E.g. { "fields": [ { "fieldType": string, "fieldName": string, "displayName": string, "multiValued": boolean, "readAccessType": string, "indexed": boolean, "numericIndexingSpec": { "minValue": double, "maxValue": double } } ] }. name: field_raw_json - description: |- JSON file entry ID containing fields of the schema. Acceptable values for fieldType are BOOL, DATE, DOUBLE, EMAIL, INT64, PHONE, and STRING. Acceptable values for readAccessType are ADMINS_AND_SELF- Only administrators and the associated user can see values, and ALL_DOMAIN_USERS- Any user in your domain can see values. E.g. { "fields": [ { "fieldType": string, "fieldName": string, "displayName": string, "multiValued": boolean, "readAccessType": string, "indexed": boolean, "numericIndexingSpec": { "minValue": double, "maxValue": double } } ] }. name: field_json_entry_id description: "Updates a custom user schema.\nNote: field_raw_json has higher precedence when both field_raw_json and field_json_entry_id are provided." name: gsuite-custom-user-schema-update outputs: - contextPath: GSuite.UserSchema.kind description: The type of the API resource. type: String - contextPath: GSuite.UserSchema.etag description: The ETag of the resource. type: String - contextPath: GSuite.UserSchema.schemaId description: The unique identifier of the schema. type: String - contextPath: GSuite.UserSchema.schemaName description: The schema's name. type: String - contextPath: GSuite.UserSchema.displayName description: Display Name for the schema. type: String - contextPath: GSuite.UserSchema.fields.kind description: The kind of resource this is. type: String - contextPath: GSuite.UserSchema.fields.fieldId description: The unique identifier of the field. type: String - contextPath: GSuite.UserSchema.fields.etag description: The ETag of the field. type: String - contextPath: GSuite.UserSchema.fields.fieldType description: The type of the field. type: String - contextPath: GSuite.UserSchema.fields.fieldName description: The name of the field. type: String - contextPath: GSuite.UserSchema.fields.displayName description: Display name of the field. type: String - contextPath: GSuite.UserSchema.fields.multiValued description: A boolean specifying whether this is a multi-valued field or not. type: Boolean - contextPath: GSuite.UserSchema.fields.readAccessType description: Specifies who can view values of this field. type: Boolean - contextPath: GSuite.UserSchema.fields.indexed description: Specifies whether the field is indexed or not. type: Boolean - contextPath: GSuite.UserSchema.fields.numericIndexingSpecMinValue description: Minimum value of this field. type: Number - contextPath: GSuite.UserSchema.fields.numericIndexingSpecMaxValue description: Maximum value of this field. type: Number - arguments: - description: Email ID of the G Suite domain admin acts on behalf of an end-user. name: admin_email - description: ID of the user whose data is being transferred. name: old_owner_id required: true - description: ID of the user to whom the data is being transferred. name: new_owner_id required: true - description: The application's ID. name: application_id - description: Key and value pair of application data transfer parameters. Key and value must be delimited by (:) colon. Multiple values must be delimited by (,) comma. Multiple key-value pairs must be delimited by (;) semi-colon. E.g. key1:val;key2:val1,val2. name: application_transfer_params - description: |- Raw JSON containing the whole body of the application data transfers. E.g. { "applicationDataTransfers": [ { "applicationId": long, "applicationTransferParams": [ { "key": string, "value": [ string ] } ] } ] }. name: applications_raw_json - description: |- JSON file Entry ID containing the whole body of the application data transfers. E.g. { "applicationDataTransfers": [ { "applicationId": long, "applicationTransferParams": [ { "key": string, "value": [ string ] } ] } ] }. name: applications_raw_json_entry_id description: |- Inserts a data transfer request. Note: If all three applications_raw_json, applications_raw_json_entry_id and application_id are provided the higher precedence will be in order of applications_raw_json, applications_raw_json_entry_id, and application_id respectively. name: gsuite-datatransfer-request-create outputs: - contextPath: GSuite.DataTransfer.kind description: Identifies the resource as a DataTransfer request. type: String - contextPath: GSuite.DataTransfer.etag description: ETag of the resource. type: String - contextPath: GSuite.DataTransfer.id description: The transfer's ID. type: String - contextPath: GSuite.DataTransfer.oldOwnerUserId description: ID of the user whose data is being transferred. type: String - contextPath: GSuite.DataTransfer.newOwnerUserId description: ID of the user to whom the data is being transferred. type: String - contextPath: GSuite.DataTransfer.applicationDataTransfers.applicationId description: The application's ID. type: Number - contextPath: GSuite.DataTransfer.applicationDataTransfers.applicationTransferParams.key description: The type of the transfer parameter. type: String - contextPath: GSuite.DataTransfer.applicationDataTransfers.applicationTransferParams.value description: The value of the corresponding transfer parameter. type: Unknown - contextPath: GSuite.DataTransfer.applicationDataTransfers.applicationTransferStatus description: Current status of transfer for this application. type: String - contextPath: GSuite.DataTransfer.overallTransferStatusCode description: Overall transfer status. type: String - contextPath: GSuite.DataTransfer.requestTime description: The time at which the data transfer was requested. type: Date - arguments: - description: Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. name: user_key required: true - description: Email ID of the G Suite domain admin acts on behalf of an end-user. name: admin_email description: Deletes a user. name: gsuite-user-delete - arguments: - description: 'The user''s first name.' name: first_name - description: The user's last name. name: last_name - description: Stores the password for the user account. A password can contain any combination of ASCII characters. A minimum of 8 characters is required. The maximum length is 100 characters. The password will be sent in MD5 hash format. name: password - description: The user's primary email address. The primary_email must be unique and cannot be an alias of another user. name: primary_email - description: User's Country. name: country - auto: PREDEFINED description: The address type. name: address_type predefined: - home - other - work - description: The ZIP or postal code, if applicable. name: postal_code - auto: PREDEFINED description: Set to true, If this is the user's primary address. name: is_address_primary predefined: - 'true' - 'false' - description: For extended addresses, such as an address that includes a sub-region. name: extended_address - description: The abbreviated province or state. name: region - description: The street address, such as 1600 Amphitheatre Parkway. Whitespace within the string is ignored; however, newlines are significant. name: street_address - description: The user's secondary email address. name: secondary_email_address - auto: PREDEFINED description: The type of the secondary email account. name: secondary_email_type predefined: - home - other - work - auto: PREDEFINED description: User's gender. name: gender predefined: - female - male - other - unknown - auto: PREDEFINED description: If true, the user's IP address is on allow list. name: is_ip_white_listed predefined: - 'true' - 'false' - auto: PREDEFINED description: Content type of note, either plain text or HTML. If not provided, considered as plain text. name: notes_content_type predefined: - text_plain - text_html - description: Contents of notes. name: notes_value - description: A human-readable phone number. It may be in any telephone number format. name: phone_number - auto: PREDEFINED description: The type of phone number. name: phone_number_type predefined: - assistant - callback - car - company_main - grand_central - home - home_fax - isdn - main - mobile - other - other_fax - pager - radio - telex - tty_tdd - work - work_fax - work_mobile - work_pager - auto: PREDEFINED description: Indicates if this is the user's primary phone number. A user may only have one primary phone number. name: is_phone_number_primary predefined: - 'true' - 'false' - description: Recovery email of the user. name: recovery_email - description: 'Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212.' name: recovery_phone - auto: PREDEFINED description: Indicates if the user is suspended. name: suspended predefined: - 'true' - 'false' - description: Email ID of the G Suite domain admin acts on behalf of an end-user. name: admin_email - description: Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. name: user_key required: true - auto: PREDEFINED description: Indicates if the user is archived. name: archived predefined: - 'true' - 'false' - description: To move the user to OU (Organization Unit). 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 (/). name: org_unit_path description: Updates a user. name: gsuite-user-update outputs: - contextPath: GSuite.User.id description: The unique ID for the user. type: String - contextPath: GSuite.User.primaryEmail description: The user's primary email address. type: String - contextPath: GSuite.User.firstName description: The user's first name. type: String - contextPath: GSuite.User.lastName description: The user's last name. type: String - contextPath: GSuite.User.customerId description: The unique ID for the customer's G Suite account. type: String - contextPath: GSuite.User.gender description: Gender. type: String - contextPath: GSuite.User.suspended description: Indicates if the user is suspended. type: Boolean - contextPath: GSuite.User.notesValue description: Contents of notes. type: String - contextPath: GSuite.User.notesContentType description: Content type of notes. type: String - contextPath: GSuite.User.isAdmin description: Indicates a user with super administrator privileges. type: Boolean - contextPath: GSuite.User.creationTime description: The time the user's account was created. type: Date - contextPath: GSuite.User.phones.value description: A human-readable phone number. It may be in any telephone number format. type: String - contextPath: GSuite.User.phones.type description: The type of phone number. type: String - contextPath: GSuite.User.phones.primary description: Indicates if this is the user's primary phone number. type: Boolean - contextPath: GSuite.User.phones.customType description: If the value of type is custom, this property contains the custom type. type: String - contextPath: GSuite.User.addresses.type description: The address type. type: String - contextPath: GSuite.User.addresses.customType description: If the address type is custom, this property contains the custom value. type: String - contextPath: GSuite.User.addresses.sourceIsStructured description: Indicates if the user-supplied address was formatted. Formatted addresses are not currently supported. type: Boolean - contextPath: GSuite.User.addresses.formatted description: A full and unstructured postal address. This is not synced with the structured address fields. type: String - contextPath: GSuite.User.addresses.poBox description: The post office box, if present. type: String - contextPath: GSuite.User.addresses.locality description: The town or city of the address. type: String - contextPath: GSuite.User.addresses.countryCode description: The country code. Uses the ISO 3166-1 standard. type: String - contextPath: GSuite.User.addresses.country description: Country. type: String - contextPath: GSuite.User.addresses.postalCode description: The ZIP or postal code. type: String - contextPath: GSuite.User.addresses.region description: The abbreviated province or state. type: String - contextPath: GSuite.User.addresses.streetAddress description: The street address. type: String - contextPath: GSuite.User.addresses.extendedAddress description: For extended addresses, such as an address that includes a sub-region. type: String - contextPath: GSuite.User.addresses.primary description: If this is the user's primary address. type: Boolean - contextPath: GSuite.User.emails.address description: The user's secondary email. type: String - contextPath: GSuite.User.emails.type description: The secondary email type. type: String - contextPath: GSuite.User.emails.customType description: If the value of type is custom, this property contains the custom type string. type: String - contextPath: GSuite.User.emails.primary description: Indicates if this is the user's primary email. Only one entry can be marked as primary. type: Boolean - contextPath: GSuite.User.ipWhitelisted description: If true, the user's IP address is added to allow list. type: Boolean - contextPath: GSuite.User.recoveryEmail description: Recovery email of the user. type: String - contextPath: GSuite.User.isDelegatedAdmin description: Indicates if the user is a delegated administrator. type: Boolean - contextPath: GSuite.User.recoveryPhone description: Recovery phone of the user. type: String - contextPath: GSuite.User.orgUnitPath description: 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 (/). type: String - contextPath: GSuite.User.isMailboxSetup description: Indicates if the user's Google mailbox is created. type: Boolean - contextPath: GSuite.User.kind description: The type of the API resource. type: Boolean - contextPath: GSuite.User.etag description: ETag of the resource. type: Boolean - contextPath: GSuite.User.hashFunction description: Stores the hash format of the password property. type: String - contextPath: GSuite.User.archived description: Indicates if the user is archived. type: Boolean - contextPath: GSuite.User.fullName description: The user's full name formed by concatenating the first and last name values. type: String - contextPath: GSuite.User.lastLoginTime description: The last time the user logged into the user's account. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00. type: Date - contextPath: GSuite.User.deletionTime description: The time the user's account was deleted. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example 2010-04-05T17:30:04+01:00. type: Date - contextPath: GSuite.User.agreedToTerms description: This property is true if the user has completed an initial login and accepted the Terms of Service agreement. type: Boolean - contextPath: GSuite.User.suspensionReason description: Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the suspended property is true. type: String - contextPath: GSuite.User.changePasswordAtNextLogin description: 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. type: Boolean - contextPath: GSuite.User.ims.type description: Type of the user's Instant Messenger (IM) account. type: Boolean - contextPath: GSuite.User.ims.customType description: If the IM type is custom, this property holds the custom type string. type: String - contextPath: GSuite.User.ims.protocol description: An IM protocol identifies the IM network. The value can be a custom network or the standard network. type: String - contextPath: GSuite.User.ims.customProtocol description: If the protocol value is custom_protocol, this property holds the custom protocol's string. type: String - contextPath: GSuite.User.ims.im description: The user's IM network ID. type: String - contextPath: GSuite.User.ims.primary description: If this is the user's primary IM. Only one entry in the IM list can have a value of true. type: Boolean - contextPath: GSuite.User.externalIds.value description: The value of the external ID. type: String - contextPath: GSuite.User.externalIds.type description: The type of the external ID. type: String - contextPath: GSuite.User.externalIds.customType description: If the external ID type is custom, this property holds the custom type. type: String - contextPath: GSuite.User.relations.value description: The name of the person the user is related to. type: String - contextPath: GSuite.User.relations.type description: The type of relation. type: String - contextPath: GSuite.User.relations.customType description: If the value of type is custom, this property contains the custom type. type: String - contextPath: GSuite.User.organizations.name description: The name of the organization. type: String - contextPath: GSuite.User.organizations.title description: The user's title within the organization, for example 'member' or 'engineer'. type: String - contextPath: GSuite.User.organizations.primary description: Indicates if this is the user's primary organization. A user may only have one primary organization. type: Boolean - contextPath: GSuite.User.organizations.type description: The type of organization. type: String - contextPath: GSuite.User.organizations.customType description: If the value of type is custom, this property contains the custom type. type: String - contextPath: GSuite.User.organizations.department description: Specifies the department within the organization, such as 'sales' or 'engineering'. type: String - contextPath: GSuite.User.organizations.symbol description: Text string symbol of the organization. For example, the text symbol for Google is GOOG. type: String - contextPath: GSuite.User.organizations.location description: The physical location of the organization. This does not need to be a fully qualified address. type: String - contextPath: GSuite.User.organizations.description description: The description of the organization. type: String - contextPath: GSuite.User.organizations.domain description: The domain the organization belongs to. type: String - contextPath: GSuite.User.organizations.costCenter description: The cost center of the user's organization. type: String - contextPath: GSuite.User.organizations.fullTimeEquivalent description: The full-time equivalent millipercent within the organization (100000 = 100%). type: String - contextPath: GSuite.User.languages.languageCode description: Language Code. Should be used for storing Google III LanguageCode string representation for language. Illegal values cause SchemaException. type: String - contextPath: GSuite.User.languages.customLanguage description: Other language. A user can provide their own language name if there is no corresponding Google III language code. If this is set, LanguageCode can't be set. type: String - contextPath: GSuite.User.posixAccounts.username description: The username of the account. type: String - contextPath: GSuite.User.posixAccounts.uid description: The POSIX compliant user ID. type: Number - contextPath: GSuite.User.posixAccounts.gid description: The default group ID. type: Number - contextPath: GSuite.User.posixAccounts.homeDirectory description: The path to the home directory for this account. type: String - contextPath: GSuite.User.posixAccounts.shell description: The path to the login shell for this account. type: String - contextPath: GSuite.User.posixAccounts.gecos description: The GECOS (user information) for this account. type: String - contextPath: GSuite.User.posixAccounts.systemId description: System identifier for which account Username or Uid apply to. type: String - contextPath: GSuite.User.posixAccounts.primary description: If this is user's primary account within the SystemId. type: Boolean - contextPath: GSuite.User.posixAccounts.accountId description: A POSIX account field identifier. type: String - contextPath: GSuite.User.posixAccounts.operatingSystemType description: The operating system type for this account. type: String - contextPath: GSuite.User.sshPublicKeys.key description: An SSH public key. type: String - contextPath: GSuite.User.sshPublicKeys.expirationTimeUsec description: An expiration time in microseconds since epoch. type: String - contextPath: GSuite.User.sshPublicKeys.fingerprint description: A SHA-256 fingerprint of the SSH public key. type: String - contextPath: GSuite.User.aliases description: List of the user's alias email addresses. type: Unknown - contextPath: GSuite.User.nonEditableAliases description: List of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain. type: Unknown - contextPath: GSuite.User.websites.value description: The URL of the website. type: String - contextPath: GSuite.User.websites.primary description: If this is user's primary website or not. type: Boolean - contextPath: GSuite.User.websites.type description: The type or purpose of the website. For example, a website could be labeled as home or blog. Alternatively, an entry can have a custom type. type: String - contextPath: GSuite.User.websites.customType description: The custom type. Only used if the type is custom. type: String - contextPath: GSuite.User.locations.type description: The location type. type: String - contextPath: GSuite.User.locations.customType description: If the location type is custom, this property contains the custom value. type: String - contextPath: GSuite.User.locations.area description: Textual location. This is most useful for display purposes to concisely describe the location. For example, "Mountain View, CA", "Near Seattle". type: String - contextPath: GSuite.User.locations.buildingId description: Building identifier. type: String - contextPath: GSuite.User.locations.floorName description: Floor name/number. type: String - contextPath: GSuite.User.locations.floorSection description: Floor section. More specific location within the floor. For example, if a floor is divided into sections "A", "B", and "C", this field would identify one of those values. type: String - contextPath: GSuite.User.locations.deskCode description: Most specific textual code of individual desk location. type: String - contextPath: GSuite.User.keywords.type description: Each entry can have a type which indicates standard type of that entry. For example, keyword could be of type occupation or outlook. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value. type: String - contextPath: GSuite.User.keywords.customType description: Custom Type. type: String - contextPath: GSuite.User.keywords.value description: Keyword. type: String - contextPath: GSuite.User.isEnrolledIn2Sv description: Is enrolled in 2-step verification. type: Boolean - contextPath: GSuite.User.isEnforcedIn2Sv description: Is 2-step verification enforced. type: Boolean - contextPath: GSuite.User.includeInGlobalAddressList description: Indicates if the user's profile is visible in the G Suite global address list when the contact sharing feature is enabled for the domain. type: Boolean - contextPath: GSuite.User.thumbnailPhotoUrl description: Photo Url of the user. type: String - contextPath: GSuite.User.thumbnailPhotoEtag description: ETag of the user's photo. type: String - contextPath: GSuite.User.customSchemas description: Custom fields of the user. type: Unknown compliantpolicies: - User Soft Remediation - arguments: - description: 'One of the following: user email address, alias email address, or the unique user ID.' name: user required: true description: Retrieve a user's details given a user key. name: gsuite-user-get outputs: - contextPath: GSuite.User.id description: The unique ID for the user. type: String - contextPath: GSuite.User.primaryEmail description: The user's primary email address. type: String - contextPath: GSuite.User.firstName description: The user's first name. type: String - contextPath: GSuite.User.lastName description: The user's last name. type: String - contextPath: GSuite.User.customerId description: The unique ID for the customer's G Suite account. type: String - contextPath: GSuite.User.gender description: Gender. type: String - contextPath: GSuite.User.suspended description: Indicates if the user is suspended. type: Boolean - contextPath: GSuite.User.notesValue description: Contents of notes. type: String - contextPath: GSuite.User.notesContentType description: Content type of notes. type: String - contextPath: GSuite.User.isAdmin description: Indicates a user with super administrator privileges. type: Boolean - contextPath: GSuite.User.creationTime description: The time the user's account was created. type: Date - contextPath: GSuite.User.phones.value description: A human-readable phone number. It may be in any telephone number format. type: String - contextPath: GSuite.User.phones.type description: The type of phone number. type: String - contextPath: GSuite.User.phones.primary description: Indicates if this is the user's primary phone number. type: Boolean - contextPath: GSuite.User.phones.customType description: If the value of type is custom, this property contains the custom type. type: String - contextPath: GSuite.User.addresses.type description: The address type. type: String - contextPath: GSuite.User.addresses.customType description: If the address type is custom, this property contains the custom value. type: String - contextPath: GSuite.User.addresses.sourceIsStructured description: Indicates if the user-supplied address was formatted. Formatted addresses are not currently supported. type: Boolean - contextPath: GSuite.User.addresses.formatted description: A full and unstructured postal address. This is not synced with the structured address fields. type: String - contextPath: GSuite.User.addresses.poBox description: The post office box, if present. type: String - contextPath: GSuite.User.addresses.locality description: The town or city of the address. type: String - contextPath: GSuite.User.addresses.countryCode description: The country code. Uses the ISO 3166-1 standard. type: String - contextPath: GSuite.User.addresses.country description: Country. type: String - contextPath: GSuite.User.addresses.postalCode description: The ZIP or postal code. type: String - contextPath: GSuite.User.addresses.region description: The abbreviated province or state. type: String - contextPath: GSuite.User.addresses.streetAddress description: The street address. type: String - contextPath: GSuite.User.addresses.extendedAddress description: For extended addresses, such as an address that includes a sub-region. type: String - contextPath: GSuite.User.addresses.primary description: If this is the user's primary address. type: Boolean - contextPath: GSuite.User.emails.address description: The user's secondary email. type: String - contextPath: GSuite.User.emails.type description: The secondary email type. type: String - contextPath: GSuite.User.emails.customType description: If the value of type is custom, this property contains the custom type string. type: String - contextPath: GSuite.User.emails.primary description: Indicates if this is the user's primary email. Only one entry can be marked as primary. type: Boolean - contextPath: GSuite.User.ipWhitelisted description: If true, the user's IP address is added to allow list. type: Boolean - contextPath: GSuite.User.recoveryEmail description: Recovery email of the user. type: String - contextPath: GSuite.User.isDelegatedAdmin description: Indicates if the user is a delegated administrator. type: Boolean - contextPath: GSuite.User.recoveryPhone description: Recovery phone of the user. type: String - contextPath: GSuite.User.orgUnitPath description: 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 (/). type: String - contextPath: GSuite.User.isMailboxSetup description: Indicates if the user's Google mailbox is created. type: Boolean - contextPath: GSuite.User.kind description: The type of the API resource. type: Boolean - contextPath: GSuite.User.etag description: ETag of the resource. type: Boolean - contextPath: GSuite.User.hashFunction description: Stores the hash format of the password property. type: String - contextPath: GSuite.User.archived description: Indicates if the user is archived. type: Boolean - contextPath: GSuite.User.fullName description: The user's full name formed by concatenating the first and last name values. type: String - contextPath: GSuite.User.lastLoginTime description: The last time the user logged into the user's account. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00. type: Date - contextPath: GSuite.User.deletionTime description: The time the user's account was deleted. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example 2010-04-05T17:30:04+01:00. type: Date - contextPath: GSuite.User.agreedToTerms description: This property is true if the user has completed an initial login and accepted the Terms of Service agreement. type: Boolean - contextPath: GSuite.User.suspensionReason description: Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the suspended property is true. type: String - contextPath: GSuite.User.changePasswordAtNextLogin description: 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. type: Boolean - contextPath: GSuite.User.ims.type description: Type of the user's Instant Messenger (IM) account. type: Boolean - contextPath: GSuite.User.ims.customType description: If the IM type is custom, this property holds the custom type string. type: String - contextPath: GSuite.User.ims.protocol description: An IM protocol identifies the IM network. The value can be a custom network or the standard network. type: String - contextPath: GSuite.User.ims.customProtocol description: If the protocol value is custom_protocol, this property holds the custom protocol's string. type: String - contextPath: GSuite.User.ims.im description: The user's IM network ID. type: String - contextPath: GSuite.User.ims.primary description: If this is the user's primary IM. Only one entry in the IM list can have a value of true. type: Boolean - contextPath: GSuite.User.externalIds.value description: The value of the external ID. type: String - contextPath: GSuite.User.externalIds.type description: The type of the external ID. type: String - contextPath: GSuite.User.externalIds.customType description: If the external ID type is custom, this property holds the custom type. type: String - contextPath: GSuite.User.relations.value description: The name of the person the user is related to. type: String - contextPath: GSuite.User.relations.type description: The type of relation. type: String - contextPath: GSuite.User.relations.customType description: If the value of type is custom, this property contains the custom type. type: String - contextPath: GSuite.User.organizations.name description: The name of the organization. type: String - contextPath: GSuite.User.organizations.title description: The user's title within the organization, for example 'member' or 'engineer'. type: String - contextPath: GSuite.User.organizations.primary description: Indicates if this is the user's primary organization. A user may only have one primary organization. type: Boolean - contextPath: GSuite.User.organizations.type description: The type of organization. type: String - contextPath: GSuite.User.organizations.customType description: If the value of type is custom, this property contains the custom type. type: String - contextPath: GSuite.User.organizations.department description: Specifies the department within the organization, such as 'sales' or 'engineering'. type: String - contextPath: GSuite.User.organizations.symbol description: Text string symbol of the organization. For example, the text symbol for Google is GOOG. type: String - contextPath: GSuite.User.organizations.location description: The physical location of the organization. This does not need to be a fully qualified address. type: String - contextPath: GSuite.User.organizations.description description: The description of the organization. type: String - contextPath: GSuite.User.organizations.domain description: The domain the organization belongs to. type: String - contextPath: GSuite.User.organizations.costCenter description: The cost center of the user's organization. type: String - contextPath: GSuite.User.organizations.fullTimeEquivalent description: The full-time equivalent millipercent within the organization (100000 = 100%). type: String - contextPath: GSuite.User.languages.languageCode description: Language Code. Should be used for storing Google III LanguageCode string representation for language. Illegal values cause SchemaException. type: String - contextPath: GSuite.User.languages.customLanguage description: Other language. A user can provide their own language name if there is no corresponding Google III language code. If this is set, LanguageCode can't be set. type: String - contextPath: GSuite.User.posixAccounts.username description: The username of the account. type: String - contextPath: GSuite.User.posixAccounts.uid description: The POSIX compliant user ID. type: Number - contextPath: GSuite.User.posixAccounts.gid description: The default group ID. type: Number - contextPath: GSuite.User.posixAccounts.homeDirectory description: The path to the home directory for this account. type: String - contextPath: GSuite.User.posixAccounts.shell description: The path to the login shell for this account. type: String - contextPath: GSuite.User.posixAccounts.gecos description: The GECOS (user information) for this account. type: String - contextPath: GSuite.User.posixAccounts.systemId description: System identifier for which account Username or Uid apply to. type: String - contextPath: GSuite.User.posixAccounts.primary description: If this is user's primary account within the SystemId. type: Boolean - contextPath: GSuite.User.posixAccounts.accountId description: A POSIX account field identifier. type: String - contextPath: GSuite.User.posixAccounts.operatingSystemType description: The operating system type for this account. type: String - contextPath: GSuite.User.sshPublicKeys.key description: An SSH public key. type: String - contextPath: GSuite.User.sshPublicKeys.expirationTimeUsec description: An expiration time in microseconds since epoch. type: String - contextPath: GSuite.User.sshPublicKeys.fingerprint description: A SHA-256 fingerprint of the SSH public key. type: String - contextPath: GSuite.User.aliases description: List of the user's alias email addresses. type: Unknown - contextPath: GSuite.User.nonEditableAliases description: List of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain. type: Unknown - contextPath: GSuite.User.websites.value description: The URL of the website. type: String - contextPath: GSuite.User.websites.primary description: If this is user's primary website or not. type: Boolean - contextPath: GSuite.User.websites.type description: The type or purpose of the website. For example, a website could be labeled as home or blog. Alternatively, an entry can have a custom type. type: String - contextPath: GSuite.User.websites.customType description: The custom type. Only used if the type is custom. type: String - contextPath: GSuite.User.locations.type description: The location type. type: String - contextPath: GSuite.User.locations.customType description: If the location type is custom, this property contains the custom value. type: String - contextPath: GSuite.User.locations.area description: Textual location. This is most useful for display purposes to concisely describe the location. For example, "Mountain View, CA", "Near Seattle". type: String - contextPath: GSuite.User.locations.buildingId description: Building identifier. type: String - contextPath: GSuite.User.locations.floorName description: Floor name/number. type: String - contextPath: GSuite.User.locations.floorSection description: Floor section. More specific location within the floor. For example, if a floor is divided into sections "A", "B", and "C", this field would identify one of those values. type: String - contextPath: GSuite.User.locations.deskCode description: Most specific textual code of individual desk location. type: String - contextPath: GSuite.User.keywords.type description: Each entry can have a type which indicates standard type of that entry. For example, keyword could be of type occupation or outlook. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value. type: String - contextPath: GSuite.User.keywords.customType description: Custom Type. type: String - contextPath: GSuite.User.keywords.value description: Keyword. type: String - contextPath: GSuite.User.isEnrolledIn2Sv description: Is enrolled in 2-step verification. type: Boolean - contextPath: GSuite.User.isEnforcedIn2Sv description: Is 2-step verification enforced. type: Boolean - contextPath: GSuite.User.includeInGlobalAddressList description: Indicates if the user's profile is visible in the G Suite global address list when the contact sharing feature is enabled for the domain. type: Boolean - contextPath: GSuite.User.thumbnailPhotoUrl description: Photo Url of the user. type: String - contextPath: GSuite.User.thumbnailPhotoEtag description: ETag of the user's photo. type: String - contextPath: GSuite.User.customSchemas description: Custom fields of the user. type: Unknown - arguments: - description: 'One of the following: group email address, group alias, or the unique group ID.' name: group required: true description: Retreive a group's details given a group key. name: gsuite-group-get outputs: - contextPath: GSuite.Group.kind description: The type of the API resource. type: String - contextPath: GSuite.Group.id description: The unique ID of a group. type: String - contextPath: GSuite.Group.etag description: ETag of the resource. type: String - contextPath: GSuite.Group.email description: The group's email address. type: String - contextPath: GSuite.Group.name description: The group's display name. type: String - contextPath: GSuite.Group.directMembersCount description: The number of users that are direct members of the group. type: String - contextPath: GSuite.Group.description description: An extended description to help users determine the purpose of a group. type: String - contextPath: GSuite.Group.adminCreated description: Value is true if this group was created by an administrator rather than a user. type: Boolean - contextPath: GSuite.Group.aliases description: List of a group's alias email addresses. type: String - contextPath: GSuite.Group.nonEditableAliases description: List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. type: String - arguments: - description: 'One of the following: user email address, alias email address, or the unique user ID.' name: user_key required: true description: Indicates if the user is forced to change their password at next login. name: gsuite-user-reset-password outputs: - contextPath: GSuite.User.id description: The unique ID for the user. type: String - contextPath: GSuite.User.primaryEmail description: The user's primary email address. type: String - contextPath: GSuite.User.firstName description: The user's first name. type: String - contextPath: GSuite.User.lastName description: The user's last name. type: String - contextPath: GSuite.User.customerId description: The unique ID for the customer's G Suite account. type: String - contextPath: GSuite.User.gender description: The user's gender. type: String - contextPath: GSuite.User.suspended description: Indicates if the user is suspended. type: Boolean - contextPath: GSuite.User.notesValue description: Content of the notes. type: String - contextPath: GSuite.User.notesContentType description: Content type of the notes. type: String - contextPath: GSuite.User.isAdmin description: Indicates a user with super administrator privileges. type: Boolean - contextPath: GSuite.User.creationTime description: The time the user's account was created. type: Date - contextPath: GSuite.User.phones.value description: A human-readable phone number. It may be in any telephone number format. type: String - contextPath: GSuite.User.phones.type description: The type of phone number. type: String - contextPath: GSuite.User.phones.primary description: Indicates if this is the user's primary phone number. type: Boolean - contextPath: GSuite.User.phones.customType description: If the value of type is custom, this property contains the custom type string. type: String - contextPath: GSuite.User.addresses.type description: The address type. type: String - contextPath: GSuite.User.addresses.customType description: If the value of type is custom, this property contains the custom type string. type: String - contextPath: GSuite.User.addresses.sourceIsStructured description: Indicates if the user-supplied address was formatted. Formatted addresses are not currently supported. type: Boolean - contextPath: GSuite.User.addresses.formatted description: A full and unstructured postal address. This is not synced with the structured address fields. type: String - contextPath: GSuite.User.addresses.poBox description: The post office box, if present. type: String - contextPath: GSuite.User.addresses.locality description: The town or city of the address. type: String - contextPath: GSuite.User.addresses.countryCode description: The country code. Uses the ISO 3166-1 standard. type: String - contextPath: GSuite.User.addresses.country description: Country. type: String - contextPath: GSuite.User.addresses.postalCode description: The ZIP or postal code. type: String - contextPath: GSuite.User.addresses.region description: The abbreviated province or state. type: String - contextPath: GSuite.User.addresses.streetAddress description: The street address. type: String - contextPath: GSuite.User.addresses.extendedAddress description: For extended addresses, such as an address that includes a sub-region. type: String - contextPath: GSuite.User.addresses.primary description: If this is the user's primary address. type: Boolean - contextPath: GSuite.User.emails.address description: The user's secondary email. type: String - contextPath: GSuite.User.emails.type description: The secondary email type. type: String - contextPath: GSuite.User.emails.customType description: If the value of type is custom, this property contains the custom type string. type: String - contextPath: GSuite.User.emails.primary description: Indicates if this is the user's primary email. Only one entry can be marked as primary. type: Boolean - contextPath: GSuite.User.ipWhitelisted description: If true, the user's IP address is added to the allow list. type: Boolean - contextPath: GSuite.User.recoveryEmail description: Recovery email of the user. type: String - contextPath: GSuite.User.isDelegatedAdmin description: Indicates if the user is a delegated administrator. type: Boolean - contextPath: GSuite.User.recoveryPhone description: Recovery phone of the user. type: String - contextPath: GSuite.User.orgUnitPath description: 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 (/). type: String - contextPath: GSuite.User.isMailboxSetup description: Indicates if the user's Google mailbox is created. type: Boolean - contextPath: GSuite.User.kind description: The type of the API resource. type: Boolean - contextPath: GSuite.User.etag description: ETag of the resource. type: Boolean - contextPath: GSuite.User.hashFunction description: Stores the hash format of the password property. type: String - contextPath: GSuite.User.archived description: Indicates if the user is archived. type: Boolean - contextPath: GSuite.User.fullName description: The user's full name formed by concatenating the first and last name values. type: String - contextPath: GSuite.User.lastLoginTime description: The last time the user logged into the user's account. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00. type: Date - contextPath: GSuite.User.deletionTime description: The time the user's account was deleted. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example 2010-04-05T17:30:04+01:00. type: Date - contextPath: GSuite.User.agreedToTerms description: This property is true if the user has completed an initial login and accepted the Terms of Service agreement. type: Boolean - contextPath: GSuite.User.suspensionReason description: The reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the suspended property is true. type: String - contextPath: GSuite.User.changePasswordAtNextLogin description: 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. type: Boolean - contextPath: GSuite.User.ims.type description: Type of the user's Instant Messenger (IM) account. type: Boolean - contextPath: GSuite.User.ims.customType description: If the IM type is custom, this property holds the custom type string. type: String - contextPath: GSuite.User.ims.protocol description: An IM protocol identifies the IM network. The value can be a custom network or the standard network. type: String - contextPath: GSuite.User.ims.customProtocol description: If the protocol value is custom_protocol, this property holds the custom protocol's string. type: String - contextPath: GSuite.User.ims.im description: The user's IM network ID. type: String - contextPath: GSuite.User.ims.primary description: If this is the user's primary IM. Only one entry in the IM list can have a value of true. type: Boolean - contextPath: GSuite.User.externalIds.value description: The value of the external ID. type: String - contextPath: GSuite.User.externalIds.type description: The type of the external ID. type: String - contextPath: GSuite.User.externalIds.customType description: If the external ID type is custom, this property holds the custom type. type: String - contextPath: GSuite.User.relations.value description: The name of the person the user is related to. type: String - contextPath: GSuite.User.relations.type description: The type of relationship. type: String - contextPath: GSuite.User.relations.customType description: If the value of type is custom, this property contains the custom type. type: String - contextPath: GSuite.User.organizations.name description: The name of the organization. type: String - contextPath: GSuite.User.organizations.title description: The user's title within the organization, for example 'member' or 'engineer'. type: String - contextPath: GSuite.User.organizations.primary description: Indicates if this is the user's primary organization. A user may only have one primary organization. type: Boolean - contextPath: GSuite.User.organizations.type description: The type of organization. type: String - contextPath: GSuite.User.organizations.customType description: If the value of type is custom, this property contains the custom type. type: String - contextPath: GSuite.User.organizations.department description: Specifies the department within the organization, such as 'sales' or 'engineering'. type: String - contextPath: GSuite.User.organizations.symbol description: Text string symbol of the organization. For example, the text symbol for Google is GOOG. type: String - contextPath: GSuite.User.organizations.location description: The physical location of the organization. This does not need to be a fully qualified address. type: String - contextPath: GSuite.User.organizations.description description: The description of the organization. type: String - contextPath: GSuite.User.organizations.domain description: The domain the organization belongs to. type: String - contextPath: GSuite.User.organizations.costCenter description: The cost center of the user's organization. type: String - contextPath: GSuite.User.organizations.fullTimeEquivalent description: The full-time equivalent millipercent within the organization (100000 = 100%). type: String - contextPath: GSuite.User.languages.languageCode description: Language Code. Should be used for storing Google III LanguageCode string representation for language. Illegal values cause SchemaException. type: String - contextPath: GSuite.User.languages.customLanguage description: Other language. A user can provide their own language name if there is no corresponding Google III language code. If this is set, LanguageCode can't be set. type: String - contextPath: GSuite.User.posixAccounts.username description: The username of the account. type: String - contextPath: GSuite.User.posixAccounts.uid description: The POSIX compliant user ID. type: Number - contextPath: GSuite.User.posixAccounts.gid description: The default group ID. type: Number - contextPath: GSuite.User.posixAccounts.homeDirectory description: The path to the home directory for this account. type: String - contextPath: GSuite.User.posixAccounts.shell description: The path to the login shell for this account. type: String - contextPath: GSuite.User.posixAccounts.gecos description: The GECOS (user information) for this account. type: String - contextPath: GSuite.User.posixAccounts.systemId description: System identifier for which account Username or UID applies to. type: String - contextPath: GSuite.User.posixAccounts.primary description: If this is the user's primary account within the SystemId. type: Boolean - contextPath: GSuite.User.posixAccounts.accountId description: A POSIX account field identifier. type: String - contextPath: GSuite.User.posixAccounts.operatingSystemType description: The operating system type for this account. type: String - contextPath: GSuite.User.sshPublicKeys.key description: An SSH public key. type: String - contextPath: GSuite.User.sshPublicKeys.expirationTimeUsec description: An expiration time in microseconds since epoch. type: String - contextPath: GSuite.User.sshPublicKeys.fingerprint description: A SHA-256 fingerprint of the SSH public key. type: String - contextPath: GSuite.User.aliases description: List of the user's alias email addresses. type: Unknown - contextPath: GSuite.User.nonEditableAliases description: List of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain. type: Unknown - contextPath: GSuite.User.websites.value description: The URL of the website. type: String - contextPath: GSuite.User.websites.primary description: If this is the user's primary website or not. type: Boolean - contextPath: GSuite.User.websites.type description: The type or purpose of the website. For example, a website could be labeled as home or blog. Alternatively, an entry can have a custom type. type: String - contextPath: GSuite.User.websites.customType description: The custom type. Only used if the type is custom. type: String - contextPath: GSuite.User.locations.type description: The location type. type: String - contextPath: GSuite.User.locations.customType description: If the location type is custom, this property contains the custom value. type: String - contextPath: GSuite.User.locations.area description: Textual location. This is most useful for display purposes to concisely describe the location. For example, "Mountain View, CA", "Near Seattle". type: String - contextPath: GSuite.User.locations.buildingId description: Building identifier. type: String - contextPath: GSuite.User.locations.floorName description: Floor name/number. type: String - contextPath: GSuite.User.locations.floorSection description: Floor section. More specific location within the floor. For example, if a floor is divided into sections "A", "B", and "C", this field would identify one of those values. type: String - contextPath: GSuite.User.locations.deskCode description: Most specific textual code of individual desk location. type: String - contextPath: GSuite.User.keywords.type description: Each entry can have a type which indicates the standard type of that entry. For example, keyword could be of type occupation or outlook. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value. type: String - contextPath: GSuite.User.keywords.customType description: Custom Type. type: String - contextPath: GSuite.User.keywords.value description: Keyword. type: String - contextPath: GSuite.User.isEnrolledIn2Sv description: Is enrolled in 2-step verification. type: Boolean - contextPath: GSuite.User.isEnforcedIn2Sv description: Is 2-step verification enforced. type: Boolean - contextPath: GSuite.User.includeInGlobalAddressList description: Indicates if the user's profile is visible in the G Suite global address list when the contact sharing feature is enabled for the domain. type: Boolean - contextPath: GSuite.User.thumbnailPhotoUrl description: Photo URL of the user. type: String - contextPath: GSuite.User.thumbnailPhotoEtag description: ETag of the user's photo. type: String - contextPath: GSuite.User.customSchemas description: Custom fields of the user. type: Unknown - arguments: - description: The unique identifier of the customer's Google account. name: customer_id - description: A comma-separated list of unique device IDs of Chrome browser devices to move. A maximum of 600 browsers may be moved per request. To get resource_id, please use gsuite-chromebrowserdevice-list command. name: resource_ids isArray: true required: true - description: Destination organization unit to move devices to. Full path of the organizational unit or its ID prefixed with 'id:'. name: org_unit_path required: true description: To move Chrome browser devices assigned to an account from one organization unit to another. name: gsuite-chromebrowserdevice-move-ou - arguments: - description: The unique identifier of the customer's Google account. name: customer_id - description: The unique ID of the device. name: device_id - auto: PREDEFINED description: Field by which to order. name: order_by predefined: - id - last_sync - machine_name - extension_count - policy_count - os_version - last_signed_in_user - annotated_user - annotated_location - annotated_asset_id - notes - browser_version_channel - org_unit - enrollment_date - save_browsing_clickthrough - platform_major_version - last_activity - browser_version_sortable - os_version_sortable - description: The full path of the organizational unit or its unique ID. name: org_unit_path - auto: PREDEFINED description: Restrict information returned to a set of selected fields. "BASIC" - Includes only the basic metadata fields (i.e., the ones found in the columns of the admin console browser list as enumerated above). "FULL" - Includes all metadata fields (as enumerated above). name: projection predefined: - BASIC - FULL - description: Search string using the list page query language (Filter Query Language). name: query - auto: PREDEFINED description: "Whether to return results in ascending or descending order. Must be used with the orderBy parameter. Possible values are: ASCENDING, DESCENDING." name: sort_order predefined: - ASCENDING - DESCENDING - description: The maximum number of policy schemas to return. Default and maximum are 100. name: page_size defaultValue: '100' - description: Page token. name: page_token - description: Limit of number of devices. Default is 100. name: limit defaultValue: '50' description: Retrieve all Chrome browser devices for an account or a specific Chrome browser device. name: gsuite-chromebrowserdevice-list outputs: - contextPath: GSuite.ChromeBrowserDevices.nextPageToken description: The token of the next page. type: String - contextPath: GSuite.ChromeBrowserDevices.browserObjects.deviceId description: The unique Device ID for the device. type: String - contextPath: GSuite.ChromeBrowserDevices.browserObjects.kind description: The type of device. type: String - contextPath: GSuite.ChromeBrowserDevices.browserObjects.osPlatform description: operating system platform. type: String - contextPath: GSuite.ChromeBrowserDevices.browserObjects.osVersion description: Device operating system version. type: String - contextPath: GSuite.ChromeBrowserDevices.browserObjects.machineName description: Device machine name. type: String - contextPath: GSuite.ChromeBrowserDevices.browserObjects.lastRegistrationTime description: Device last registration time. type: String - contextPath: GSuite.ChromeBrowserDevices.browserObjects.lastActivityTime description: Device last activity time. type: String - contextPath: GSuite.ChromeBrowserDevices.browserObjects.osPlatformVersion description: Device operating system platform version. type: String - contextPath: GSuite.ChromeBrowserDevices.browserObjects.serialNumber description: Device serial number. type: String - contextPath: GSuite.ChromeBrowserDevices.browserObjects.virtualDeviceId description: Device virtual ID. type: String - contextPath: GSuite.ChromeBrowserDevices.browserObjects.orgUnitPath description: Device organizational unit path. type: String - contextPath: GSuite.ChromeBrowserDevices.browserObjects.deviceIdentifiersHistory description: Device identifier history. type: String - arguments: - description: ID of the Google Workspace account or literal 'my_customer' for the customer associated with the request. name: customer_id - auto: PREDEFINED description: In case of Group use “POST…groups:batchModify”. In case of OrgUnit use “POST…orgunits:batchModify”. name: target_type required: true predefined: - Group - OrgUnit - description: |- String as JSON representation of the ModifyGroupPolicyRequest { "requests": [ { "policyTargetKey": { "targetResource": "orgunits/03ph8a2z1kjba6k", "additionalTargetKeys": { "app_id": "chrome:jldhpllghnbhlbpcmnajkpdmadaolakh" } }, "policyValue": { "policySchema": "chrome.users.apps.InstallType", "value": { "appInstallType": "BLOCKED" } }, "updateMask": "appInstallType" } ] } name: policy_raw_json - description: Entry ID of the file that contains JSON representation of the ModifyGroupPolicyRequest. name: policy_field_json_entry_id - description: |- The target resource on which this policy is applied. The following resources are supported: Organizational Unit ("orgunits/{orgunit_id}") Group ("groups/{groupId}"). name: target_resource - description: |- Map containing the additional target key name and value pairs used to further identify the target of the policy. A string containing a list of "key": "value" pairs. Example: ""name": "wrench", "mass": "1.3kg", "count": "3"". name: additional_target_keys - description: The fully qualified name of the policy schema that is being inherited. name: policy_schema - description: The value of the policy that is compatible with the schema that it is associated with Struct format. name: policy_value - description: |- Policy fields to update. Only fields in this mask will be updated; other fields in policyValue will be ignored (even if they have values). If a field is in this list it must have a value in 'policyValue'. This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo". Field mask format. name: update_mask description: Modifies multiple policy values that are applied to a specific group. All targets must have the same target format. That is to say that they must point to the same target resource and must have the same keys specified in additionalTargetKeyNames, though the values for those keys may be different. On failure the request will return the error details as part of the google.rpc.Status. name: gsuite-policy-modify - arguments: - description: ID of the Google Workspace account or literal "my_customer" for the customer associated with the request. name: customer_id - description: The policy schema resource name to query. Required when asking for a specific policy. name: schema_name - description: The schema filter is used to find a particular schema based on fields like its resource name, description and additionalTargetKeyNames. name: filter - description: The maximum number of policy schemas to return. Defaults to 100 and has a maximum of 1000. name: page_size - description: Page token. name: page_token - description: Limit of policies returned. name: limit defaultValue: '50' description: Gets a list of policy schemas that match a specified filter value for a given customer. name: gsuite-policy-schemas-list outputs: - contextPath: GSuite.PolicySchema.nextPageToken description: The token of the next page. type: String - contextPath: GSuite.PolicySchema.policySchemaObjects description: A list of policy schemas objects. type: List - contextPath: GSuite.PolicySchema.policySchemaObjects.name description: Policy name. type: String - contextPath: GSuite.PolicySchema.policySchemaObjects.policyDescription description: Policy description. type: String - contextPath: GSuite.PolicySchema.policySchemaObjects.definition description: Policy definition. type: Array - contextPath: GSuite.PolicySchema.policySchemaObjects.definition.enumType description: Policy definition ENUM type. type: List - contextPath: GSuite.PolicySchema.policySchemaObjects.definition.messageType description: Policy definition message type. type: List - contextPath: GSuite.PolicySchema.policySchemaObjects.fieldDescriptions description: Policy file description. type: Array - contextPath: GSuite.PolicySchema.policySchemaObjects.fieldDescriptions.description description: Policy file object description. type: String - contextPath: GSuite.PolicySchema.policySchemaObjects.fieldDescriptions.field description: Policy file description field. type: String - contextPath: GSuite.PolicySchema.policySchemaObjects.fieldDescriptions.fieldConstraints description: Policy file description field constraints. type: Array - contextPath: GSuite.PolicySchema.policySchemaObjects.fieldDescriptions.knownValueDescriptions description: Policy file description known value description. type: List - contextPath: GSuite.PolicySchema.policySchemaObjects.notices description: Policy notice. type: List - contextPath: GSuite.PolicySchema.policySchemaObjects.notices.acknowledgementRequired description: Policy notice is acknowledgement required. type: Boolean - contextPath: GSuite.PolicySchema.policySchemaObjects.notices.field description: Policy notice field. type: String - contextPath: GSuite.PolicySchema.policySchemaObjects.notices.noticeMessage description: Policy notice message. type: String - contextPath: GSuite.PolicySchema.policySchemaObjects.notices.noticeValue description: Policy notice value. type: String - contextPath: GSuite.PolicySchema.policySchemaObjects.supportUri description: Policy support URI. type: String - contextPath: GSuite.PolicySchema.policySchemaObjects.schemaName description: Policy schema name. type: String - contextPath: GSuite.PolicySchema.policySchemaObjects.validTargetResources description: Policy valid target resources. type: List - contextPath: GSuite.PolicySchema.policySchemaObjects.policyApiLifecycle description: Policy API lifecycle. type: Array - contextPath: GSuite.PolicySchema.policySchemaObjects.policyApiLifecycle.policyApiLifecycleStage description: Policy API lifecycle stage. type: String - contextPath: GSuite.PolicySchema.policySchemaObjects.categoryTitle description: Policy category title. type: String - contextPath: GSuite.PolicySchema.policySchemaObjects.supportedPlatforms description: Policy supported platforms. type: String - arguments: - description: ID of the Google Workspace account or literal "my_customer" for the customer associated with the request. name: customer_id - description: 'Specify a schema name to view a particular schema, for example: chrome.users.ShowLogoutButton. See https://developers.google.com/chrome/policy/guides/policy-schemas for details on schema namespaces.' name: policy_schema_filter required: true - auto: PREDEFINED description: Type of target. name: target_type required: true predefined: - Group - OrgUnit - description: 'The target resource on which this policy is applied. The following resources are supported: Organizational Unit ("orgunits/{orgunit_id}") or Group ("groups/{groupId}").' name: target_resource required: true - description: 'Map (key: string, value: string) containing the additional target key name and value pairs used to further identify the target of the policy.' name: additional_target_keys - description: The maximum number of policy schemas to return. Defaults to 100 and has a maximum of 1000. name: page_size - description: Page token. name: page_token - description: Limit of policies returned. name: limit defaultValue: '50' description: Gets the resolved policy values for a list of policies that match a search query. name: gsuite-policy-resolve outputs: - contextPath: GSuite.Policy.nextPageToken description: The token of the next page. type: String - contextPath: GSuite.Policy.policyObject.targetKey.targetResource description: Policy target key target resource. type: String - contextPath: GSuite.Policy.policyObject.targetKey.additionalTargetKeys description: Policy target key additional target keys. type: String - contextPath: GSuite.Policy.policyObject.value.policySchema description: Policy schema value. type: String - contextPath: GSuite.Policy.policyObject.value.value description: Policy value. type: String - contextPath: GSuite.Policy.policyObject.sourceKey.targetResource description: Policy source key target resource. type: String - contextPath: GSuite.Policy.policyObject.addedSourceKey.targetResource description: Policy added source key target resource. type: String - arguments: - description: ID of the Google Workspace account or literal "my_customer" for the customer associated with the request. name: customer_id - description: |- String as JSON representation of the DeleteGroupPolicyRequest { "policyTargetKey": { object (PolicyTargetKey) }, "policySchema": string } name: policy_raw_json - description: |- Entry Id of the file that contains JSON representation of the DeleteGroupPolicyRequest { "policyTargetKey": { object (PolicyTargetKey) }, "policySchema": string } name: policy_field_json_entry_id - description: |- The target resource on which this policy is applied. The following resources are supported: Organizational Unit ("orgunits/{orgunit_id}") Group ("groups/{groupId}"). name: target_resource - description: |- Map containing the additional target key name and value pairs used to further identify the target of the policy. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. name: additional_target_keys - description: The fully qualified name of the policy schema that is being inherited. name: policy_schema description: Delete multiple policy values that are applied to a specific group. All targets must have the same target format. That is to say that they must point to the same target resource and must have the same keys specified in additionalTargetKeyNames, though the values for those keys may be different. On failure the request will return the error details as part of the google.rpc.Status. name: gsuite-policy-groups-delete dockerimage: demisto/googleapi-python3:1.0.0.10182333 runonce: false script: '-' subtype: python3 type: python tests: - GSuiteAdmin-Test - playbook-GSuiteAdmin-MobileDevices-Test fromversion: 5.0.0