|
632 | 632 | } |
633 | 633 | }, |
634 | 634 | "metadata": { |
635 | | - "description": "Updates reseller metadata associated with the device.", |
| 635 | + "description": "Updates reseller metadata associated with the device. Android devices only.", |
636 | 636 | "flatPath": "v1/partners/{partnersId}/devices/{devicesId}/metadata", |
637 | 637 | "httpMethod": "POST", |
638 | 638 | "id": "androiddeviceprovisioning.partners.devices.metadata", |
|
719 | 719 | } |
720 | 720 | }, |
721 | 721 | "updateMetadataAsync": { |
722 | | - "description": "Updates the reseller metadata attached to a batch of devices. This method updates devices asynchronously and returns an `Operation` that can be used to track progress. Read [Long\u2011running batch operations](/zero-touch/guides/how-it-works#operations).", |
| 722 | + "description": "Updates the reseller metadata attached to a batch of devices. This method updates devices asynchronously and returns an `Operation` that can be used to track progress. Read [Long\u2011running batch operations](/zero-touch/guides/how-it-works#operations). Android Devices only.", |
723 | 723 | "flatPath": "v1/partners/{partnersId}/devices:updateMetadataAsync", |
724 | 724 | "httpMethod": "POST", |
725 | 725 | "id": "androiddeviceprovisioning.partners.devices.updateMetadataAsync", |
|
825 | 825 | } |
826 | 826 | } |
827 | 827 | }, |
828 | | - "revision": "20221012", |
| 828 | + "revision": "20221023", |
829 | 829 | "rootUrl": "https://androiddeviceprovisioning.googleapis.com/", |
830 | 830 | "schemas": { |
831 | 831 | "ClaimDeviceRequest": { |
832 | 832 | "description": "Request message to claim a device on behalf of a customer.", |
833 | 833 | "id": "ClaimDeviceRequest", |
834 | 834 | "properties": { |
835 | 835 | "customerId": { |
836 | | - "description": "Required. The ID of the customer for whom the device is being claimed.", |
| 836 | + "description": "The ID of the customer for whom the device is being claimed.", |
837 | 837 | "format": "int64", |
838 | 838 | "type": "string" |
839 | 839 | }, |
|
845 | 845 | "$ref": "DeviceMetadata", |
846 | 846 | "description": "Optional. The metadata to attach to the device." |
847 | 847 | }, |
| 848 | + "googleWorkspaceCustomerId": { |
| 849 | + "description": "The Google Workspace customer ID.", |
| 850 | + "type": "string" |
| 851 | + }, |
| 852 | + "preProvisioningToken": { |
| 853 | + "description": "Optional. Must and can only be set for Chrome OS devices.", |
| 854 | + "type": "string" |
| 855 | + }, |
848 | 856 | "sectionType": { |
849 | 857 | "description": "Required. The section type of the device's provisioning record.", |
850 | 858 | "enum": [ |
|
913 | 921 | "description": "Required. The name of the company. For example _XYZ Corp_. Displayed to the company's employees in the zero-touch enrollment portal.", |
914 | 922 | "type": "string" |
915 | 923 | }, |
| 924 | + "googleWorkspaceAccount": { |
| 925 | + "$ref": "GoogleWorkspaceAccount", |
| 926 | + "description": "Output only. The Google Workspace account associated with this customer. Only used for customer Companies.", |
| 927 | + "readOnly": true |
| 928 | + }, |
916 | 929 | "languageCode": { |
917 | 930 | "description": "Input only. The preferred locale of the customer represented as a BCP47 language code. This field is validated on input and requests containing unsupported language codes will be rejected. Supported language codes: Arabic (ar) Chinese (Hong Kong) (zh-HK) Chinese (Simplified) (zh-CN) Chinese (Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (UK) (en-GB) English (US) (en-US) Filipino (fil) Finnish (fi) French (fr) German (de) Hebrew (iw) Hindi (hi) Hungarian (hu) Indonesian (id) Italian (it) Japanese (ja) Korean (ko) Norwegian (Bokmal) (no) Polish (pl) Portuguese (Brazil) (pt-BR) Portuguese (Portugal) (pt-PT) Russian (ru) Spanish (es) Spanish (Latin America) (es-419) Swedish (sv) Thai (th) Turkish (tr) Ukrainian (uk) Vietnamese (vi)", |
918 | 931 | "type": "string" |
|
1116 | 1129 | "type": "object" |
1117 | 1130 | }, |
1118 | 1131 | "Device": { |
1119 | | - "description": "An Android device registered for zero-touch enrollment.", |
| 1132 | + "description": "An Android or Chrome OS device registered for zero-touch enrollment.", |
1120 | 1133 | "id": "Device", |
1121 | 1134 | "properties": { |
1122 | 1135 | "claims": { |
|
1169 | 1182 | ], |
1170 | 1183 | "type": "string" |
1171 | 1184 | }, |
| 1185 | + "googleWorkspaceCustomerId": { |
| 1186 | + "description": "The ID of the Google Workspace account that owns the Chrome OS device.", |
| 1187 | + "type": "string" |
| 1188 | + }, |
1172 | 1189 | "ownerCompanyId": { |
1173 | | - "description": "The ID of the Customer that purchased the device.", |
| 1190 | + "description": "The ID of the Customer that purchased the Android device.", |
1174 | 1191 | "format": "int64", |
1175 | 1192 | "type": "string" |
1176 | 1193 | }, |
|
1211 | 1228 | "description": "Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).", |
1212 | 1229 | "id": "DeviceIdentifier", |
1213 | 1230 | "properties": { |
| 1231 | + "chromeOsAttestedDeviceId": { |
| 1232 | + "description": "An identifier provided by OEMs, carried through the production and sales process. Only applicable to Chrome OS devices.", |
| 1233 | + "type": "string" |
| 1234 | + }, |
| 1235 | + "deviceType": { |
| 1236 | + "description": "The type of the device", |
| 1237 | + "enum": [ |
| 1238 | + "DEVICE_TYPE_UNSPECIFIED", |
| 1239 | + "DEVICE_TYPE_ANDROID", |
| 1240 | + "DEVICE_TYPE_CHROME_OS" |
| 1241 | + ], |
| 1242 | + "enumDescriptions": [ |
| 1243 | + "Device type is not specified.", |
| 1244 | + "Android device", |
| 1245 | + "Chrome OS device" |
| 1246 | + ], |
| 1247 | + "type": "string" |
| 1248 | + }, |
1214 | 1249 | "imei": { |
1215 | 1250 | "description": "The device\u2019s IMEI number. Validated on input.", |
1216 | 1251 | "type": "string" |
1217 | 1252 | }, |
1218 | 1253 | "manufacturer": { |
1219 | | - "description": "The device manufacturer\u2019s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).", |
| 1254 | + "description": "The device manufacturer\u2019s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [Android manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).", |
1220 | 1255 | "type": "string" |
1221 | 1256 | }, |
1222 | 1257 | "meid": { |
1223 | 1258 | "description": "The device\u2019s MEID number.", |
1224 | 1259 | "type": "string" |
1225 | 1260 | }, |
1226 | 1261 | "model": { |
1227 | | - "description": "The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names).", |
| 1262 | + "description": "The device model's name. Allowed values are listed in [Android models](/zero-touch/resources/manufacturer-names#model-names) and [Chrome OS models](https://support.google.com/chrome/a/answer/10130175?hl=en#identify_compatible).", |
1228 | 1263 | "type": "string" |
1229 | 1264 | }, |
1230 | 1265 | "serialNumber": { |
|
1290 | 1325 | "type": "string" |
1291 | 1326 | }, |
1292 | 1327 | "progress": { |
1293 | | - "description": "The processing progress of the operation. Measured as a number from 0 to 100. A value of 10O doesnt always mean the operation completed\u2014check for the inclusion of a `done` field.", |
| 1328 | + "description": "The processing progress of the operation. Measured as a number from 0 to 100. A value of 10O doesn't always mean the operation completed\u2014check for the inclusion of a `done` field.", |
1294 | 1329 | "format": "int32", |
1295 | 1330 | "type": "integer" |
1296 | 1331 | } |
|
1392 | 1427 | "id": "FindDevicesByOwnerRequest", |
1393 | 1428 | "properties": { |
1394 | 1429 | "customerId": { |
1395 | | - "description": "Required. The list of customer IDs to search for.", |
| 1430 | + "description": "The list of customer IDs to search for.", |
1396 | 1431 | "items": { |
1397 | 1432 | "format": "int64", |
1398 | 1433 | "type": "string" |
1399 | 1434 | }, |
1400 | 1435 | "type": "array" |
1401 | 1436 | }, |
| 1437 | + "googleWorkspaceCustomerId": { |
| 1438 | + "description": "The list of IDs of Google Workspace accounts to search for.", |
| 1439 | + "items": { |
| 1440 | + "type": "string" |
| 1441 | + }, |
| 1442 | + "type": "array" |
| 1443 | + }, |
1402 | 1444 | "limit": { |
1403 | 1445 | "description": "Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.", |
1404 | 1446 | "format": "int64", |
|
1448 | 1490 | }, |
1449 | 1491 | "type": "object" |
1450 | 1492 | }, |
| 1493 | + "GoogleWorkspaceAccount": { |
| 1494 | + "description": "A Google Workspace customer.", |
| 1495 | + "id": "GoogleWorkspaceAccount", |
| 1496 | + "properties": { |
| 1497 | + "customerId": { |
| 1498 | + "description": "Required. The customer ID.", |
| 1499 | + "type": "string" |
| 1500 | + }, |
| 1501 | + "preProvisioningTokens": { |
| 1502 | + "description": "Output only. The pre-provisioning tokens previously used to claim devices.", |
| 1503 | + "items": { |
| 1504 | + "type": "string" |
| 1505 | + }, |
| 1506 | + "readOnly": true, |
| 1507 | + "type": "array" |
| 1508 | + } |
| 1509 | + }, |
| 1510 | + "type": "object" |
| 1511 | + }, |
1451 | 1512 | "ListCustomersResponse": { |
1452 | 1513 | "description": "Response message of all customers related to this partner.", |
1453 | 1514 | "id": "ListCustomersResponse", |
|
1580 | 1641 | "id": "PartnerClaim", |
1581 | 1642 | "properties": { |
1582 | 1643 | "customerId": { |
1583 | | - "description": "Required. The ID of the customer for whom the device is being claimed.", |
| 1644 | + "description": "The ID of the customer for whom the device is being claimed.", |
1584 | 1645 | "format": "int64", |
1585 | 1646 | "type": "string" |
1586 | 1647 | }, |
|
1592 | 1653 | "$ref": "DeviceMetadata", |
1593 | 1654 | "description": "Required. The metadata to attach to the device at claim." |
1594 | 1655 | }, |
| 1656 | + "googleWorkspaceCustomerId": { |
| 1657 | + "description": "The Google Workspace customer ID.", |
| 1658 | + "type": "string" |
| 1659 | + }, |
| 1660 | + "preProvisioningToken": { |
| 1661 | + "description": "Optional. Must and can only be set for Chrome OS devices.", |
| 1662 | + "type": "string" |
| 1663 | + }, |
1595 | 1664 | "sectionType": { |
1596 | 1665 | "description": "Required. The section type of the device's provisioning record.", |
1597 | 1666 | "enum": [ |
|
1654 | 1723 | "id": "PerDeviceStatusInBatch", |
1655 | 1724 | "properties": { |
1656 | 1725 | "deviceId": { |
1657 | | - "description": "If processing succeeds, the device ID of the device.", |
| 1726 | + "description": "If processing succeeds, the device ID of the Android device.", |
1658 | 1727 | "format": "int64", |
1659 | 1728 | "type": "string" |
1660 | 1729 | }, |
|
1676 | 1745 | "SINGLE_DEVICE_STATUS_PERMISSION_DENIED", |
1677 | 1746 | "SINGLE_DEVICE_STATUS_INVALID_DEVICE_IDENTIFIER", |
1678 | 1747 | "SINGLE_DEVICE_STATUS_INVALID_SECTION_TYPE", |
1679 | | - "SINGLE_DEVICE_STATUS_SECTION_NOT_YOURS" |
| 1748 | + "SINGLE_DEVICE_STATUS_SECTION_NOT_YOURS", |
| 1749 | + "SINGLE_DEVICE_STATUS_INVALID_TOKEN", |
| 1750 | + "SINGLE_DEVICE_STATUS_REVOKED_TOKEN" |
1680 | 1751 | ], |
1681 | 1752 | "enumDescriptions": [ |
1682 | 1753 | "Invalid code. Shouldn't be used.", |
|
1686 | 1757 | "Permission denied.", |
1687 | 1758 | "Invalid device identifier.", |
1688 | 1759 | "Invalid section type.", |
1689 | | - "This section is claimed by another company." |
| 1760 | + "This section is claimed by another company.", |
| 1761 | + "Invalid pre-provisioning token.", |
| 1762 | + "Revoked pre-provisioning token." |
1690 | 1763 | ], |
1691 | 1764 | "type": "string" |
1692 | 1765 | } |
|
0 commit comments