1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="androidmanagement_v1.enterprises.devices.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, wipeDataFlags=None, wipeReasonMessage=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a device. This operation attempts to wipe the device but this is not guaranteed to succeed if the device is offline for an extended period. Deleted devices do not show up in enterprises.devices.list calls and a 404 is returned from enterprises.devices.get.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a device. Deleted devices will respond with a 404 error.</p>
<p class="toc_element">
<code><a href="#issueCommand">issueCommand(name, body=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists devices for a given enterprise. Deleted devices are not returned in the response.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a device.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, wipeDataFlags=None, wipeReasonMessage=None, x__xgafv=None)</code>
<pre>Deletes a device. This operation attempts to wipe the device but this is not guaranteed to succeed if the device is offline for an extended period. Deleted devices do not show up in enterprises.devices.list calls and a 404 is returned from enterprises.devices.get.
Args:
name: string, The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. (required)
wipeDataFlags: string, Optional flags that control the device wiping behavior. (repeated)
Allowed values
WIPE_DATA_FLAG_UNSPECIFIED - This value is ignored.
PRESERVE_RESET_PROTECTION_DATA - Preserve the factory reset protection data on the device.
WIPE_EXTERNAL_STORAGE - Additionally wipe the device's external storage (such as SD cards).
WIPE_ESIMS - For company-owned devices, this removes all eSIMs from the device when the device is wiped. In personally-owned devices, this will remove managed eSIMs (eSIMs which are added via the ADD_ESIM command) on the devices and no personally owned eSIMs will be removed.
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a device. Deleted devices will respond with a 404 error.
Args:
name: string, The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch.
"apiLevel": 42, # The API level of the Android platform version running on the device.
"applicationReports": [ # Reports for apps installed on the device. This information is only available when application_reports_enabled is true in the device's policy.
{ # Information reported about an installed app.
"applicationSource": "A String", # The source of the package.
"displayName": "A String", # The display name of the app.
"events": [ # The list of app events which have occurred in the last 30 hours.
{ # An app-related event.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # App event type.
},
],
"installerPackageName": "A String", # The package name of the app that installed this app.
"keyedAppStates": [ # List of keyed app states reported by the app.
{ # Keyed app state reported by the app.
"createTime": "A String", # The creation time of the app state on the device.
"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”).
"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.
"lastUpdateTime": "A String", # The time the app state was most recently updated.
"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.
"severity": "A String", # The severity of the app state.
},
],
"packageName": "A String", # Package name of the app.
"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.
"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.
"A String",
],
"state": "A String", # Application state.
"userFacingType": "A String", # Whether the app is user facing.
"versionCode": 42, # The app version code, which can be used to determine whether one version is more recent than another.
"versionName": "A String", # The app version as displayed to the user.
},
],
"appliedPasswordPolicies": [ # The password requirements currently applied to the device. This field exists because the applied requirements may be slightly different from those specified in passwordPolicies in some cases. Note that this field does not provide information about password compliance. For non-compliance information, see nonComplianceDetails. NonComplianceDetail.fieldPath, is set based on passwordPolicies, not based on this field.
{ # Requirements for the password used to unlock a device.
"maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction.
"passwordExpirationTimeout": "A String", # Password expiration timeout.
"passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction.
"passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX.
"passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordQuality": "A String", # The required password quality.
"passwordScope": "A String", # The scope that the password requirement applies to.
"requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile.
"unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION.
},
],
"appliedPolicyName": "A String", # The name of the policy currently applied to the device.
"appliedPolicyVersion": "A String", # The version of the policy currently applied to the device.
"appliedState": "A String", # The state currently applied to the device.
"commonCriteriaModeInfo": { # Information about Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC).This information is only available if statusReportingSettings.commonCriteriaModeEnabled is true in the device's policy. # Information about Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC).This information is only available if statusReportingSettings.commonCriteriaModeEnabled is true in the device's policy the device is company-owned.
"commonCriteriaModeStatus": "A String", # Whether Common Criteria Mode is enabled.
"policySignatureVerificationStatus": "A String", # Output only. The status of policy signature verification.
},
"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.
"adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device.
"developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device.
"encryptionStatus": "A String", # Encryption status from DevicePolicyManager.
"isDeviceSecure": True or False, # Whether the device is secured with PIN/password.
"isEncrypted": True or False, # Whether the storage encryption is enabled.
"unknownSourcesEnabled": True or False, # Whether installing apps from unknown sources is enabled.
"verifyAppsEnabled": True or False, # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced on the device.
},
"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.
"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.
"localizedMessages": { # A map containing 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.
"a_key": "A String",
},
},
"displays": [ # Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy.
{ # Device display information.
"density": 42, # Display density expressed as dots-per-inch.
"displayId": 42, # Unique display id.
"height": 42, # Display height in pixels.
"name": "A String", # Name of the display.
"refreshRate": 42, # Refresh rate of the display in frames per second.
"state": "A String", # State of the display.
"width": 42, # Display width in pixels.
},
],
"dpcMigrationInfo": { # Information related to whether this device was migrated from being managed by another Device Policy Controller (DPC). # Output only. Information related to whether this device was migrated from being managed by another Device Policy Controller (DPC).
"additionalData": "A String", # Output only. If this device was migrated from another DPC, the additionalData field of the migration token is populated here.
"previousDpc": "A String", # Output only. If this device was migrated from another DPC, this is its package name. Not populated otherwise.
},
"enrollmentTime": "A String", # The time of device enrollment.
"enrollmentTokenData": "A String", # If the device was enrolled with an enrollment token with additional data provided, this field contains that data.
"enrollmentTokenName": "A String", # If the device was enrolled with an enrollment token, this field contains the name of the token.
"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.
"batteryShutdownTemperatures": [ # Battery shutdown temperature thresholds in Celsius for each battery on the device.
3.14,
],
"batteryThrottlingTemperatures": [ # Battery throttling temperature thresholds in Celsius for each battery on the device.
3.14,
],
"brand": "A String", # Brand of the device. For example, Google.
"cpuShutdownTemperatures": [ # CPU shutdown temperature thresholds in Celsius for each CPU on the device.
3.14,
],
"cpuThrottlingTemperatures": [ # CPU throttling temperature thresholds in Celsius for each CPU on the device.
3.14,
],
"deviceBasebandVersion": "A String", # Baseband version. For example, MDM9625_104662.22.05.34p.
"enterpriseSpecificId": "A String", # Output only. ID that uniquely identifies a personally-owned device in a particular organization. On the same physical device when enrolled with the same organization, this ID persists across setups and even factory resets. This ID is available on personally-owned devices with a work profile on devices running Android 12 and above.
"euiccChipInfo": [ # Output only. Information related to the eUICC chip.
{ # Information related to the eUICC chip.
"eid": "A String", # Output only. The Embedded Identity Document (EID) that identifies the eUICC chip for each eUICC chip on the device. This is available on company owned devices running Android 13 and above.
},
],
"gpuShutdownTemperatures": [ # GPU shutdown temperature thresholds in Celsius for each GPU on the device.
3.14,
],
"gpuThrottlingTemperatures": [ # GPU throttling temperature thresholds in Celsius for each GPU on the device.
3.14,
],
"hardware": "A String", # Name of the hardware. For example, Angler.
"manufacturer": "A String", # Manufacturer. For example, Motorola.
"model": "A String", # The model of the device. For example, Asus Nexus 7.
"serialNumber": "A String", # The device serial number. However, for personally-owned devices running Android 12 and above, this is the same as the enterpriseSpecificId.
"skinShutdownTemperatures": [ # Device skin shutdown temperature thresholds in Celsius.
3.14,
],
"skinThrottlingTemperatures": [ # Device skin throttling temperature thresholds in Celsius.
3.14,
],
},
"hardwareStatusSamples": [ # Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy.
{ # Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health.
"batteryTemperatures": [ # Current battery temperatures in Celsius for each battery on the device.
3.14,
],
"cpuTemperatures": [ # Current CPU temperatures in Celsius for each CPU on the device.
3.14,
],
"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.
3.14,
],
"createTime": "A String", # The time the measurements were taken.
"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.
3.14,
],
"gpuTemperatures": [ # Current GPU temperatures in Celsius for each GPU on the device.
3.14,
],
"skinTemperatures": [ # Current device skin temperatures in Celsius.
3.14,
],
},
],
"lastPolicyComplianceReportTime": "A String", # Deprecated.
"lastPolicySyncTime": "A String", # The last time the device fetched its policy.
"lastStatusReportTime": "A String", # The last time the device sent a status report.
"managementMode": "A String", # The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported.
"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.Events are retained for a certain period of time and old events are deleted.
{ # An event related to memory and storage measurements.To distinguish between new and old events, we recommend using the createTime field.
"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.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # Event type.
},
],
"memoryInfo": { # Information about device memory and storage. # Memory information: contains information about device memory and storage.
"totalInternalStorage": "A String", # Total internal storage on device in bytes.
"totalRam": "A String", # Total RAM on device in bytes.
},
"name": "A String", # The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
"networkInfo": { # Device network info. # Device network information. This information is only available if networkInfoEnabled is true in the device's policy.
"imei": "A String", # IMEI number of the GSM device. For example, A1000031212.
"meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1.
"networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone.
"telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
{ # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
"activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below API level 35.
"carrierName": "A String", # The carrier name associated with this SIM card.
"configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below API level 35.
"iccId": "A String", # Output only. The ICCID associated with this SIM card.
"phoneNumber": "A String", # The phone number associated with this SIM card.
},
],
"wifiMacAddress": "A String", # Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11.
},
"nonComplianceDetails": [ # Details about policy settings that the device is not compliant with.
{ # Provides detail about non-compliance with a policy setting.
"currentValue": "", # If the policy setting could not be applied, the current value of the setting on the device.
"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
"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.
"nonComplianceReason": "A String", # The reason the device is not in compliance with the setting.
"packageName": "A String", # The package name indicating which app is out of compliance, if applicable.
"settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field.
"specificNonComplianceContext": { # Additional context for SpecificNonComplianceReason. # Additional context for specific_non_compliance_reason.
"oncWifiContext": { # Additional context for non-compliance related to Wi-Fi configuration. # Additional context for non-compliance related to Wi-Fi configuration. See ONC_WIFI_INVALID_VALUE and ONC_WIFI_API_LEVEL
"wifiGuid": "A String", # The GUID of non-compliant Wi-Fi configuration.
},
"passwordPoliciesContext": { # Additional context for non-compliance related to password policies. # Additional context for non-compliance related to password policies. See PASSWORD_POLICIES_PASSWORD_EXPIRED and PASSWORD_POLICIES_PASSWORD_NOT_SUFFICIENT.
"passwordPolicyScope": "A String", # The scope of non-compliant password.
},
},
"specificNonComplianceReason": "A String", # The policy-specific reason the device is not in compliance with the setting.
},
],
"ownership": "A String", # Ownership of the managed device.
"policyCompliant": True or False, # Whether the device is compliant with its policy.
"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.
"powerManagementEvents": [ # Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy.
{ # A power management event.
"batteryLevel": 3.14, # For BATTERY_LEVEL_COLLECTED events, the battery level as a percentage.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # Event type.
},
],
"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.
"A String",
],
"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.
"devicePosture": "A String", # Device's security posture value.
"postureDetails": [ # Additional details regarding the security posture of the device.
{ # Additional details regarding the security posture of the device.
"advice": [ # Corresponding admin-facing advice to mitigate this security risk and improve the security posture of the device.
{ # Provides a user-facing message with locale info. The maximum message length is 4096 characters.
"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.
"localizedMessages": { # A map containing 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.
"a_key": "A String",
},
},
],
"securityRisk": "A String", # A specific security risk that negatively affects the security posture of the device.
},
],
},
"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.
"androidBuildNumber": "A String", # Android build ID string meant for displaying to the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys.
"androidBuildTime": "A String", # Build time.
"androidDevicePolicyVersionCode": 42, # The Android Device Policy app version code.
"androidDevicePolicyVersionName": "A String", # The Android Device Policy app version as displayed to the user.
"androidVersion": "A String", # The user-visible Android version string. For example, 6.0.1.
"bootloaderVersion": "A String", # The system bootloader version number, e.g. 0.6.7.
"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.
"deviceKernelVersion": "A String", # Kernel version, for example, 2.6.32.9-g103d848.
"primaryLanguageCode": "A String", # An IETF BCP 47 language code for the primary locale on the device.
"securityPatchLevel": "A String", # Security patch level, e.g. 2016-05-01.
"systemUpdateInfo": { # Information about a potential pending system update. # Information about a potential pending system update.
"updateReceivedTime": "A String", # The time when the update was first available. A zero value indicates that this field is not set. This field is set only if an update is available (that is, updateStatus is neither UPDATE_STATUS_UNKNOWN nor UP_TO_DATE).
"updateStatus": "A String", # The status of an update: whether an update exists and what type it is.
},
},
"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.
"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.
"a_key": "A String",
},
"user": { # A user belonging to an enterprise. # The user who owns the device.
"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.
},
"userName": "A String", # The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}.
}</pre>
</div>
<div class="method">
<code class="details" id="issueCommand">issueCommand(name, body=None, x__xgafv=None)</code>
<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.
Args:
name: string, The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. (required)
body: object, The request body.
The object takes the form of:
{ # A command.
"addEsimParams": { # Parameters associated with the ADD_ESIM command to add an eSIM profile to the device. # Optional. Parameters for the ADD_ESIM command to add an eSIM profile to the device. If this is set, then it is suggested that type should not be set. In this case, the server automatically sets it to ADD_ESIM. It is also acceptable to explicitly set type to ADD_ESIM.
"activationCode": "A String", # Required. The activation code for the eSIM profile.
"activationState": "A String", # Required. The activation state of the eSIM profile once it is downloaded.
},
"clearAppsDataParams": { # Parameters associated with the CLEAR_APP_DATA command to clear the data of specified apps from the device. # Parameters for the CLEAR_APP_DATA command to clear the data of specified apps from the device. See ClearAppsDataParams. If this is set, then it is suggested that type should not be set. In this case, the server automatically sets it to CLEAR_APP_DATA. It is also acceptable to explicitly set type to CLEAR_APP_DATA.
"packageNames": [ # The package names of the apps whose data will be cleared when the command is executed.
"A String",
],
},
"clearAppsDataStatus": { # Status of the CLEAR_APP_DATA command to clear the data of specified apps from the device. # Output only. Status of the CLEAR_APP_DATA command to clear the data of specified apps from the device. See ClearAppsDataStatus.
"results": { # The per-app results, a mapping from package names to the respective clearing result.
"a_key": { # The result of an attempt to clear the data of a single app.
"clearingResult": "A String", # The result of an attempt to clear the data of a single app.
},
},
},
"createTime": "A String", # The timestamp at which the command was created. The timestamp is automatically generated by the server.
"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.
"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. For reasoning about command errors, prefer fields in the following order (most preferred first): 1. Command-specific fields like clearAppsDataStatus, startLostModeStatus, or similar, if they exist. 2. This field, if set. 3. The generic error field in the Operation that wraps the command.
"esimStatus": { # Status and error details (if present) of an ADD_ESIM or REMOVE_ESIM command. # Output only. Status of an ADD_ESIM or REMOVE_ESIM command.
"esimInfo": { # Details of the eSIM added or removed. # Output only. Information about the eSIM added or removed. This is populated only when the eSIM operation status is SUCCESS.
"iccId": "A String", # Output only. ICC ID of the eSIM.
},
"internalErrorDetails": { # Internal error details if present for the ADD_ESIM or REMOVE_ESIM command. # Output only. Details of the error if the status is set to INTERNAL_ERROR.
"errorCode": "A String", # Output only. Integer representation of the error code as specified here (https://developer.android.com/reference/android/telephony/euicc/EuiccManager#EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE). See also, OPERATION_SMDX_SUBJECT_REASON_CODE. See error_code_detail for more details.
"errorCodeDetail": "A String", # Output only. The error code detail corresponding to the error_code.
"operationCode": "A String", # Output only. Integer representation of the operation code as specified here (https://developer.android.com/reference/android/telephony/euicc/EuiccManager#EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE). See operation_code_detail for more details.
"operationCodeDetail": "A String", # Output only. The operation code detail corresponding to the operation_code.
},
"status": "A String", # Output only. Status of an ADD_ESIM or REMOVE_ESIM command.
},
"newPassword": "A String", # For commands of type RESET_PASSWORD, optionally specifies the new password. Note: The new password must be at least 6 characters long if it is numeric in case of Android 14 devices. Else the command will fail with INVALID_VALUE.
"removeEsimParams": { # Parameters associated with the REMOVE_ESIM command to remove an eSIM profile from the device. # Optional. Parameters for the REMOVE_ESIM command to remove an eSIM profile from the device. If this is set, then it is suggested that type should not be set. In this case, the server automatically sets it to REMOVE_ESIM. It is also acceptable to explicitly set type to REMOVE_ESIM.
"iccId": "A String", # Required. ICC ID of the eSIM profile to be deleted.
},
"requestDeviceInfoParams": { # Parameters associated with the REQUEST_DEVICE_INFO command to get device related information. # Optional. Parameters for the REQUEST_DEVICE_INFO command to get device related information. If this is set, then it is suggested that type should not be set. In this case, the server automatically sets it to REQUEST_DEVICE_INFO . It is also acceptable to explicitly set type to REQUEST_DEVICE_INFO.
"deviceInfo": "A String", # Required. Type of device information to be requested.
},
"requestDeviceInfoStatus": { # Status of the REQUEST_DEVICE_INFO command. # Output only. Status of the REQUEST_DEVICE_INFO command.
"eidInfo": { # Information related to the EIDs of the device. # Information related to the EIDs of the device.
"eids": [ # Output only. EID information for each eUICC chip.
{ # EID information for each eUICC chip.
"eid": "A String", # Output only. The EID
},
],
},
"status": "A String", # Output only. Status of a REQUEST_DEVICE_INFO command.
},
"resetPasswordFlags": [ # For commands of type RESET_PASSWORD, optionally specifies flags.
"A String",
],
"startLostModeParams": { # Parameters associated with the START_LOST_MODE command to put the device into lost mode. At least one of the parameters, not including the organization name, must be provided in order for the device to be put into lost mode. # Parameters for the START_LOST_MODE command to put the device into lost mode. See StartLostModeParams. If this is set, then it is suggested that type should not be set. In this case, the server automatically sets it to START_LOST_MODE. It is also acceptable to explicitly set type to START_LOST_MODE.
"lostEmailAddress": "A String", # The email address displayed to the user when the device is in lost mode.
"lostMessage": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # The message displayed to the user when the device is in lost mode.
"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.
"localizedMessages": { # A map containing 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.
"a_key": "A String",
},
},
"lostOrganization": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # The organization name displayed to the user when the device is in lost mode.
"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.
"localizedMessages": { # A map containing 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.
"a_key": "A String",
},
},
"lostPhoneNumber": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # The phone number that will be called when the device is in lost mode and the call owner button is tapped.
"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.
"localizedMessages": { # A map containing 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.
"a_key": "A String",
},
},
"lostStreetAddress": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # The street address displayed to the user when the device is in lost mode.
"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.
"localizedMessages": { # A map containing 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.
"a_key": "A String",
},
},
},
"startLostModeStatus": { # Status of the START_LOST_MODE command to put the device into lost mode. # Output only. Status of the START_LOST_MODE command to put the device into lost mode. See StartLostModeStatus.
"status": "A String", # The status. See StartLostModeStatus.
},
"stopLostModeParams": { # Parameters associated with the STOP_LOST_MODE command to take the device out of lost mode. # Parameters for the STOP_LOST_MODE command to take the device out of lost mode. See StopLostModeParams. If this is set, then it is suggested that type should not be set. In this case, the server automatically sets it to STOP_LOST_MODE. It is also acceptable to explicitly set type to STOP_LOST_MODE.
},
"stopLostModeStatus": { # Status of the STOP_LOST_MODE command to take the device out of lost mode. # Output only. Status of the STOP_LOST_MODE command to take the device out of lost mode. See StopLostModeStatus.
"status": "A String", # The status. See StopLostModeStatus.
},
"type": "A String", # The type of the command.
"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.
"wipeParams": { # Parameters associated with the WIPE command to wipe the device. # Optional. Parameters for the WIPE command to wipe the device. If this is set, then it is suggested that type should not be set. In this case, the server automatically sets it to WIPE. It is also acceptable to explicitly set type to WIPE.
"wipeDataFlags": [ # Optional. Flags to determine what data to wipe.
"A String",
],
"wipeReason": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # 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.
"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.
"localizedMessages": { # A map containing 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.
"a_key": "A String",
},
},
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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}.
"response": { # The normal, successful response of the operation. 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists devices for a given enterprise. Deleted devices are not returned in the response.
Args:
parent: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required)
pageSize: integer, The requested page size. If unspecified, at most 10 devices will be returned. The maximum value is 100; values above 100 will be coerced to 100. The limits can change over time.
pageToken: string, A token identifying a page of results returned by the server.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response to a request to list devices for a given enterprise.
"devices": [ # The list of devices.
{ # A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch.
"apiLevel": 42, # The API level of the Android platform version running on the device.
"applicationReports": [ # Reports for apps installed on the device. This information is only available when application_reports_enabled is true in the device's policy.
{ # Information reported about an installed app.
"applicationSource": "A String", # The source of the package.
"displayName": "A String", # The display name of the app.
"events": [ # The list of app events which have occurred in the last 30 hours.
{ # An app-related event.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # App event type.
},
],
"installerPackageName": "A String", # The package name of the app that installed this app.
"keyedAppStates": [ # List of keyed app states reported by the app.
{ # Keyed app state reported by the app.
"createTime": "A String", # The creation time of the app state on the device.
"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”).
"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.
"lastUpdateTime": "A String", # The time the app state was most recently updated.
"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.
"severity": "A String", # The severity of the app state.
},
],
"packageName": "A String", # Package name of the app.
"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.
"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.
"A String",
],
"state": "A String", # Application state.
"userFacingType": "A String", # Whether the app is user facing.
"versionCode": 42, # The app version code, which can be used to determine whether one version is more recent than another.
"versionName": "A String", # The app version as displayed to the user.
},
],
"appliedPasswordPolicies": [ # The password requirements currently applied to the device. This field exists because the applied requirements may be slightly different from those specified in passwordPolicies in some cases. Note that this field does not provide information about password compliance. For non-compliance information, see nonComplianceDetails. NonComplianceDetail.fieldPath, is set based on passwordPolicies, not based on this field.
{ # Requirements for the password used to unlock a device.
"maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction.
"passwordExpirationTimeout": "A String", # Password expiration timeout.
"passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction.
"passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX.
"passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordQuality": "A String", # The required password quality.
"passwordScope": "A String", # The scope that the password requirement applies to.
"requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile.
"unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION.
},
],
"appliedPolicyName": "A String", # The name of the policy currently applied to the device.
"appliedPolicyVersion": "A String", # The version of the policy currently applied to the device.
"appliedState": "A String", # The state currently applied to the device.
"commonCriteriaModeInfo": { # Information about Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC).This information is only available if statusReportingSettings.commonCriteriaModeEnabled is true in the device's policy. # Information about Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC).This information is only available if statusReportingSettings.commonCriteriaModeEnabled is true in the device's policy the device is company-owned.
"commonCriteriaModeStatus": "A String", # Whether Common Criteria Mode is enabled.
"policySignatureVerificationStatus": "A String", # Output only. The status of policy signature verification.
},
"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.
"adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device.
"developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device.
"encryptionStatus": "A String", # Encryption status from DevicePolicyManager.
"isDeviceSecure": True or False, # Whether the device is secured with PIN/password.
"isEncrypted": True or False, # Whether the storage encryption is enabled.
"unknownSourcesEnabled": True or False, # Whether installing apps from unknown sources is enabled.
"verifyAppsEnabled": True or False, # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced on the device.
},
"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.
"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.
"localizedMessages": { # A map containing 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.
"a_key": "A String",
},
},
"displays": [ # Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy.
{ # Device display information.
"density": 42, # Display density expressed as dots-per-inch.
"displayId": 42, # Unique display id.
"height": 42, # Display height in pixels.
"name": "A String", # Name of the display.
"refreshRate": 42, # Refresh rate of the display in frames per second.
"state": "A String", # State of the display.
"width": 42, # Display width in pixels.
},
],
"dpcMigrationInfo": { # Information related to whether this device was migrated from being managed by another Device Policy Controller (DPC). # Output only. Information related to whether this device was migrated from being managed by another Device Policy Controller (DPC).
"additionalData": "A String", # Output only. If this device was migrated from another DPC, the additionalData field of the migration token is populated here.
"previousDpc": "A String", # Output only. If this device was migrated from another DPC, this is its package name. Not populated otherwise.
},
"enrollmentTime": "A String", # The time of device enrollment.
"enrollmentTokenData": "A String", # If the device was enrolled with an enrollment token with additional data provided, this field contains that data.
"enrollmentTokenName": "A String", # If the device was enrolled with an enrollment token, this field contains the name of the token.
"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.
"batteryShutdownTemperatures": [ # Battery shutdown temperature thresholds in Celsius for each battery on the device.
3.14,
],
"batteryThrottlingTemperatures": [ # Battery throttling temperature thresholds in Celsius for each battery on the device.
3.14,
],
"brand": "A String", # Brand of the device. For example, Google.
"cpuShutdownTemperatures": [ # CPU shutdown temperature thresholds in Celsius for each CPU on the device.
3.14,
],
"cpuThrottlingTemperatures": [ # CPU throttling temperature thresholds in Celsius for each CPU on the device.
3.14,
],
"deviceBasebandVersion": "A String", # Baseband version. For example, MDM9625_104662.22.05.34p.
"enterpriseSpecificId": "A String", # Output only. ID that uniquely identifies a personally-owned device in a particular organization. On the same physical device when enrolled with the same organization, this ID persists across setups and even factory resets. This ID is available on personally-owned devices with a work profile on devices running Android 12 and above.
"euiccChipInfo": [ # Output only. Information related to the eUICC chip.
{ # Information related to the eUICC chip.
"eid": "A String", # Output only. The Embedded Identity Document (EID) that identifies the eUICC chip for each eUICC chip on the device. This is available on company owned devices running Android 13 and above.
},
],
"gpuShutdownTemperatures": [ # GPU shutdown temperature thresholds in Celsius for each GPU on the device.
3.14,
],
"gpuThrottlingTemperatures": [ # GPU throttling temperature thresholds in Celsius for each GPU on the device.
3.14,
],
"hardware": "A String", # Name of the hardware. For example, Angler.
"manufacturer": "A String", # Manufacturer. For example, Motorola.
"model": "A String", # The model of the device. For example, Asus Nexus 7.
"serialNumber": "A String", # The device serial number. However, for personally-owned devices running Android 12 and above, this is the same as the enterpriseSpecificId.
"skinShutdownTemperatures": [ # Device skin shutdown temperature thresholds in Celsius.
3.14,
],
"skinThrottlingTemperatures": [ # Device skin throttling temperature thresholds in Celsius.
3.14,
],
},
"hardwareStatusSamples": [ # Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy.
{ # Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health.
"batteryTemperatures": [ # Current battery temperatures in Celsius for each battery on the device.
3.14,
],
"cpuTemperatures": [ # Current CPU temperatures in Celsius for each CPU on the device.
3.14,
],
"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.
3.14,
],
"createTime": "A String", # The time the measurements were taken.
"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.
3.14,
],
"gpuTemperatures": [ # Current GPU temperatures in Celsius for each GPU on the device.
3.14,
],
"skinTemperatures": [ # Current device skin temperatures in Celsius.
3.14,
],
},
],
"lastPolicyComplianceReportTime": "A String", # Deprecated.
"lastPolicySyncTime": "A String", # The last time the device fetched its policy.
"lastStatusReportTime": "A String", # The last time the device sent a status report.
"managementMode": "A String", # The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported.
"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.Events are retained for a certain period of time and old events are deleted.
{ # An event related to memory and storage measurements.To distinguish between new and old events, we recommend using the createTime field.
"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.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # Event type.
},
],
"memoryInfo": { # Information about device memory and storage. # Memory information: contains information about device memory and storage.
"totalInternalStorage": "A String", # Total internal storage on device in bytes.
"totalRam": "A String", # Total RAM on device in bytes.
},
"name": "A String", # The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
"networkInfo": { # Device network info. # Device network information. This information is only available if networkInfoEnabled is true in the device's policy.
"imei": "A String", # IMEI number of the GSM device. For example, A1000031212.
"meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1.
"networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone.
"telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
{ # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
"activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below API level 35.
"carrierName": "A String", # The carrier name associated with this SIM card.
"configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below API level 35.
"iccId": "A String", # Output only. The ICCID associated with this SIM card.
"phoneNumber": "A String", # The phone number associated with this SIM card.
},
],
"wifiMacAddress": "A String", # Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11.
},
"nonComplianceDetails": [ # Details about policy settings that the device is not compliant with.
{ # Provides detail about non-compliance with a policy setting.
"currentValue": "", # If the policy setting could not be applied, the current value of the setting on the device.
"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
"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.
"nonComplianceReason": "A String", # The reason the device is not in compliance with the setting.
"packageName": "A String", # The package name indicating which app is out of compliance, if applicable.
"settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field.
"specificNonComplianceContext": { # Additional context for SpecificNonComplianceReason. # Additional context for specific_non_compliance_reason.
"oncWifiContext": { # Additional context for non-compliance related to Wi-Fi configuration. # Additional context for non-compliance related to Wi-Fi configuration. See ONC_WIFI_INVALID_VALUE and ONC_WIFI_API_LEVEL
"wifiGuid": "A String", # The GUID of non-compliant Wi-Fi configuration.
},
"passwordPoliciesContext": { # Additional context for non-compliance related to password policies. # Additional context for non-compliance related to password policies. See PASSWORD_POLICIES_PASSWORD_EXPIRED and PASSWORD_POLICIES_PASSWORD_NOT_SUFFICIENT.
"passwordPolicyScope": "A String", # The scope of non-compliant password.
},
},
"specificNonComplianceReason": "A String", # The policy-specific reason the device is not in compliance with the setting.
},
],
"ownership": "A String", # Ownership of the managed device.
"policyCompliant": True or False, # Whether the device is compliant with its policy.
"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.
"powerManagementEvents": [ # Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy.
{ # A power management event.
"batteryLevel": 3.14, # For BATTERY_LEVEL_COLLECTED events, the battery level as a percentage.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # Event type.
},
],
"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.
"A String",
],
"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.
"devicePosture": "A String", # Device's security posture value.
"postureDetails": [ # Additional details regarding the security posture of the device.
{ # Additional details regarding the security posture of the device.
"advice": [ # Corresponding admin-facing advice to mitigate this security risk and improve the security posture of the device.
{ # Provides a user-facing message with locale info. The maximum message length is 4096 characters.
"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.
"localizedMessages": { # A map containing 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.
"a_key": "A String",
},
},
],
"securityRisk": "A String", # A specific security risk that negatively affects the security posture of the device.
},
],
},
"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.
"androidBuildNumber": "A String", # Android build ID string meant for displaying to the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys.
"androidBuildTime": "A String", # Build time.
"androidDevicePolicyVersionCode": 42, # The Android Device Policy app version code.
"androidDevicePolicyVersionName": "A String", # The Android Device Policy app version as displayed to the user.
"androidVersion": "A String", # The user-visible Android version string. For example, 6.0.1.
"bootloaderVersion": "A String", # The system bootloader version number, e.g. 0.6.7.
"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.
"deviceKernelVersion": "A String", # Kernel version, for example, 2.6.32.9-g103d848.
"primaryLanguageCode": "A String", # An IETF BCP 47 language code for the primary locale on the device.
"securityPatchLevel": "A String", # Security patch level, e.g. 2016-05-01.
"systemUpdateInfo": { # Information about a potential pending system update. # Information about a potential pending system update.
"updateReceivedTime": "A String", # The time when the update was first available. A zero value indicates that this field is not set. This field is set only if an update is available (that is, updateStatus is neither UPDATE_STATUS_UNKNOWN nor UP_TO_DATE).
"updateStatus": "A String", # The status of an update: whether an update exists and what type it is.
},
},
"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.
"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.
"a_key": "A String",
},
"user": { # A user belonging to an enterprise. # The user who owns the device.
"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.
},
"userName": "A String", # The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}.
},
],
"nextPageToken": "A String", # If there are more results, a token to retrieve next page of results.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a device.
Args:
name: string, The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. (required)
body: object, The request body.
The object takes the form of:
{ # A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch.
"apiLevel": 42, # The API level of the Android platform version running on the device.
"applicationReports": [ # Reports for apps installed on the device. This information is only available when application_reports_enabled is true in the device's policy.
{ # Information reported about an installed app.
"applicationSource": "A String", # The source of the package.
"displayName": "A String", # The display name of the app.
"events": [ # The list of app events which have occurred in the last 30 hours.
{ # An app-related event.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # App event type.
},
],
"installerPackageName": "A String", # The package name of the app that installed this app.
"keyedAppStates": [ # List of keyed app states reported by the app.
{ # Keyed app state reported by the app.
"createTime": "A String", # The creation time of the app state on the device.
"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”).
"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.
"lastUpdateTime": "A String", # The time the app state was most recently updated.
"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.
"severity": "A String", # The severity of the app state.
},
],
"packageName": "A String", # Package name of the app.
"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.
"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.
"A String",
],
"state": "A String", # Application state.
"userFacingType": "A String", # Whether the app is user facing.
"versionCode": 42, # The app version code, which can be used to determine whether one version is more recent than another.
"versionName": "A String", # The app version as displayed to the user.
},
],
"appliedPasswordPolicies": [ # The password requirements currently applied to the device. This field exists because the applied requirements may be slightly different from those specified in passwordPolicies in some cases. Note that this field does not provide information about password compliance. For non-compliance information, see nonComplianceDetails. NonComplianceDetail.fieldPath, is set based on passwordPolicies, not based on this field.
{ # Requirements for the password used to unlock a device.
"maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction.
"passwordExpirationTimeout": "A String", # Password expiration timeout.
"passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction.
"passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX.
"passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordQuality": "A String", # The required password quality.
"passwordScope": "A String", # The scope that the password requirement applies to.
"requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile.
"unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION.
},
],
"appliedPolicyName": "A String", # The name of the policy currently applied to the device.
"appliedPolicyVersion": "A String", # The version of the policy currently applied to the device.
"appliedState": "A String", # The state currently applied to the device.
"commonCriteriaModeInfo": { # Information about Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC).This information is only available if statusReportingSettings.commonCriteriaModeEnabled is true in the device's policy. # Information about Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC).This information is only available if statusReportingSettings.commonCriteriaModeEnabled is true in the device's policy the device is company-owned.
"commonCriteriaModeStatus": "A String", # Whether Common Criteria Mode is enabled.
"policySignatureVerificationStatus": "A String", # Output only. The status of policy signature verification.
},
"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.
"adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device.
"developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device.
"encryptionStatus": "A String", # Encryption status from DevicePolicyManager.
"isDeviceSecure": True or False, # Whether the device is secured with PIN/password.
"isEncrypted": True or False, # Whether the storage encryption is enabled.
"unknownSourcesEnabled": True or False, # Whether installing apps from unknown sources is enabled.
"verifyAppsEnabled": True or False, # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced on the device.
},
"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.
"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.
"localizedMessages": { # A map containing 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.
"a_key": "A String",
},
},
"displays": [ # Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy.
{ # Device display information.
"density": 42, # Display density expressed as dots-per-inch.
"displayId": 42, # Unique display id.
"height": 42, # Display height in pixels.
"name": "A String", # Name of the display.
"refreshRate": 42, # Refresh rate of the display in frames per second.
"state": "A String", # State of the display.
"width": 42, # Display width in pixels.
},
],
"dpcMigrationInfo": { # Information related to whether this device was migrated from being managed by another Device Policy Controller (DPC). # Output only. Information related to whether this device was migrated from being managed by another Device Policy Controller (DPC).
"additionalData": "A String", # Output only. If this device was migrated from another DPC, the additionalData field of the migration token is populated here.
"previousDpc": "A String", # Output only. If this device was migrated from another DPC, this is its package name. Not populated otherwise.
},
"enrollmentTime": "A String", # The time of device enrollment.
"enrollmentTokenData": "A String", # If the device was enrolled with an enrollment token with additional data provided, this field contains that data.
"enrollmentTokenName": "A String", # If the device was enrolled with an enrollment token, this field contains the name of the token.
"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.
"batteryShutdownTemperatures": [ # Battery shutdown temperature thresholds in Celsius for each battery on the device.
3.14,
],
"batteryThrottlingTemperatures": [ # Battery throttling temperature thresholds in Celsius for each battery on the device.
3.14,
],
"brand": "A String", # Brand of the device. For example, Google.
"cpuShutdownTemperatures": [ # CPU shutdown temperature thresholds in Celsius for each CPU on the device.
3.14,
],
"cpuThrottlingTemperatures": [ # CPU throttling temperature thresholds in Celsius for each CPU on the device.
3.14,
],
"deviceBasebandVersion": "A String", # Baseband version. For example, MDM9625_104662.22.05.34p.
"enterpriseSpecificId": "A String", # Output only. ID that uniquely identifies a personally-owned device in a particular organization. On the same physical device when enrolled with the same organization, this ID persists across setups and even factory resets. This ID is available on personally-owned devices with a work profile on devices running Android 12 and above.
"euiccChipInfo": [ # Output only. Information related to the eUICC chip.
{ # Information related to the eUICC chip.
"eid": "A String", # Output only. The Embedded Identity Document (EID) that identifies the eUICC chip for each eUICC chip on the device. This is available on company owned devices running Android 13 and above.
},
],
"gpuShutdownTemperatures": [ # GPU shutdown temperature thresholds in Celsius for each GPU on the device.
3.14,
],
"gpuThrottlingTemperatures": [ # GPU throttling temperature thresholds in Celsius for each GPU on the device.
3.14,
],
"hardware": "A String", # Name of the hardware. For example, Angler.
"manufacturer": "A String", # Manufacturer. For example, Motorola.
"model": "A String", # The model of the device. For example, Asus Nexus 7.
"serialNumber": "A String", # The device serial number. However, for personally-owned devices running Android 12 and above, this is the same as the enterpriseSpecificId.
"skinShutdownTemperatures": [ # Device skin shutdown temperature thresholds in Celsius.
3.14,
],
"skinThrottlingTemperatures": [ # Device skin throttling temperature thresholds in Celsius.
3.14,
],
},
"hardwareStatusSamples": [ # Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy.
{ # Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health.
"batteryTemperatures": [ # Current battery temperatures in Celsius for each battery on the device.
3.14,
],
"cpuTemperatures": [ # Current CPU temperatures in Celsius for each CPU on the device.
3.14,
],
"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.
3.14,
],
"createTime": "A String", # The time the measurements were taken.
"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.
3.14,
],
"gpuTemperatures": [ # Current GPU temperatures in Celsius for each GPU on the device.
3.14,
],
"skinTemperatures": [ # Current device skin temperatures in Celsius.
3.14,
],
},
],
"lastPolicyComplianceReportTime": "A String", # Deprecated.
"lastPolicySyncTime": "A String", # The last time the device fetched its policy.
"lastStatusReportTime": "A String", # The last time the device sent a status report.
"managementMode": "A String", # The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported.
"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.Events are retained for a certain period of time and old events are deleted.
{ # An event related to memory and storage measurements.To distinguish between new and old events, we recommend using the createTime field.
"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.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # Event type.
},
],
"memoryInfo": { # Information about device memory and storage. # Memory information: contains information about device memory and storage.
"totalInternalStorage": "A String", # Total internal storage on device in bytes.
"totalRam": "A String", # Total RAM on device in bytes.
},
"name": "A String", # The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
"networkInfo": { # Device network info. # Device network information. This information is only available if networkInfoEnabled is true in the device's policy.
"imei": "A String", # IMEI number of the GSM device. For example, A1000031212.
"meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1.
"networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone.
"telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
{ # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
"activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below API level 35.
"carrierName": "A String", # The carrier name associated with this SIM card.
"configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below API level 35.
"iccId": "A String", # Output only. The ICCID associated with this SIM card.
"phoneNumber": "A String", # The phone number associated with this SIM card.
},
],
"wifiMacAddress": "A String", # Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11.
},
"nonComplianceDetails": [ # Details about policy settings that the device is not compliant with.
{ # Provides detail about non-compliance with a policy setting.
"currentValue": "", # If the policy setting could not be applied, the current value of the setting on the device.
"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
"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.
"nonComplianceReason": "A String", # The reason the device is not in compliance with the setting.
"packageName": "A String", # The package name indicating which app is out of compliance, if applicable.
"settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field.
"specificNonComplianceContext": { # Additional context for SpecificNonComplianceReason. # Additional context for specific_non_compliance_reason.
"oncWifiContext": { # Additional context for non-compliance related to Wi-Fi configuration. # Additional context for non-compliance related to Wi-Fi configuration. See ONC_WIFI_INVALID_VALUE and ONC_WIFI_API_LEVEL
"wifiGuid": "A String", # The GUID of non-compliant Wi-Fi configuration.
},
"passwordPoliciesContext": { # Additional context for non-compliance related to password policies. # Additional context for non-compliance related to password policies. See PASSWORD_POLICIES_PASSWORD_EXPIRED and PASSWORD_POLICIES_PASSWORD_NOT_SUFFICIENT.
"passwordPolicyScope": "A String", # The scope of non-compliant password.
},
},
"specificNonComplianceReason": "A String", # The policy-specific reason the device is not in compliance with the setting.
},
],
"ownership": "A String", # Ownership of the managed device.
"policyCompliant": True or False, # Whether the device is compliant with its policy.
"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.
"powerManagementEvents": [ # Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy.
{ # A power management event.
"batteryLevel": 3.14, # For BATTERY_LEVEL_COLLECTED events, the battery level as a percentage.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # Event type.
},
],
"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.
"A String",
],
"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.
"devicePosture": "A String", # Device's security posture value.
"postureDetails": [ # Additional details regarding the security posture of the device.
{ # Additional details regarding the security posture of the device.
"advice": [ # Corresponding admin-facing advice to mitigate this security risk and improve the security posture of the device.
{ # Provides a user-facing message with locale info. The maximum message length is 4096 characters.
"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.
"localizedMessages": { # A map containing 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.
"a_key": "A String",
},
},
],
"securityRisk": "A String", # A specific security risk that negatively affects the security posture of the device.
},
],
},
"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.
"androidBuildNumber": "A String", # Android build ID string meant for displaying to the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys.
"androidBuildTime": "A String", # Build time.
"androidDevicePolicyVersionCode": 42, # The Android Device Policy app version code.
"androidDevicePolicyVersionName": "A String", # The Android Device Policy app version as displayed to the user.
"androidVersion": "A String", # The user-visible Android version string. For example, 6.0.1.
"bootloaderVersion": "A String", # The system bootloader version number, e.g. 0.6.7.
"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.
"deviceKernelVersion": "A String", # Kernel version, for example, 2.6.32.9-g103d848.
"primaryLanguageCode": "A String", # An IETF BCP 47 language code for the primary locale on the device.
"securityPatchLevel": "A String", # Security patch level, e.g. 2016-05-01.
"systemUpdateInfo": { # Information about a potential pending system update. # Information about a potential pending system update.
"updateReceivedTime": "A String", # The time when the update was first available. A zero value indicates that this field is not set. This field is set only if an update is available (that is, updateStatus is neither UPDATE_STATUS_UNKNOWN nor UP_TO_DATE).
"updateStatus": "A String", # The status of an update: whether an update exists and what type it is.
},
},
"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.
"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.
"a_key": "A String",
},
"user": { # A user belonging to an enterprise. # The user who owns the device.
"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.
},
"userName": "A String", # The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}.
}
updateMask: string, The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch.
"apiLevel": 42, # The API level of the Android platform version running on the device.
"applicationReports": [ # Reports for apps installed on the device. This information is only available when application_reports_enabled is true in the device's policy.
{ # Information reported about an installed app.
"applicationSource": "A String", # The source of the package.
"displayName": "A String", # The display name of the app.
"events": [ # The list of app events which have occurred in the last 30 hours.
{ # An app-related event.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # App event type.
},
],
"installerPackageName": "A String", # The package name of the app that installed this app.
"keyedAppStates": [ # List of keyed app states reported by the app.
{ # Keyed app state reported by the app.
"createTime": "A String", # The creation time of the app state on the device.
"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”).
"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.
"lastUpdateTime": "A String", # The time the app state was most recently updated.
"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.
"severity": "A String", # The severity of the app state.
},
],
"packageName": "A String", # Package name of the app.
"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.
"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.
"A String",
],
"state": "A String", # Application state.
"userFacingType": "A String", # Whether the app is user facing.
"versionCode": 42, # The app version code, which can be used to determine whether one version is more recent than another.
"versionName": "A String", # The app version as displayed to the user.
},
],
"appliedPasswordPolicies": [ # The password requirements currently applied to the device. This field exists because the applied requirements may be slightly different from those specified in passwordPolicies in some cases. Note that this field does not provide information about password compliance. For non-compliance information, see nonComplianceDetails. NonComplianceDetail.fieldPath, is set based on passwordPolicies, not based on this field.
{ # Requirements for the password used to unlock a device.
"maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction.
"passwordExpirationTimeout": "A String", # Password expiration timeout.
"passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction.
"passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX.
"passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX.
"passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX.
"passwordQuality": "A String", # The required password quality.
"passwordScope": "A String", # The scope that the password requirement applies to.
"requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile.
"unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION.
},
],
"appliedPolicyName": "A String", # The name of the policy currently applied to the device.
"appliedPolicyVersion": "A String", # The version of the policy currently applied to the device.
"appliedState": "A String", # The state currently applied to the device.
"commonCriteriaModeInfo": { # Information about Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC).This information is only available if statusReportingSettings.commonCriteriaModeEnabled is true in the device's policy. # Information about Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC).This information is only available if statusReportingSettings.commonCriteriaModeEnabled is true in the device's policy the device is company-owned.
"commonCriteriaModeStatus": "A String", # Whether Common Criteria Mode is enabled.
"policySignatureVerificationStatus": "A String", # Output only. The status of policy signature verification.
},
"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.
"adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device.
"developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device.
"encryptionStatus": "A String", # Encryption status from DevicePolicyManager.
"isDeviceSecure": True or False, # Whether the device is secured with PIN/password.
"isEncrypted": True or False, # Whether the storage encryption is enabled.
"unknownSourcesEnabled": True or False, # Whether installing apps from unknown sources is enabled.
"verifyAppsEnabled": True or False, # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced on the device.
},
"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.
"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.
"localizedMessages": { # A map containing 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.
"a_key": "A String",
},
},
"displays": [ # Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy.
{ # Device display information.
"density": 42, # Display density expressed as dots-per-inch.
"displayId": 42, # Unique display id.
"height": 42, # Display height in pixels.
"name": "A String", # Name of the display.
"refreshRate": 42, # Refresh rate of the display in frames per second.
"state": "A String", # State of the display.
"width": 42, # Display width in pixels.
},
],
"dpcMigrationInfo": { # Information related to whether this device was migrated from being managed by another Device Policy Controller (DPC). # Output only. Information related to whether this device was migrated from being managed by another Device Policy Controller (DPC).
"additionalData": "A String", # Output only. If this device was migrated from another DPC, the additionalData field of the migration token is populated here.
"previousDpc": "A String", # Output only. If this device was migrated from another DPC, this is its package name. Not populated otherwise.
},
"enrollmentTime": "A String", # The time of device enrollment.
"enrollmentTokenData": "A String", # If the device was enrolled with an enrollment token with additional data provided, this field contains that data.
"enrollmentTokenName": "A String", # If the device was enrolled with an enrollment token, this field contains the name of the token.
"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.
"batteryShutdownTemperatures": [ # Battery shutdown temperature thresholds in Celsius for each battery on the device.
3.14,
],
"batteryThrottlingTemperatures": [ # Battery throttling temperature thresholds in Celsius for each battery on the device.
3.14,
],
"brand": "A String", # Brand of the device. For example, Google.
"cpuShutdownTemperatures": [ # CPU shutdown temperature thresholds in Celsius for each CPU on the device.
3.14,
],
"cpuThrottlingTemperatures": [ # CPU throttling temperature thresholds in Celsius for each CPU on the device.
3.14,
],
"deviceBasebandVersion": "A String", # Baseband version. For example, MDM9625_104662.22.05.34p.
"enterpriseSpecificId": "A String", # Output only. ID that uniquely identifies a personally-owned device in a particular organization. On the same physical device when enrolled with the same organization, this ID persists across setups and even factory resets. This ID is available on personally-owned devices with a work profile on devices running Android 12 and above.
"euiccChipInfo": [ # Output only. Information related to the eUICC chip.
{ # Information related to the eUICC chip.
"eid": "A String", # Output only. The Embedded Identity Document (EID) that identifies the eUICC chip for each eUICC chip on the device. This is available on company owned devices running Android 13 and above.
},
],
"gpuShutdownTemperatures": [ # GPU shutdown temperature thresholds in Celsius for each GPU on the device.
3.14,
],
"gpuThrottlingTemperatures": [ # GPU throttling temperature thresholds in Celsius for each GPU on the device.
3.14,
],
"hardware": "A String", # Name of the hardware. For example, Angler.
"manufacturer": "A String", # Manufacturer. For example, Motorola.
"model": "A String", # The model of the device. For example, Asus Nexus 7.
"serialNumber": "A String", # The device serial number. However, for personally-owned devices running Android 12 and above, this is the same as the enterpriseSpecificId.
"skinShutdownTemperatures": [ # Device skin shutdown temperature thresholds in Celsius.
3.14,
],
"skinThrottlingTemperatures": [ # Device skin throttling temperature thresholds in Celsius.
3.14,
],
},
"hardwareStatusSamples": [ # Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy.
{ # Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health.
"batteryTemperatures": [ # Current battery temperatures in Celsius for each battery on the device.
3.14,
],
"cpuTemperatures": [ # Current CPU temperatures in Celsius for each CPU on the device.
3.14,
],
"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.
3.14,
],
"createTime": "A String", # The time the measurements were taken.
"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.
3.14,
],
"gpuTemperatures": [ # Current GPU temperatures in Celsius for each GPU on the device.
3.14,
],
"skinTemperatures": [ # Current device skin temperatures in Celsius.
3.14,
],
},
],
"lastPolicyComplianceReportTime": "A String", # Deprecated.
"lastPolicySyncTime": "A String", # The last time the device fetched its policy.
"lastStatusReportTime": "A String", # The last time the device sent a status report.
"managementMode": "A String", # The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported.
"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.Events are retained for a certain period of time and old events are deleted.
{ # An event related to memory and storage measurements.To distinguish between new and old events, we recommend using the createTime field.
"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.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # Event type.
},
],
"memoryInfo": { # Information about device memory and storage. # Memory information: contains information about device memory and storage.
"totalInternalStorage": "A String", # Total internal storage on device in bytes.
"totalRam": "A String", # Total RAM on device in bytes.
},
"name": "A String", # The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
"networkInfo": { # Device network info. # Device network information. This information is only available if networkInfoEnabled is true in the device's policy.
"imei": "A String", # IMEI number of the GSM device. For example, A1000031212.
"meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1.
"networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone.
"telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
{ # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
"activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below API level 35.
"carrierName": "A String", # The carrier name associated with this SIM card.
"configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below API level 35.
"iccId": "A String", # Output only. The ICCID associated with this SIM card.
"phoneNumber": "A String", # The phone number associated with this SIM card.
},
],
"wifiMacAddress": "A String", # Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11.
},
"nonComplianceDetails": [ # Details about policy settings that the device is not compliant with.
{ # Provides detail about non-compliance with a policy setting.
"currentValue": "", # If the policy setting could not be applied, the current value of the setting on the device.
"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
"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.
"nonComplianceReason": "A String", # The reason the device is not in compliance with the setting.
"packageName": "A String", # The package name indicating which app is out of compliance, if applicable.
"settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field.
"specificNonComplianceContext": { # Additional context for SpecificNonComplianceReason. # Additional context for specific_non_compliance_reason.
"oncWifiContext": { # Additional context for non-compliance related to Wi-Fi configuration. # Additional context for non-compliance related to Wi-Fi configuration. See ONC_WIFI_INVALID_VALUE and ONC_WIFI_API_LEVEL
"wifiGuid": "A String", # The GUID of non-compliant Wi-Fi configuration.
},
"passwordPoliciesContext": { # Additional context for non-compliance related to password policies. # Additional context for non-compliance related to password policies. See PASSWORD_POLICIES_PASSWORD_EXPIRED and PASSWORD_POLICIES_PASSWORD_NOT_SUFFICIENT.
"passwordPolicyScope": "A String", # The scope of non-compliant password.
},
},
"specificNonComplianceReason": "A String", # The policy-specific reason the device is not in compliance with the setting.
},
],
"ownership": "A String", # Ownership of the managed device.
"policyCompliant": True or False, # Whether the device is compliant with its policy.
"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.
"powerManagementEvents": [ # Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy.
{ # A power management event.
"batteryLevel": 3.14, # For BATTERY_LEVEL_COLLECTED events, the battery level as a percentage.
"createTime": "A String", # The creation time of the event.
"eventType": "A String", # Event type.
},
],
"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.
"A String",
],
"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.
"devicePosture": "A String", # Device's security posture value.
"postureDetails": [ # Additional details regarding the security posture of the device.
{ # Additional details regarding the security posture of the device.
"advice": [ # Corresponding admin-facing advice to mitigate this security risk and improve the security posture of the device.
{ # Provides a user-facing message with locale info. The maximum message length is 4096 characters.
"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.
"localizedMessages": { # A map containing 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.
"a_key": "A String",
},
},
],
"securityRisk": "A String", # A specific security risk that negatively affects the security posture of the device.
},
],
},
"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.
"androidBuildNumber": "A String", # Android build ID string meant for displaying to the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys.
"androidBuildTime": "A String", # Build time.
"androidDevicePolicyVersionCode": 42, # The Android Device Policy app version code.
"androidDevicePolicyVersionName": "A String", # The Android Device Policy app version as displayed to the user.
"androidVersion": "A String", # The user-visible Android version string. For example, 6.0.1.
"bootloaderVersion": "A String", # The system bootloader version number, e.g. 0.6.7.
"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.
"deviceKernelVersion": "A String", # Kernel version, for example, 2.6.32.9-g103d848.
"primaryLanguageCode": "A String", # An IETF BCP 47 language code for the primary locale on the device.
"securityPatchLevel": "A String", # Security patch level, e.g. 2016-05-01.
"systemUpdateInfo": { # Information about a potential pending system update. # Information about a potential pending system update.
"updateReceivedTime": "A String", # The time when the update was first available. A zero value indicates that this field is not set. This field is set only if an update is available (that is, updateStatus is neither UPDATE_STATUS_UNKNOWN nor UP_TO_DATE).
"updateStatus": "A String", # The status of an update: whether an update exists and what type it is.
},
},
"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.
"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.
"a_key": "A String",
},
"user": { # A user belonging to an enterprise. # The user who owns the device.
"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.
},
"userName": "A String", # The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}.
}</pre>
</div>
</body></html>
|