REST Resource: mobiledevices

Resource: MobileDevice

Google Workspace Mobile Management includes Android, Google Sync, and iOS devices. For more information about common group mobile device API tasks, see the Developer's Guide.

JSON representation
{
  "kind": string,
  "etag": string,
  "resourceId": string,
  "deviceId": string,
  "name": [
    string
  ],
  "email": [
    string
  ],
  "model": string,
  "os": string,
  "type": string,
  "status": string,
  "hardwareId": string,
  "firstSync": string,
  "lastSync": string,
  "userAgent": string,
  "serialNumber": string,
  "imei": string,
  "meid": string,
  "wifiMacAddress": string,
  "networkOperator": string,
  "defaultLanguage": string,
  "managedAccountIsOnOwnerProfile": boolean,
  "deviceCompromisedStatus": string,
  "buildNumber": string,
  "kernelVersion": string,
  "basebandVersion": string,
  "unknownSourcesStatus": boolean,
  "developerOptionsStatus": boolean,
  "otherAccountsInfo": [
    string
  ],
  "adbStatus": boolean,
  "supportsWorkProfile": boolean,
  "manufacturer": string,
  "releaseVersion": string,
  "securityPatchLevel": string,
  "brand": string,
  "bootloaderVersion": string,
  "hardware": string,
  "encryptionStatus": string,
  "devicePasswordStatus": string,
  "privilege": string,
  "applications": [
    {
      "packageName": string,
      "displayName": string,
      "versionName": string,
      "versionCode": integer,
      "permission": [
        string
      ]
    }
  ]
}
Fields
kind

string

The type of the API resource. For Mobiledevices resources, the value is admin#directory#mobiledevice.

etag

string

ETag of the resource.

resourceId

string

The unique ID the API service uses to identify the mobile device.

deviceId

string

The serial number for a Google Sync mobile device. For Android and iOS devices, this is a software generated unique identifier.

name[]

string

asps.list of the owner's user names. If your application needs the current list of device owner names, use the get method. For more information about retrieving mobile device user information, see the Developer's Guide.

email[]

string

asps.list of owner's email addresses. If your application needs the current list of user emails, use the get method. For additional information, see the retrieve a user method.

model

string

The mobile device's model name, for example Nexus S. This property can be updated. For more information, see the Developer's Guide.

os

string

The mobile device's operating system, for example IOS 4.3 or Android 2.3.5. This property can be updated. For more information, see the Developer's Guide.

type

string

The type of mobile device.

status

string

The device's status.

hardwareId

string

The IMEI/MEID unique identifier for Android hardware. It is not applicable to Google Sync devices. When adding an Android mobile device, this is an optional property. When updating one of these devices, this is a read-only property.

firstSync

string

The date and time the device was initially synchronized with the policy settings in the Admin console. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form <em>YYYY-MM-DD</em>T<em>hh:mm:ssTZD</em>. For example, 2010-04-05T17:30:04+01:00.

lastSync

string

The date and time the device was last synchronized with the policy settings in the Admin console. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form <em>YYYY-MM-DD</em>T<em>hh:mm:ssTZD</em>. For example, 2010-04-05T17:30:04+01:00.

userAgent

string

Gives information about the device such as os version. This property can be updated. For more information, see the Developer's Guide.

serialNumber

string

The device's serial number.

imei

string

The device's IMEI number.

meid

string

The device's MEID number.

wifiMacAddress

string

The device's MAC address on Wi-Fi networks.

networkOperator

string

Mobile Device mobile or network operator (if available) (Read-only)

defaultLanguage

string

The default locale used on the device.

managedAccountIsOnOwnerProfile

boolean

Boolean indicating if this account is on owner/primary profile or not.

deviceCompromisedStatus

string

The compromised device status.

buildNumber

string

The device's operating system build number.

kernelVersion

string

The device's kernel version.

basebandVersion

string

The device's baseband version.

unknownSourcesStatus

boolean

Unknown sources enabled or disabled on device (Read-only)

developerOptionsStatus

boolean

Developer options enabled or disabled on device (Read-only)

otherAccountsInfo[]

string

asps.list of accounts added on device (Read-only)

adbStatus

boolean

Adb (USB debugging) enabled or disabled on device (Read-only)

supportsWorkProfile

boolean

Work profile supported on device (Read-only)

manufacturer

string

Mobile Device manufacturer (Read-only)

releaseVersion

string

Mobile Device release version version (Read-only)

securityPatchLevel

string (int64 format)

Mobile Device Security patch level (Read-only)

brand

string

Mobile Device Brand (Read-only)

bootloaderVersion

string

Mobile Device Bootloader version (Read-only)

hardware

string

Mobile Device Hardware (Read-only)

encryptionStatus

string

Mobile Device Encryption Status (Read-only)

devicePasswordStatus

string

DevicePasswordStatus (Read-only)

privilege

string

DMAgentPermission (Read-only)

applications[]

object

The list of applications installed on an Android mobile device. It is not applicable to Google Sync and iOS devices. The list includes any Android applications that access Google Workspace data.

When updating an applications list, it is important to note that updates replace the existing list. If the Android device has two existing applications and the API updates the list with five applications, the is now the updated list of five applications.

applications[].packageName

string

The application's package name. An example is com.android.browser.

applications[].displayName

string

The application's display name. An example is Browser.

applications[].versionName

string

The application's version name. An example is 3.2-140714.

applications[].versionCode

integer

The application's version code. An example is 13.

applications[].permission[]

string

The list of permissions of this application. These can be either a standard Android permission or one defined by the application, and are found in an application's Android manifest. Examples of a Calendar application's permissions are READ_CALENDAR, or MANAGE_ACCOUNTS.

Methods

action

Takes an action that affects a mobile device.

delete

Removes a mobile device.

get

Retrieves a mobile device's properties.

list

Retrieves a paginated list of all user-owned mobile devices for an account.