Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1 | { |
| 2 | "basePath": "", |
| 3 | "title": "Android Device Provisioning Partner API", |
| 4 | "version": "v1", |
| 5 | "baseUrl": "https://androiddeviceprovisioning.googleapis.com/", |
| 6 | "parameters": { |
| 7 | "access_token": { |
| 8 | "location": "query", |
| 9 | "description": "OAuth access token.", |
| 10 | "type": "string" |
| 11 | }, |
| 12 | "prettyPrint": { |
| 13 | "type": "boolean", |
| 14 | "location": "query", |
| 15 | "default": "true", |
| 16 | "description": "Returns response with indentations and line breaks." |
| 17 | }, |
| 18 | "quotaUser": { |
| 19 | "type": "string", |
| 20 | "location": "query", |
| 21 | "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." |
| 22 | }, |
| 23 | "uploadType": { |
| 24 | "location": "query", |
| 25 | "type": "string", |
| 26 | "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." |
| 27 | }, |
| 28 | "callback": { |
| 29 | "description": "JSONP", |
| 30 | "type": "string", |
| 31 | "location": "query" |
| 32 | }, |
| 33 | "$.xgafv": { |
| 34 | "enumDescriptions": [ |
| 35 | "v1 error format", |
| 36 | "v2 error format" |
| 37 | ], |
| 38 | "description": "V1 error format.", |
| 39 | "enum": [ |
| 40 | "1", |
| 41 | "2" |
| 42 | ], |
| 43 | "type": "string", |
| 44 | "location": "query" |
| 45 | }, |
| 46 | "fields": { |
| 47 | "description": "Selector specifying which fields to include in a partial response.", |
| 48 | "type": "string", |
| 49 | "location": "query" |
| 50 | }, |
| 51 | "oauth_token": { |
| 52 | "type": "string", |
| 53 | "description": "OAuth 2.0 token for the current user.", |
| 54 | "location": "query" |
| 55 | }, |
| 56 | "key": { |
| 57 | "location": "query", |
| 58 | "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", |
| 59 | "type": "string" |
| 60 | }, |
| 61 | "alt": { |
| 62 | "default": "json", |
| 63 | "description": "Data format for response.", |
| 64 | "enum": [ |
| 65 | "json", |
| 66 | "media", |
| 67 | "proto" |
| 68 | ], |
| 69 | "location": "query", |
| 70 | "enumDescriptions": [ |
| 71 | "Responses with Content-Type of application/json", |
| 72 | "Media download with context-dependent Content-Type", |
| 73 | "Responses with Content-Type of application/x-protobuf" |
| 74 | ], |
| 75 | "type": "string" |
| 76 | }, |
| 77 | "upload_protocol": { |
| 78 | "type": "string", |
| 79 | "location": "query", |
| 80 | "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." |
| 81 | } |
| 82 | }, |
| 83 | "batchPath": "batch", |
| 84 | "documentationLink": "https://developers.google.com/zero-touch/", |
| 85 | "ownerDomain": "google.com", |
| 86 | "protocol": "rest", |
| 87 | "servicePath": "", |
| 88 | "icons": { |
| 89 | "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 90 | "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 91 | }, |
| 92 | "canonicalName": "Android Provisioning Partner", |
| 93 | "version_module": true, |
| 94 | "description": "Automates Android zero-touch enrollment for device resellers, customers, and EMMs.", |
| 95 | "name": "androiddeviceprovisioning", |
| 96 | "discoveryVersion": "v1", |
| 97 | "kind": "discovery#restDescription", |
| 98 | "resources": { |
| 99 | "partners": { |
| 100 | "resources": { |
| 101 | "customers": { |
| 102 | "methods": { |
| 103 | "create": { |
| 104 | "request": { |
| 105 | "$ref": "CreateCustomerRequest" |
| 106 | }, |
| 107 | "flatPath": "v1/partners/{partnersId}/customers", |
| 108 | "path": "v1/{+parent}/customers", |
| 109 | "description": "Creates a customer for zero-touch enrollment. After the method returns successfully, admin and owner roles can manage devices and EMM configs by calling API methods or using their zero-touch enrollment portal. The customer receives an email that welcomes them to zero-touch enrollment and explains how to sign into the portal.", |
| 110 | "parameters": { |
| 111 | "parent": { |
| 112 | "required": true, |
| 113 | "pattern": "^partners/[^/]+$", |
| 114 | "description": "Required. The parent resource ID in the format `partners/[PARTNER_ID]` that identifies the reseller.", |
| 115 | "location": "path", |
| 116 | "type": "string" |
| 117 | } |
| 118 | }, |
| 119 | "parameterOrder": [ |
| 120 | "parent" |
| 121 | ], |
| 122 | "httpMethod": "POST", |
| 123 | "id": "androiddeviceprovisioning.partners.customers.create", |
| 124 | "response": { |
| 125 | "$ref": "Company" |
| 126 | } |
| 127 | }, |
| 128 | "list": { |
| 129 | "parameters": { |
| 130 | "partnerId": { |
| 131 | "location": "path", |
| 132 | "required": true, |
| 133 | "format": "int64", |
| 134 | "pattern": "^[^/]+$", |
| 135 | "description": "Required. The ID of the reseller partner.", |
| 136 | "type": "string" |
| 137 | }, |
| 138 | "pageSize": { |
| 139 | "description": "The maximum number of results to be returned. If not specified or 0, all the records are returned.", |
| 140 | "type": "integer", |
| 141 | "format": "int32", |
| 142 | "location": "query" |
| 143 | }, |
| 144 | "pageToken": { |
| 145 | "location": "query", |
| 146 | "type": "string", |
| 147 | "description": "A token identifying a page of results returned by the server." |
| 148 | } |
| 149 | }, |
| 150 | "flatPath": "v1/partners/{partnersId}/customers", |
| 151 | "id": "androiddeviceprovisioning.partners.customers.list", |
| 152 | "path": "v1/partners/{+partnerId}/customers", |
| 153 | "description": "Lists the customers that are enrolled to the reseller identified by the `partnerId` argument. This list includes customers that the reseller created and customers that enrolled themselves using the portal.", |
| 154 | "httpMethod": "GET", |
| 155 | "parameterOrder": [ |
| 156 | "partnerId" |
| 157 | ], |
| 158 | "response": { |
| 159 | "$ref": "ListCustomersResponse" |
| 160 | } |
| 161 | } |
| 162 | } |
| 163 | }, |
| 164 | "vendors": { |
| 165 | "methods": { |
| 166 | "list": { |
| 167 | "id": "androiddeviceprovisioning.partners.vendors.list", |
| 168 | "parameters": { |
| 169 | "pageToken": { |
| 170 | "type": "string", |
| 171 | "location": "query", |
| 172 | "description": "A token identifying a page of results returned by the server." |
| 173 | }, |
| 174 | "parent": { |
| 175 | "location": "path", |
| 176 | "required": true, |
| 177 | "type": "string", |
| 178 | "description": "Required. The resource name in the format `partners/[PARTNER_ID]`.", |
| 179 | "pattern": "^partners/[^/]+$" |
| 180 | }, |
| 181 | "pageSize": { |
| 182 | "type": "integer", |
| 183 | "location": "query", |
| 184 | "description": "The maximum number of results to be returned.", |
| 185 | "format": "int32" |
| 186 | } |
| 187 | }, |
| 188 | "description": "Lists the vendors of the partner.", |
| 189 | "response": { |
| 190 | "$ref": "ListVendorsResponse" |
| 191 | }, |
| 192 | "httpMethod": "GET", |
| 193 | "parameterOrder": [ |
| 194 | "parent" |
| 195 | ], |
| 196 | "flatPath": "v1/partners/{partnersId}/vendors", |
| 197 | "path": "v1/{+parent}/vendors" |
| 198 | } |
| 199 | }, |
| 200 | "resources": { |
| 201 | "customers": { |
| 202 | "methods": { |
| 203 | "list": { |
| 204 | "httpMethod": "GET", |
| 205 | "flatPath": "v1/partners/{partnersId}/vendors/{vendorsId}/customers", |
| 206 | "description": "Lists the customers of the vendor.", |
| 207 | "id": "androiddeviceprovisioning.partners.vendors.customers.list", |
| 208 | "parameterOrder": [ |
| 209 | "parent" |
| 210 | ], |
| 211 | "parameters": { |
| 212 | "pageSize": { |
| 213 | "type": "integer", |
| 214 | "description": "The maximum number of results to be returned.", |
| 215 | "location": "query", |
| 216 | "format": "int32" |
| 217 | }, |
| 218 | "pageToken": { |
| 219 | "description": "A token identifying a page of results returned by the server.", |
| 220 | "location": "query", |
| 221 | "type": "string" |
| 222 | }, |
| 223 | "parent": { |
| 224 | "pattern": "^partners/[^/]+/vendors/[^/]+$", |
| 225 | "location": "path", |
| 226 | "type": "string", |
| 227 | "required": true, |
| 228 | "description": "Required. The resource name in the format `partners/[PARTNER_ID]/vendors/[VENDOR_ID]`." |
| 229 | } |
| 230 | }, |
| 231 | "path": "v1/{+parent}/customers", |
| 232 | "response": { |
| 233 | "$ref": "ListVendorCustomersResponse" |
| 234 | } |
| 235 | } |
| 236 | } |
| 237 | } |
| 238 | } |
| 239 | }, |
| 240 | "devices": { |
| 241 | "methods": { |
| 242 | "unclaim": { |
| 243 | "request": { |
| 244 | "$ref": "UnclaimDeviceRequest" |
| 245 | }, |
| 246 | "httpMethod": "POST", |
| 247 | "flatPath": "v1/partners/{partnersId}/devices:unclaim", |
| 248 | "description": "Unclaims a device from a customer and removes it from zero-touch enrollment.", |
| 249 | "parameters": { |
| 250 | "partnerId": { |
| 251 | "format": "int64", |
| 252 | "pattern": "^[^/]+$", |
| 253 | "description": "Required. The ID of the reseller partner.", |
| 254 | "required": true, |
| 255 | "type": "string", |
| 256 | "location": "path" |
| 257 | } |
| 258 | }, |
| 259 | "parameterOrder": [ |
| 260 | "partnerId" |
| 261 | ], |
| 262 | "id": "androiddeviceprovisioning.partners.devices.unclaim", |
| 263 | "path": "v1/partners/{+partnerId}/devices:unclaim", |
| 264 | "response": { |
| 265 | "$ref": "Empty" |
| 266 | } |
| 267 | }, |
| 268 | "unclaimAsync": { |
| 269 | "flatPath": "v1/partners/{partnersId}/devices:unclaimAsync", |
| 270 | "response": { |
| 271 | "$ref": "Operation" |
| 272 | }, |
| 273 | "parameterOrder": [ |
| 274 | "partnerId" |
| 275 | ], |
| 276 | "request": { |
| 277 | "$ref": "UnclaimDevicesRequest" |
| 278 | }, |
| 279 | "description": "Unclaims a batch of devices for a customer asynchronously. Removes the devices from zero-touch enrollment. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).", |
| 280 | "httpMethod": "POST", |
| 281 | "parameters": { |
| 282 | "partnerId": { |
| 283 | "pattern": "^[^/]+$", |
| 284 | "type": "string", |
| 285 | "format": "int64", |
| 286 | "description": "Required. The reseller partner ID.", |
| 287 | "required": true, |
| 288 | "location": "path" |
| 289 | } |
| 290 | }, |
| 291 | "path": "v1/partners/{+partnerId}/devices:unclaimAsync", |
| 292 | "id": "androiddeviceprovisioning.partners.devices.unclaimAsync" |
| 293 | }, |
| 294 | "updateMetadataAsync": { |
| 295 | "path": "v1/partners/{+partnerId}/devices:updateMetadataAsync", |
| 296 | "flatPath": "v1/partners/{partnersId}/devices:updateMetadataAsync", |
| 297 | "parameterOrder": [ |
| 298 | "partnerId" |
| 299 | ], |
| 300 | "httpMethod": "POST", |
| 301 | "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‑running batch operations](/zero-touch/guides/how-it-works#operations).", |
| 302 | "request": { |
| 303 | "$ref": "UpdateDeviceMetadataInBatchRequest" |
| 304 | }, |
| 305 | "parameters": { |
| 306 | "partnerId": { |
| 307 | "description": "Required. The reseller partner ID.", |
| 308 | "format": "int64", |
| 309 | "location": "path", |
| 310 | "type": "string", |
| 311 | "pattern": "^[^/]+$", |
| 312 | "required": true |
| 313 | } |
| 314 | }, |
| 315 | "id": "androiddeviceprovisioning.partners.devices.updateMetadataAsync", |
| 316 | "response": { |
| 317 | "$ref": "Operation" |
| 318 | } |
| 319 | }, |
| 320 | "claimAsync": { |
| 321 | "request": { |
| 322 | "$ref": "ClaimDevicesRequest" |
| 323 | }, |
| 324 | "parameterOrder": [ |
| 325 | "partnerId" |
| 326 | ], |
| 327 | "parameters": { |
| 328 | "partnerId": { |
| 329 | "location": "path", |
| 330 | "required": true, |
| 331 | "type": "string", |
| 332 | "pattern": "^[^/]+$", |
| 333 | "description": "Required. The ID of the reseller partner.", |
| 334 | "format": "int64" |
| 335 | } |
| 336 | }, |
| 337 | "response": { |
| 338 | "$ref": "Operation" |
| 339 | }, |
| 340 | "path": "v1/partners/{+partnerId}/devices:claimAsync", |
| 341 | "id": "androiddeviceprovisioning.partners.devices.claimAsync", |
| 342 | "httpMethod": "POST", |
| 343 | "description": "Claims a batch of devices for a customer asynchronously. Adds the devices to zero-touch enrollment. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).", |
| 344 | "flatPath": "v1/partners/{partnersId}/devices:claimAsync" |
| 345 | }, |
| 346 | "findByIdentifier": { |
| 347 | "response": { |
| 348 | "$ref": "FindDevicesByDeviceIdentifierResponse" |
| 349 | }, |
| 350 | "parameters": { |
| 351 | "partnerId": { |
| 352 | "required": true, |
| 353 | "format": "int64", |
| 354 | "type": "string", |
| 355 | "pattern": "^[^/]+$", |
| 356 | "description": "Required. The ID of the reseller partner.", |
| 357 | "location": "path" |
| 358 | } |
| 359 | }, |
| 360 | "path": "v1/partners/{+partnerId}/devices:findByIdentifier", |
| 361 | "flatPath": "v1/partners/{partnersId}/devices:findByIdentifier", |
| 362 | "id": "androiddeviceprovisioning.partners.devices.findByIdentifier", |
| 363 | "request": { |
| 364 | "$ref": "FindDevicesByDeviceIdentifierRequest" |
| 365 | }, |
| 366 | "httpMethod": "POST", |
| 367 | "description": "Finds devices by hardware identifiers, such as IMEI.", |
| 368 | "parameterOrder": [ |
| 369 | "partnerId" |
| 370 | ] |
| 371 | }, |
| 372 | "get": { |
| 373 | "path": "v1/{+name}", |
| 374 | "httpMethod": "GET", |
| 375 | "id": "androiddeviceprovisioning.partners.devices.get", |
| 376 | "flatPath": "v1/partners/{partnersId}/devices/{devicesId}", |
| 377 | "response": { |
| 378 | "$ref": "Device" |
| 379 | }, |
| 380 | "parameters": { |
| 381 | "name": { |
| 382 | "required": true, |
| 383 | "type": "string", |
| 384 | "description": "Required. The device API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.", |
| 385 | "pattern": "^partners/[^/]+/devices/[^/]+$", |
| 386 | "location": "path" |
| 387 | } |
| 388 | }, |
| 389 | "parameterOrder": [ |
| 390 | "name" |
| 391 | ], |
| 392 | "description": "Gets a device." |
| 393 | }, |
| 394 | "findByOwner": { |
| 395 | "path": "v1/partners/{+partnerId}/devices:findByOwner", |
| 396 | "response": { |
| 397 | "$ref": "FindDevicesByOwnerResponse" |
| 398 | }, |
| 399 | "httpMethod": "POST", |
| 400 | "request": { |
| 401 | "$ref": "FindDevicesByOwnerRequest" |
| 402 | }, |
| 403 | "flatPath": "v1/partners/{partnersId}/devices:findByOwner", |
| 404 | "description": "Finds devices claimed for customers. The results only contain devices registered to the reseller that's identified by the `partnerId` argument. The customer's devices purchased from other resellers don't appear in the results.", |
| 405 | "parameters": { |
| 406 | "partnerId": { |
| 407 | "format": "int64", |
| 408 | "pattern": "^[^/]+$", |
| 409 | "type": "string", |
| 410 | "required": true, |
| 411 | "description": "Required. The ID of the reseller partner.", |
| 412 | "location": "path" |
| 413 | } |
| 414 | }, |
| 415 | "parameterOrder": [ |
| 416 | "partnerId" |
| 417 | ], |
| 418 | "id": "androiddeviceprovisioning.partners.devices.findByOwner" |
| 419 | }, |
| 420 | "claim": { |
| 421 | "parameters": { |
| 422 | "partnerId": { |
| 423 | "pattern": "^[^/]+$", |
| 424 | "format": "int64", |
| 425 | "type": "string", |
| 426 | "location": "path", |
| 427 | "description": "Required. The ID of the reseller partner.", |
| 428 | "required": true |
| 429 | } |
| 430 | }, |
| 431 | "response": { |
| 432 | "$ref": "ClaimDeviceResponse" |
| 433 | }, |
| 434 | "id": "androiddeviceprovisioning.partners.devices.claim", |
| 435 | "httpMethod": "POST", |
| 436 | "path": "v1/partners/{+partnerId}/devices:claim", |
| 437 | "request": { |
| 438 | "$ref": "ClaimDeviceRequest" |
| 439 | }, |
| 440 | "flatPath": "v1/partners/{partnersId}/devices:claim", |
| 441 | "description": "Claims a device for a customer and adds it to zero-touch enrollment. If the device is already claimed by another customer, the call returns an error.", |
| 442 | "parameterOrder": [ |
| 443 | "partnerId" |
| 444 | ] |
| 445 | }, |
| 446 | "metadata": { |
| 447 | "response": { |
| 448 | "$ref": "DeviceMetadata" |
| 449 | }, |
| 450 | "parameterOrder": [ |
| 451 | "metadataOwnerId", |
| 452 | "deviceId" |
| 453 | ], |
| 454 | "parameters": { |
| 455 | "deviceId": { |
| 456 | "required": true, |
| 457 | "pattern": "^[^/]+$", |
| 458 | "location": "path", |
| 459 | "format": "int64", |
| 460 | "description": "Required. The ID of the device.", |
| 461 | "type": "string" |
| 462 | }, |
| 463 | "metadataOwnerId": { |
| 464 | "pattern": "^[^/]+$", |
| 465 | "format": "int64", |
| 466 | "location": "path", |
| 467 | "required": true, |
| 468 | "description": "Required. The owner of the newly set metadata. Set this to the partner ID.", |
| 469 | "type": "string" |
| 470 | } |
| 471 | }, |
| 472 | "request": { |
| 473 | "$ref": "UpdateDeviceMetadataRequest" |
| 474 | }, |
| 475 | "path": "v1/partners/{+metadataOwnerId}/devices/{+deviceId}/metadata", |
| 476 | "description": "Updates reseller metadata associated with the device.", |
| 477 | "httpMethod": "POST", |
| 478 | "flatPath": "v1/partners/{partnersId}/devices/{devicesId}/metadata", |
| 479 | "id": "androiddeviceprovisioning.partners.devices.metadata" |
| 480 | } |
| 481 | } |
| 482 | } |
| 483 | } |
| 484 | }, |
| 485 | "operations": { |
| 486 | "methods": { |
| 487 | "get": { |
| 488 | "httpMethod": "GET", |
| 489 | "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", |
| 490 | "flatPath": "v1/operations/{operationsId}", |
| 491 | "path": "v1/{+name}", |
| 492 | "response": { |
| 493 | "$ref": "Operation" |
| 494 | }, |
| 495 | "id": "androiddeviceprovisioning.operations.get", |
| 496 | "parameterOrder": [ |
| 497 | "name" |
| 498 | ], |
| 499 | "parameters": { |
| 500 | "name": { |
| 501 | "description": "The name of the operation resource.", |
| 502 | "location": "path", |
| 503 | "pattern": "^operations/.*$", |
| 504 | "type": "string", |
| 505 | "required": true |
| 506 | } |
| 507 | } |
| 508 | } |
| 509 | } |
| 510 | }, |
| 511 | "customers": { |
| 512 | "resources": { |
| 513 | "configurations": { |
| 514 | "methods": { |
| 515 | "patch": { |
| 516 | "httpMethod": "PATCH", |
| 517 | "flatPath": "v1/customers/{customersId}/configurations/{configurationsId}", |
| 518 | "id": "androiddeviceprovisioning.customers.configurations.patch", |
| 519 | "description": "Updates a configuration's field values.", |
| 520 | "parameters": { |
| 521 | "name": { |
| 522 | "pattern": "^customers/[^/]+/configurations/[^/]+$", |
| 523 | "location": "path", |
| 524 | "required": true, |
| 525 | "type": "string", |
| 526 | "description": "Output only. The API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by the server." |
| 527 | }, |
| 528 | "updateMask": { |
| 529 | "location": "query", |
| 530 | "format": "google-fieldmask", |
| 531 | "description": "Required. The field mask applied to the target `Configuration` before updating the fields. To learn more about using field masks, read [FieldMask](/protocol-buffers/docs/reference/google.protobuf#fieldmask) in the Protocol Buffers documentation.", |
| 532 | "type": "string" |
| 533 | } |
| 534 | }, |
| 535 | "request": { |
| 536 | "$ref": "Configuration" |
| 537 | }, |
| 538 | "path": "v1/{+name}", |
| 539 | "response": { |
| 540 | "$ref": "Configuration" |
| 541 | }, |
| 542 | "parameterOrder": [ |
| 543 | "name" |
| 544 | ] |
| 545 | }, |
| 546 | "list": { |
| 547 | "flatPath": "v1/customers/{customersId}/configurations", |
| 548 | "httpMethod": "GET", |
| 549 | "id": "androiddeviceprovisioning.customers.configurations.list", |
| 550 | "description": "Lists a customer's configurations.", |
| 551 | "parameterOrder": [ |
| 552 | "parent" |
| 553 | ], |
| 554 | "response": { |
| 555 | "$ref": "CustomerListConfigurationsResponse" |
| 556 | }, |
| 557 | "parameters": { |
| 558 | "parent": { |
| 559 | "description": "Required. The customer that manages the listed configurations. An API resource name in the format `customers/[CUSTOMER_ID]`.", |
| 560 | "location": "path", |
| 561 | "type": "string", |
| 562 | "required": true, |
| 563 | "pattern": "^customers/[^/]+$" |
| 564 | } |
| 565 | }, |
| 566 | "path": "v1/{+parent}/configurations" |
| 567 | }, |
| 568 | "delete": { |
| 569 | "httpMethod": "DELETE", |
| 570 | "path": "v1/{+name}", |
| 571 | "flatPath": "v1/customers/{customersId}/configurations/{configurationsId}", |
| 572 | "description": "Deletes an unused configuration. The API call fails if the customer has devices with the configuration applied.", |
| 573 | "response": { |
| 574 | "$ref": "Empty" |
| 575 | }, |
| 576 | "parameterOrder": [ |
| 577 | "name" |
| 578 | ], |
| 579 | "parameters": { |
| 580 | "name": { |
| 581 | "description": "Required. The configuration to delete. An API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. If the configuration is applied to any devices, the API call fails.", |
| 582 | "location": "path", |
| 583 | "required": true, |
| 584 | "type": "string", |
| 585 | "pattern": "^customers/[^/]+/configurations/[^/]+$" |
| 586 | } |
| 587 | }, |
| 588 | "id": "androiddeviceprovisioning.customers.configurations.delete" |
| 589 | }, |
| 590 | "get": { |
| 591 | "response": { |
| 592 | "$ref": "Configuration" |
| 593 | }, |
| 594 | "id": "androiddeviceprovisioning.customers.configurations.get", |
| 595 | "flatPath": "v1/customers/{customersId}/configurations/{configurationsId}", |
| 596 | "httpMethod": "GET", |
| 597 | "description": "Gets the details of a configuration.", |
| 598 | "parameterOrder": [ |
| 599 | "name" |
| 600 | ], |
| 601 | "parameters": { |
| 602 | "name": { |
| 603 | "required": true, |
| 604 | "type": "string", |
| 605 | "pattern": "^customers/[^/]+/configurations/[^/]+$", |
| 606 | "location": "path", |
| 607 | "description": "Required. The configuration to get. An API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`." |
| 608 | } |
| 609 | }, |
| 610 | "path": "v1/{+name}" |
| 611 | }, |
| 612 | "create": { |
| 613 | "httpMethod": "POST", |
| 614 | "request": { |
| 615 | "$ref": "Configuration" |
| 616 | }, |
| 617 | "parameterOrder": [ |
| 618 | "parent" |
| 619 | ], |
| 620 | "path": "v1/{+parent}/configurations", |
| 621 | "response": { |
| 622 | "$ref": "Configuration" |
| 623 | }, |
| 624 | "description": "Creates a new configuration. Once created, a customer can apply the configuration to devices.", |
| 625 | "parameters": { |
| 626 | "parent": { |
| 627 | "description": "Required. The customer that manages the configuration. An API resource name in the format `customers/[CUSTOMER_ID]`.", |
| 628 | "location": "path", |
| 629 | "pattern": "^customers/[^/]+$", |
| 630 | "required": true, |
| 631 | "type": "string" |
| 632 | } |
| 633 | }, |
| 634 | "flatPath": "v1/customers/{customersId}/configurations", |
| 635 | "id": "androiddeviceprovisioning.customers.configurations.create" |
| 636 | } |
| 637 | } |
| 638 | }, |
| 639 | "devices": { |
| 640 | "methods": { |
| 641 | "list": { |
| 642 | "parameterOrder": [ |
| 643 | "parent" |
| 644 | ], |
| 645 | "flatPath": "v1/customers/{customersId}/devices", |
| 646 | "description": "Lists a customer's devices.", |
| 647 | "response": { |
| 648 | "$ref": "CustomerListDevicesResponse" |
| 649 | }, |
| 650 | "httpMethod": "GET", |
| 651 | "path": "v1/{+parent}/devices", |
| 652 | "id": "androiddeviceprovisioning.customers.devices.list", |
| 653 | "parameters": { |
| 654 | "pageToken": { |
| 655 | "type": "string", |
| 656 | "location": "query", |
| 657 | "description": "A token specifying which result page to return." |
| 658 | }, |
| 659 | "pageSize": { |
| 660 | "location": "query", |
| 661 | "description": "The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.", |
| 662 | "format": "int64", |
| 663 | "type": "string" |
| 664 | }, |
| 665 | "parent": { |
| 666 | "pattern": "^customers/[^/]+$", |
| 667 | "description": "Required. The customer managing the devices. An API resource name in the format `customers/[CUSTOMER_ID]`.", |
| 668 | "location": "path", |
| 669 | "type": "string", |
| 670 | "required": true |
| 671 | } |
| 672 | } |
| 673 | }, |
| 674 | "unclaim": { |
| 675 | "path": "v1/{+parent}/devices:unclaim", |
| 676 | "flatPath": "v1/customers/{customersId}/devices:unclaim", |
| 677 | "httpMethod": "POST", |
| 678 | "id": "androiddeviceprovisioning.customers.devices.unclaim", |
| 679 | "response": { |
| 680 | "$ref": "Empty" |
| 681 | }, |
| 682 | "request": { |
| 683 | "$ref": "CustomerUnclaimDeviceRequest" |
| 684 | }, |
| 685 | "description": "Unclaims a device from a customer and removes it from zero-touch enrollment. After removing a device, a customer must contact their reseller to register the device into zero-touch enrollment again.", |
| 686 | "parameterOrder": [ |
| 687 | "parent" |
| 688 | ], |
| 689 | "parameters": { |
| 690 | "parent": { |
| 691 | "type": "string", |
| 692 | "required": true, |
| 693 | "description": "Required. The customer managing the device. An API resource name in the format `customers/[CUSTOMER_ID]`.", |
| 694 | "location": "path", |
| 695 | "pattern": "^customers/[^/]+$" |
| 696 | } |
| 697 | } |
| 698 | }, |
| 699 | "applyConfiguration": { |
| 700 | "response": { |
| 701 | "$ref": "Empty" |
| 702 | }, |
| 703 | "httpMethod": "POST", |
| 704 | "id": "androiddeviceprovisioning.customers.devices.applyConfiguration", |
| 705 | "parameterOrder": [ |
| 706 | "parent" |
| 707 | ], |
| 708 | "parameters": { |
| 709 | "parent": { |
| 710 | "required": true, |
| 711 | "description": "Required. The customer managing the device. An API resource name in the format `customers/[CUSTOMER_ID]`.", |
| 712 | "type": "string", |
| 713 | "location": "path", |
| 714 | "pattern": "^customers/[^/]+$" |
| 715 | } |
| 716 | }, |
| 717 | "request": { |
| 718 | "$ref": "CustomerApplyConfigurationRequest" |
| 719 | }, |
| 720 | "description": "Applies a Configuration to the device to register the device for zero-touch enrollment. After applying a configuration to a device, the device automatically provisions itself on first boot, or next factory reset.", |
| 721 | "flatPath": "v1/customers/{customersId}/devices:applyConfiguration", |
| 722 | "path": "v1/{+parent}/devices:applyConfiguration" |
| 723 | }, |
| 724 | "removeConfiguration": { |
| 725 | "id": "androiddeviceprovisioning.customers.devices.removeConfiguration", |
| 726 | "response": { |
| 727 | "$ref": "Empty" |
| 728 | }, |
| 729 | "httpMethod": "POST", |
| 730 | "description": "Removes a configuration from device.", |
| 731 | "request": { |
| 732 | "$ref": "CustomerRemoveConfigurationRequest" |
| 733 | }, |
| 734 | "parameters": { |
| 735 | "parent": { |
| 736 | "required": true, |
| 737 | "description": "Required. The customer managing the device in the format `customers/[CUSTOMER_ID]`.", |
| 738 | "type": "string", |
| 739 | "location": "path", |
| 740 | "pattern": "^customers/[^/]+$" |
| 741 | } |
| 742 | }, |
| 743 | "flatPath": "v1/customers/{customersId}/devices:removeConfiguration", |
| 744 | "path": "v1/{+parent}/devices:removeConfiguration", |
| 745 | "parameterOrder": [ |
| 746 | "parent" |
| 747 | ] |
| 748 | }, |
| 749 | "get": { |
| 750 | "parameters": { |
| 751 | "name": { |
| 752 | "pattern": "^customers/[^/]+/devices/[^/]+$", |
| 753 | "required": true, |
| 754 | "location": "path", |
| 755 | "type": "string", |
| 756 | "description": "Required. The device to get. An API resource name in the format `customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`." |
| 757 | } |
| 758 | }, |
| 759 | "path": "v1/{+name}", |
| 760 | "httpMethod": "GET", |
| 761 | "response": { |
| 762 | "$ref": "Device" |
| 763 | }, |
| 764 | "id": "androiddeviceprovisioning.customers.devices.get", |
| 765 | "parameterOrder": [ |
| 766 | "name" |
| 767 | ], |
| 768 | "flatPath": "v1/customers/{customersId}/devices/{devicesId}", |
| 769 | "description": "Gets the details of a device." |
| 770 | } |
| 771 | } |
| 772 | }, |
| 773 | "dpcs": { |
| 774 | "methods": { |
| 775 | "list": { |
| 776 | "response": { |
| 777 | "$ref": "CustomerListDpcsResponse" |
| 778 | }, |
| 779 | "parameterOrder": [ |
| 780 | "parent" |
| 781 | ], |
| 782 | "flatPath": "v1/customers/{customersId}/dpcs", |
| 783 | "description": "Lists the DPCs (device policy controllers) that support zero-touch enrollment.", |
| 784 | "httpMethod": "GET", |
| 785 | "parameters": { |
| 786 | "parent": { |
| 787 | "type": "string", |
| 788 | "required": true, |
| 789 | "pattern": "^customers/[^/]+$", |
| 790 | "description": "Required. The customer that can use the DPCs in configurations. An API resource name in the format `customers/[CUSTOMER_ID]`.", |
| 791 | "location": "path" |
| 792 | } |
| 793 | }, |
| 794 | "id": "androiddeviceprovisioning.customers.dpcs.list", |
| 795 | "path": "v1/{+parent}/dpcs" |
| 796 | } |
| 797 | } |
| 798 | } |
| 799 | }, |
| 800 | "methods": { |
| 801 | "list": { |
| 802 | "path": "v1/customers", |
| 803 | "response": { |
| 804 | "$ref": "CustomerListCustomersResponse" |
| 805 | }, |
| 806 | "id": "androiddeviceprovisioning.customers.list", |
| 807 | "parameters": { |
| 808 | "pageSize": { |
| 809 | "format": "int32", |
| 810 | "type": "integer", |
| 811 | "description": "The maximum number of customers to show in a page of results. A number between 1 and 100 (inclusive).", |
| 812 | "location": "query" |
| 813 | }, |
| 814 | "pageToken": { |
| 815 | "type": "string", |
| 816 | "location": "query", |
| 817 | "description": "A token specifying which result page to return." |
| 818 | } |
| 819 | }, |
| 820 | "parameterOrder": [], |
| 821 | "description": "Lists the user's customer accounts.", |
| 822 | "flatPath": "v1/customers", |
| 823 | "httpMethod": "GET" |
| 824 | } |
| 825 | } |
| 826 | } |
| 827 | }, |
| 828 | "revision": "20200801", |
| 829 | "mtlsRootUrl": "https://androiddeviceprovisioning.mtls.googleapis.com/", |
| 830 | "schemas": { |
| 831 | "ClaimDeviceRequest": { |
| 832 | "id": "ClaimDeviceRequest", |
| 833 | "description": "Request message to claim a device on behalf of a customer.", |
| 834 | "type": "object", |
| 835 | "properties": { |
| 836 | "deviceIdentifier": { |
| 837 | "description": "Required. Required. The device identifier of the device to claim.", |
| 838 | "$ref": "DeviceIdentifier" |
| 839 | }, |
| 840 | "sectionType": { |
| 841 | "type": "string", |
| 842 | "enumDescriptions": [ |
| 843 | "Unspecified section type.", |
| 844 | "SIM-lock section type.", |
| 845 | "Zero-touch enrollment section type." |
| 846 | ], |
| 847 | "enum": [ |
| 848 | "SECTION_TYPE_UNSPECIFIED", |
| 849 | "SECTION_TYPE_SIM_LOCK", |
| 850 | "SECTION_TYPE_ZERO_TOUCH" |
| 851 | ], |
| 852 | "description": "Required. The section type of the device's provisioning record." |
| 853 | }, |
| 854 | "customerId": { |
| 855 | "description": "Required. The ID of the customer for whom the device is being claimed.", |
| 856 | "type": "string", |
| 857 | "format": "int64" |
| 858 | }, |
| 859 | "deviceMetadata": { |
| 860 | "description": "Optional. The metadata to attach to the device.", |
| 861 | "$ref": "DeviceMetadata" |
| 862 | } |
| 863 | } |
| 864 | }, |
| 865 | "Empty": { |
| 866 | "id": "Empty", |
| 867 | "properties": {}, |
| 868 | "type": "object", |
| 869 | "description": "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); } The JSON representation for `Empty` is empty JSON object `{}`." |
| 870 | }, |
| 871 | "UpdateMetadataArguments": { |
| 872 | "id": "UpdateMetadataArguments", |
| 873 | "type": "object", |
| 874 | "properties": { |
| 875 | "deviceId": { |
| 876 | "type": "string", |
| 877 | "description": "Required. Device ID of the device.", |
| 878 | "format": "int64" |
| 879 | }, |
| 880 | "deviceMetadata": { |
| 881 | "$ref": "DeviceMetadata", |
| 882 | "description": "Required. The metadata to update." |
| 883 | }, |
| 884 | "deviceIdentifier": { |
| 885 | "description": "Required. Device identifier.", |
| 886 | "$ref": "DeviceIdentifier" |
| 887 | } |
| 888 | }, |
| 889 | "description": "Identifies metadata updates to one device." |
| 890 | }, |
| 891 | "DevicesLongRunningOperationResponse": { |
| 892 | "description": "Tracks the status of a long-running operation to claim, unclaim, or attach metadata to devices. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).", |
| 893 | "properties": { |
| 894 | "perDeviceStatus": { |
| 895 | "description": "The processing status for each device in the operation. One `PerDeviceStatus` per device. The list order matches the items in the original request.", |
| 896 | "type": "array", |
| 897 | "items": { |
| 898 | "$ref": "OperationPerDevice" |
| 899 | } |
| 900 | }, |
| 901 | "successCount": { |
| 902 | "type": "integer", |
| 903 | "format": "int32", |
| 904 | "description": "A summary of how many items in the operation the server processed successfully. Updated as the operation progresses." |
| 905 | } |
| 906 | }, |
| 907 | "type": "object", |
| 908 | "id": "DevicesLongRunningOperationResponse" |
| 909 | }, |
| 910 | "PartnerUnclaim": { |
| 911 | "properties": { |
| 912 | "deviceIdentifier": { |
| 913 | "description": "Required. Device identifier of the device.", |
| 914 | "$ref": "DeviceIdentifier" |
| 915 | }, |
| 916 | "deviceId": { |
| 917 | "format": "int64", |
| 918 | "description": "Required. Device ID of the device.", |
| 919 | "type": "string" |
| 920 | }, |
| 921 | "vacationModeExpireTime": { |
| 922 | "description": "Optional. The expiration time of the vacation unlock.", |
| 923 | "type": "string", |
| 924 | "format": "google-datetime" |
| 925 | }, |
| 926 | "vacationModeDays": { |
| 927 | "format": "int32", |
| 928 | "description": "Optional. The duration of the vacation unlock starting from when the request is processed. (1 day is treated as 24 hours)", |
| 929 | "type": "integer" |
| 930 | }, |
| 931 | "sectionType": { |
| 932 | "description": "Required. The section type of the device's provisioning record.", |
| 933 | "type": "string", |
| 934 | "enum": [ |
| 935 | "SECTION_TYPE_UNSPECIFIED", |
| 936 | "SECTION_TYPE_SIM_LOCK", |
| 937 | "SECTION_TYPE_ZERO_TOUCH" |
| 938 | ], |
| 939 | "enumDescriptions": [ |
| 940 | "Unspecified section type.", |
| 941 | "SIM-lock section type.", |
| 942 | "Zero-touch enrollment section type." |
| 943 | ] |
| 944 | } |
| 945 | }, |
| 946 | "id": "PartnerUnclaim", |
| 947 | "description": "Identifies one unclaim request.", |
| 948 | "type": "object" |
| 949 | }, |
| 950 | "CustomerListConfigurationsResponse": { |
| 951 | "properties": { |
| 952 | "configurations": { |
| 953 | "description": "The configurations.", |
| 954 | "items": { |
| 955 | "$ref": "Configuration" |
| 956 | }, |
| 957 | "type": "array" |
| 958 | } |
| 959 | }, |
| 960 | "description": "Response message of customer's listing configuration.", |
| 961 | "id": "CustomerListConfigurationsResponse", |
| 962 | "type": "object" |
| 963 | }, |
| 964 | "FindDevicesByOwnerRequest": { |
| 965 | "type": "object", |
| 966 | "id": "FindDevicesByOwnerRequest", |
| 967 | "description": "Request to find devices by customers.", |
| 968 | "properties": { |
| 969 | "customerId": { |
| 970 | "description": "Required. The list of customer IDs to search for.", |
| 971 | "items": { |
| 972 | "type": "string", |
| 973 | "format": "int64" |
| 974 | }, |
| 975 | "type": "array" |
| 976 | }, |
| 977 | "pageToken": { |
| 978 | "type": "string", |
| 979 | "description": "A token specifying which result page to return." |
| 980 | }, |
| 981 | "limit": { |
| 982 | "description": "Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.", |
| 983 | "type": "string", |
| 984 | "format": "int64" |
| 985 | }, |
| 986 | "sectionType": { |
| 987 | "enumDescriptions": [ |
| 988 | "Unspecified section type.", |
| 989 | "SIM-lock section type.", |
| 990 | "Zero-touch enrollment section type." |
| 991 | ], |
| 992 | "enum": [ |
| 993 | "SECTION_TYPE_UNSPECIFIED", |
| 994 | "SECTION_TYPE_SIM_LOCK", |
| 995 | "SECTION_TYPE_ZERO_TOUCH" |
| 996 | ], |
| 997 | "type": "string", |
| 998 | "description": "Required. The section type of the device's provisioning record." |
| 999 | } |
| 1000 | } |
| 1001 | }, |
| 1002 | "CustomerListDevicesResponse": { |
| 1003 | "properties": { |
| 1004 | "devices": { |
| 1005 | "description": "The customer's devices.", |
| 1006 | "type": "array", |
| 1007 | "items": { |
| 1008 | "$ref": "Device" |
| 1009 | } |
| 1010 | }, |
| 1011 | "nextPageToken": { |
| 1012 | "type": "string", |
| 1013 | "description": "A token used to access the next page of results. Omitted if no further results are available." |
| 1014 | } |
| 1015 | }, |
| 1016 | "id": "CustomerListDevicesResponse", |
| 1017 | "type": "object", |
| 1018 | "description": "Response message of customer's liting devices." |
| 1019 | }, |
| 1020 | "UpdateDeviceMetadataRequest": { |
| 1021 | "properties": { |
| 1022 | "deviceMetadata": { |
| 1023 | "$ref": "DeviceMetadata", |
| 1024 | "description": "Required. The metadata to attach to the device." |
| 1025 | } |
| 1026 | }, |
| 1027 | "type": "object", |
| 1028 | "description": "Request to set metadata for a device.", |
| 1029 | "id": "UpdateDeviceMetadataRequest" |
| 1030 | }, |
| 1031 | "CustomerRemoveConfigurationRequest": { |
| 1032 | "description": "Request message for customer to remove the configuration from device.", |
| 1033 | "type": "object", |
| 1034 | "id": "CustomerRemoveConfigurationRequest", |
| 1035 | "properties": { |
| 1036 | "device": { |
| 1037 | "$ref": "DeviceReference", |
| 1038 | "description": "Required. The device to remove the configuration from." |
| 1039 | } |
| 1040 | } |
| 1041 | }, |
| 1042 | "Operation": { |
| 1043 | "type": "object", |
| 1044 | "description": "This resource represents a long-running operation that is the result of a network API call.", |
| 1045 | "id": "Operation", |
| 1046 | "properties": { |
| 1047 | "name": { |
| 1048 | "description": "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}`.", |
| 1049 | "type": "string" |
| 1050 | }, |
| 1051 | "metadata": { |
| 1052 | "additionalProperties": { |
| 1053 | "type": "any", |
| 1054 | "description": "Properties of the object. Contains field @type with type URL." |
| 1055 | }, |
| 1056 | "description": "This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.", |
| 1057 | "type": "object" |
| 1058 | }, |
| 1059 | "error": { |
| 1060 | "description": "This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`.", |
| 1061 | "$ref": "Status" |
| 1062 | }, |
| 1063 | "done": { |
| 1064 | "type": "boolean", |
| 1065 | "description": "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." |
| 1066 | }, |
| 1067 | "response": { |
| 1068 | "type": "object", |
| 1069 | "description": "This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.", |
| 1070 | "additionalProperties": { |
| 1071 | "type": "any", |
| 1072 | "description": "Properties of the object. Contains field @type with type URL." |
| 1073 | } |
| 1074 | } |
| 1075 | } |
| 1076 | }, |
| 1077 | "FindDevicesByOwnerResponse": { |
| 1078 | "type": "object", |
| 1079 | "description": "Response containing found devices.", |
| 1080 | "id": "FindDevicesByOwnerResponse", |
| 1081 | "properties": { |
| 1082 | "totalSize": { |
| 1083 | "type": "integer", |
| 1084 | "description": "The total count of items in the list irrespective of pagination.", |
| 1085 | "format": "int32" |
| 1086 | }, |
| 1087 | "devices": { |
| 1088 | "type": "array", |
| 1089 | "items": { |
| 1090 | "$ref": "Device" |
| 1091 | }, |
| 1092 | "description": "The customer's devices." |
| 1093 | }, |
| 1094 | "nextPageToken": { |
| 1095 | "type": "string", |
| 1096 | "description": "A token used to access the next page of results. Omitted if no further results are available." |
| 1097 | } |
| 1098 | } |
| 1099 | }, |
| 1100 | "UnclaimDevicesRequest": { |
| 1101 | "type": "object", |
| 1102 | "description": "Request to unclaim devices asynchronously in batch.", |
| 1103 | "id": "UnclaimDevicesRequest", |
| 1104 | "properties": { |
| 1105 | "unclaims": { |
| 1106 | "items": { |
| 1107 | "$ref": "PartnerUnclaim" |
| 1108 | }, |
| 1109 | "description": "Required. The list of devices to unclaim.", |
| 1110 | "type": "array" |
| 1111 | } |
| 1112 | } |
| 1113 | }, |
| 1114 | "DeviceIdentifier": { |
| 1115 | "type": "object", |
| 1116 | "id": "DeviceIdentifier", |
| 1117 | "properties": { |
| 1118 | "serialNumber": { |
| 1119 | "type": "string", |
| 1120 | "description": "The manufacturer's serial number for the device. This value might not be unique across different device models." |
| 1121 | }, |
| 1122 | "model": { |
| 1123 | "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).", |
| 1124 | "type": "string" |
| 1125 | }, |
| 1126 | "manufacturer": { |
| 1127 | "type": "string", |
| 1128 | "description": "The device manufacturer’s 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)." |
| 1129 | }, |
| 1130 | "meid": { |
| 1131 | "description": "The device’s MEID number.", |
| 1132 | "type": "string" |
| 1133 | }, |
| 1134 | "imei": { |
| 1135 | "description": "The device’s IMEI number. Validated on input.", |
| 1136 | "type": "string" |
| 1137 | } |
| 1138 | }, |
| 1139 | "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)." |
| 1140 | }, |
| 1141 | "DeviceClaim": { |
| 1142 | "properties": { |
| 1143 | "vacationModeExpireTime": { |
| 1144 | "description": "The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'.", |
| 1145 | "type": "string", |
| 1146 | "format": "google-datetime" |
| 1147 | }, |
| 1148 | "sectionType": { |
| 1149 | "type": "string", |
| 1150 | "readOnly": true, |
| 1151 | "enumDescriptions": [ |
| 1152 | "Unspecified section type.", |
| 1153 | "SIM-lock section type.", |
| 1154 | "Zero-touch enrollment section type." |
| 1155 | ], |
| 1156 | "description": "Output only. The type of claim made on the device.", |
| 1157 | "enum": [ |
| 1158 | "SECTION_TYPE_UNSPECIFIED", |
| 1159 | "SECTION_TYPE_SIM_LOCK", |
| 1160 | "SECTION_TYPE_ZERO_TOUCH" |
| 1161 | ] |
| 1162 | }, |
| 1163 | "ownerCompanyId": { |
| 1164 | "type": "string", |
| 1165 | "description": "The ID of the Customer that purchased the device.", |
| 1166 | "format": "int64" |
| 1167 | }, |
| 1168 | "resellerId": { |
| 1169 | "description": "The ID of the reseller that claimed the device.", |
| 1170 | "format": "int64", |
| 1171 | "type": "string" |
| 1172 | }, |
| 1173 | "vacationModeStartTime": { |
| 1174 | "description": "The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'.", |
| 1175 | "format": "google-datetime", |
| 1176 | "type": "string" |
| 1177 | } |
| 1178 | }, |
| 1179 | "description": "A record of a device claimed by a reseller for a customer. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. To learn more, read [Claim devices for customers](/zero-touch/guides/how-it-works#claim).", |
| 1180 | "type": "object", |
| 1181 | "id": "DeviceClaim" |
| 1182 | }, |
| 1183 | "UpdateDeviceMetadataInBatchRequest": { |
| 1184 | "properties": { |
| 1185 | "updates": { |
| 1186 | "type": "array", |
| 1187 | "description": "Required. The list of metadata updates.", |
| 1188 | "items": { |
| 1189 | "$ref": "UpdateMetadataArguments" |
| 1190 | } |
| 1191 | } |
| 1192 | }, |
| 1193 | "id": "UpdateDeviceMetadataInBatchRequest", |
| 1194 | "description": "Request to update device metadata in batch.", |
| 1195 | "type": "object" |
| 1196 | }, |
| 1197 | "CustomerListCustomersResponse": { |
| 1198 | "description": "Response message for listing my customers.", |
| 1199 | "properties": { |
| 1200 | "nextPageToken": { |
| 1201 | "type": "string", |
| 1202 | "description": "A token used to access the next page of results. Omitted if no further results are available." |
| 1203 | }, |
| 1204 | "customers": { |
| 1205 | "type": "array", |
| 1206 | "description": "The customer accounts the calling user is a member of.", |
| 1207 | "items": { |
| 1208 | "$ref": "Company" |
| 1209 | } |
| 1210 | } |
| 1211 | }, |
| 1212 | "id": "CustomerListCustomersResponse", |
| 1213 | "type": "object" |
| 1214 | }, |
| 1215 | "ClaimDeviceResponse": { |
| 1216 | "properties": { |
| 1217 | "deviceId": { |
| 1218 | "description": "The device ID of the claimed device.", |
| 1219 | "type": "string", |
| 1220 | "format": "int64" |
| 1221 | }, |
| 1222 | "deviceName": { |
| 1223 | "type": "string", |
| 1224 | "description": "The resource name of the device in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`." |
| 1225 | } |
| 1226 | }, |
| 1227 | "id": "ClaimDeviceResponse", |
| 1228 | "description": "Response message containing device id of the claim.", |
| 1229 | "type": "object" |
| 1230 | }, |
| 1231 | "DeviceMetadata": { |
| 1232 | "description": "Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata).", |
| 1233 | "id": "DeviceMetadata", |
| 1234 | "properties": { |
| 1235 | "entries": { |
| 1236 | "additionalProperties": { |
| 1237 | "type": "string" |
| 1238 | }, |
| 1239 | "type": "object", |
| 1240 | "description": "Metadata entries recorded as key-value pairs." |
| 1241 | } |
| 1242 | }, |
| 1243 | "type": "object" |
| 1244 | }, |
| 1245 | "CustomerApplyConfigurationRequest": { |
| 1246 | "type": "object", |
| 1247 | "description": "Request message for customer to assign a configuration to device.", |
| 1248 | "properties": { |
| 1249 | "device": { |
| 1250 | "$ref": "DeviceReference", |
| 1251 | "description": "Required. The device the configuration is applied to." |
| 1252 | }, |
| 1253 | "configuration": { |
| 1254 | "description": "Required. The configuration applied to the device in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.", |
| 1255 | "type": "string" |
| 1256 | } |
| 1257 | }, |
| 1258 | "id": "CustomerApplyConfigurationRequest" |
| 1259 | }, |
| 1260 | "CustomerListDpcsResponse": { |
| 1261 | "id": "CustomerListDpcsResponse", |
| 1262 | "type": "object", |
| 1263 | "description": "Response message of customer's listing DPCs.", |
| 1264 | "properties": { |
| 1265 | "dpcs": { |
| 1266 | "items": { |
| 1267 | "$ref": "Dpc" |
| 1268 | }, |
| 1269 | "type": "array", |
| 1270 | "description": "The list of DPCs available to the customer that support zero-touch enrollment." |
| 1271 | } |
| 1272 | } |
| 1273 | }, |
| 1274 | "Company": { |
| 1275 | "type": "object", |
| 1276 | "id": "Company", |
| 1277 | "description": "A reseller, vendor, or customer in the zero-touch reseller and customer APIs.", |
| 1278 | "properties": { |
| 1279 | "companyId": { |
| 1280 | "description": "Output only. The ID of the company. Assigned by the server.", |
| 1281 | "readOnly": true, |
| 1282 | "format": "int64", |
| 1283 | "type": "string" |
| 1284 | }, |
| 1285 | "ownerEmails": { |
| 1286 | "type": "array", |
| 1287 | "items": { |
| 1288 | "type": "string" |
| 1289 | }, |
| 1290 | "description": "Required. Input only. Email address of customer's users in the owner role. At least one `owner_email` is required. Each email address must be associated with a Google Account. Owners share the same access as admins but can also add, delete, and edit your organization's portal users." |
| 1291 | }, |
| 1292 | "adminEmails": { |
| 1293 | "items": { |
| 1294 | "type": "string" |
| 1295 | }, |
| 1296 | "type": "array", |
| 1297 | "description": "Optional. Email address of customer's users in the admin role. Each email address must be associated with a Google Account." |
| 1298 | }, |
| 1299 | "name": { |
| 1300 | "type": "string", |
| 1301 | "readOnly": true, |
| 1302 | "description": "Output only. The API resource name of the company. The resource name is one of the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server." |
| 1303 | }, |
| 1304 | "companyName": { |
| 1305 | "description": "Required. The name of the company. For example _XYZ Corp_. Displayed to the company's employees in the zero-touch enrollment portal.", |
| 1306 | "type": "string" |
| 1307 | }, |
| 1308 | "termsStatus": { |
| 1309 | "description": "Output only. Whether any user from the company has accepted the latest Terms of Service (ToS). See TermsStatus.", |
| 1310 | "enum": [ |
| 1311 | "TERMS_STATUS_UNSPECIFIED", |
| 1312 | "TERMS_STATUS_NOT_ACCEPTED", |
| 1313 | "TERMS_STATUS_ACCEPTED", |
| 1314 | "TERMS_STATUS_STALE" |
| 1315 | ], |
| 1316 | "enumDescriptions": [ |
| 1317 | "Default value. This value should never be set if the enum is present.", |
| 1318 | "None of the company's users have accepted the ToS.", |
| 1319 | "One (or more) of the company's users has accepted the ToS.", |
| 1320 | "None of the company's users has accepted the current ToS but at least one user accepted a previous ToS." |
| 1321 | ], |
| 1322 | "readOnly": true, |
| 1323 | "type": "string" |
| 1324 | } |
| 1325 | } |
| 1326 | }, |
| 1327 | "Configuration": { |
| 1328 | "properties": { |
| 1329 | "contactEmail": { |
| 1330 | "description": "Required. The email address that device users can contact to get help. Zero-touch enrollment shows this email address to device users before device provisioning. The value is validated on input.", |
| 1331 | "type": "string" |
| 1332 | }, |
| 1333 | "dpcExtras": { |
| 1334 | "description": "The JSON-formatted EMM provisioning extras that are passed to the DPC.", |
| 1335 | "type": "string" |
| 1336 | }, |
| 1337 | "dpcResourcePath": { |
| 1338 | "description": "Required. The resource name of the selected DPC (device policy controller) in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs, call `customers.dpcs.list`.", |
| 1339 | "type": "string" |
| 1340 | }, |
| 1341 | "name": { |
| 1342 | "readOnly": true, |
| 1343 | "description": "Output only. The API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by the server.", |
| 1344 | "type": "string" |
| 1345 | }, |
| 1346 | "contactPhone": { |
| 1347 | "type": "string", |
| 1348 | "description": "Required. The telephone number that device users can call, using another device, to get help. Zero-touch enrollment shows this number to device users before device provisioning. Accepts numerals, spaces, the plus sign, hyphens, and parentheses." |
| 1349 | }, |
| 1350 | "configurationId": { |
| 1351 | "type": "string", |
| 1352 | "description": "Output only. The ID of the configuration. Assigned by the server.", |
| 1353 | "readOnly": true, |
| 1354 | "format": "int64" |
| 1355 | }, |
| 1356 | "configurationName": { |
| 1357 | "description": "Required. A short name that describes the configuration's purpose. For example, _Sales team_ or _Temporary employees_. The zero-touch enrollment portal displays this name to IT admins.", |
| 1358 | "type": "string" |
| 1359 | }, |
| 1360 | "customMessage": { |
| 1361 | "description": "A message, containing one or two sentences, to help device users get help or give them more details about what’s happening to their device. Zero-touch enrollment shows this message before the device is provisioned.", |
| 1362 | "type": "string" |
| 1363 | }, |
| 1364 | "companyName": { |
| 1365 | "description": "Required. The name of the organization. Zero-touch enrollment shows this organization name to device users during device provisioning.", |
| 1366 | "type": "string" |
| 1367 | }, |
| 1368 | "isDefault": { |
| 1369 | "type": "boolean", |
| 1370 | "description": "Required. Whether this is the default configuration that zero-touch enrollment applies to any new devices the organization purchases in the future. Only one customer configuration can be the default. Setting this value to `true`, changes the previous default configuration's `isDefault` value to `false`." |
| 1371 | } |
| 1372 | }, |
| 1373 | "type": "object", |
| 1374 | "description": "A configuration collects the provisioning options for Android devices. Each configuration combines the following: * The EMM device policy controller (DPC) installed on the devices. * EMM policies enforced on the devices. * Metadata displayed on the device to help users during setup. Customers can add as many configurations as they need. However, zero-touch enrollment works best when a customer sets a default configuration that's applied to any new devices the organization purchases.", |
| 1375 | "id": "Configuration" |
| 1376 | }, |
| 1377 | "OperationPerDevice": { |
| 1378 | "description": "A task for each device in the operation. Corresponds to each device change in the request.", |
| 1379 | "id": "OperationPerDevice", |
| 1380 | "properties": { |
| 1381 | "unclaim": { |
| 1382 | "$ref": "PartnerUnclaim", |
| 1383 | "description": "A copy of the original device-unclaim request received by the server." |
| 1384 | }, |
| 1385 | "updateMetadata": { |
| 1386 | "description": "A copy of the original metadata-update request received by the server.", |
| 1387 | "$ref": "UpdateMetadataArguments" |
| 1388 | }, |
| 1389 | "result": { |
| 1390 | "description": "The processing result for each device.", |
| 1391 | "$ref": "PerDeviceStatusInBatch" |
| 1392 | }, |
| 1393 | "claim": { |
| 1394 | "description": "A copy of the original device-claim request received by the server.", |
| 1395 | "$ref": "PartnerClaim" |
| 1396 | } |
| 1397 | }, |
| 1398 | "type": "object" |
| 1399 | }, |
| 1400 | "UnclaimDeviceRequest": { |
| 1401 | "type": "object", |
| 1402 | "properties": { |
| 1403 | "sectionType": { |
| 1404 | "enumDescriptions": [ |
| 1405 | "Unspecified section type.", |
| 1406 | "SIM-lock section type.", |
| 1407 | "Zero-touch enrollment section type." |
| 1408 | ], |
| 1409 | "type": "string", |
| 1410 | "enum": [ |
| 1411 | "SECTION_TYPE_UNSPECIFIED", |
| 1412 | "SECTION_TYPE_SIM_LOCK", |
| 1413 | "SECTION_TYPE_ZERO_TOUCH" |
| 1414 | ], |
| 1415 | "description": "Required. The section type of the device's provisioning record." |
| 1416 | }, |
| 1417 | "deviceId": { |
| 1418 | "format": "int64", |
| 1419 | "type": "string", |
| 1420 | "description": "Required. The device ID returned by `ClaimDevice`." |
| 1421 | }, |
| 1422 | "vacationModeDays": { |
| 1423 | "type": "integer", |
| 1424 | "format": "int32", |
| 1425 | "description": "The duration of the vacation unlock starting from when the request is processed. (1 day is treated as 24 hours)" |
| 1426 | }, |
| 1427 | "vacationModeExpireTime": { |
| 1428 | "format": "google-datetime", |
| 1429 | "type": "string", |
| 1430 | "description": "The expiration time of the vacation unlock." |
| 1431 | }, |
| 1432 | "deviceIdentifier": { |
| 1433 | "description": "Required. The device identifier you used when you claimed this device.", |
| 1434 | "$ref": "DeviceIdentifier" |
| 1435 | } |
| 1436 | }, |
| 1437 | "id": "UnclaimDeviceRequest", |
| 1438 | "description": "Request message to unclaim a device." |
| 1439 | }, |
| 1440 | "DevicesLongRunningOperationMetadata": { |
| 1441 | "properties": { |
| 1442 | "progress": { |
| 1443 | "format": "int32", |
| 1444 | "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—check for the inclusion of a `done` field.", |
| 1445 | "type": "integer" |
| 1446 | }, |
| 1447 | "processingStatus": { |
| 1448 | "type": "string", |
| 1449 | "enumDescriptions": [ |
| 1450 | "Invalid code. Shouldn't be used.", |
| 1451 | "Pending.", |
| 1452 | "In progress.", |
| 1453 | "Processed. This doesn't mean all items were processed successfully, you should check the `response` field for the result of every item." |
| 1454 | ], |
| 1455 | "enum": [ |
| 1456 | "BATCH_PROCESS_STATUS_UNSPECIFIED", |
| 1457 | "BATCH_PROCESS_PENDING", |
| 1458 | "BATCH_PROCESS_IN_PROGRESS", |
| 1459 | "BATCH_PROCESS_PROCESSED" |
| 1460 | ], |
| 1461 | "description": "The processing status of the operation." |
| 1462 | }, |
| 1463 | "devicesCount": { |
| 1464 | "description": "The number of metadata updates in the operation. This might be different from the number of updates in the request if the API can't parse some of the updates.", |
| 1465 | "type": "integer", |
| 1466 | "format": "int32" |
| 1467 | } |
| 1468 | }, |
| 1469 | "description": "Tracks the status of a long-running operation to asynchronously update a batch of reseller metadata attached to devices. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).", |
| 1470 | "type": "object", |
| 1471 | "id": "DevicesLongRunningOperationMetadata" |
| 1472 | }, |
| 1473 | "CustomerUnclaimDeviceRequest": { |
| 1474 | "id": "CustomerUnclaimDeviceRequest", |
| 1475 | "properties": { |
| 1476 | "device": { |
| 1477 | "description": "Required. The device to unclaim.", |
| 1478 | "$ref": "DeviceReference" |
| 1479 | } |
| 1480 | }, |
| 1481 | "type": "object", |
| 1482 | "description": "Request message for customer to unclaim a device." |
| 1483 | }, |
| 1484 | "Dpc": { |
| 1485 | "id": "Dpc", |
| 1486 | "type": "object", |
| 1487 | "properties": { |
| 1488 | "dpcName": { |
| 1489 | "description": "Output only. The title of the DPC app in Google Play. For example, _Google Apps Device Policy_. Useful in an application's user interface.", |
| 1490 | "readOnly": true, |
| 1491 | "type": "string" |
| 1492 | }, |
| 1493 | "name": { |
| 1494 | "description": "Output only. The API resource name in the format `customers/[CUSTOMER_ID]/dpcs/[DPC_ID]`. Assigned by the server. To maintain a reference to a DPC across customer accounts, persist and match the last path component (`DPC_ID`).", |
| 1495 | "type": "string", |
| 1496 | "readOnly": true |
| 1497 | }, |
| 1498 | "packageName": { |
| 1499 | "readOnly": true, |
| 1500 | "type": "string", |
| 1501 | "description": "Output only. The DPC's Android application ID that looks like a Java package name. Zero-touch enrollment installs the DPC app onto a device using this identifier." |
| 1502 | } |
| 1503 | }, |
| 1504 | "description": "An EMM's DPC ([device policy controller](http://developer.android.com/work/dpc/build-dpc.html)). Zero-touch enrollment installs a DPC (listed in the `Configuration`) on a device to maintain the customer's mobile policies. All the DPCs listed by the API support zero-touch enrollment and are available in Google Play." |
| 1505 | }, |
| 1506 | "ListVendorsResponse": { |
| 1507 | "type": "object", |
| 1508 | "id": "ListVendorsResponse", |
| 1509 | "properties": { |
| 1510 | "vendors": { |
| 1511 | "type": "array", |
| 1512 | "items": { |
| 1513 | "$ref": "Company" |
| 1514 | }, |
| 1515 | "description": "List of vendors of the reseller partner. Fields `name`, `companyId` and `companyName` are populated to the Company object." |
| 1516 | }, |
| 1517 | "nextPageToken": { |
| 1518 | "description": "A token to retrieve the next page of results. Omitted if no further results are available.", |
| 1519 | "type": "string" |
| 1520 | }, |
| 1521 | "totalSize": { |
| 1522 | "format": "int32", |
| 1523 | "description": "The total count of items in the list irrespective of pagination.", |
| 1524 | "type": "integer" |
| 1525 | } |
| 1526 | }, |
| 1527 | "description": "Response message to list vendors of the partner." |
| 1528 | }, |
| 1529 | "FindDevicesByDeviceIdentifierResponse": { |
| 1530 | "properties": { |
| 1531 | "nextPageToken": { |
| 1532 | "description": "A token used to access the next page of results. Omitted if no further results are available.", |
| 1533 | "type": "string" |
| 1534 | }, |
| 1535 | "totalSize": { |
| 1536 | "type": "integer", |
| 1537 | "description": "The total count of items in the list irrespective of pagination.", |
| 1538 | "format": "int32" |
| 1539 | }, |
| 1540 | "devices": { |
| 1541 | "type": "array", |
| 1542 | "description": "Found devices.", |
| 1543 | "items": { |
| 1544 | "$ref": "Device" |
| 1545 | } |
| 1546 | } |
| 1547 | }, |
| 1548 | "type": "object", |
| 1549 | "description": "Response containing found devices.", |
| 1550 | "id": "FindDevicesByDeviceIdentifierResponse" |
| 1551 | }, |
| 1552 | "Status": { |
| 1553 | "type": "object", |
| 1554 | "description": "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).", |
| 1555 | "properties": { |
| 1556 | "code": { |
| 1557 | "type": "integer", |
| 1558 | "format": "int32", |
| 1559 | "description": "The status code, which should be an enum value of google.rpc.Code." |
| 1560 | }, |
| 1561 | "details": { |
| 1562 | "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", |
| 1563 | "items": { |
| 1564 | "additionalProperties": { |
| 1565 | "type": "any", |
| 1566 | "description": "Properties of the object. Contains field @type with type URL." |
| 1567 | }, |
| 1568 | "type": "object" |
| 1569 | }, |
| 1570 | "type": "array" |
| 1571 | }, |
| 1572 | "message": { |
| 1573 | "description": "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.", |
| 1574 | "type": "string" |
| 1575 | } |
| 1576 | }, |
| 1577 | "id": "Status" |
| 1578 | }, |
| 1579 | "ClaimDevicesRequest": { |
| 1580 | "id": "ClaimDevicesRequest", |
| 1581 | "type": "object", |
| 1582 | "description": "Request to claim devices asynchronously in batch. Claiming a device adds the device to zero-touch enrollment and shows the device in the customer's view of the portal.", |
| 1583 | "properties": { |
| 1584 | "claims": { |
| 1585 | "description": "Required. A list of device claims.", |
| 1586 | "type": "array", |
| 1587 | "items": { |
| 1588 | "$ref": "PartnerClaim" |
| 1589 | } |
| 1590 | } |
| 1591 | } |
| 1592 | }, |
| 1593 | "Device": { |
| 1594 | "id": "Device", |
| 1595 | "description": "An Android device registered for zero-touch enrollment.", |
| 1596 | "type": "object", |
| 1597 | "properties": { |
| 1598 | "deviceId": { |
| 1599 | "description": "Output only. The ID of the device. Assigned by the server.", |
| 1600 | "readOnly": true, |
| 1601 | "format": "int64", |
| 1602 | "type": "string" |
| 1603 | }, |
| 1604 | "deviceMetadata": { |
| 1605 | "$ref": "DeviceMetadata", |
| 1606 | "description": "The metadata attached to the device. Structured as key-value pairs. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata)." |
| 1607 | }, |
| 1608 | "claims": { |
| 1609 | "items": { |
| 1610 | "$ref": "DeviceClaim" |
| 1611 | }, |
| 1612 | "description": "Output only. The provisioning claims for a device. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. Call `partners.devices.unclaim` or `partners.devices.unclaimAsync` to remove the device from zero-touch enrollment.", |
| 1613 | "readOnly": true, |
| 1614 | "type": "array" |
| 1615 | }, |
| 1616 | "name": { |
| 1617 | "type": "string", |
| 1618 | "description": "Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.", |
| 1619 | "readOnly": true |
| 1620 | }, |
| 1621 | "deviceIdentifier": { |
| 1622 | "$ref": "DeviceIdentifier", |
| 1623 | "description": "The hardware IDs that identify a manufactured device. To learn more, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers)." |
| 1624 | }, |
| 1625 | "configuration": { |
| 1626 | "type": "string", |
| 1627 | "description": "Not available to resellers." |
| 1628 | } |
| 1629 | } |
| 1630 | }, |
| 1631 | "CreateCustomerRequest": { |
| 1632 | "description": "Request message to create a customer.", |
| 1633 | "type": "object", |
| 1634 | "properties": { |
| 1635 | "customer": { |
| 1636 | "$ref": "Company", |
| 1637 | "description": "Required. The company data to populate the new customer. Must contain a value for `companyName` and at least one `owner_email` that's associated with a Google Account. The values for `companyId` and `name` must be empty." |
| 1638 | } |
| 1639 | }, |
| 1640 | "id": "CreateCustomerRequest" |
| 1641 | }, |
| 1642 | "FindDevicesByDeviceIdentifierRequest": { |
| 1643 | "type": "object", |
| 1644 | "properties": { |
| 1645 | "pageToken": { |
| 1646 | "type": "string", |
| 1647 | "description": "A token specifying which result page to return." |
| 1648 | }, |
| 1649 | "limit": { |
| 1650 | "type": "string", |
| 1651 | "format": "int64", |
| 1652 | "description": "Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive." |
| 1653 | }, |
| 1654 | "deviceIdentifier": { |
| 1655 | "$ref": "DeviceIdentifier", |
| 1656 | "description": "Required. Required. The device identifier to search for." |
| 1657 | } |
| 1658 | }, |
| 1659 | "description": "Request to find devices.", |
| 1660 | "id": "FindDevicesByDeviceIdentifierRequest" |
| 1661 | }, |
| 1662 | "PerDeviceStatusInBatch": { |
| 1663 | "description": "Captures the processing status for each device in the operation.", |
| 1664 | "properties": { |
| 1665 | "errorIdentifier": { |
| 1666 | "description": "If processing fails, the error type.", |
| 1667 | "type": "string" |
| 1668 | }, |
| 1669 | "status": { |
| 1670 | "description": "The result status of the device after processing.", |
| 1671 | "enum": [ |
| 1672 | "SINGLE_DEVICE_STATUS_UNSPECIFIED", |
| 1673 | "SINGLE_DEVICE_STATUS_UNKNOWN_ERROR", |
| 1674 | "SINGLE_DEVICE_STATUS_OTHER_ERROR", |
| 1675 | "SINGLE_DEVICE_STATUS_SUCCESS", |
| 1676 | "SINGLE_DEVICE_STATUS_PERMISSION_DENIED", |
| 1677 | "SINGLE_DEVICE_STATUS_INVALID_DEVICE_IDENTIFIER", |
| 1678 | "SINGLE_DEVICE_STATUS_INVALID_SECTION_TYPE", |
| 1679 | "SINGLE_DEVICE_STATUS_SECTION_NOT_YOURS" |
| 1680 | ], |
| 1681 | "enumDescriptions": [ |
| 1682 | "Invalid code. Shouldn't be used.", |
| 1683 | "Unknown error. We don't expect this error to occur here.", |
| 1684 | "Other error. We know/expect this error, but there's no defined error code for the error.", |
| 1685 | "Success.", |
| 1686 | "Permission denied.", |
| 1687 | "Invalid device identifier.", |
| 1688 | "Invalid section type.", |
| 1689 | "This section is claimed by another company." |
| 1690 | ], |
| 1691 | "type": "string" |
| 1692 | }, |
| 1693 | "errorMessage": { |
| 1694 | "type": "string", |
| 1695 | "description": "If processing fails, a developer message explaining what went wrong." |
| 1696 | }, |
| 1697 | "deviceId": { |
| 1698 | "format": "int64", |
| 1699 | "type": "string", |
| 1700 | "description": "If processing succeeds, the device ID of the device." |
| 1701 | } |
| 1702 | }, |
| 1703 | "id": "PerDeviceStatusInBatch", |
| 1704 | "type": "object" |
| 1705 | }, |
| 1706 | "PartnerClaim": { |
| 1707 | "id": "PartnerClaim", |
| 1708 | "type": "object", |
| 1709 | "description": "Identifies one claim request.", |
| 1710 | "properties": { |
| 1711 | "customerId": { |
| 1712 | "format": "int64", |
| 1713 | "type": "string", |
| 1714 | "description": "Required. The ID of the customer for whom the device is being claimed." |
| 1715 | }, |
| 1716 | "deviceIdentifier": { |
| 1717 | "$ref": "DeviceIdentifier", |
| 1718 | "description": "Required. Required. Device identifier of the device." |
| 1719 | }, |
| 1720 | "sectionType": { |
| 1721 | "type": "string", |
| 1722 | "enumDescriptions": [ |
| 1723 | "Unspecified section type.", |
| 1724 | "SIM-lock section type.", |
| 1725 | "Zero-touch enrollment section type." |
| 1726 | ], |
| 1727 | "enum": [ |
| 1728 | "SECTION_TYPE_UNSPECIFIED", |
| 1729 | "SECTION_TYPE_SIM_LOCK", |
| 1730 | "SECTION_TYPE_ZERO_TOUCH" |
| 1731 | ], |
| 1732 | "description": "Required. The section type of the device's provisioning record." |
| 1733 | }, |
| 1734 | "deviceMetadata": { |
| 1735 | "$ref": "DeviceMetadata", |
| 1736 | "description": "Required. The metadata to attach to the device at claim." |
| 1737 | } |
| 1738 | } |
| 1739 | }, |
| 1740 | "ListVendorCustomersResponse": { |
| 1741 | "type": "object", |
| 1742 | "properties": { |
| 1743 | "totalSize": { |
| 1744 | "type": "integer", |
| 1745 | "format": "int32", |
| 1746 | "description": "The total count of items in the list irrespective of pagination." |
| 1747 | }, |
| 1748 | "customers": { |
| 1749 | "items": { |
| 1750 | "$ref": "Company" |
| 1751 | }, |
| 1752 | "description": "List of customers of the vendor.", |
| 1753 | "type": "array" |
| 1754 | }, |
| 1755 | "nextPageToken": { |
| 1756 | "description": "A token to retrieve the next page of results. Omitted if no further results are available.", |
| 1757 | "type": "string" |
| 1758 | } |
| 1759 | }, |
| 1760 | "description": "Response message to list customers of the vendor.", |
| 1761 | "id": "ListVendorCustomersResponse" |
| 1762 | }, |
| 1763 | "DeviceReference": { |
| 1764 | "type": "object", |
| 1765 | "description": "A `DeviceReference` is an API abstraction that lets you supply a _device_ argument to a method using one of the following identifier types: * A numeric API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to the manufactured device. Methods that operate on devices take a `DeviceReference` as a parameter type because it's more flexible for the caller. To learn more about device identifiers, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).", |
| 1766 | "id": "DeviceReference", |
| 1767 | "properties": { |
| 1768 | "deviceIdentifier": { |
| 1769 | "description": "The hardware IDs of the device.", |
| 1770 | "$ref": "DeviceIdentifier" |
| 1771 | }, |
| 1772 | "deviceId": { |
| 1773 | "type": "string", |
| 1774 | "description": "The ID of the device.", |
| 1775 | "format": "int64" |
| 1776 | } |
| 1777 | } |
| 1778 | }, |
| 1779 | "ListCustomersResponse": { |
| 1780 | "id": "ListCustomersResponse", |
| 1781 | "description": "Response message of all customers related to this partner.", |
| 1782 | "properties": { |
| 1783 | "nextPageToken": { |
| 1784 | "type": "string", |
| 1785 | "description": "A token to retrieve the next page of results. Omitted if no further results are available." |
| 1786 | }, |
| 1787 | "totalSize": { |
| 1788 | "description": "The total count of items in the list irrespective of pagination.", |
| 1789 | "type": "integer", |
| 1790 | "format": "int32" |
| 1791 | }, |
| 1792 | "customers": { |
| 1793 | "items": { |
| 1794 | "$ref": "Company" |
| 1795 | }, |
| 1796 | "description": "List of customers related to this reseller partner.", |
| 1797 | "type": "array" |
| 1798 | } |
| 1799 | }, |
| 1800 | "type": "object" |
| 1801 | } |
| 1802 | }, |
| 1803 | "id": "androiddeviceprovisioning:v1", |
| 1804 | "ownerName": "Google", |
| 1805 | "fullyEncodeReservedExpansion": true, |
| 1806 | "rootUrl": "https://androiddeviceprovisioning.googleapis.com/" |
| 1807 | } |