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