REST Resource: enterprises.devices

{
  "name": string,
  "userName": string,
  "managementMode": enum (ManagementMode),
  "state": enum (DeviceState),
  "appliedState": enum (DeviceState),
  "policyCompliant": boolean,
  "nonComplianceDetails": [
    {
      object (NonComplianceDetail)
    }
  ],
  "enrollmentTime": string,
  "lastStatusReportTime": string,
  "lastPolicyComplianceReportTime": string,
  "lastPolicySyncTime": string,
  "policyName": string,
  "appliedPolicyName": string,
  "appliedPolicyVersion": string,
  "apiLevel": integer,
  "enrollmentTokenData": string,
  "enrollmentTokenName": string,
  "disabledReason": {
    object (UserFacingMessage)
  },
  "softwareInfo": {
    object (SoftwareInfo)
  },
  "hardwareInfo": {
    object (HardwareInfo)
  },
  "displays": [
    {
      object (Display)
    }
  ],
  "applicationReports": [
    {
      object (ApplicationReport)
    }
  ],
  "previousDeviceNames": [
    string
  ],
  "networkInfo": {
    object (NetworkInfo)
  },
  "memoryInfo": {
    object (MemoryInfo)
  },
  "memoryEvents": [
    {
      object (MemoryEvent)
    }
  ],
  "powerManagementEvents": [
    {
      object (PowerManagementEvent)
    }
  ],
  "hardwareStatusSamples": [
    {
      object (HardwareStatus)
    }
  ],
  "deviceSettings": {
    object (DeviceSettings)
  },
  "user": {
    object (User)
  },
  "systemProperties": {
    string: string,
    ...
  },
  "securityPosture": {
    object (SecurityPosture)
  },
  "ownership": enum (Ownership),
  "commonCriteriaModeInfo": {
    object (CommonCriteriaModeInfo)
  },
  "appliedPasswordPolicies": [
    {
      object (PasswordRequirements)
    }
  ],
  "dpcMigrationInfo": {
    object (DpcMigrationInfo)
  }
}

string

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

string

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

enum (ManagementMode)

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

enum (DeviceState)

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.

enum (DeviceState)

The state currently applied to the device.

boolean

Whether the device is compliant with its policy.

object (NonComplianceDetail)

Details about policy settings that the device is not compliant with.

string (Timestamp format)

The time of device enrollment.

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".

string (Timestamp format)

The last time the device sent a status report.

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".

string (Timestamp format)

Deprecated.

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".

string (Timestamp format)

The last time the device fetched its policy.

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".

string

The name of the policy applied to the device, in the form enterprises/{enterpriseId}/policies/{policyId}. If not specified, the policyName 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.

string

The name of the policy currently applied to the device.

string (int64 format)

The version of the policy currently applied to the device.

integer

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

string

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

string

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

object (UserFacingMessage)

If the device state is DISABLED, an optional message that is displayed on the device indicating the reason the device is disabled. This field can be modified by a patch request.

object (SoftwareInfo)

Detailed information about the device software. This information is only available if softwareInfoEnabled is true in the device's policy.

object (HardwareInfo)

Detailed information about the device hardware.

object (Display)

Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy.

object (ApplicationReport)

Reports for apps installed on the device. This information is only available when applicationReportsEnabled is true in the device's policy.

string

If the same physical device has been enrolled multiple times, this field contains its previous device names. The serial number is used as the unique identifier to determine if the same physical device has enrolled previously. The names are in chronological order.

object (NetworkInfo)

Device network information. This information is only available if networkInfoEnabled is true in the device's policy.

object (MemoryInfo)

Memory information: contains information about device memory and storage.

object (MemoryEvent)

Events related to memory and storage measurements in chronological order. This information is only available if memoryInfoEnabled is true in the device's policy.

Events are retained for a certain period of time and old events are deleted.

object (PowerManagementEvent)

Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy.

object (HardwareStatus)

Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy.

object (DeviceSettings)

Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy.

object (User)

The user who owns the device.

map (key: string, value: string)

Map of selected system properties name and value related to the device. This information is only available if systemPropertiesEnabled is true in the device's policy.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

object (SecurityPosture)

Device's security posture value that reflects how secure the device is.

enum (Ownership)

Ownership of the managed device.

object (CommonCriteriaModeInfo)

Information about Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (CC).

This information is only available if statusReportingSettings.commonCriteriaModeEnabled is true in the device's policy the device is company-owned.

object (PasswordRequirements)

The password requirements currently applied to the device.

• The applied requirements may be slightly different from those specified in passwordPolicies in some cases.
• fieldPath is set based on passwordPolicies.

object (DpcMigrationInfo)

Output only. Information related to whether this device was migrated from being managed by another Device Policy Controller (DPC).

{
  "settingName": string,
  "nonComplianceReason": enum (NonComplianceReason),
  "packageName": string,
  "fieldPath": string,
  "currentValue": value,
  "installationFailureReason": enum (InstallationFailureReason),
  "specificNonComplianceReason": enum (SpecificNonComplianceReason),
  "specificNonComplianceContext": {
    object (SpecificNonComplianceContext)
  }
}

string

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

enum (NonComplianceReason)

The reason the device is not in compliance with the setting.

string

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

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

value (Value format)

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

enum (InstallationFailureReason)

If packageName 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.

enum (SpecificNonComplianceReason)

The policy-specific reason the device is not in compliance with the setting.

object (SpecificNonComplianceContext)

Additional context for specificNonComplianceReason.

{
  "oncWifiContext": {
    object (OncWifiContext)
  },
  "passwordPoliciesContext": {
    object (PasswordPoliciesContext)
  }
}

object (OncWifiContext)

Additional context for non-compliance related to Wi-Fi configuration. See ONC_WIFI_INVALID_VALUE and ONC_WIFI_API_LEVEL

object (PasswordPoliciesContext)

Additional context for non-compliance related to password policies. See PASSWORD_POLICIES_PASSWORD_EXPIRED and PASSWORD_POLICIES_PASSWORD_NOT_SUFFICIENT.

{
  "wifiGuid": string
}

string

The GUID of non-compliant Wi-Fi configuration.

{
  "passwordPolicyScope": enum (PasswordPolicyScope)
}

enum (PasswordPolicyScope)

The scope of non-compliant password.

{
  "androidVersion": string,
  "androidDevicePolicyVersionCode": integer,
  "androidDevicePolicyVersionName": string,
  "androidBuildNumber": string,
  "deviceKernelVersion": string,
  "bootloaderVersion": string,
  "androidBuildTime": string,
  "securityPatchLevel": string,
  "primaryLanguageCode": string,
  "deviceBuildSignature": string,
  "systemUpdateInfo": {
    object (SystemUpdateInfo)
  }
}

string

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

integer

The Android Device Policy app version code.

string

The Android Device Policy app version as displayed to the user.

string

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

string

Kernel version, for example, 2.6.32.9-g103d848.

string

The system bootloader version number, e.g. 0.6.7.

string (Timestamp format)

Build time.

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".

string

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

string

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

string

SHA-256 hash of android.content.pm.Signature associated with the system package, which can be used to verify that the system build hasn't been modified.

object (SystemUpdateInfo)

Information about a potential pending system update.

{
  "updateStatus": enum (UpdateStatus),
  "updateReceivedTime": string
}

enum (UpdateStatus)

The status of an update: whether an update exists and what type it is.

string (Timestamp format)

The time when the update was first available. A zero value indicates that this field is not set. This field is set only if an update is available (that is, updateStatus is neither UPDATE_STATUS_UNKNOWN nor UP_TO_DATE).

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".

{
  "brand": string,
  "hardware": string,
  "deviceBasebandVersion": string,
  "manufacturer": string,
  "serialNumber": string,
  "model": string,
  "batteryShutdownTemperatures": [
    number
  ],
  "batteryThrottlingTemperatures": [
    number
  ],
  "cpuShutdownTemperatures": [
    number
  ],
  "cpuThrottlingTemperatures": [
    number
  ],
  "gpuShutdownTemperatures": [
    number
  ],
  "gpuThrottlingTemperatures": [
    number
  ],
  "skinShutdownTemperatures": [
    number
  ],
  "skinThrottlingTemperatures": [
    number
  ],
  "enterpriseSpecificId": string
}

string

Brand of the device. For example, Google.

string

Name of the hardware. For example, Angler.

string

Baseband version. For example, MDM9625_104662.22.05.34p.

string

Manufacturer. For example, Motorola.

string

The device serial number.

string

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

number

Battery shutdown temperature thresholds in Celsius for each battery on the device.

number

Battery throttling temperature thresholds in Celsius for each battery on the device.

number

CPU shutdown temperature thresholds in Celsius for each CPU on the device.

number

CPU throttling temperature thresholds in Celsius for each CPU on the device.

number

GPU shutdown temperature thresholds in Celsius for each GPU on the device.

number

GPU throttling temperature thresholds in Celsius for each GPU on the device.

number

Device skin shutdown temperature thresholds in Celsius.

number

Device skin throttling temperature thresholds in Celsius.

string

Output only. ID that uniquely identifies a personally-owned device in a particular organization. On the same physical device when enrolled with the same organization, this ID persists across setups and even factory resets. This ID is available on personally-owned devices with a work profile on devices running Android 12 and above.

{
  "name": string,
  "displayId": integer,
  "refreshRate": integer,
  "state": enum (DisplayState),
  "width": integer,
  "height": integer,
  "density": integer
}

string

Name of the display.

integer

Unique display id.

integer

Refresh rate of the display in frames per second.

enum (DisplayState)

State of the display.

integer

Display width in pixels.

integer

Display height in pixels.

integer

Display density expressed as dots-per-inch.

{
  "packageName": string,
  "versionName": string,
  "versionCode": integer,
  "events": [
    {
      object (ApplicationEvent)
    }
  ],
  "displayName": string,
  "packageSha256Hash": string,
  "signingKeyCertFingerprints": [
    string
  ],
  "installerPackageName": string,
  "applicationSource": enum (ApplicationSource),
  "state": enum (ApplicationState),
  "keyedAppStates": [
    {
      object (KeyedAppState)
    }
  ],
  "userFacingType": enum (UserFacingType)
}

string

Package name of the app.

string

The app version as displayed to the user.

integer

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

object (ApplicationEvent)

The list of app events which have occurred in the last 30 hours.

string

The display name of the app.

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.

string

The SHA-1 hash of each android.content.pm.Signature associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number.

string

The package name of the app that installed this app.

enum (ApplicationSource)

The source of the package.

enum (ApplicationState)

Application state.

object (KeyedAppState)

List of keyed app states reported by the app.

enum (UserFacingType)

Whether the app is user facing.

{
  "eventType": enum (ApplicationEventType),
  "createTime": string
}

enum (ApplicationEventType)

App event type.

string (Timestamp format)

The creation time of the event.

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".

{
  "key": string,
  "severity": enum (Severity),
  "message": string,
  "data": string,
  "createTime": string,
  "lastUpdateTime": string
}

string

The key for the app state. Acts as a point of reference for what the app is providing state for. For example, when providing managed configuration feedback, this key could be the managed configuration key.

enum (Severity)

The severity of the app state.

string

Optionally, a free-form message string to explain the app state. If the state was triggered by a particular value (e.g. a managed configuration value), it should be included in the message.

string

Optionally, a machine-readable value to be read by the EMM. For example, setting values that the admin can choose to query against in the EMM console (e.g. “notify me if the battery_warning data < 10”).

string (Timestamp format)

The creation time of the app state on the 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".

string (Timestamp format)

The time the app state was most recently updated.

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".

{
  "imei": string,
  "meid": string,
  "wifiMacAddress": string,
  "networkOperatorName": string,
  "telephonyInfos": [
    {
      object (TelephonyInfo)
    }
  ]
}

string

IMEI number of the GSM device. For example, A1000031212.

string

MEID number of the CDMA device. For example, A00000292788E1.

string

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

string

Alphabetic name of current registered operator. For example, Vodafone.

object (TelephonyInfo)

Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23.

{
  "phoneNumber": string,
  "carrierName": string,
  "iccId": string
}

string

The phone number associated with this SIM card.

string

The carrier name associated with this SIM card.

string

Output only. The ICCID associated with this SIM card.

{
  "totalRam": string,
  "totalInternalStorage": string
}

string (int64 format)

Total RAM on device in bytes.

string (int64 format)

Total internal storage on device in bytes.

{
  "eventType": enum (MemoryEventType),
  "createTime": string,
  "byteCount": string
}

enum (MemoryEventType)

Event type.

string (Timestamp format)

The creation time of the event.

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".

string (int64 format)

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

{
  "eventType": enum (PowerManagementEventType),
  "createTime": string,
  "batteryLevel": number
}

enum (PowerManagementEventType)

Event type.

string (Timestamp format)

The creation time of the event.

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".

number

For BATTERY_LEVEL_COLLECTED events, the battery level as a percentage.

{
  "createTime": string,
  "batteryTemperatures": [
    number
  ],
  "cpuTemperatures": [
    number
  ],
  "gpuTemperatures": [
    number
  ],
  "skinTemperatures": [
    number
  ],
  "fanSpeeds": [
    number
  ],
  "cpuUsages": [
    number
  ]
}

string (Timestamp format)

The time the measurements were taken.

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".

number

Current battery temperatures in Celsius for each battery on the device.

number

Current CPU temperatures in Celsius for each CPU on the device.

number

Current GPU temperatures in Celsius for each GPU on the device.

number

Current device skin temperatures in Celsius.

number

Fan speeds in RPM for each fan on the device. Empty array means that there are no fans or fan speed is not supported on the system.

number

CPU usages in percentage for each core available on the device. Usage is 0 for each unplugged core. Empty array implies that CPU usage is not supported in the system.

{
  "isDeviceSecure": boolean,
  "unknownSourcesEnabled": boolean,
  "developmentSettingsEnabled": boolean,
  "adbEnabled": boolean,
  "isEncrypted": boolean,
  "encryptionStatus": enum (EncryptionStatus),
  "verifyAppsEnabled": boolean
}

boolean

Whether the device is secured with PIN/password.

boolean

Whether installing apps from unknown sources is enabled.

boolean

Whether developer mode is enabled on the device.

boolean

Whether ADB is enabled on the device.

boolean

Whether the storage encryption is enabled.

enum (EncryptionStatus)

Encryption status from DevicePolicyManager.

boolean

Whether Google Play Protect verification is enforced on the device.

{
  "devicePosture": enum (DevicePosture),
  "postureDetails": [
    {
      object (PostureDetail)
    }
  ]
}

enum (DevicePosture)

Device's security posture value.

object (PostureDetail)

Additional details regarding the security posture of the device.

{
  "securityRisk": enum (SecurityRisk),
  "advice": [
    {
      object (UserFacingMessage)
    }
  ]
}

enum (SecurityRisk)

A specific security risk that negatively affects the security posture of the device.

object (UserFacingMessage)

Corresponding admin-facing advice to mitigate this security risk and improve the security posture of the device.

{
  "commonCriteriaModeStatus": enum (CommonCriteriaModeStatus),
  "policySignatureVerificationStatus": enum (PolicySignatureVerificationStatus)
}

enum (CommonCriteriaModeStatus)

Whether Common Criteria Mode is enabled.

enum (PolicySignatureVerificationStatus)

Output only. The status of policy signature verification.

{
  "previousDpc": string,
  "additionalData": string
}

string

Output only. If this device was migrated from another DPC, this is its package name. Not populated otherwise.

string

Output only. If this device was migrated from another DPC, the additionalData field of the migration token is populated here.