REST Resource: devices

Resource: Device

A Device within the Cloud Identity Devices API.

Represents a Device known to Google Cloud, independent of the device ownership, type, and whether it is assigned or in use by a user.

JSON representation
{
  "name": string,
  "createTime": string,
  "lastSyncTime": string,
  "ownerType": enum (DeviceOwnership),
  "model": string,
  "osVersion": string,
  "deviceType": enum (DeviceType),
  "serialNumber": string,
  "assetTag": string,
  "imei": string,
  "meid": string,
  "wifiMacAddresses": [
    string
  ],
  "networkOperator": string,
  "manufacturer": string,
  "releaseVersion": string,
  "brand": string,
  "buildNumber": string,
  "kernelVersion": string,
  "basebandVersion": string,
  "enabledDeveloperOptions": boolean,
  "otherAccounts": [
    string
  ],
  "enabledUsbDebugging": boolean,
  "securityPatchTime": string,
  "bootloaderVersion": string,
  "encryptionState": enum (EncryptionState),
  "androidSpecificAttributes": {
    object (AndroidAttributes)
  },
  "managementState": enum (ManagementState),
  "compromisedState": enum (CompromisedState)
}
Fields
name

string

Output only. Resource name of the Device in format: devices/{device_id}, where device_id is the unique id assigned to the Device.

createTime

string (Timestamp format)

Output only. When the Company-Owned device was imported. This field is empty for BYOD devices.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

lastSyncTime

string (Timestamp format)

Most recent time when device synced with this service.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

ownerType

enum (DeviceOwnership)

Output only. Whether the device is owned by the company or an individual

model

string

Output only. Model name of device. Example: Pixel 3.

osVersion

string

Output only. OS version of the device. Example: Android 8.1.0.

deviceType

enum (DeviceType)

Output only. Type of device.

serialNumber

string

Serial Number of device. Example: HT82V1A01076.

assetTag

string

Asset tag of the device.

imei

string

Output only. IMEI number of device if GSM device; empty otherwise.

meid

string

Output only. MEID number of device if CDMA device; empty otherwise.

wifiMacAddresses[]

string

WiFi MAC addresses of device.

networkOperator

string

Output only. Mobile or network operator of device, if available.

manufacturer

string

Output only. Device manufacturer. Example: Motorola.

releaseVersion

string

Output only. OS release version. Example: 6.0.

brand

string

Output only. Device brand. Example: Samsung.

buildNumber

string

Output only. Build number of the device.

kernelVersion

string

Output only. Kernel version of the device.

basebandVersion

string

Output only. Baseband version of the device.

enabledDeveloperOptions

boolean

Output only. Whether developer options is enabled on device.

otherAccounts[]

string

Output only. Domain name for Google accounts on device. Type for other accounts on device. On Android, will only be populated if |ownershipPrivilege| is |PROFILE_OWNER| or |DEVICE_OWNER|. Does not include the account signed in to the device policy app if that account's domain has only one account. Examples: "com.example", "xyz.com".

enabledUsbDebugging

boolean

Output only. Whether USB debugging is enabled on device.

securityPatchTime

string (Timestamp format)

Output only. OS security patch update time on device.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

bootloaderVersion

string

Output only. Device bootloader version. Example: 0.6.7.

encryptionState

enum (EncryptionState)

Output only. Device encryption state.

androidSpecificAttributes

object (AndroidAttributes)

Output only. Attributes specific to Android devices.

managementState

enum (ManagementState)

Output only. Management state of the device

compromisedState

enum (CompromisedState)

Output only. Represents whether the Device is compromised.

DeviceOwnership

Possible owners of the device: Company or individual

Enums
DEVICE_OWNERSHIP_UNSPECIFIED Default value. The value is unused.
COMPANY Company owns the device.
BYOD Bring Your Own Device (i.e. individual owns the device)

DeviceType

Type of device

Enums
DEVICE_TYPE_UNSPECIFIED Unknown device type
ANDROID Device is an Android device
IOS Device is an iOS device
GOOGLE_SYNC Device is a Google Sync device.
WINDOWS Device is a Windows device.
MAC_OS Device is a MacOS device.
LINUX Device is a Linux device.
CHROME_OS Device is a ChromeOS device.

EncryptionState

Possible values of encryption state for this device.

Enums
ENCRYPTION_STATE_UNSPECIFIED Encryption Status is not set.
UNSUPPORTED_BY_DEVICE Device doesn't support encryption.
ENCRYPTED Device is encrypted.
NOT_ENCRYPTED Device is not encrypted.

AndroidAttributes

Resource representing the Android specific attributes of a Device.

JSON representation
{
  "enabledUnknownSources": boolean,
  "supportsWorkProfile": boolean,
  "ownerProfileAccount": boolean,
  "ownershipPrivilege": enum (OwnershipPrivilege)
}
Fields
enabledUnknownSources

boolean

Whether applications from unknown sources can be installed on device.

supportsWorkProfile

boolean

Whether device supports Android work profiles. If false, this service will not block access to corp data even if an administrator turns on the "Enforce Work Profile" policy.

ownerProfileAccount

boolean

Whether this account is on an owner/primary profile. For phones, only true for owner profiles. Android 4+ devices can have secondary or restricted user profiles.

ownershipPrivilege

enum (OwnershipPrivilege)

Ownership privileges on device.

OwnershipPrivilege

Specifies how the device ownership privilege is configured on the device.

Enums
OWNERSHIP_PRIVILEGE_UNSPECIFIED Ownership privilege is not set.
DEVICE_ADMINISTRATOR Active device administrator privileges on the device.
PROFILE_OWNER Profile Owner privileges. The account is in a managed corporate profile.
DEVICE_OWNER Device Owner privileges on the device.

ManagementState

Possible management states of a device.

Enums
MANAGEMENT_STATE_UNSPECIFIED Default value. This value is unused.
APPROVED Device is approved.
BLOCKED Device is blocked.
PENDING Device is pending approval.
UNPROVISIONED The device is not provisioned. Device will start from this state until some action is taken (i.e. a user starts using the device).
WIPING Data and settings on the device are being removed.
WIPED All data and settings on the device are removed.

CompromisedState

Represents whether the device is compromised

Enums
COMPROMISED_STATE_UNSPECIFIED Default value.
COMPROMISED The device is compromised (currently, this means Android device is rooted).
UNCOMPROMISED The device is safe (currently, this means Android device is unrooted).

Methods

cancelWipe

Cancels an unfinished device wipe.

create

Creates a device.

delete

Deletes the specified device.

get

Retrieves the specified device.

list

Lists/Searches devices.

wipe

Wipes all data on the specified device.