Mobiledevices

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

For a list of methods for this resource, see the end of this page.

Resource representations

The following JSON template is used for Mobiledevices resources in the Directory API:

{
  "kind": "admin#directory#mobiledevice",
  "etag": etag,
  "resourceId": string,
  "deviceId": string,
  "name": [
    string
  ],
  "email": [
    string
  ],
  "model": string,
  "os": string,
  "type": string,
  "status": string,
  "hardwareId": string,
  "firstSync": datetime,
  "lastSync": datetime,
  "userAgent": string,
  "applications": [
    {
      "packageName": string,
      "displayName": string,
      "versionName": string,
      "versionCode": integer,
      "permission": [
        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,
  "adbStatus": boolean,
  "developerOptionsStatus": boolean,
  "supportsWorkProfile": boolean,
  "otherAccountsInfo": [
    string
  ],
  "manufacturer": string,
  "releaseVersion": string,
  "securityPatchLevel": long,
  "brand": string,
  "bootloaderVersion": string,
  "hardware": string,
  "encryptionStatus": string,
  "devicePasswordStatus": string,
  "privilege": string
}

Property name	Value	Description
`adbStatus`	`boolean`	Adb (USB debugging) enabled or disabled on device (Read-only)
`applications[]`	`list`	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 G Suite 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[].displayName`	`string`	The application's display name. An example is `Browser`.
`applications[].packageName`	`string`	The application's package name. An example is `com.android.browser`.
`applications[].permission[]`	`list`	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`.
`applications[].versionCode`	`integer`	The application's version code. An example is `13`.
`applications[].versionName`	`string`	The application's version name. An example is `3.2-140714`.
`basebandVersion`	`string`	The device's baseband version.
`bootloaderVersion`	`string`	Mobile Device Bootloader version (Read-only)
`brand`	`string`	Mobile Device Brand (Read-only)
`buildNumber`	`string`	The device's operating system build number.
`defaultLanguage`	`string`	The default locale used on the device.
`developerOptionsStatus`	`boolean`	Developer options enabled or disabled on device (Read-only)
`deviceCompromisedStatus`	`string`	The compromised device status. Acceptable values are: "`Compromise detected`": There are indications the mobile device has been compromised, such as, the presence of an unlocked bootloader, use of a custom ROM, or the presence of a 'SU (Superuser) binary' on the device. "`No compromise detected`": No compromise has been detected on the device. "`Undetected`": The status of the device is unknown.
`deviceId`	`string`	The serial number for a Google Sync mobile device. For Android and iOS devices, this is a software generated unique identifier.
`devicePasswordStatus`	`string`	DevicePasswordStatus (Read-only) Acceptable values are: "`Off`" "`On`" "`Unknown`"
`email[]`	`list`	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.
`encryptionStatus`	`string`	Mobile Device Encryption Status (Read-only)
`etag`	`etag`	ETag of the resource.
`firstSync`	`datetime`	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 `YYYY-MM-DDThh:mm:ssTZD`. For example, `2010-04-05T17:30:04+01:00`.
`hardware`	`string`	Mobile Device Hardware (Read-only)
`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.
`imei`	`string`	The device's IMEI number.
`kernelVersion`	`string`	The device's kernel version.
`kind`	`string`	The type of the API resource. For Mobiledevices resources, the value is `admin#directory#mobiledevice`.
`lastSync`	`datetime`	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 `YYYY-MM-DDThh:mm:ssTZD`. For example, `2010-04-05T17:30:04+01:00`.
`managedAccountIsOnOwnerProfile`	`boolean`	Boolean indicating if this account is on owner/primary profile or not.
`manufacturer`	`string`	Mobile Device manufacturer (Read-only)
`meid`	`string`	The device's MEID number.
`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.
`name[]`	`list`	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.
`networkOperator`	`string`	Mobile Device mobile or network operator (if available) (Read-only)
`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.
`otherAccountsInfo[]`	`list`	List of accounts added on device (Read-only)
`privilege`	`string`	DMAgentPermission (Read-only) Acceptable values are: "`Device administrator`" "`Device owner`" "`Profile owner`" "`Undetected`"
`releaseVersion`	`string`	Mobile Device release version version (Read-only)
`resourceId`	`string`	The unique ID the API service uses to identify the mobile device.
`securityPatchLevel`	`long`	Mobile Device Security patch level (Read-only)
`serialNumber`	`string`	The device's serial number.
`status`	`string`	The device's status. Acceptable values are: "`ACCOUNT_WIPED`" "`ACCOUNT_WIPING`" "`APPROVED`": Device is approved. "`BLOCKED`": A blocked device still shows up in the Admin console's Devices tab, but the user cannot access G Suite data such as mail and calendar from the device. Even though blocked on the mobile device, this user can still access the G Suite services from a desktop computer. A user must be suspended from all G Suite access to be blocked. "`PENDING`": Device's approval is pending. If the device has not been approved by an account administrator and therefore is not activated, a newly added device's status is `PENDING`. Once a new device is added in `PENDING` state, an action needs to be taken to either complete the device's activation where the new device's status is `APPROVED`, or the activation is denied and the new device's status is `BLOCKED`. For more information about actions, see the Developer's Guide. "`UNKNOWN`": The status of the device is unknown. "`UNPROVISIONED`": This is the default state. If a domain does require a device to be activated, the device starts in this status until provisioning is completed. "`WIPED`": A remote wipe removes all device-based data like mail, calendar, and contacts from the device, but it may not delete data stored on the device's SD card. A user's G Suite data remains available through a web browser or other authorized mobile device. Once the content has been deleted, the device's settings are reset to its defaults. "`WIPING`": The device is being remotely wiped. For Android and iOS devices, the device usually receives the remote wipe command within a few seconds. However, sometimes the command doesn't reach the device right away, so the Device Policy app checks the server every three hours for a wipe command. Therefore, the maximum time before the device is wiped is about 3 hours, or when the device reconnects to the network.
`supportsWorkProfile`	`boolean`	Work profile supported on device (Read-only)
`type`	`string`	The type of mobile device. Acceptable values are: "`ANDROID`" "`GOOGLE_SYNC`" "`IOS_SYNC`"
`unknownSourcesStatus`	`boolean`	Unknown sources enabled or disabled on device (Read-only)
`userAgent`	`string`	Gives information about the device such as `os` version. This property can be updated. For more information, see the Developer's Guide.
`wifiMacAddress`	`string`	The device's MAC address on Wi-Fi networks.

Methods

action: Takes an action that affects a mobile device. For example, remotely wiping a device.
delete: Removes a mobile device.
get: Retrieves a mobile device's properties.
list: Retrieves a paginated list of all mobile devices for an account.