| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="androidmanagement_v1.html">Android Management API</a> . <a href="androidmanagement_v1.enterprises.html">enterprises</a> . <a href="androidmanagement_v1.enterprises.devices.html">devices</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="androidmanagement_v1.enterprises.devices.operations.html">operations()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the operations Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 83 | <code><a href="#delete">delete(name, wipeReasonMessage=None, wipeDataFlags=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 84 | <p class="firstline">Deletes a device. This operation wipes the device.</p> |
| 85 | <p class="toc_element"> |
| 86 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 87 | <p class="firstline">Gets a device.</p> |
| 88 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 89 | <code><a href="#issueCommand">issueCommand(name, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 90 | <p class="firstline">Issues a command to a device. The Operation resource returned contains a Command in its metadata field. Use the get operation method to get the status of the command.</p> |
| 91 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 92 | <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 93 | <p class="firstline">Lists devices for a given enterprise.</p> |
| 94 | <p class="toc_element"> |
| 95 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 96 | <p class="firstline">Retrieves the next page of results.</p> |
| 97 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 98 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 99 | <p class="firstline">Updates a device.</p> |
| 100 | <h3>Method Details</h3> |
| 101 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 102 | <code class="details" id="delete">delete(name, wipeReasonMessage=None, wipeDataFlags=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 103 | <pre>Deletes a device. This operation wipes the device. |
| 104 | |
| 105 | Args: |
| 106 | name: string, The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 107 | wipeReasonMessage: string, Optional. A short message displayed to the user before wiping the work profile on personal devices. This has no effect on company owned devices. The maximum message length is 200 characters. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 108 | wipeDataFlags: string, Optional flags that control the device wiping behavior. (repeated) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 109 | x__xgafv: string, V1 error format. |
| 110 | Allowed values |
| 111 | 1 - v1 error format |
| 112 | 2 - v2 error format |
| 113 | |
| 114 | Returns: |
| 115 | An object of the form: |
| 116 | |
| 117 | { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: |
| 118 | # service Foo { |
| 119 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 120 | # } |
| 121 | # The JSON representation for Empty is empty JSON object {}. |
| 122 | }</pre> |
| 123 | </div> |
| 124 | |
| 125 | <div class="method"> |
| 126 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 127 | <pre>Gets a device. |
| 128 | |
| 129 | Args: |
| 130 | name: string, The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. (required) |
| 131 | x__xgafv: string, V1 error format. |
| 132 | Allowed values |
| 133 | 1 - v1 error format |
| 134 | 2 - v2 error format |
| 135 | |
| 136 | Returns: |
| 137 | An object of the form: |
| 138 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 139 | { # A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 140 | "appliedState": "A String", # The state currently applied to the device. |
| 141 | "enrollmentTime": "A String", # The time of device enrollment. |
| 142 | "lastPolicySyncTime": "A String", # The last time the device fetched its policy. |
| 143 | "nonComplianceDetails": [ # Details about policy settings that the device is not compliant with. |
| 144 | { # Provides detail about non-compliance with a policy setting. |
| 145 | "currentValue": "", # If the policy setting could not be applied, the current value of the setting on the device. |
| 146 | "settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field. |
| 147 | "fieldPath": "A 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 |
| 148 | "packageName": "A String", # The package name indicating which app is out of compliance, if applicable. |
| 149 | "installationFailureReason": "A String", # 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. |
| 150 | "nonComplianceReason": "A String", # The reason the device is not in compliance with the setting. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 151 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 152 | ], |
| 153 | "memoryInfo": { # Information about device memory and storage. # Memory information. This information is only available if memoryInfoEnabled is true in the device's policy. |
| 154 | "totalRam": "A String", # Total RAM on device in bytes. |
| 155 | "totalInternalStorage": "A String", # Total internal storage on device in bytes. |
| 156 | }, |
| 157 | "displays": [ # Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy. |
| 158 | { # Device display information. |
| 159 | "width": 42, # Display width in pixels. |
| 160 | "displayId": 42, # Unique display id. |
| 161 | "name": "A String", # Name of the display. |
| 162 | "height": 42, # Display height in pixels. |
| 163 | "density": 42, # Display density expressed as dots-per-inch. |
| 164 | "refreshRate": 42, # Refresh rate of the display in frames per second. |
| 165 | "state": "A String", # State of the display. |
| 166 | }, |
| 167 | ], |
| 168 | "enrollmentTokenName": "A String", # If the device was enrolled with an enrollment token, this field contains the name of the token. |
| 169 | "name": "A String", # The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. |
| 170 | "policyName": "A 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. |
| 171 | "managementMode": "A String", # The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported. |
| 172 | "policyCompliant": True or False, # Whether the device is compliant with its policy. |
| 173 | "state": "A String", # 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. |
| 174 | "hardwareInfo": { # Information about device hardware. The fields related to temperature thresholds are only available if hardwareStatusEnabled is true in the device's policy. # Detailed information about the device hardware. |
| 175 | "skinThrottlingTemperatures": [ # Device skin throttling temperature thresholds in Celsius. |
| 176 | 3.14, |
| 177 | ], |
| 178 | "serialNumber": "A String", # The device serial number. |
| 179 | "batteryShutdownTemperatures": [ # Battery shutdown temperature thresholds in Celsius for each battery on the device. |
| 180 | 3.14, |
| 181 | ], |
| 182 | "hardware": "A String", # Name of the hardware. For example, Angler. |
| 183 | "gpuShutdownTemperatures": [ # GPU shutdown temperature thresholds in Celsius for each GPU on the device. |
| 184 | 3.14, |
| 185 | ], |
| 186 | "brand": "A String", # Brand of the device. For example, Google. |
| 187 | "gpuThrottlingTemperatures": [ # GPU throttling temperature thresholds in Celsius for each GPU on the device. |
| 188 | 3.14, |
| 189 | ], |
| 190 | "batteryThrottlingTemperatures": [ # Battery throttling temperature thresholds in Celsius for each battery on the device. |
| 191 | 3.14, |
| 192 | ], |
| 193 | "cpuShutdownTemperatures": [ # CPU shutdown temperature thresholds in Celsius for each CPU on the device. |
| 194 | 3.14, |
| 195 | ], |
| 196 | "cpuThrottlingTemperatures": [ # CPU throttling temperature thresholds in Celsius for each CPU on the device. |
| 197 | 3.14, |
| 198 | ], |
| 199 | "model": "A String", # The model of the device. For example, Asus Nexus 7. |
| 200 | "manufacturer": "A String", # Manufacturer. For example, Motorola. |
| 201 | "skinShutdownTemperatures": [ # Device skin shutdown temperature thresholds in Celsius. |
| 202 | 3.14, |
| 203 | ], |
| 204 | "deviceBasebandVersion": "A String", # Baseband version. For example, MDM9625_104662.22.05.34p. |
| 205 | }, |
| 206 | "softwareInfo": { # Information about device software. # Detailed information about the device software. This information is only available if softwareInfoEnabled is true in the device's policy. |
| 207 | "bootloaderVersion": "A String", # The system bootloader version number, e.g. 0.6.7. |
| 208 | "androidDevicePolicyVersionName": "A String", # The Android Device Policy app version as displayed to the user. |
| 209 | "primaryLanguageCode": "A String", # An IETF BCP 47 language code for the primary locale on the device. |
| 210 | "androidBuildTime": "A String", # Build time. |
| 211 | "androidBuildNumber": "A String", # Android build ID string meant for displaying to the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys. |
| 212 | "androidVersion": "A String", # The user-visible Android version string. For example, 6.0.1. |
| 213 | "securityPatchLevel": "A String", # Security patch level, e.g. 2016-05-01. |
| 214 | "deviceKernelVersion": "A String", # Kernel version, for example, 2.6.32.9-g103d848. |
| 215 | "deviceBuildSignature": "A 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. |
| 216 | "androidDevicePolicyVersionCode": 42, # The Android Device Policy app version code. |
| 217 | }, |
| 218 | "lastPolicyComplianceReportTime": "A String", # Deprecated. |
| 219 | "securityPosture": { # The security posture of the device, as determined by the current device state and the policies applied. # Device's security posture value that reflects how secure the device is. |
| 220 | "postureDetails": [ # Additional details regarding the security posture of the device. |
| 221 | { # Additional details regarding the security posture of the device. |
| 222 | "securityRisk": "A String", # A specific security risk that negatively affects the security posture of the device. |
| 223 | "advice": [ # Corresponding admin-facing advice to mitigate this security risk and improve the security posture of the device. |
| 224 | { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. |
| 225 | "localizedMessages": { # 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. |
| 226 | "a_key": "A String", |
| 227 | }, |
| 228 | "defaultMessage": "A 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. |
| 229 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 230 | ], |
| 231 | }, |
| 232 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 233 | "devicePosture": "A String", # Device's security posture value. |
| 234 | }, |
| 235 | "disabledReason": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # 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. |
| 236 | "localizedMessages": { # 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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 237 | "a_key": "A String", |
| 238 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 239 | "defaultMessage": "A 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. |
| 240 | }, |
| 241 | "ownership": "A String", # Ownership of the managed device. |
| 242 | "hardwareStatusSamples": [ # Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy. |
| 243 | { # Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health. |
| 244 | "batteryTemperatures": [ # Current battery temperatures in Celsius for each battery on the device. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 245 | 3.14, |
| 246 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 247 | "cpuUsages": [ # 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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 248 | 3.14, |
| 249 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 250 | "createTime": "A String", # The time the measurements were taken. |
| 251 | "skinTemperatures": [ # Current device skin temperatures in Celsius. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 252 | 3.14, |
| 253 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 254 | "fanSpeeds": [ # 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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 255 | 3.14, |
| 256 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 257 | "cpuTemperatures": [ # Current CPU temperatures in Celsius for each CPU on the device. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 258 | 3.14, |
| 259 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 260 | "gpuTemperatures": [ # Current GPU temperatures in Celsius for each GPU on the device. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 261 | 3.14, |
| 262 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 263 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 264 | ], |
| 265 | "userName": "A String", # The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}. |
| 266 | "systemProperties": { # 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. |
| 267 | "a_key": "A String", |
| 268 | }, |
| 269 | "networkInfo": { # Device network info. # Device network information. This information is only available if networkInfoEnabled is true in the device's policy. |
| 270 | "networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone. |
| 271 | "wifiMacAddress": "A String", # Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11. |
| 272 | "meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1. |
| 273 | "imei": "A String", # IMEI number of the GSM device. For example, A1000031212. |
| 274 | }, |
| 275 | "appliedPolicyVersion": "A String", # The version of the policy currently applied to the device. |
| 276 | "deviceSettings": { # Information about security related device settings on device. # Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy. |
| 277 | "adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device. |
| 278 | "unknownSourcesEnabled": True or False, # Whether installing apps from unknown sources is enabled. |
| 279 | "isDeviceSecure": True or False, # Whether the device is secured with PIN/password. |
| 280 | "verifyAppsEnabled": True or False, # Whether Verify Apps (Google Play Protect (https://support.google.com/googleplay/answer/2812853)) is enabled on the device. |
| 281 | "developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device. |
| 282 | "isEncrypted": True or False, # Whether the storage encryption is enabled. |
| 283 | "encryptionStatus": "A String", # Encryption status from DevicePolicyManager. |
| 284 | }, |
| 285 | "applicationReports": [ # Reports for apps installed on the device. This information is only available when application_reports_enabled is true in the device's policy. |
| 286 | { # Information reported about an installed app. |
| 287 | "packageSha256Hash": "A 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. |
| 288 | "installerPackageName": "A String", # The package name of the app that installed this app. |
| 289 | "keyedAppStates": [ # List of keyed app states reported by the app. |
| 290 | { # Keyed app state reported by the app. |
| 291 | "createTime": "A String", # The creation time of the app state on the device. |
| 292 | "severity": "A String", # The severity of the app state. |
| 293 | "lastUpdateTime": "A String", # The time the app state was most recently updated. |
| 294 | "data": "A 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”). |
| 295 | "message": "A 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. |
| 296 | "key": "A 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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 297 | }, |
| 298 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 299 | "versionName": "A String", # The app version as displayed to the user. |
| 300 | "events": [ # List of app events. The most recent 20 events are stored in the list. |
| 301 | { # An app-related event. |
| 302 | "eventType": "A String", # App event type. |
| 303 | "createTime": "A String", # The creation time of the event. |
| 304 | }, |
| 305 | ], |
| 306 | "packageName": "A String", # Package name of the app. |
| 307 | "state": "A String", # Application state. |
| 308 | "displayName": "A String", # The display name of the app. |
| 309 | "applicationSource": "A String", # The source of the package. |
| 310 | "signingKeyCertFingerprints": [ # The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number. |
| 311 | "A String", |
| 312 | ], |
| 313 | "versionCode": 42, # The app version code, which can be used to determine whether one version is more recent than another. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 314 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 315 | ], |
| 316 | "appliedPolicyName": "A String", # The name of the policy currently applied to the device. |
| 317 | "lastStatusReportTime": "A String", # The last time the device sent a status report. |
| 318 | "apiLevel": 42, # The API level of the Android platform version running on the device. |
| 319 | "enrollmentTokenData": "A String", # If the device was enrolled with an enrollment token with additional data provided, this field contains that data. |
| 320 | "memoryEvents": [ # Events related to memory and storage measurements in chronological order. This information is only available if memoryInfoEnabled is true in the device's policy. |
| 321 | { # An event related to memory and storage measurements. |
| 322 | "createTime": "A String", # The creation time of the event. |
| 323 | "byteCount": "A String", # The number of free bytes in the medium, or for EXTERNAL_STORAGE_DETECTED, the total capacity in bytes of the storage medium. |
| 324 | "eventType": "A String", # Event type. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 325 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 326 | ], |
| 327 | "previousDeviceNames": [ # 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. |
| 328 | "A String", |
| 329 | ], |
| 330 | "user": { # A user belonging to an enterprise. # The user who owns the device. |
| 331 | "accountIdentifier": "A 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. |
| 332 | }, |
| 333 | "powerManagementEvents": [ # Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy. |
| 334 | { # A power management event. |
| 335 | "createTime": "A String", # The creation time of the event. |
| 336 | "eventType": "A String", # Event type. |
| 337 | "batteryLevel": 3.14, # For BATTERY_LEVEL_COLLECTED events, the battery level as a percentage. |
| 338 | }, |
| 339 | ], |
| 340 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 341 | </div> |
| 342 | |
| 343 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 344 | <code class="details" id="issueCommand">issueCommand(name, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 345 | <pre>Issues a command to a device. The Operation resource returned contains a Command in its metadata field. Use the get operation method to get the status of the command. |
| 346 | |
| 347 | Args: |
| 348 | name: string, The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 349 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 350 | The object takes the form of: |
| 351 | |
| 352 | { # A command. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 353 | "newPassword": "A String", # For commands of type RESET_PASSWORD, optionally specifies the new password. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 354 | "createTime": "A String", # The timestamp at which the command was created. The timestamp is automatically generated by the server. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 355 | "resetPasswordFlags": [ # For commands of type RESET_PASSWORD, optionally specifies flags. |
| 356 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 357 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 358 | "userName": "A String", # The resource name of the user that owns the device in the form enterprises/{enterpriseId}/users/{userId}. This is automatically generated by the server based on the device the command is sent to. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 359 | "duration": "A String", # The duration for which the command is valid. The command will expire if not executed by the device during this time. The default duration if unspecified is ten minutes. There is no maximum duration. |
| 360 | "type": "A String", # The type of the command. |
| 361 | "errorCode": "A String", # If the command failed, an error code explaining the failure. This is not set when the command is cancelled by the caller. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 362 | } |
| 363 | |
| 364 | x__xgafv: string, V1 error format. |
| 365 | Allowed values |
| 366 | 1 - v1 error format |
| 367 | 2 - v2 error format |
| 368 | |
| 369 | Returns: |
| 370 | An object of the form: |
| 371 | |
| 372 | { # This resource represents a long-running operation that is the result of a network API call. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 373 | "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse. |
| 374 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 375 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 376 | "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| 377 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 378 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 379 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 380 | }, |
| 381 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 382 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 383 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 384 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 385 | "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 386 | "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| 387 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 388 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 389 | "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 390 | }</pre> |
| 391 | </div> |
| 392 | |
| 393 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 394 | <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 395 | <pre>Lists devices for a given enterprise. |
| 396 | |
| 397 | Args: |
| 398 | parent: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required) |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 399 | pageToken: string, A token identifying a page of results returned by the server. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 400 | pageSize: integer, The requested page size. The actual page size may be fixed to a min or max value. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 401 | x__xgafv: string, V1 error format. |
| 402 | Allowed values |
| 403 | 1 - v1 error format |
| 404 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 405 | |
| 406 | Returns: |
| 407 | An object of the form: |
| 408 | |
| 409 | { # Response to a request to list devices for a given enterprise. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 410 | "nextPageToken": "A String", # If there are more results, a token to retrieve next page of results. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 411 | "devices": [ # The list of devices. |
| 412 | { # A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 413 | "appliedState": "A String", # The state currently applied to the device. |
| 414 | "enrollmentTime": "A String", # The time of device enrollment. |
| 415 | "lastPolicySyncTime": "A String", # The last time the device fetched its policy. |
| 416 | "nonComplianceDetails": [ # Details about policy settings that the device is not compliant with. |
| 417 | { # Provides detail about non-compliance with a policy setting. |
| 418 | "currentValue": "", # If the policy setting could not be applied, the current value of the setting on the device. |
| 419 | "settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field. |
| 420 | "fieldPath": "A 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 |
| 421 | "packageName": "A String", # The package name indicating which app is out of compliance, if applicable. |
| 422 | "installationFailureReason": "A String", # 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. |
| 423 | "nonComplianceReason": "A String", # The reason the device is not in compliance with the setting. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 424 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 425 | ], |
| 426 | "memoryInfo": { # Information about device memory and storage. # Memory information. This information is only available if memoryInfoEnabled is true in the device's policy. |
| 427 | "totalRam": "A String", # Total RAM on device in bytes. |
| 428 | "totalInternalStorage": "A String", # Total internal storage on device in bytes. |
| 429 | }, |
| 430 | "displays": [ # Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy. |
| 431 | { # Device display information. |
| 432 | "width": 42, # Display width in pixels. |
| 433 | "displayId": 42, # Unique display id. |
| 434 | "name": "A String", # Name of the display. |
| 435 | "height": 42, # Display height in pixels. |
| 436 | "density": 42, # Display density expressed as dots-per-inch. |
| 437 | "refreshRate": 42, # Refresh rate of the display in frames per second. |
| 438 | "state": "A String", # State of the display. |
| 439 | }, |
| 440 | ], |
| 441 | "enrollmentTokenName": "A String", # If the device was enrolled with an enrollment token, this field contains the name of the token. |
| 442 | "name": "A String", # The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. |
| 443 | "policyName": "A 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. |
| 444 | "managementMode": "A String", # The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported. |
| 445 | "policyCompliant": True or False, # Whether the device is compliant with its policy. |
| 446 | "state": "A String", # 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. |
| 447 | "hardwareInfo": { # Information about device hardware. The fields related to temperature thresholds are only available if hardwareStatusEnabled is true in the device's policy. # Detailed information about the device hardware. |
| 448 | "skinThrottlingTemperatures": [ # Device skin throttling temperature thresholds in Celsius. |
| 449 | 3.14, |
| 450 | ], |
| 451 | "serialNumber": "A String", # The device serial number. |
| 452 | "batteryShutdownTemperatures": [ # Battery shutdown temperature thresholds in Celsius for each battery on the device. |
| 453 | 3.14, |
| 454 | ], |
| 455 | "hardware": "A String", # Name of the hardware. For example, Angler. |
| 456 | "gpuShutdownTemperatures": [ # GPU shutdown temperature thresholds in Celsius for each GPU on the device. |
| 457 | 3.14, |
| 458 | ], |
| 459 | "brand": "A String", # Brand of the device. For example, Google. |
| 460 | "gpuThrottlingTemperatures": [ # GPU throttling temperature thresholds in Celsius for each GPU on the device. |
| 461 | 3.14, |
| 462 | ], |
| 463 | "batteryThrottlingTemperatures": [ # Battery throttling temperature thresholds in Celsius for each battery on the device. |
| 464 | 3.14, |
| 465 | ], |
| 466 | "cpuShutdownTemperatures": [ # CPU shutdown temperature thresholds in Celsius for each CPU on the device. |
| 467 | 3.14, |
| 468 | ], |
| 469 | "cpuThrottlingTemperatures": [ # CPU throttling temperature thresholds in Celsius for each CPU on the device. |
| 470 | 3.14, |
| 471 | ], |
| 472 | "model": "A String", # The model of the device. For example, Asus Nexus 7. |
| 473 | "manufacturer": "A String", # Manufacturer. For example, Motorola. |
| 474 | "skinShutdownTemperatures": [ # Device skin shutdown temperature thresholds in Celsius. |
| 475 | 3.14, |
| 476 | ], |
| 477 | "deviceBasebandVersion": "A String", # Baseband version. For example, MDM9625_104662.22.05.34p. |
| 478 | }, |
| 479 | "softwareInfo": { # Information about device software. # Detailed information about the device software. This information is only available if softwareInfoEnabled is true in the device's policy. |
| 480 | "bootloaderVersion": "A String", # The system bootloader version number, e.g. 0.6.7. |
| 481 | "androidDevicePolicyVersionName": "A String", # The Android Device Policy app version as displayed to the user. |
| 482 | "primaryLanguageCode": "A String", # An IETF BCP 47 language code for the primary locale on the device. |
| 483 | "androidBuildTime": "A String", # Build time. |
| 484 | "androidBuildNumber": "A String", # Android build ID string meant for displaying to the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys. |
| 485 | "androidVersion": "A String", # The user-visible Android version string. For example, 6.0.1. |
| 486 | "securityPatchLevel": "A String", # Security patch level, e.g. 2016-05-01. |
| 487 | "deviceKernelVersion": "A String", # Kernel version, for example, 2.6.32.9-g103d848. |
| 488 | "deviceBuildSignature": "A 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. |
| 489 | "androidDevicePolicyVersionCode": 42, # The Android Device Policy app version code. |
| 490 | }, |
| 491 | "lastPolicyComplianceReportTime": "A String", # Deprecated. |
| 492 | "securityPosture": { # The security posture of the device, as determined by the current device state and the policies applied. # Device's security posture value that reflects how secure the device is. |
| 493 | "postureDetails": [ # Additional details regarding the security posture of the device. |
| 494 | { # Additional details regarding the security posture of the device. |
| 495 | "securityRisk": "A String", # A specific security risk that negatively affects the security posture of the device. |
| 496 | "advice": [ # Corresponding admin-facing advice to mitigate this security risk and improve the security posture of the device. |
| 497 | { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. |
| 498 | "localizedMessages": { # 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. |
| 499 | "a_key": "A String", |
| 500 | }, |
| 501 | "defaultMessage": "A 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. |
| 502 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 503 | ], |
| 504 | }, |
| 505 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 506 | "devicePosture": "A String", # Device's security posture value. |
| 507 | }, |
| 508 | "disabledReason": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # 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. |
| 509 | "localizedMessages": { # 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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 510 | "a_key": "A String", |
| 511 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 512 | "defaultMessage": "A 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. |
| 513 | }, |
| 514 | "ownership": "A String", # Ownership of the managed device. |
| 515 | "hardwareStatusSamples": [ # Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy. |
| 516 | { # Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health. |
| 517 | "batteryTemperatures": [ # Current battery temperatures in Celsius for each battery on the device. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 518 | 3.14, |
| 519 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 520 | "cpuUsages": [ # 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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 521 | 3.14, |
| 522 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 523 | "createTime": "A String", # The time the measurements were taken. |
| 524 | "skinTemperatures": [ # Current device skin temperatures in Celsius. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 525 | 3.14, |
| 526 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 527 | "fanSpeeds": [ # 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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 528 | 3.14, |
| 529 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 530 | "cpuTemperatures": [ # Current CPU temperatures in Celsius for each CPU on the device. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 531 | 3.14, |
| 532 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 533 | "gpuTemperatures": [ # Current GPU temperatures in Celsius for each GPU on the device. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 534 | 3.14, |
| 535 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 536 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 537 | ], |
| 538 | "userName": "A String", # The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}. |
| 539 | "systemProperties": { # 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. |
| 540 | "a_key": "A String", |
| 541 | }, |
| 542 | "networkInfo": { # Device network info. # Device network information. This information is only available if networkInfoEnabled is true in the device's policy. |
| 543 | "networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone. |
| 544 | "wifiMacAddress": "A String", # Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11. |
| 545 | "meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1. |
| 546 | "imei": "A String", # IMEI number of the GSM device. For example, A1000031212. |
| 547 | }, |
| 548 | "appliedPolicyVersion": "A String", # The version of the policy currently applied to the device. |
| 549 | "deviceSettings": { # Information about security related device settings on device. # Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy. |
| 550 | "adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device. |
| 551 | "unknownSourcesEnabled": True or False, # Whether installing apps from unknown sources is enabled. |
| 552 | "isDeviceSecure": True or False, # Whether the device is secured with PIN/password. |
| 553 | "verifyAppsEnabled": True or False, # Whether Verify Apps (Google Play Protect (https://support.google.com/googleplay/answer/2812853)) is enabled on the device. |
| 554 | "developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device. |
| 555 | "isEncrypted": True or False, # Whether the storage encryption is enabled. |
| 556 | "encryptionStatus": "A String", # Encryption status from DevicePolicyManager. |
| 557 | }, |
| 558 | "applicationReports": [ # Reports for apps installed on the device. This information is only available when application_reports_enabled is true in the device's policy. |
| 559 | { # Information reported about an installed app. |
| 560 | "packageSha256Hash": "A 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. |
| 561 | "installerPackageName": "A String", # The package name of the app that installed this app. |
| 562 | "keyedAppStates": [ # List of keyed app states reported by the app. |
| 563 | { # Keyed app state reported by the app. |
| 564 | "createTime": "A String", # The creation time of the app state on the device. |
| 565 | "severity": "A String", # The severity of the app state. |
| 566 | "lastUpdateTime": "A String", # The time the app state was most recently updated. |
| 567 | "data": "A 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”). |
| 568 | "message": "A 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. |
| 569 | "key": "A 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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 570 | }, |
| 571 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 572 | "versionName": "A String", # The app version as displayed to the user. |
| 573 | "events": [ # List of app events. The most recent 20 events are stored in the list. |
| 574 | { # An app-related event. |
| 575 | "eventType": "A String", # App event type. |
| 576 | "createTime": "A String", # The creation time of the event. |
| 577 | }, |
| 578 | ], |
| 579 | "packageName": "A String", # Package name of the app. |
| 580 | "state": "A String", # Application state. |
| 581 | "displayName": "A String", # The display name of the app. |
| 582 | "applicationSource": "A String", # The source of the package. |
| 583 | "signingKeyCertFingerprints": [ # The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number. |
| 584 | "A String", |
| 585 | ], |
| 586 | "versionCode": 42, # The app version code, which can be used to determine whether one version is more recent than another. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 587 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 588 | ], |
| 589 | "appliedPolicyName": "A String", # The name of the policy currently applied to the device. |
| 590 | "lastStatusReportTime": "A String", # The last time the device sent a status report. |
| 591 | "apiLevel": 42, # The API level of the Android platform version running on the device. |
| 592 | "enrollmentTokenData": "A String", # If the device was enrolled with an enrollment token with additional data provided, this field contains that data. |
| 593 | "memoryEvents": [ # Events related to memory and storage measurements in chronological order. This information is only available if memoryInfoEnabled is true in the device's policy. |
| 594 | { # An event related to memory and storage measurements. |
| 595 | "createTime": "A String", # The creation time of the event. |
| 596 | "byteCount": "A String", # The number of free bytes in the medium, or for EXTERNAL_STORAGE_DETECTED, the total capacity in bytes of the storage medium. |
| 597 | "eventType": "A String", # Event type. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 598 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 599 | ], |
| 600 | "previousDeviceNames": [ # 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. |
| 601 | "A String", |
| 602 | ], |
| 603 | "user": { # A user belonging to an enterprise. # The user who owns the device. |
| 604 | "accountIdentifier": "A 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 605 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 606 | "powerManagementEvents": [ # Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy. |
| 607 | { # A power management event. |
| 608 | "createTime": "A String", # The creation time of the event. |
| 609 | "eventType": "A String", # Event type. |
| 610 | "batteryLevel": 3.14, # For BATTERY_LEVEL_COLLECTED events, the battery level as a percentage. |
| 611 | }, |
| 612 | ], |
| 613 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 614 | ], |
| 615 | }</pre> |
| 616 | </div> |
| 617 | |
| 618 | <div class="method"> |
| 619 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 620 | <pre>Retrieves the next page of results. |
| 621 | |
| 622 | Args: |
| 623 | previous_request: The request for the previous page. (required) |
| 624 | previous_response: The response from the request for the previous page. (required) |
| 625 | |
| 626 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 627 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 628 | page. Returns None if there are no more items in the collection. |
| 629 | </pre> |
| 630 | </div> |
| 631 | |
| 632 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 633 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 634 | <pre>Updates a device. |
| 635 | |
| 636 | Args: |
| 637 | name: string, The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 638 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 639 | The object takes the form of: |
| 640 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 641 | { # A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 642 | "appliedState": "A String", # The state currently applied to the device. |
| 643 | "enrollmentTime": "A String", # The time of device enrollment. |
| 644 | "lastPolicySyncTime": "A String", # The last time the device fetched its policy. |
| 645 | "nonComplianceDetails": [ # Details about policy settings that the device is not compliant with. |
| 646 | { # Provides detail about non-compliance with a policy setting. |
| 647 | "currentValue": "", # If the policy setting could not be applied, the current value of the setting on the device. |
| 648 | "settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field. |
| 649 | "fieldPath": "A 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 |
| 650 | "packageName": "A String", # The package name indicating which app is out of compliance, if applicable. |
| 651 | "installationFailureReason": "A String", # 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. |
| 652 | "nonComplianceReason": "A String", # The reason the device is not in compliance with the setting. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 653 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 654 | ], |
| 655 | "memoryInfo": { # Information about device memory and storage. # Memory information. This information is only available if memoryInfoEnabled is true in the device's policy. |
| 656 | "totalRam": "A String", # Total RAM on device in bytes. |
| 657 | "totalInternalStorage": "A String", # Total internal storage on device in bytes. |
| 658 | }, |
| 659 | "displays": [ # Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy. |
| 660 | { # Device display information. |
| 661 | "width": 42, # Display width in pixels. |
| 662 | "displayId": 42, # Unique display id. |
| 663 | "name": "A String", # Name of the display. |
| 664 | "height": 42, # Display height in pixels. |
| 665 | "density": 42, # Display density expressed as dots-per-inch. |
| 666 | "refreshRate": 42, # Refresh rate of the display in frames per second. |
| 667 | "state": "A String", # State of the display. |
| 668 | }, |
| 669 | ], |
| 670 | "enrollmentTokenName": "A String", # If the device was enrolled with an enrollment token, this field contains the name of the token. |
| 671 | "name": "A String", # The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. |
| 672 | "policyName": "A 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. |
| 673 | "managementMode": "A String", # The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported. |
| 674 | "policyCompliant": True or False, # Whether the device is compliant with its policy. |
| 675 | "state": "A String", # 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. |
| 676 | "hardwareInfo": { # Information about device hardware. The fields related to temperature thresholds are only available if hardwareStatusEnabled is true in the device's policy. # Detailed information about the device hardware. |
| 677 | "skinThrottlingTemperatures": [ # Device skin throttling temperature thresholds in Celsius. |
| 678 | 3.14, |
| 679 | ], |
| 680 | "serialNumber": "A String", # The device serial number. |
| 681 | "batteryShutdownTemperatures": [ # Battery shutdown temperature thresholds in Celsius for each battery on the device. |
| 682 | 3.14, |
| 683 | ], |
| 684 | "hardware": "A String", # Name of the hardware. For example, Angler. |
| 685 | "gpuShutdownTemperatures": [ # GPU shutdown temperature thresholds in Celsius for each GPU on the device. |
| 686 | 3.14, |
| 687 | ], |
| 688 | "brand": "A String", # Brand of the device. For example, Google. |
| 689 | "gpuThrottlingTemperatures": [ # GPU throttling temperature thresholds in Celsius for each GPU on the device. |
| 690 | 3.14, |
| 691 | ], |
| 692 | "batteryThrottlingTemperatures": [ # Battery throttling temperature thresholds in Celsius for each battery on the device. |
| 693 | 3.14, |
| 694 | ], |
| 695 | "cpuShutdownTemperatures": [ # CPU shutdown temperature thresholds in Celsius for each CPU on the device. |
| 696 | 3.14, |
| 697 | ], |
| 698 | "cpuThrottlingTemperatures": [ # CPU throttling temperature thresholds in Celsius for each CPU on the device. |
| 699 | 3.14, |
| 700 | ], |
| 701 | "model": "A String", # The model of the device. For example, Asus Nexus 7. |
| 702 | "manufacturer": "A String", # Manufacturer. For example, Motorola. |
| 703 | "skinShutdownTemperatures": [ # Device skin shutdown temperature thresholds in Celsius. |
| 704 | 3.14, |
| 705 | ], |
| 706 | "deviceBasebandVersion": "A String", # Baseband version. For example, MDM9625_104662.22.05.34p. |
| 707 | }, |
| 708 | "softwareInfo": { # Information about device software. # Detailed information about the device software. This information is only available if softwareInfoEnabled is true in the device's policy. |
| 709 | "bootloaderVersion": "A String", # The system bootloader version number, e.g. 0.6.7. |
| 710 | "androidDevicePolicyVersionName": "A String", # The Android Device Policy app version as displayed to the user. |
| 711 | "primaryLanguageCode": "A String", # An IETF BCP 47 language code for the primary locale on the device. |
| 712 | "androidBuildTime": "A String", # Build time. |
| 713 | "androidBuildNumber": "A String", # Android build ID string meant for displaying to the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys. |
| 714 | "androidVersion": "A String", # The user-visible Android version string. For example, 6.0.1. |
| 715 | "securityPatchLevel": "A String", # Security patch level, e.g. 2016-05-01. |
| 716 | "deviceKernelVersion": "A String", # Kernel version, for example, 2.6.32.9-g103d848. |
| 717 | "deviceBuildSignature": "A 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. |
| 718 | "androidDevicePolicyVersionCode": 42, # The Android Device Policy app version code. |
| 719 | }, |
| 720 | "lastPolicyComplianceReportTime": "A String", # Deprecated. |
| 721 | "securityPosture": { # The security posture of the device, as determined by the current device state and the policies applied. # Device's security posture value that reflects how secure the device is. |
| 722 | "postureDetails": [ # Additional details regarding the security posture of the device. |
| 723 | { # Additional details regarding the security posture of the device. |
| 724 | "securityRisk": "A String", # A specific security risk that negatively affects the security posture of the device. |
| 725 | "advice": [ # Corresponding admin-facing advice to mitigate this security risk and improve the security posture of the device. |
| 726 | { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. |
| 727 | "localizedMessages": { # 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. |
| 728 | "a_key": "A String", |
| 729 | }, |
| 730 | "defaultMessage": "A 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. |
| 731 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 732 | ], |
| 733 | }, |
| 734 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 735 | "devicePosture": "A String", # Device's security posture value. |
| 736 | }, |
| 737 | "disabledReason": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # 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. |
| 738 | "localizedMessages": { # 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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 739 | "a_key": "A String", |
| 740 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 741 | "defaultMessage": "A 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. |
| 742 | }, |
| 743 | "ownership": "A String", # Ownership of the managed device. |
| 744 | "hardwareStatusSamples": [ # Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy. |
| 745 | { # Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health. |
| 746 | "batteryTemperatures": [ # Current battery temperatures in Celsius for each battery on the device. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 747 | 3.14, |
| 748 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 749 | "cpuUsages": [ # 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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 750 | 3.14, |
| 751 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 752 | "createTime": "A String", # The time the measurements were taken. |
| 753 | "skinTemperatures": [ # Current device skin temperatures in Celsius. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 754 | 3.14, |
| 755 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 756 | "fanSpeeds": [ # 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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 757 | 3.14, |
| 758 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 759 | "cpuTemperatures": [ # Current CPU temperatures in Celsius for each CPU on the device. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 760 | 3.14, |
| 761 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 762 | "gpuTemperatures": [ # Current GPU temperatures in Celsius for each GPU on the device. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 763 | 3.14, |
| 764 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 765 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 766 | ], |
| 767 | "userName": "A String", # The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}. |
| 768 | "systemProperties": { # 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. |
| 769 | "a_key": "A String", |
| 770 | }, |
| 771 | "networkInfo": { # Device network info. # Device network information. This information is only available if networkInfoEnabled is true in the device's policy. |
| 772 | "networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone. |
| 773 | "wifiMacAddress": "A String", # Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11. |
| 774 | "meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1. |
| 775 | "imei": "A String", # IMEI number of the GSM device. For example, A1000031212. |
| 776 | }, |
| 777 | "appliedPolicyVersion": "A String", # The version of the policy currently applied to the device. |
| 778 | "deviceSettings": { # Information about security related device settings on device. # Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy. |
| 779 | "adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device. |
| 780 | "unknownSourcesEnabled": True or False, # Whether installing apps from unknown sources is enabled. |
| 781 | "isDeviceSecure": True or False, # Whether the device is secured with PIN/password. |
| 782 | "verifyAppsEnabled": True or False, # Whether Verify Apps (Google Play Protect (https://support.google.com/googleplay/answer/2812853)) is enabled on the device. |
| 783 | "developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device. |
| 784 | "isEncrypted": True or False, # Whether the storage encryption is enabled. |
| 785 | "encryptionStatus": "A String", # Encryption status from DevicePolicyManager. |
| 786 | }, |
| 787 | "applicationReports": [ # Reports for apps installed on the device. This information is only available when application_reports_enabled is true in the device's policy. |
| 788 | { # Information reported about an installed app. |
| 789 | "packageSha256Hash": "A 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. |
| 790 | "installerPackageName": "A String", # The package name of the app that installed this app. |
| 791 | "keyedAppStates": [ # List of keyed app states reported by the app. |
| 792 | { # Keyed app state reported by the app. |
| 793 | "createTime": "A String", # The creation time of the app state on the device. |
| 794 | "severity": "A String", # The severity of the app state. |
| 795 | "lastUpdateTime": "A String", # The time the app state was most recently updated. |
| 796 | "data": "A 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”). |
| 797 | "message": "A 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. |
| 798 | "key": "A 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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 799 | }, |
| 800 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 801 | "versionName": "A String", # The app version as displayed to the user. |
| 802 | "events": [ # List of app events. The most recent 20 events are stored in the list. |
| 803 | { # An app-related event. |
| 804 | "eventType": "A String", # App event type. |
| 805 | "createTime": "A String", # The creation time of the event. |
| 806 | }, |
| 807 | ], |
| 808 | "packageName": "A String", # Package name of the app. |
| 809 | "state": "A String", # Application state. |
| 810 | "displayName": "A String", # The display name of the app. |
| 811 | "applicationSource": "A String", # The source of the package. |
| 812 | "signingKeyCertFingerprints": [ # The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number. |
| 813 | "A String", |
| 814 | ], |
| 815 | "versionCode": 42, # The app version code, which can be used to determine whether one version is more recent than another. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 816 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 817 | ], |
| 818 | "appliedPolicyName": "A String", # The name of the policy currently applied to the device. |
| 819 | "lastStatusReportTime": "A String", # The last time the device sent a status report. |
| 820 | "apiLevel": 42, # The API level of the Android platform version running on the device. |
| 821 | "enrollmentTokenData": "A String", # If the device was enrolled with an enrollment token with additional data provided, this field contains that data. |
| 822 | "memoryEvents": [ # Events related to memory and storage measurements in chronological order. This information is only available if memoryInfoEnabled is true in the device's policy. |
| 823 | { # An event related to memory and storage measurements. |
| 824 | "createTime": "A String", # The creation time of the event. |
| 825 | "byteCount": "A String", # The number of free bytes in the medium, or for EXTERNAL_STORAGE_DETECTED, the total capacity in bytes of the storage medium. |
| 826 | "eventType": "A String", # Event type. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 827 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 828 | ], |
| 829 | "previousDeviceNames": [ # 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. |
| 830 | "A String", |
| 831 | ], |
| 832 | "user": { # A user belonging to an enterprise. # The user who owns the device. |
| 833 | "accountIdentifier": "A 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. |
| 834 | }, |
| 835 | "powerManagementEvents": [ # Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy. |
| 836 | { # A power management event. |
| 837 | "createTime": "A String", # The creation time of the event. |
| 838 | "eventType": "A String", # Event type. |
| 839 | "batteryLevel": 3.14, # For BATTERY_LEVEL_COLLECTED events, the battery level as a percentage. |
| 840 | }, |
| 841 | ], |
| 842 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 843 | |
| 844 | updateMask: string, The field mask indicating the fields to update. If not set, all modifiable fields will be modified. |
| 845 | x__xgafv: string, V1 error format. |
| 846 | Allowed values |
| 847 | 1 - v1 error format |
| 848 | 2 - v2 error format |
| 849 | |
| 850 | Returns: |
| 851 | An object of the form: |
| 852 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 853 | { # A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 854 | "appliedState": "A String", # The state currently applied to the device. |
| 855 | "enrollmentTime": "A String", # The time of device enrollment. |
| 856 | "lastPolicySyncTime": "A String", # The last time the device fetched its policy. |
| 857 | "nonComplianceDetails": [ # Details about policy settings that the device is not compliant with. |
| 858 | { # Provides detail about non-compliance with a policy setting. |
| 859 | "currentValue": "", # If the policy setting could not be applied, the current value of the setting on the device. |
| 860 | "settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field. |
| 861 | "fieldPath": "A 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 |
| 862 | "packageName": "A String", # The package name indicating which app is out of compliance, if applicable. |
| 863 | "installationFailureReason": "A String", # 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. |
| 864 | "nonComplianceReason": "A String", # The reason the device is not in compliance with the setting. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 865 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 866 | ], |
| 867 | "memoryInfo": { # Information about device memory and storage. # Memory information. This information is only available if memoryInfoEnabled is true in the device's policy. |
| 868 | "totalRam": "A String", # Total RAM on device in bytes. |
| 869 | "totalInternalStorage": "A String", # Total internal storage on device in bytes. |
| 870 | }, |
| 871 | "displays": [ # Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy. |
| 872 | { # Device display information. |
| 873 | "width": 42, # Display width in pixels. |
| 874 | "displayId": 42, # Unique display id. |
| 875 | "name": "A String", # Name of the display. |
| 876 | "height": 42, # Display height in pixels. |
| 877 | "density": 42, # Display density expressed as dots-per-inch. |
| 878 | "refreshRate": 42, # Refresh rate of the display in frames per second. |
| 879 | "state": "A String", # State of the display. |
| 880 | }, |
| 881 | ], |
| 882 | "enrollmentTokenName": "A String", # If the device was enrolled with an enrollment token, this field contains the name of the token. |
| 883 | "name": "A String", # The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. |
| 884 | "policyName": "A 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. |
| 885 | "managementMode": "A String", # The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported. |
| 886 | "policyCompliant": True or False, # Whether the device is compliant with its policy. |
| 887 | "state": "A String", # 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. |
| 888 | "hardwareInfo": { # Information about device hardware. The fields related to temperature thresholds are only available if hardwareStatusEnabled is true in the device's policy. # Detailed information about the device hardware. |
| 889 | "skinThrottlingTemperatures": [ # Device skin throttling temperature thresholds in Celsius. |
| 890 | 3.14, |
| 891 | ], |
| 892 | "serialNumber": "A String", # The device serial number. |
| 893 | "batteryShutdownTemperatures": [ # Battery shutdown temperature thresholds in Celsius for each battery on the device. |
| 894 | 3.14, |
| 895 | ], |
| 896 | "hardware": "A String", # Name of the hardware. For example, Angler. |
| 897 | "gpuShutdownTemperatures": [ # GPU shutdown temperature thresholds in Celsius for each GPU on the device. |
| 898 | 3.14, |
| 899 | ], |
| 900 | "brand": "A String", # Brand of the device. For example, Google. |
| 901 | "gpuThrottlingTemperatures": [ # GPU throttling temperature thresholds in Celsius for each GPU on the device. |
| 902 | 3.14, |
| 903 | ], |
| 904 | "batteryThrottlingTemperatures": [ # Battery throttling temperature thresholds in Celsius for each battery on the device. |
| 905 | 3.14, |
| 906 | ], |
| 907 | "cpuShutdownTemperatures": [ # CPU shutdown temperature thresholds in Celsius for each CPU on the device. |
| 908 | 3.14, |
| 909 | ], |
| 910 | "cpuThrottlingTemperatures": [ # CPU throttling temperature thresholds in Celsius for each CPU on the device. |
| 911 | 3.14, |
| 912 | ], |
| 913 | "model": "A String", # The model of the device. For example, Asus Nexus 7. |
| 914 | "manufacturer": "A String", # Manufacturer. For example, Motorola. |
| 915 | "skinShutdownTemperatures": [ # Device skin shutdown temperature thresholds in Celsius. |
| 916 | 3.14, |
| 917 | ], |
| 918 | "deviceBasebandVersion": "A String", # Baseband version. For example, MDM9625_104662.22.05.34p. |
| 919 | }, |
| 920 | "softwareInfo": { # Information about device software. # Detailed information about the device software. This information is only available if softwareInfoEnabled is true in the device's policy. |
| 921 | "bootloaderVersion": "A String", # The system bootloader version number, e.g. 0.6.7. |
| 922 | "androidDevicePolicyVersionName": "A String", # The Android Device Policy app version as displayed to the user. |
| 923 | "primaryLanguageCode": "A String", # An IETF BCP 47 language code for the primary locale on the device. |
| 924 | "androidBuildTime": "A String", # Build time. |
| 925 | "androidBuildNumber": "A String", # Android build ID string meant for displaying to the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys. |
| 926 | "androidVersion": "A String", # The user-visible Android version string. For example, 6.0.1. |
| 927 | "securityPatchLevel": "A String", # Security patch level, e.g. 2016-05-01. |
| 928 | "deviceKernelVersion": "A String", # Kernel version, for example, 2.6.32.9-g103d848. |
| 929 | "deviceBuildSignature": "A 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. |
| 930 | "androidDevicePolicyVersionCode": 42, # The Android Device Policy app version code. |
| 931 | }, |
| 932 | "lastPolicyComplianceReportTime": "A String", # Deprecated. |
| 933 | "securityPosture": { # The security posture of the device, as determined by the current device state and the policies applied. # Device's security posture value that reflects how secure the device is. |
| 934 | "postureDetails": [ # Additional details regarding the security posture of the device. |
| 935 | { # Additional details regarding the security posture of the device. |
| 936 | "securityRisk": "A String", # A specific security risk that negatively affects the security posture of the device. |
| 937 | "advice": [ # Corresponding admin-facing advice to mitigate this security risk and improve the security posture of the device. |
| 938 | { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. |
| 939 | "localizedMessages": { # 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. |
| 940 | "a_key": "A String", |
| 941 | }, |
| 942 | "defaultMessage": "A 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. |
| 943 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 944 | ], |
| 945 | }, |
| 946 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 947 | "devicePosture": "A String", # Device's security posture value. |
| 948 | }, |
| 949 | "disabledReason": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # 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. |
| 950 | "localizedMessages": { # 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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 951 | "a_key": "A String", |
| 952 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 953 | "defaultMessage": "A 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. |
| 954 | }, |
| 955 | "ownership": "A String", # Ownership of the managed device. |
| 956 | "hardwareStatusSamples": [ # Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy. |
| 957 | { # Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health. |
| 958 | "batteryTemperatures": [ # Current battery temperatures in Celsius for each battery on the device. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 959 | 3.14, |
| 960 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 961 | "cpuUsages": [ # 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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 962 | 3.14, |
| 963 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 964 | "createTime": "A String", # The time the measurements were taken. |
| 965 | "skinTemperatures": [ # Current device skin temperatures in Celsius. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 966 | 3.14, |
| 967 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 968 | "fanSpeeds": [ # 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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 969 | 3.14, |
| 970 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 971 | "cpuTemperatures": [ # Current CPU temperatures in Celsius for each CPU on the device. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 972 | 3.14, |
| 973 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 974 | "gpuTemperatures": [ # Current GPU temperatures in Celsius for each GPU on the device. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 975 | 3.14, |
| 976 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 977 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 978 | ], |
| 979 | "userName": "A String", # The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}. |
| 980 | "systemProperties": { # 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. |
| 981 | "a_key": "A String", |
| 982 | }, |
| 983 | "networkInfo": { # Device network info. # Device network information. This information is only available if networkInfoEnabled is true in the device's policy. |
| 984 | "networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone. |
| 985 | "wifiMacAddress": "A String", # Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11. |
| 986 | "meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1. |
| 987 | "imei": "A String", # IMEI number of the GSM device. For example, A1000031212. |
| 988 | }, |
| 989 | "appliedPolicyVersion": "A String", # The version of the policy currently applied to the device. |
| 990 | "deviceSettings": { # Information about security related device settings on device. # Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy. |
| 991 | "adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device. |
| 992 | "unknownSourcesEnabled": True or False, # Whether installing apps from unknown sources is enabled. |
| 993 | "isDeviceSecure": True or False, # Whether the device is secured with PIN/password. |
| 994 | "verifyAppsEnabled": True or False, # Whether Verify Apps (Google Play Protect (https://support.google.com/googleplay/answer/2812853)) is enabled on the device. |
| 995 | "developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device. |
| 996 | "isEncrypted": True or False, # Whether the storage encryption is enabled. |
| 997 | "encryptionStatus": "A String", # Encryption status from DevicePolicyManager. |
| 998 | }, |
| 999 | "applicationReports": [ # Reports for apps installed on the device. This information is only available when application_reports_enabled is true in the device's policy. |
| 1000 | { # Information reported about an installed app. |
| 1001 | "packageSha256Hash": "A 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. |
| 1002 | "installerPackageName": "A String", # The package name of the app that installed this app. |
| 1003 | "keyedAppStates": [ # List of keyed app states reported by the app. |
| 1004 | { # Keyed app state reported by the app. |
| 1005 | "createTime": "A String", # The creation time of the app state on the device. |
| 1006 | "severity": "A String", # The severity of the app state. |
| 1007 | "lastUpdateTime": "A String", # The time the app state was most recently updated. |
| 1008 | "data": "A 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”). |
| 1009 | "message": "A 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. |
| 1010 | "key": "A 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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1011 | }, |
| 1012 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1013 | "versionName": "A String", # The app version as displayed to the user. |
| 1014 | "events": [ # List of app events. The most recent 20 events are stored in the list. |
| 1015 | { # An app-related event. |
| 1016 | "eventType": "A String", # App event type. |
| 1017 | "createTime": "A String", # The creation time of the event. |
| 1018 | }, |
| 1019 | ], |
| 1020 | "packageName": "A String", # Package name of the app. |
| 1021 | "state": "A String", # Application state. |
| 1022 | "displayName": "A String", # The display name of the app. |
| 1023 | "applicationSource": "A String", # The source of the package. |
| 1024 | "signingKeyCertFingerprints": [ # The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number. |
| 1025 | "A String", |
| 1026 | ], |
| 1027 | "versionCode": 42, # The app version code, which can be used to determine whether one version is more recent than another. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1028 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1029 | ], |
| 1030 | "appliedPolicyName": "A String", # The name of the policy currently applied to the device. |
| 1031 | "lastStatusReportTime": "A String", # The last time the device sent a status report. |
| 1032 | "apiLevel": 42, # The API level of the Android platform version running on the device. |
| 1033 | "enrollmentTokenData": "A String", # If the device was enrolled with an enrollment token with additional data provided, this field contains that data. |
| 1034 | "memoryEvents": [ # Events related to memory and storage measurements in chronological order. This information is only available if memoryInfoEnabled is true in the device's policy. |
| 1035 | { # An event related to memory and storage measurements. |
| 1036 | "createTime": "A String", # The creation time of the event. |
| 1037 | "byteCount": "A String", # The number of free bytes in the medium, or for EXTERNAL_STORAGE_DETECTED, the total capacity in bytes of the storage medium. |
| 1038 | "eventType": "A String", # Event type. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1039 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1040 | ], |
| 1041 | "previousDeviceNames": [ # 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. |
| 1042 | "A String", |
| 1043 | ], |
| 1044 | "user": { # A user belonging to an enterprise. # The user who owns the device. |
| 1045 | "accountIdentifier": "A 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. |
| 1046 | }, |
| 1047 | "powerManagementEvents": [ # Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy. |
| 1048 | { # A power management event. |
| 1049 | "createTime": "A String", # The creation time of the event. |
| 1050 | "eventType": "A String", # Event type. |
| 1051 | "batteryLevel": 3.14, # For BATTERY_LEVEL_COLLECTED events, the battery level as a percentage. |
| 1052 | }, |
| 1053 | ], |
| 1054 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1055 | </div> |
| 1056 | |
| 1057 | </body></html> |