Skip to main content

devices

Creates, updates, deletes, gets or lists a devices resource.

Overview

Namedevices
TypeResource
Idgoogle.cloudidentity.devices

Fields

NameDatatypeDescription
namestringOutput only. Resource name of the Device in format: devices/{device}, where device is the unique id assigned to the Device.
androidSpecificAttributesobjectResource representing the Android specific attributes of a Device.
assetTagstringAsset tag of the device.
basebandVersionstringOutput only. Baseband version of the device.
bootloaderVersionstringOutput only. Device bootloader version. Example: 0.6.7.
brandstringOutput only. Device brand. Example: Samsung.
buildNumberstringOutput only. Build number of the device.
compromisedStatestringOutput only. Represents whether the Device is compromised.
createTimestringOutput only. When the Company-Owned device was imported. This field is empty for BYOD devices.
deviceIdstringUnique identifier for the device.
deviceTypestringOutput only. Type of device.
enabledDeveloperOptionsbooleanOutput only. Whether developer options is enabled on device.
enabledUsbDebuggingbooleanOutput only. Whether USB debugging is enabled on device.
encryptionStatestringOutput only. Device encryption state.
endpointVerificationSpecificAttributesobjectResource representing the Endpoint Verification-specific attributes of a device.
hostnamestringHost name of the device.
imeistringOutput only. IMEI number of device if GSM device; empty otherwise.
kernelVersionstringOutput only. Kernel version of the device.
lastSyncTimestringMost recent time when device synced with this service.
managementStatestringOutput only. Management state of the device
manufacturerstringOutput only. Device manufacturer. Example: Motorola.
meidstringOutput only. MEID number of device if CDMA device; empty otherwise.
modelstringOutput only. Model name of device. Example: Pixel 3.
networkOperatorstringOutput only. Mobile or network operator of device, if available.
osVersionstringOutput only. OS version of the device. Example: Android 8.1.0.
otherAccountsarrayOutput only. Domain name for Google accounts on device. Type for other accounts on device. On Android, will only be populated if
ownerTypestringOutput only. Whether the device is owned by the company or an individual
releaseVersionstringOutput only. OS release version. Example: 6.0.
securityPatchTimestringOutput only. OS security patch update time on device.
serialNumberstringSerial Number of device. Example: HT82V1A01076.
unifiedDeviceIdstringOutput only. Unified device id of the device.
wifiMacAddressesarrayWiFi MAC addresses of device.

Methods

NameAccessible byRequired ParamsDescription
getSELECTdevicesIdRetrieves the specified device.
listSELECTLists/Searches devices.
createINSERTCreates a device. Only company-owned device may be created. Note: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity Premium
deleteDELETEdevicesIdDeletes the specified device.
cancel_wipeEXECdevicesIdCancels an unfinished device wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped. This operation is possible when the device is in a "pending wipe" state. The device enters the "pending wipe" state when a wipe device command is issued, but has not yet been sent to the device. The cancel wipe will fail if the wipe command has already been issued to the device.
wipeEXECdevicesIdWipes all data on the specified device.

SELECT examples

Lists/Searches devices.

SELECT
name,
androidSpecificAttributes,
assetTag,
basebandVersion,
bootloaderVersion,
brand,
buildNumber,
compromisedState,
createTime,
deviceId,
deviceType,
enabledDeveloperOptions,
enabledUsbDebugging,
encryptionState,
endpointVerificationSpecificAttributes,
hostname,
imei,
kernelVersion,
lastSyncTime,
managementState,
manufacturer,
meid,
model,
networkOperator,
osVersion,
otherAccounts,
ownerType,
releaseVersion,
securityPatchTime,
serialNumber,
unifiedDeviceId,
wifiMacAddresses
FROM google.cloudidentity.devices
;

INSERT example

Use the following StackQL query and manifest file to create a new devices resource.

/*+ create */
INSERT INTO google.cloudidentity.devices (
lastSyncTime,
serialNumber,
assetTag,
wifiMacAddresses,
deviceId,
hostname
)
SELECT
'{{ lastSyncTime }}',
'{{ serialNumber }}',
'{{ assetTag }}',
'{{ wifiMacAddresses }}',
'{{ deviceId }}',
'{{ hostname }}'
;

DELETE example

Deletes the specified devices resource.

/*+ delete */
DELETE FROM google.cloudidentity.devices
WHERE devicesId = '{{ devicesId }}';