List

Lists devices for a given enterprise

3 variables
110 variables

Lists devices for a given enterprise

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • Manage Android devices and apps for your customers

Input

This building block consumes 3 input parameters

  = Parameter name
  = Format

parent STRING Required

The name of the enterprise in the form enterprises/{enterpriseId}

pageToken STRING

A token identifying a page of results returned by the server

pageSize INTEGER

The requested page size. The actual page size may be fixed to a min or max value

Output

This building block provides 110 output parameters

  = Parameter name
  = Format

devices[] OBJECT

A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch

devices[].previousDeviceNames[] STRING

devices[].lastStatusReportTime ANY

The last time the device sent a status report

devices[].policyCompliant BOOLEAN

Whether the device is compliant with its policy

devices[].deviceSettings OBJECT

Information about security related device settings on device

devices[].deviceSettings.developmentSettingsEnabled BOOLEAN

Whether developer mode is enabled on the device

devices[].deviceSettings.adbEnabled BOOLEAN

Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device

devices[].deviceSettings.isEncrypted BOOLEAN

Whether the storage encryption is enabled

devices[].deviceSettings.encryptionStatus ENUMERATION

Encryption status from DevicePolicyManager

devices[].deviceSettings.isDeviceSecure BOOLEAN

Whether the device is secured with PIN/password

devices[].deviceSettings.unknownSourcesEnabled BOOLEAN

Whether installing apps from unknown sources is enabled

devices[].deviceSettings.verifyAppsEnabled BOOLEAN

Whether Verify Apps (Google Play Protect (https://support.google.com/googleplay/answer/2812853)) is enabled on the device

devices[].state ENUMERATION

The state to be applied to the device. This field can be modified by a patch request. Note that when calling enterprises.devices.patch, ACTIVE and DISABLED are the only allowable values. To enter the device into a DELETED state, call enterprises.devices.delete

devices[].enrollmentTime ANY

The time of device enrollment

devices[].hardwareInfo OBJECT

Information about device hardware. The fields related to temperature thresholds are only available if hardwareStatusEnabled is true in the device's policy

devices[].hardwareInfo.model STRING

The model of the device. For example, Asus Nexus 7

devices[].hardwareInfo.cpuShutdownTemperatures[] FLOAT

devices[].hardwareInfo.skinThrottlingTemperatures[] FLOAT

devices[].hardwareInfo.hardware STRING

Name of the hardware. For example, Angler

devices[].hardwareInfo.cpuThrottlingTemperatures[] FLOAT

devices[].hardwareInfo.gpuShutdownTemperatures[] FLOAT

devices[].hardwareInfo.gpuThrottlingTemperatures[] FLOAT

devices[].hardwareInfo.batteryThrottlingTemperatures[] FLOAT

devices[].hardwareInfo.manufacturer STRING

Manufacturer. For example, Motorola

devices[].hardwareInfo.serialNumber STRING

The device serial number

devices[].hardwareInfo.brand STRING

Brand of the device. For example, Google

devices[].hardwareInfo.deviceBasebandVersion STRING

Baseband version. For example, MDM9625_104662.22.05.34p

devices[].hardwareInfo.batteryShutdownTemperatures[] FLOAT

devices[].hardwareInfo.skinShutdownTemperatures[] FLOAT

devices[].softwareInfo OBJECT

Information about device software

devices[].softwareInfo.androidDevicePolicyVersionName STRING

The Android Device Policy app version as displayed to the user

devices[].softwareInfo.bootloaderVersion STRING

The system bootloader version number, e.g. 0.6.7

devices[].softwareInfo.androidDevicePolicyVersionCode INTEGER

The Android Device Policy app version code

devices[].softwareInfo.deviceKernelVersion STRING

Kernel version, for example, 2.6.32.9-g103d848

devices[].softwareInfo.androidBuildTime ANY

Build time

devices[].softwareInfo.securityPatchLevel STRING

Security patch level, e.g. 2016-05-01

devices[].softwareInfo.androidBuildNumber STRING

Android build ID string meant for displaying to the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys

devices[].softwareInfo.androidVersion STRING

The user-visible Android version string. For example, 6.0.1

devices[].softwareInfo.primaryLanguageCode STRING

An IETF BCP 47 language code for the primary locale on the device

devices[].softwareInfo.deviceBuildSignature STRING

SHA-256 hash of android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the system package, which can be used to verify that the system build hasn't been modified

devices[].disabledReason OBJECT

Provides a user-facing message with locale info. The maximum message length is 4096 characters

devices[].disabledReason.defaultMessage STRING

The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided

devices[].disabledReason.localizedMessages OBJECT

A map containing <locale, message> pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr

devices[].disabledReason.localizedMessages.customKey.value STRING

A map containing <locale, message> pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr

devices[].appliedPolicyVersion INTEGER

The version of the policy currently applied to the device

devices[].displays[] OBJECT

Device display information

devices[].displays[].density INTEGER

Display density expressed as dots-per-inch

devices[].displays[].height INTEGER

Display height in pixels

devices[].displays[].width INTEGER

Display width in pixels

devices[].displays[].refreshRate INTEGER

Refresh rate of the display in frames per second

devices[].displays[].displayId INTEGER

Unique display id

devices[].displays[].state ENUMERATION

State of the display

devices[].displays[].name STRING

Name of the display

devices[].applicationReports[] OBJECT

Information reported about an installed app

devices[].applicationReports[].state ENUMERATION

Application state

devices[].applicationReports[].applicationSource ENUMERATION

The source of the package

devices[].applicationReports[].packageName STRING

Package name of the app

devices[].applicationReports[].versionName STRING

The app version as displayed to the user

devices[].applicationReports[].versionCode INTEGER

The app version code, which can be used to determine whether one version is more recent than another

devices[].applicationReports[].packageSha256Hash STRING

The SHA-256 hash of the app's APK file, which can be used to verify the app hasn't been modified. Each byte of the hash value is represented as a two-digit hexadecimal number

devices[].applicationReports[].displayName STRING

The display name of the app

devices[].applicationReports[].installerPackageName STRING

The package name of the app that installed this app

devices[].applicationReports[].signingKeyCertFingerprints[] STRING

devices[].apiLevel INTEGER

The API level of the Android platform version running on the device

devices[].userName STRING

The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}

devices[].networkInfo OBJECT

Device network info

devices[].networkInfo.networkOperatorName STRING

Alphabetic name of current registered operator. For example, Vodafone

devices[].networkInfo.imei STRING

IMEI number of the GSM device. For example, A1000031212

devices[].networkInfo.meid STRING

MEID number of the CDMA device. For example, A00000292788E1

devices[].networkInfo.wifiMacAddress STRING

Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11

devices[].memoryInfo OBJECT

Information about device memory and storage

devices[].memoryInfo.totalRam INTEGER

Total RAM on device in bytes

devices[].memoryInfo.totalInternalStorage INTEGER

Total internal storage on device in bytes

devices[].memoryEvents[] OBJECT

An event related to memory and storage measurements

devices[].memoryEvents[].eventType ENUMERATION

Event type

devices[].memoryEvents[].createTime ANY

The creation time of the event

devices[].memoryEvents[].byteCount INTEGER

The number of free bytes in the medium, or for EXTERNAL_STORAGE_DETECTED, the total capacity in bytes of the storage medium

devices[].systemProperties OBJECT

Map of selected system properties name and value related to the device

devices[].systemProperties.customKey.value STRING

Map of selected system properties name and value related to the device

devices[].appliedState ENUMERATION

The state currently applied to the device

devices[].hardwareStatusSamples[] OBJECT

Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health

devices[].hardwareStatusSamples[].createTime ANY

The time the measurements were taken

devices[].hardwareStatusSamples[].fanSpeeds[] FLOAT

devices[].hardwareStatusSamples[].cpuUsages[] FLOAT

devices[].hardwareStatusSamples[].skinTemperatures[] FLOAT

devices[].hardwareStatusSamples[].batteryTemperatures[] FLOAT

devices[].hardwareStatusSamples[].cpuTemperatures[] FLOAT

devices[].hardwareStatusSamples[].gpuTemperatures[] FLOAT

devices[].appliedPolicyName STRING

The name of the policy currently applied to the device

devices[].lastPolicySyncTime ANY

The last time the device fetched its policy

devices[].policyName STRING

The name of the policy applied to the device, in the form enterprises/{enterpriseId}/policies/{policyId}. If not specified, the policy_name for the device's user is applied. This field can be modified by a patch request. You can specify only the policyId when calling enterprises.devices.patch, as long as the policyId doesn’t contain any slashes. The rest of the policy name is inferred

devices[].powerManagementEvents[] OBJECT

A power management event

devices[].powerManagementEvents[].batteryLevel FLOAT

For BATTERY_LEVEL_COLLECTED events, the battery level as a percentage

devices[].powerManagementEvents[].eventType ENUMERATION

Event type

devices[].powerManagementEvents[].createTime ANY

The creation time of the event

devices[].name STRING

The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}

devices[].enrollmentTokenName STRING

If the device was enrolled with an enrollment token, this field contains the name of the token

devices[].lastPolicyComplianceReportTime ANY

Deprecated

devices[].enrollmentTokenData STRING

If the device was enrolled with an enrollment token with additional data provided, this field contains that data

devices[].managementMode ENUMERATION

The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported

devices[].nonComplianceDetails[] OBJECT

Provides detail about non-compliance with a policy setting

devices[].nonComplianceDetails[].installationFailureReason ENUMERATION

If package_name is set and the non-compliance reason is APP_NOT_INSTALLED or APP_NOT_UPDATED, the detailed reason the app can't be installed or updated

devices[].nonComplianceDetails[].packageName STRING

The package name indicating which app is out of compliance, if applicable

devices[].nonComplianceDetails[].fieldPath STRING

For settings with nested fields, if a particular nested field is out of compliance, this specifies the full path to the offending field. The path is formatted in the same way the policy JSON field would be referenced in JavaScript, that is: 1) For object-typed fields, the field name is followed by a dot then by a subfield name. 2) For array-typed fields, the field name is followed by the array index enclosed in brackets. For example, to indicate a problem with the url field in the externalData field in the 3rd application, the path would be applications[2].externalData.url

devices[].nonComplianceDetails[].currentValue ANY

If the policy setting could not be applied, the current value of the setting on the device

devices[].nonComplianceDetails[].settingName STRING

The name of the policy setting. This is the JSON field name of a top-level Policy field

devices[].nonComplianceDetails[].nonComplianceReason ENUMERATION

The reason the device is not in compliance with the setting

devices[].user OBJECT

A user belonging to an enterprise

devices[].user.accountIdentifier STRING

A unique identifier you create for this user, such as user342 or asset#44418. This field must be set when the user is created and can't be updated. This field must not contain personally identifiable information (PII). This identifier must be 1024 characters or less; otherwise, the update policy request will fail

nextPageToken STRING

If there are more results, a token to retrieve next page of results