| 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"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 83 | <code><a href="#delete">delete(name, wipeDataFlags=None, wipeReasonMessage=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 | 6502091 | 2020-05-20 12:08:20 -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"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 102 | <code class="details" id="delete">delete(name, wipeDataFlags=None, wipeReasonMessage=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) |
| 107 | wipeDataFlags: string, Optional flags that control the device wiping behavior. (repeated) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 108 | 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 | 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. |
| 140 | "nonComplianceDetails": [ # Details about policy settings that the device is not compliant with. |
| 141 | { # Provides detail about non-compliance with a policy setting. |
| 142 | "settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field. |
| 143 | "nonComplianceReason": "A String", # The reason the device is not in compliance with the setting. |
| 144 | "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. |
| 145 | "packageName": "A String", # The package name indicating which app is out of compliance, if applicable. |
| 146 | "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 |
| 147 | "currentValue": "", # If the policy setting could not be applied, the current value of the setting on the device. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 148 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 149 | ], |
| 150 | "user": { # A user belonging to an enterprise. # The user who owns the device. |
| 151 | "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. |
| 152 | }, |
| 153 | "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. |
| 154 | "A String", |
| 155 | ], |
| 156 | "lastStatusReportTime": "A String", # The last time the device sent a status report. |
| 157 | "policyCompliant": True or False, # Whether the device is compliant with its policy. |
| 158 | "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. |
| 159 | "unknownSourcesEnabled": True or False, # Whether installing apps from unknown sources is enabled. |
| 160 | "verifyAppsEnabled": True or False, # Whether Verify Apps (Google Play Protect (https://support.google.com/googleplay/answer/2812853)) is enabled on the device. |
| 161 | "developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device. |
| 162 | "adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device. |
| 163 | "isEncrypted": True or False, # Whether the storage encryption is enabled. |
| 164 | "encryptionStatus": "A String", # Encryption status from DevicePolicyManager. |
| 165 | "isDeviceSecure": True or False, # Whether the device is secured with PIN/password. |
| 166 | }, |
| 167 | "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. |
| 168 | "enrollmentTime": "A String", # The time of device enrollment. |
| 169 | "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. |
| 170 | "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. |
| 171 | "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. |
| 172 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 173 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 174 | }, |
| 175 | "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. |
| 176 | "securityPatchLevel": "A String", # Security patch level, e.g. 2016-05-01. |
| 177 | "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. |
| 178 | "primaryLanguageCode": "A String", # An IETF BCP 47 language code for the primary locale on the device. |
| 179 | "androidVersion": "A String", # The user-visible Android version string. For example, 6.0.1. |
| 180 | "androidBuildNumber": "A String", # Android build ID string meant for displaying to the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys. |
| 181 | "androidDevicePolicyVersionName": "A String", # The Android Device Policy app version as displayed to the user. |
| 182 | "androidDevicePolicyVersionCode": 42, # The Android Device Policy app version code. |
| 183 | "bootloaderVersion": "A String", # The system bootloader version number, e.g. 0.6.7. |
| 184 | "deviceKernelVersion": "A String", # Kernel version, for example, 2.6.32.9-g103d848. |
| 185 | "androidBuildTime": "A String", # Build time. |
| 186 | }, |
| 187 | "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. |
| 188 | "gpuThrottlingTemperatures": [ # GPU throttling temperature thresholds in Celsius for each GPU on the device. |
| 189 | 3.14, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 190 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 191 | "batteryThrottlingTemperatures": [ # Battery throttling temperature thresholds in Celsius for each battery on the device. |
| 192 | 3.14, |
| 193 | ], |
| 194 | "manufacturer": "A String", # Manufacturer. For example, Motorola. |
| 195 | "serialNumber": "A String", # The device serial number. |
| 196 | "brand": "A String", # Brand of the device. For example, Google. |
| 197 | "deviceBasebandVersion": "A String", # Baseband version. For example, MDM9625_104662.22.05.34p. |
| 198 | "batteryShutdownTemperatures": [ # Battery shutdown temperature thresholds in Celsius for each battery on the device. |
| 199 | 3.14, |
| 200 | ], |
| 201 | "skinShutdownTemperatures": [ # Device skin shutdown temperature thresholds in Celsius. |
| 202 | 3.14, |
| 203 | ], |
| 204 | "model": "A String", # The model of the device. For example, Asus Nexus 7. |
| 205 | "cpuShutdownTemperatures": [ # CPU shutdown temperature thresholds in Celsius for each CPU on the device. |
| 206 | 3.14, |
| 207 | ], |
| 208 | "skinThrottlingTemperatures": [ # Device skin throttling temperature thresholds in Celsius. |
| 209 | 3.14, |
| 210 | ], |
| 211 | "hardware": "A String", # Name of the hardware. For example, Angler. |
| 212 | "cpuThrottlingTemperatures": [ # CPU throttling temperature thresholds in Celsius for each CPU on the device. |
| 213 | 3.14, |
| 214 | ], |
| 215 | "gpuShutdownTemperatures": [ # GPU shutdown temperature thresholds in Celsius for each GPU on the device. |
| 216 | 3.14, |
| 217 | ], |
| 218 | }, |
| 219 | "appliedPolicyVersion": "A String", # The version of the policy currently applied to the device. |
| 220 | "displays": [ # Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy. |
| 221 | { # Device display information. |
| 222 | "density": 42, # Display density expressed as dots-per-inch. |
| 223 | "height": 42, # Display height in pixels. |
| 224 | "width": 42, # Display width in pixels. |
| 225 | "refreshRate": 42, # Refresh rate of the display in frames per second. |
| 226 | "state": "A String", # State of the display. |
| 227 | "displayId": 42, # Unique display id. |
| 228 | "name": "A String", # Name of the display. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 229 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 230 | ], |
| 231 | "applicationReports": [ # Reports for apps installed on the device. This information is only available when application_reports_enabled is true in the device's policy. |
| 232 | { # Information reported about an installed app. |
| 233 | "displayName": "A String", # The display name of the app. |
| 234 | "installerPackageName": "A String", # The package name of the app that installed this app. |
| 235 | "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. |
| 236 | "A String", |
| 237 | ], |
| 238 | "applicationSource": "A String", # The source of the package. |
| 239 | "state": "A String", # Application state. |
| 240 | "versionName": "A String", # The app version as displayed to the user. |
| 241 | "packageName": "A String", # Package name of the app. |
| 242 | "keyedAppStates": [ # List of keyed app states reported by the app. |
| 243 | { # Keyed app state reported by the app. |
| 244 | "severity": "A String", # The severity of the app state. |
| 245 | "lastUpdateTime": "A String", # The time the app state was most recently updated. |
| 246 | "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”). |
| 247 | "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. |
| 248 | "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. |
| 249 | "createTime": "A String", # The creation time of the app state on the device. |
| 250 | }, |
| 251 | ], |
| 252 | "versionCode": 42, # The app version code, which can be used to determine whether one version is more recent than another. |
| 253 | "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. |
| 254 | "events": [ # List of app events. The most recent 20 events are stored in the list. |
| 255 | { # An app-related event. |
| 256 | "eventType": "A String", # App event type. |
| 257 | "createTime": "A String", # The creation time of the event. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 258 | }, |
| 259 | ], |
| 260 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 261 | ], |
| 262 | "apiLevel": 42, # The API level of the Android platform version running on the device. |
| 263 | "userName": "A String", # The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}. |
| 264 | "networkInfo": { # Device network info. # Device network information. This information is only available if networkInfoEnabled is true in the device's policy. |
| 265 | "networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone. |
| 266 | "imei": "A String", # IMEI number of the GSM device. For example, A1000031212. |
| 267 | "meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1. |
| 268 | "wifiMacAddress": "A String", # Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11. |
| 269 | }, |
| 270 | "memoryInfo": { # Information about device memory and storage. # Memory information. This information is only available if memoryInfoEnabled is true in the device's policy. |
| 271 | "totalRam": "A String", # Total RAM on device in bytes. |
| 272 | "totalInternalStorage": "A String", # Total internal storage on device in bytes. |
| 273 | }, |
| 274 | "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. |
| 275 | { # An event related to memory and storage measurements. |
| 276 | "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. |
| 277 | "eventType": "A String", # Event type. |
| 278 | "createTime": "A String", # The creation time of the event. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 279 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 280 | ], |
| 281 | "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. |
| 282 | "a_key": "A String", |
| 283 | }, |
| 284 | "appliedPolicyName": "A String", # The name of the policy currently applied to the device. |
| 285 | "appliedState": "A String", # The state currently applied to the device. |
| 286 | "hardwareStatusSamples": [ # Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy. |
| 287 | { # Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health. |
| 288 | "cpuTemperatures": [ # Current CPU temperatures in Celsius for each CPU on the device. |
| 289 | 3.14, |
| 290 | ], |
| 291 | "batteryTemperatures": [ # Current battery temperatures in Celsius for each battery on the device. |
| 292 | 3.14, |
| 293 | ], |
| 294 | "gpuTemperatures": [ # Current GPU temperatures in Celsius for each GPU on the device. |
| 295 | 3.14, |
| 296 | ], |
| 297 | "createTime": "A String", # The time the measurements were taken. |
| 298 | "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. |
| 299 | 3.14, |
| 300 | ], |
| 301 | "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. |
| 302 | 3.14, |
| 303 | ], |
| 304 | "skinTemperatures": [ # Current device skin temperatures in Celsius. |
| 305 | 3.14, |
| 306 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 307 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 308 | ], |
| 309 | "lastPolicySyncTime": "A String", # The last time the device fetched its policy. |
| 310 | "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. |
| 311 | "powerManagementEvents": [ # Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy. |
| 312 | { # A power management event. |
| 313 | "createTime": "A String", # The creation time of the event. |
| 314 | "batteryLevel": 3.14, # For BATTERY_LEVEL_COLLECTED events, the battery level as a percentage. |
| 315 | "eventType": "A String", # Event type. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 316 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 317 | ], |
| 318 | "name": "A String", # The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. |
| 319 | "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. |
| 320 | "postureDetails": [ # Additional details regarding the security posture of the device. |
| 321 | { # Additional details regarding the security posture of the device. |
| 322 | "securityRisk": "A String", # A specific security risk that negatively affects the security posture of the device. |
| 323 | "advice": [ # Corresponding admin-facing advice to mitigate this security risk and improve the security posture of the device. |
| 324 | { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. |
| 325 | "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. |
| 326 | "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. |
| 327 | "a_key": "A String", |
| 328 | }, |
| 329 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 330 | ], |
| 331 | }, |
| 332 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 333 | "devicePosture": "A String", # Device's security posture value. |
| 334 | }, |
| 335 | "enrollmentTokenName": "A String", # If the device was enrolled with an enrollment token, this field contains the name of the token. |
| 336 | "lastPolicyComplianceReportTime": "A String", # Deprecated. |
| 337 | "enrollmentTokenData": "A String", # If the device was enrolled with an enrollment token with additional data provided, this field contains that data. |
| 338 | "managementMode": "A String", # The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported. |
| 339 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 340 | </div> |
| 341 | |
| 342 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 343 | <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] | 344 | <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. |
| 345 | |
| 346 | Args: |
| 347 | 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] | 348 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 349 | The object takes the form of: |
| 350 | |
| 351 | { # A command. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 352 | "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. |
| 353 | "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. |
| 354 | "createTime": "A String", # The timestamp at which the command was created. The timestamp is automatically generated by the server. |
| 355 | "newPassword": "A String", # For commands of type RESET_PASSWORD, optionally specifies the new password. |
| 356 | "resetPasswordFlags": [ # For commands of type RESET_PASSWORD, optionally specifies flags. |
| 357 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 358 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 359 | "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. |
| 360 | "type": "A String", # The type of the command. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 361 | } |
| 362 | |
| 363 | x__xgafv: string, V1 error format. |
| 364 | Allowed values |
| 365 | 1 - v1 error format |
| 366 | 2 - v2 error format |
| 367 | |
| 368 | Returns: |
| 369 | An object of the form: |
| 370 | |
| 371 | { # This resource represents a long-running operation that is the result of a network API call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 372 | "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. |
| 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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 375 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 376 | "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}. |
| 377 | "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. |
| 378 | "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] | 379 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 380 | "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] | 381 | }, |
| 382 | ], |
| 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. |
| 384 | "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. |
| 385 | }, |
| 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 | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 389 | }</pre> |
| 390 | </div> |
| 391 | |
| 392 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 393 | <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] | 394 | <pre>Lists devices for a given enterprise. |
| 395 | |
| 396 | Args: |
| 397 | parent: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required) |
| 398 | pageToken: string, A token identifying a page of results returned by the server. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 399 | 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] | 400 | x__xgafv: string, V1 error format. |
| 401 | Allowed values |
| 402 | 1 - v1 error format |
| 403 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 404 | |
| 405 | Returns: |
| 406 | An object of the form: |
| 407 | |
| 408 | { # Response to a request to list devices for a given enterprise. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 409 | "devices": [ # The list of devices. |
| 410 | { # A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch. |
| 411 | "nonComplianceDetails": [ # Details about policy settings that the device is not compliant with. |
| 412 | { # Provides detail about non-compliance with a policy setting. |
| 413 | "settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field. |
| 414 | "nonComplianceReason": "A String", # The reason the device is not in compliance with the setting. |
| 415 | "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. |
| 416 | "packageName": "A String", # The package name indicating which app is out of compliance, if applicable. |
| 417 | "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 |
| 418 | "currentValue": "", # If the policy setting could not be applied, the current value of the setting on the device. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 419 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 420 | ], |
| 421 | "user": { # A user belonging to an enterprise. # The user who owns the device. |
| 422 | "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. |
| 423 | }, |
| 424 | "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. |
| 425 | "A String", |
| 426 | ], |
| 427 | "lastStatusReportTime": "A String", # The last time the device sent a status report. |
| 428 | "policyCompliant": True or False, # Whether the device is compliant with its policy. |
| 429 | "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. |
| 430 | "unknownSourcesEnabled": True or False, # Whether installing apps from unknown sources is enabled. |
| 431 | "verifyAppsEnabled": True or False, # Whether Verify Apps (Google Play Protect (https://support.google.com/googleplay/answer/2812853)) is enabled on the device. |
| 432 | "developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device. |
| 433 | "adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device. |
| 434 | "isEncrypted": True or False, # Whether the storage encryption is enabled. |
| 435 | "encryptionStatus": "A String", # Encryption status from DevicePolicyManager. |
| 436 | "isDeviceSecure": True or False, # Whether the device is secured with PIN/password. |
| 437 | }, |
| 438 | "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. |
| 439 | "enrollmentTime": "A String", # The time of device enrollment. |
| 440 | "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. |
| 441 | "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. |
| 442 | "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. |
| 443 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 444 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 445 | }, |
| 446 | "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. |
| 447 | "securityPatchLevel": "A String", # Security patch level, e.g. 2016-05-01. |
| 448 | "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. |
| 449 | "primaryLanguageCode": "A String", # An IETF BCP 47 language code for the primary locale on the device. |
| 450 | "androidVersion": "A String", # The user-visible Android version string. For example, 6.0.1. |
| 451 | "androidBuildNumber": "A String", # Android build ID string meant for displaying to the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys. |
| 452 | "androidDevicePolicyVersionName": "A String", # The Android Device Policy app version as displayed to the user. |
| 453 | "androidDevicePolicyVersionCode": 42, # The Android Device Policy app version code. |
| 454 | "bootloaderVersion": "A String", # The system bootloader version number, e.g. 0.6.7. |
| 455 | "deviceKernelVersion": "A String", # Kernel version, for example, 2.6.32.9-g103d848. |
| 456 | "androidBuildTime": "A String", # Build time. |
| 457 | }, |
| 458 | "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. |
| 459 | "gpuThrottlingTemperatures": [ # GPU throttling temperature thresholds in Celsius for each GPU on the device. |
| 460 | 3.14, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 461 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 462 | "batteryThrottlingTemperatures": [ # Battery throttling temperature thresholds in Celsius for each battery on the device. |
| 463 | 3.14, |
| 464 | ], |
| 465 | "manufacturer": "A String", # Manufacturer. For example, Motorola. |
| 466 | "serialNumber": "A String", # The device serial number. |
| 467 | "brand": "A String", # Brand of the device. For example, Google. |
| 468 | "deviceBasebandVersion": "A String", # Baseband version. For example, MDM9625_104662.22.05.34p. |
| 469 | "batteryShutdownTemperatures": [ # Battery shutdown temperature thresholds in Celsius for each battery on the device. |
| 470 | 3.14, |
| 471 | ], |
| 472 | "skinShutdownTemperatures": [ # Device skin shutdown temperature thresholds in Celsius. |
| 473 | 3.14, |
| 474 | ], |
| 475 | "model": "A String", # The model of the device. For example, Asus Nexus 7. |
| 476 | "cpuShutdownTemperatures": [ # CPU shutdown temperature thresholds in Celsius for each CPU on the device. |
| 477 | 3.14, |
| 478 | ], |
| 479 | "skinThrottlingTemperatures": [ # Device skin throttling temperature thresholds in Celsius. |
| 480 | 3.14, |
| 481 | ], |
| 482 | "hardware": "A String", # Name of the hardware. For example, Angler. |
| 483 | "cpuThrottlingTemperatures": [ # CPU throttling temperature thresholds in Celsius for each CPU on the device. |
| 484 | 3.14, |
| 485 | ], |
| 486 | "gpuShutdownTemperatures": [ # GPU shutdown temperature thresholds in Celsius for each GPU on the device. |
| 487 | 3.14, |
| 488 | ], |
| 489 | }, |
| 490 | "appliedPolicyVersion": "A String", # The version of the policy currently applied to the device. |
| 491 | "displays": [ # Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy. |
| 492 | { # Device display information. |
| 493 | "density": 42, # Display density expressed as dots-per-inch. |
| 494 | "height": 42, # Display height in pixels. |
| 495 | "width": 42, # Display width in pixels. |
| 496 | "refreshRate": 42, # Refresh rate of the display in frames per second. |
| 497 | "state": "A String", # State of the display. |
| 498 | "displayId": 42, # Unique display id. |
| 499 | "name": "A String", # Name of the display. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 500 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 501 | ], |
| 502 | "applicationReports": [ # Reports for apps installed on the device. This information is only available when application_reports_enabled is true in the device's policy. |
| 503 | { # Information reported about an installed app. |
| 504 | "displayName": "A String", # The display name of the app. |
| 505 | "installerPackageName": "A String", # The package name of the app that installed this app. |
| 506 | "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. |
| 507 | "A String", |
| 508 | ], |
| 509 | "applicationSource": "A String", # The source of the package. |
| 510 | "state": "A String", # Application state. |
| 511 | "versionName": "A String", # The app version as displayed to the user. |
| 512 | "packageName": "A String", # Package name of the app. |
| 513 | "keyedAppStates": [ # List of keyed app states reported by the app. |
| 514 | { # Keyed app state reported by the app. |
| 515 | "severity": "A String", # The severity of the app state. |
| 516 | "lastUpdateTime": "A String", # The time the app state was most recently updated. |
| 517 | "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”). |
| 518 | "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. |
| 519 | "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. |
| 520 | "createTime": "A String", # The creation time of the app state on the device. |
| 521 | }, |
| 522 | ], |
| 523 | "versionCode": 42, # The app version code, which can be used to determine whether one version is more recent than another. |
| 524 | "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. |
| 525 | "events": [ # List of app events. The most recent 20 events are stored in the list. |
| 526 | { # An app-related event. |
| 527 | "eventType": "A String", # App event type. |
| 528 | "createTime": "A String", # The creation time of the event. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 529 | }, |
| 530 | ], |
| 531 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 532 | ], |
| 533 | "apiLevel": 42, # The API level of the Android platform version running on the device. |
| 534 | "userName": "A String", # The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}. |
| 535 | "networkInfo": { # Device network info. # Device network information. This information is only available if networkInfoEnabled is true in the device's policy. |
| 536 | "networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone. |
| 537 | "imei": "A String", # IMEI number of the GSM device. For example, A1000031212. |
| 538 | "meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1. |
| 539 | "wifiMacAddress": "A String", # Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 540 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 541 | "memoryInfo": { # Information about device memory and storage. # Memory information. This information is only available if memoryInfoEnabled is true in the device's policy. |
| 542 | "totalRam": "A String", # Total RAM on device in bytes. |
| 543 | "totalInternalStorage": "A String", # Total internal storage on device in bytes. |
| 544 | }, |
| 545 | "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. |
| 546 | { # An event related to memory and storage measurements. |
| 547 | "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. |
| 548 | "eventType": "A String", # Event type. |
| 549 | "createTime": "A String", # The creation time of the event. |
| 550 | }, |
| 551 | ], |
| 552 | "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. |
| 553 | "a_key": "A String", |
| 554 | }, |
| 555 | "appliedPolicyName": "A String", # The name of the policy currently applied to the device. |
| 556 | "appliedState": "A String", # The state currently applied to the device. |
| 557 | "hardwareStatusSamples": [ # Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy. |
| 558 | { # Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health. |
| 559 | "cpuTemperatures": [ # Current CPU temperatures in Celsius for each CPU on the device. |
| 560 | 3.14, |
| 561 | ], |
| 562 | "batteryTemperatures": [ # Current battery temperatures in Celsius for each battery on the device. |
| 563 | 3.14, |
| 564 | ], |
| 565 | "gpuTemperatures": [ # Current GPU temperatures in Celsius for each GPU on the device. |
| 566 | 3.14, |
| 567 | ], |
| 568 | "createTime": "A String", # The time the measurements were taken. |
| 569 | "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. |
| 570 | 3.14, |
| 571 | ], |
| 572 | "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. |
| 573 | 3.14, |
| 574 | ], |
| 575 | "skinTemperatures": [ # Current device skin temperatures in Celsius. |
| 576 | 3.14, |
| 577 | ], |
| 578 | }, |
| 579 | ], |
| 580 | "lastPolicySyncTime": "A String", # The last time the device fetched its policy. |
| 581 | "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. |
| 582 | "powerManagementEvents": [ # Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy. |
| 583 | { # A power management event. |
| 584 | "createTime": "A String", # The creation time of the event. |
| 585 | "batteryLevel": 3.14, # For BATTERY_LEVEL_COLLECTED events, the battery level as a percentage. |
| 586 | "eventType": "A String", # Event type. |
| 587 | }, |
| 588 | ], |
| 589 | "name": "A String", # The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. |
| 590 | "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. |
| 591 | "postureDetails": [ # Additional details regarding the security posture of the device. |
| 592 | { # Additional details regarding the security posture of the device. |
| 593 | "securityRisk": "A String", # A specific security risk that negatively affects the security posture of the device. |
| 594 | "advice": [ # Corresponding admin-facing advice to mitigate this security risk and improve the security posture of the device. |
| 595 | { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. |
| 596 | "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. |
| 597 | "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. |
| 598 | "a_key": "A String", |
| 599 | }, |
| 600 | }, |
| 601 | ], |
| 602 | }, |
| 603 | ], |
| 604 | "devicePosture": "A String", # Device's security posture value. |
| 605 | }, |
| 606 | "enrollmentTokenName": "A String", # If the device was enrolled with an enrollment token, this field contains the name of the token. |
| 607 | "lastPolicyComplianceReportTime": "A String", # Deprecated. |
| 608 | "enrollmentTokenData": "A String", # If the device was enrolled with an enrollment token with additional data provided, this field contains that data. |
| 609 | "managementMode": "A String", # The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported. |
| 610 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 611 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 612 | "nextPageToken": "A String", # If there are more results, a token to retrieve next page of results. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 613 | }</pre> |
| 614 | </div> |
| 615 | |
| 616 | <div class="method"> |
| 617 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 618 | <pre>Retrieves the next page of results. |
| 619 | |
| 620 | Args: |
| 621 | previous_request: The request for the previous page. (required) |
| 622 | previous_response: The response from the request for the previous page. (required) |
| 623 | |
| 624 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 625 | 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] | 626 | page. Returns None if there are no more items in the collection. |
| 627 | </pre> |
| 628 | </div> |
| 629 | |
| 630 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 631 | <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] | 632 | <pre>Updates a device. |
| 633 | |
| 634 | Args: |
| 635 | 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] | 636 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 637 | The object takes the form of: |
| 638 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 639 | { # A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch. |
| 640 | "nonComplianceDetails": [ # Details about policy settings that the device is not compliant with. |
| 641 | { # Provides detail about non-compliance with a policy setting. |
| 642 | "settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field. |
| 643 | "nonComplianceReason": "A String", # The reason the device is not in compliance with the setting. |
| 644 | "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. |
| 645 | "packageName": "A String", # The package name indicating which app is out of compliance, if applicable. |
| 646 | "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 |
| 647 | "currentValue": "", # If the policy setting could not be applied, the current value of the setting on the device. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 648 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 649 | ], |
| 650 | "user": { # A user belonging to an enterprise. # The user who owns the device. |
| 651 | "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. |
| 652 | }, |
| 653 | "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. |
| 654 | "A String", |
| 655 | ], |
| 656 | "lastStatusReportTime": "A String", # The last time the device sent a status report. |
| 657 | "policyCompliant": True or False, # Whether the device is compliant with its policy. |
| 658 | "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. |
| 659 | "unknownSourcesEnabled": True or False, # Whether installing apps from unknown sources is enabled. |
| 660 | "verifyAppsEnabled": True or False, # Whether Verify Apps (Google Play Protect (https://support.google.com/googleplay/answer/2812853)) is enabled on the device. |
| 661 | "developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device. |
| 662 | "adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device. |
| 663 | "isEncrypted": True or False, # Whether the storage encryption is enabled. |
| 664 | "encryptionStatus": "A String", # Encryption status from DevicePolicyManager. |
| 665 | "isDeviceSecure": True or False, # Whether the device is secured with PIN/password. |
| 666 | }, |
| 667 | "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. |
| 668 | "enrollmentTime": "A String", # The time of device enrollment. |
| 669 | "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. |
| 670 | "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. |
| 671 | "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. |
| 672 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 673 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 674 | }, |
| 675 | "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. |
| 676 | "securityPatchLevel": "A String", # Security patch level, e.g. 2016-05-01. |
| 677 | "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. |
| 678 | "primaryLanguageCode": "A String", # An IETF BCP 47 language code for the primary locale on the device. |
| 679 | "androidVersion": "A String", # The user-visible Android version string. For example, 6.0.1. |
| 680 | "androidBuildNumber": "A String", # Android build ID string meant for displaying to the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys. |
| 681 | "androidDevicePolicyVersionName": "A String", # The Android Device Policy app version as displayed to the user. |
| 682 | "androidDevicePolicyVersionCode": 42, # The Android Device Policy app version code. |
| 683 | "bootloaderVersion": "A String", # The system bootloader version number, e.g. 0.6.7. |
| 684 | "deviceKernelVersion": "A String", # Kernel version, for example, 2.6.32.9-g103d848. |
| 685 | "androidBuildTime": "A String", # Build time. |
| 686 | }, |
| 687 | "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. |
| 688 | "gpuThrottlingTemperatures": [ # GPU throttling temperature thresholds in Celsius for each GPU on the device. |
| 689 | 3.14, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 690 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 691 | "batteryThrottlingTemperatures": [ # Battery throttling temperature thresholds in Celsius for each battery on the device. |
| 692 | 3.14, |
| 693 | ], |
| 694 | "manufacturer": "A String", # Manufacturer. For example, Motorola. |
| 695 | "serialNumber": "A String", # The device serial number. |
| 696 | "brand": "A String", # Brand of the device. For example, Google. |
| 697 | "deviceBasebandVersion": "A String", # Baseband version. For example, MDM9625_104662.22.05.34p. |
| 698 | "batteryShutdownTemperatures": [ # Battery shutdown temperature thresholds in Celsius for each battery on the device. |
| 699 | 3.14, |
| 700 | ], |
| 701 | "skinShutdownTemperatures": [ # Device skin shutdown temperature thresholds in Celsius. |
| 702 | 3.14, |
| 703 | ], |
| 704 | "model": "A String", # The model of the device. For example, Asus Nexus 7. |
| 705 | "cpuShutdownTemperatures": [ # CPU shutdown temperature thresholds in Celsius for each CPU on the device. |
| 706 | 3.14, |
| 707 | ], |
| 708 | "skinThrottlingTemperatures": [ # Device skin throttling temperature thresholds in Celsius. |
| 709 | 3.14, |
| 710 | ], |
| 711 | "hardware": "A String", # Name of the hardware. For example, Angler. |
| 712 | "cpuThrottlingTemperatures": [ # CPU throttling temperature thresholds in Celsius for each CPU on the device. |
| 713 | 3.14, |
| 714 | ], |
| 715 | "gpuShutdownTemperatures": [ # GPU shutdown temperature thresholds in Celsius for each GPU on the device. |
| 716 | 3.14, |
| 717 | ], |
| 718 | }, |
| 719 | "appliedPolicyVersion": "A String", # The version of the policy currently applied to the device. |
| 720 | "displays": [ # Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy. |
| 721 | { # Device display information. |
| 722 | "density": 42, # Display density expressed as dots-per-inch. |
| 723 | "height": 42, # Display height in pixels. |
| 724 | "width": 42, # Display width in pixels. |
| 725 | "refreshRate": 42, # Refresh rate of the display in frames per second. |
| 726 | "state": "A String", # State of the display. |
| 727 | "displayId": 42, # Unique display id. |
| 728 | "name": "A String", # Name of the display. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 729 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 730 | ], |
| 731 | "applicationReports": [ # Reports for apps installed on the device. This information is only available when application_reports_enabled is true in the device's policy. |
| 732 | { # Information reported about an installed app. |
| 733 | "displayName": "A String", # The display name of the app. |
| 734 | "installerPackageName": "A String", # The package name of the app that installed this app. |
| 735 | "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. |
| 736 | "A String", |
| 737 | ], |
| 738 | "applicationSource": "A String", # The source of the package. |
| 739 | "state": "A String", # Application state. |
| 740 | "versionName": "A String", # The app version as displayed to the user. |
| 741 | "packageName": "A String", # Package name of the app. |
| 742 | "keyedAppStates": [ # List of keyed app states reported by the app. |
| 743 | { # Keyed app state reported by the app. |
| 744 | "severity": "A String", # The severity of the app state. |
| 745 | "lastUpdateTime": "A String", # The time the app state was most recently updated. |
| 746 | "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”). |
| 747 | "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. |
| 748 | "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. |
| 749 | "createTime": "A String", # The creation time of the app state on the device. |
| 750 | }, |
| 751 | ], |
| 752 | "versionCode": 42, # The app version code, which can be used to determine whether one version is more recent than another. |
| 753 | "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. |
| 754 | "events": [ # List of app events. The most recent 20 events are stored in the list. |
| 755 | { # An app-related event. |
| 756 | "eventType": "A String", # App event type. |
| 757 | "createTime": "A String", # The creation time of the event. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 758 | }, |
| 759 | ], |
| 760 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 761 | ], |
| 762 | "apiLevel": 42, # The API level of the Android platform version running on the device. |
| 763 | "userName": "A String", # The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}. |
| 764 | "networkInfo": { # Device network info. # Device network information. This information is only available if networkInfoEnabled is true in the device's policy. |
| 765 | "networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone. |
| 766 | "imei": "A String", # IMEI number of the GSM device. For example, A1000031212. |
| 767 | "meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1. |
| 768 | "wifiMacAddress": "A String", # Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11. |
| 769 | }, |
| 770 | "memoryInfo": { # Information about device memory and storage. # Memory information. This information is only available if memoryInfoEnabled is true in the device's policy. |
| 771 | "totalRam": "A String", # Total RAM on device in bytes. |
| 772 | "totalInternalStorage": "A String", # Total internal storage on device in bytes. |
| 773 | }, |
| 774 | "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. |
| 775 | { # An event related to memory and storage measurements. |
| 776 | "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. |
| 777 | "eventType": "A String", # Event type. |
| 778 | "createTime": "A String", # The creation time of the event. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 779 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 780 | ], |
| 781 | "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. |
| 782 | "a_key": "A String", |
| 783 | }, |
| 784 | "appliedPolicyName": "A String", # The name of the policy currently applied to the device. |
| 785 | "appliedState": "A String", # The state currently applied to the device. |
| 786 | "hardwareStatusSamples": [ # Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy. |
| 787 | { # Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health. |
| 788 | "cpuTemperatures": [ # Current CPU temperatures in Celsius for each CPU on the device. |
| 789 | 3.14, |
| 790 | ], |
| 791 | "batteryTemperatures": [ # Current battery temperatures in Celsius for each battery on the device. |
| 792 | 3.14, |
| 793 | ], |
| 794 | "gpuTemperatures": [ # Current GPU temperatures in Celsius for each GPU on the device. |
| 795 | 3.14, |
| 796 | ], |
| 797 | "createTime": "A String", # The time the measurements were taken. |
| 798 | "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. |
| 799 | 3.14, |
| 800 | ], |
| 801 | "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. |
| 802 | 3.14, |
| 803 | ], |
| 804 | "skinTemperatures": [ # Current device skin temperatures in Celsius. |
| 805 | 3.14, |
| 806 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 807 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 808 | ], |
| 809 | "lastPolicySyncTime": "A String", # The last time the device fetched its policy. |
| 810 | "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. |
| 811 | "powerManagementEvents": [ # Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy. |
| 812 | { # A power management event. |
| 813 | "createTime": "A String", # The creation time of the event. |
| 814 | "batteryLevel": 3.14, # For BATTERY_LEVEL_COLLECTED events, the battery level as a percentage. |
| 815 | "eventType": "A String", # Event type. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 816 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 817 | ], |
| 818 | "name": "A String", # The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. |
| 819 | "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. |
| 820 | "postureDetails": [ # Additional details regarding the security posture of the device. |
| 821 | { # Additional details regarding the security posture of the device. |
| 822 | "securityRisk": "A String", # A specific security risk that negatively affects the security posture of the device. |
| 823 | "advice": [ # Corresponding admin-facing advice to mitigate this security risk and improve the security posture of the device. |
| 824 | { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. |
| 825 | "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. |
| 826 | "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. |
| 827 | "a_key": "A String", |
| 828 | }, |
| 829 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 830 | ], |
| 831 | }, |
| 832 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 833 | "devicePosture": "A String", # Device's security posture value. |
| 834 | }, |
| 835 | "enrollmentTokenName": "A String", # If the device was enrolled with an enrollment token, this field contains the name of the token. |
| 836 | "lastPolicyComplianceReportTime": "A String", # Deprecated. |
| 837 | "enrollmentTokenData": "A String", # If the device was enrolled with an enrollment token with additional data provided, this field contains that data. |
| 838 | "managementMode": "A String", # The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported. |
| 839 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 840 | |
| 841 | updateMask: string, The field mask indicating the fields to update. If not set, all modifiable fields will be modified. |
| 842 | x__xgafv: string, V1 error format. |
| 843 | Allowed values |
| 844 | 1 - v1 error format |
| 845 | 2 - v2 error format |
| 846 | |
| 847 | Returns: |
| 848 | An object of the form: |
| 849 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 850 | { # A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch. |
| 851 | "nonComplianceDetails": [ # Details about policy settings that the device is not compliant with. |
| 852 | { # Provides detail about non-compliance with a policy setting. |
| 853 | "settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field. |
| 854 | "nonComplianceReason": "A String", # The reason the device is not in compliance with the setting. |
| 855 | "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. |
| 856 | "packageName": "A String", # The package name indicating which app is out of compliance, if applicable. |
| 857 | "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 |
| 858 | "currentValue": "", # If the policy setting could not be applied, the current value of the setting on the device. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 859 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 860 | ], |
| 861 | "user": { # A user belonging to an enterprise. # The user who owns the device. |
| 862 | "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. |
| 863 | }, |
| 864 | "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. |
| 865 | "A String", |
| 866 | ], |
| 867 | "lastStatusReportTime": "A String", # The last time the device sent a status report. |
| 868 | "policyCompliant": True or False, # Whether the device is compliant with its policy. |
| 869 | "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. |
| 870 | "unknownSourcesEnabled": True or False, # Whether installing apps from unknown sources is enabled. |
| 871 | "verifyAppsEnabled": True or False, # Whether Verify Apps (Google Play Protect (https://support.google.com/googleplay/answer/2812853)) is enabled on the device. |
| 872 | "developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device. |
| 873 | "adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device. |
| 874 | "isEncrypted": True or False, # Whether the storage encryption is enabled. |
| 875 | "encryptionStatus": "A String", # Encryption status from DevicePolicyManager. |
| 876 | "isDeviceSecure": True or False, # Whether the device is secured with PIN/password. |
| 877 | }, |
| 878 | "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. |
| 879 | "enrollmentTime": "A String", # The time of device enrollment. |
| 880 | "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. |
| 881 | "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. |
| 882 | "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. |
| 883 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 884 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 885 | }, |
| 886 | "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. |
| 887 | "securityPatchLevel": "A String", # Security patch level, e.g. 2016-05-01. |
| 888 | "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. |
| 889 | "primaryLanguageCode": "A String", # An IETF BCP 47 language code for the primary locale on the device. |
| 890 | "androidVersion": "A String", # The user-visible Android version string. For example, 6.0.1. |
| 891 | "androidBuildNumber": "A String", # Android build ID string meant for displaying to the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys. |
| 892 | "androidDevicePolicyVersionName": "A String", # The Android Device Policy app version as displayed to the user. |
| 893 | "androidDevicePolicyVersionCode": 42, # The Android Device Policy app version code. |
| 894 | "bootloaderVersion": "A String", # The system bootloader version number, e.g. 0.6.7. |
| 895 | "deviceKernelVersion": "A String", # Kernel version, for example, 2.6.32.9-g103d848. |
| 896 | "androidBuildTime": "A String", # Build time. |
| 897 | }, |
| 898 | "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. |
| 899 | "gpuThrottlingTemperatures": [ # GPU throttling temperature thresholds in Celsius for each GPU on the device. |
| 900 | 3.14, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 901 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 902 | "batteryThrottlingTemperatures": [ # Battery throttling temperature thresholds in Celsius for each battery on the device. |
| 903 | 3.14, |
| 904 | ], |
| 905 | "manufacturer": "A String", # Manufacturer. For example, Motorola. |
| 906 | "serialNumber": "A String", # The device serial number. |
| 907 | "brand": "A String", # Brand of the device. For example, Google. |
| 908 | "deviceBasebandVersion": "A String", # Baseband version. For example, MDM9625_104662.22.05.34p. |
| 909 | "batteryShutdownTemperatures": [ # Battery shutdown temperature thresholds in Celsius for each battery on the device. |
| 910 | 3.14, |
| 911 | ], |
| 912 | "skinShutdownTemperatures": [ # Device skin shutdown temperature thresholds in Celsius. |
| 913 | 3.14, |
| 914 | ], |
| 915 | "model": "A String", # The model of the device. For example, Asus Nexus 7. |
| 916 | "cpuShutdownTemperatures": [ # CPU shutdown temperature thresholds in Celsius for each CPU on the device. |
| 917 | 3.14, |
| 918 | ], |
| 919 | "skinThrottlingTemperatures": [ # Device skin throttling temperature thresholds in Celsius. |
| 920 | 3.14, |
| 921 | ], |
| 922 | "hardware": "A String", # Name of the hardware. For example, Angler. |
| 923 | "cpuThrottlingTemperatures": [ # CPU throttling temperature thresholds in Celsius for each CPU on the device. |
| 924 | 3.14, |
| 925 | ], |
| 926 | "gpuShutdownTemperatures": [ # GPU shutdown temperature thresholds in Celsius for each GPU on the device. |
| 927 | 3.14, |
| 928 | ], |
| 929 | }, |
| 930 | "appliedPolicyVersion": "A String", # The version of the policy currently applied to the device. |
| 931 | "displays": [ # Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy. |
| 932 | { # Device display information. |
| 933 | "density": 42, # Display density expressed as dots-per-inch. |
| 934 | "height": 42, # Display height in pixels. |
| 935 | "width": 42, # Display width in pixels. |
| 936 | "refreshRate": 42, # Refresh rate of the display in frames per second. |
| 937 | "state": "A String", # State of the display. |
| 938 | "displayId": 42, # Unique display id. |
| 939 | "name": "A String", # Name of the display. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 940 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 941 | ], |
| 942 | "applicationReports": [ # Reports for apps installed on the device. This information is only available when application_reports_enabled is true in the device's policy. |
| 943 | { # Information reported about an installed app. |
| 944 | "displayName": "A String", # The display name of the app. |
| 945 | "installerPackageName": "A String", # The package name of the app that installed this app. |
| 946 | "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. |
| 947 | "A String", |
| 948 | ], |
| 949 | "applicationSource": "A String", # The source of the package. |
| 950 | "state": "A String", # Application state. |
| 951 | "versionName": "A String", # The app version as displayed to the user. |
| 952 | "packageName": "A String", # Package name of the app. |
| 953 | "keyedAppStates": [ # List of keyed app states reported by the app. |
| 954 | { # Keyed app state reported by the app. |
| 955 | "severity": "A String", # The severity of the app state. |
| 956 | "lastUpdateTime": "A String", # The time the app state was most recently updated. |
| 957 | "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”). |
| 958 | "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. |
| 959 | "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. |
| 960 | "createTime": "A String", # The creation time of the app state on the device. |
| 961 | }, |
| 962 | ], |
| 963 | "versionCode": 42, # The app version code, which can be used to determine whether one version is more recent than another. |
| 964 | "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. |
| 965 | "events": [ # List of app events. The most recent 20 events are stored in the list. |
| 966 | { # An app-related event. |
| 967 | "eventType": "A String", # App event type. |
| 968 | "createTime": "A String", # The creation time of the event. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 969 | }, |
| 970 | ], |
| 971 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 972 | ], |
| 973 | "apiLevel": 42, # The API level of the Android platform version running on the device. |
| 974 | "userName": "A String", # The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}. |
| 975 | "networkInfo": { # Device network info. # Device network information. This information is only available if networkInfoEnabled is true in the device's policy. |
| 976 | "networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone. |
| 977 | "imei": "A String", # IMEI number of the GSM device. For example, A1000031212. |
| 978 | "meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1. |
| 979 | "wifiMacAddress": "A String", # Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11. |
| 980 | }, |
| 981 | "memoryInfo": { # Information about device memory and storage. # Memory information. This information is only available if memoryInfoEnabled is true in the device's policy. |
| 982 | "totalRam": "A String", # Total RAM on device in bytes. |
| 983 | "totalInternalStorage": "A String", # Total internal storage on device in bytes. |
| 984 | }, |
| 985 | "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. |
| 986 | { # An event related to memory and storage measurements. |
| 987 | "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. |
| 988 | "eventType": "A String", # Event type. |
| 989 | "createTime": "A String", # The creation time of the event. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 990 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 991 | ], |
| 992 | "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. |
| 993 | "a_key": "A String", |
| 994 | }, |
| 995 | "appliedPolicyName": "A String", # The name of the policy currently applied to the device. |
| 996 | "appliedState": "A String", # The state currently applied to the device. |
| 997 | "hardwareStatusSamples": [ # Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy. |
| 998 | { # Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health. |
| 999 | "cpuTemperatures": [ # Current CPU temperatures in Celsius for each CPU on the device. |
| 1000 | 3.14, |
| 1001 | ], |
| 1002 | "batteryTemperatures": [ # Current battery temperatures in Celsius for each battery on the device. |
| 1003 | 3.14, |
| 1004 | ], |
| 1005 | "gpuTemperatures": [ # Current GPU temperatures in Celsius for each GPU on the device. |
| 1006 | 3.14, |
| 1007 | ], |
| 1008 | "createTime": "A String", # The time the measurements were taken. |
| 1009 | "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. |
| 1010 | 3.14, |
| 1011 | ], |
| 1012 | "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. |
| 1013 | 3.14, |
| 1014 | ], |
| 1015 | "skinTemperatures": [ # Current device skin temperatures in Celsius. |
| 1016 | 3.14, |
| 1017 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1018 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1019 | ], |
| 1020 | "lastPolicySyncTime": "A String", # The last time the device fetched its policy. |
| 1021 | "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. |
| 1022 | "powerManagementEvents": [ # Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy. |
| 1023 | { # A power management event. |
| 1024 | "createTime": "A String", # The creation time of the event. |
| 1025 | "batteryLevel": 3.14, # For BATTERY_LEVEL_COLLECTED events, the battery level as a percentage. |
| 1026 | "eventType": "A String", # Event type. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1027 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1028 | ], |
| 1029 | "name": "A String", # The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. |
| 1030 | "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. |
| 1031 | "postureDetails": [ # Additional details regarding the security posture of the device. |
| 1032 | { # Additional details regarding the security posture of the device. |
| 1033 | "securityRisk": "A String", # A specific security risk that negatively affects the security posture of the device. |
| 1034 | "advice": [ # Corresponding admin-facing advice to mitigate this security risk and improve the security posture of the device. |
| 1035 | { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. |
| 1036 | "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. |
| 1037 | "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. |
| 1038 | "a_key": "A String", |
| 1039 | }, |
| 1040 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1041 | ], |
| 1042 | }, |
| 1043 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1044 | "devicePosture": "A String", # Device's security posture value. |
| 1045 | }, |
| 1046 | "enrollmentTokenName": "A String", # If the device was enrolled with an enrollment token, this field contains the name of the token. |
| 1047 | "lastPolicyComplianceReportTime": "A String", # Deprecated. |
| 1048 | "enrollmentTokenData": "A String", # If the device was enrolled with an enrollment token with additional data provided, this field contains that data. |
| 1049 | "managementMode": "A String", # The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported. |
| 1050 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1051 | </div> |
| 1052 | |
| 1053 | </body></html> |