/
androiddeviceprovisioning-api.json
1905 lines (1905 loc) · 76.9 KB
/
androiddeviceprovisioning-api.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"basePath": "",
"baseUrl": "https://androiddeviceprovisioning.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Android Provisioning Partner",
"description": "Automates Android zero-touch enrollment for device resellers, customers, and EMMs.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/zero-touch/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "androiddeviceprovisioning:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://androiddeviceprovisioning.mtls.googleapis.com/",
"name": "androiddeviceprovisioning",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"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.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"customers": {
"methods": {
"list": {
"description": "Lists the user's customer accounts.",
"flatPath": "v1/customers",
"httpMethod": "GET",
"id": "androiddeviceprovisioning.customers.list",
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "The maximum number of customers to show in a page of results. A number between 1 and 100 (inclusive).",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token specifying which result page to return. This field has custom validations in ListCustomersRequestValidator",
"location": "query",
"type": "string"
}
},
"path": "v1/customers",
"response": {
"$ref": "CustomerListCustomersResponse"
}
}
},
"resources": {
"configurations": {
"methods": {
"create": {
"description": "Creates a new configuration. Once created, a customer can apply the configuration to devices.",
"flatPath": "v1/customers/{customersId}/configurations",
"httpMethod": "POST",
"id": "androiddeviceprovisioning.customers.configurations.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The customer that manages the configuration. An API resource name in the format `customers/[CUSTOMER_ID]`. This field has custom validation in CreateConfigurationRequestValidator",
"location": "path",
"pattern": "^customers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/configurations",
"request": {
"$ref": "Configuration"
},
"response": {
"$ref": "Configuration"
}
},
"delete": {
"description": "Deletes an unused configuration. The API call fails if the customer has devices with the configuration applied.",
"flatPath": "v1/customers/{customersId}/configurations/{configurationsId}",
"httpMethod": "DELETE",
"id": "androiddeviceprovisioning.customers.configurations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"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.",
"location": "path",
"pattern": "^customers/[^/]+/configurations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
}
},
"get": {
"description": "Gets the details of a configuration.",
"flatPath": "v1/customers/{customersId}/configurations/{configurationsId}",
"httpMethod": "GET",
"id": "androiddeviceprovisioning.customers.configurations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The configuration to get. An API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.",
"location": "path",
"pattern": "^customers/[^/]+/configurations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Configuration"
}
},
"list": {
"description": "Lists a customer's configurations.",
"flatPath": "v1/customers/{customersId}/configurations",
"httpMethod": "GET",
"id": "androiddeviceprovisioning.customers.configurations.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The customer that manages the listed configurations. An API resource name in the format `customers/[CUSTOMER_ID]`.",
"location": "path",
"pattern": "^customers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/configurations",
"response": {
"$ref": "CustomerListConfigurationsResponse"
}
},
"patch": {
"description": "Updates a configuration's field values.",
"flatPath": "v1/customers/{customersId}/configurations/{configurationsId}",
"httpMethod": "PATCH",
"id": "androiddeviceprovisioning.customers.configurations.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. The API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by the server.",
"location": "path",
"pattern": "^customers/[^/]+/configurations/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"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.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "Configuration"
},
"response": {
"$ref": "Configuration"
}
}
}
},
"devices": {
"methods": {
"applyConfiguration": {
"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.",
"flatPath": "v1/customers/{customersId}/devices:applyConfiguration",
"httpMethod": "POST",
"id": "androiddeviceprovisioning.customers.devices.applyConfiguration",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The customer managing the device. An API resource name in the format `customers/[CUSTOMER_ID]`.",
"location": "path",
"pattern": "^customers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/devices:applyConfiguration",
"request": {
"$ref": "CustomerApplyConfigurationRequest"
},
"response": {
"$ref": "Empty"
}
},
"get": {
"description": "Gets the details of a device.",
"flatPath": "v1/customers/{customersId}/devices/{devicesId}",
"httpMethod": "GET",
"id": "androiddeviceprovisioning.customers.devices.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The device to get. An API resource name in the format `customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`.",
"location": "path",
"pattern": "^customers/[^/]+/devices/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Device"
}
},
"list": {
"description": "Lists a customer's devices.",
"flatPath": "v1/customers/{customersId}/devices",
"httpMethod": "GET",
"id": "androiddeviceprovisioning.customers.devices.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.",
"format": "int64",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "A token specifying which result page to return.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The customer managing the devices. An API resource name in the format `customers/[CUSTOMER_ID]`.",
"location": "path",
"pattern": "^customers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/devices",
"response": {
"$ref": "CustomerListDevicesResponse"
}
},
"removeConfiguration": {
"description": "Removes a configuration from device.",
"flatPath": "v1/customers/{customersId}/devices:removeConfiguration",
"httpMethod": "POST",
"id": "androiddeviceprovisioning.customers.devices.removeConfiguration",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The customer managing the device in the format `customers/[CUSTOMER_ID]`.",
"location": "path",
"pattern": "^customers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/devices:removeConfiguration",
"request": {
"$ref": "CustomerRemoveConfigurationRequest"
},
"response": {
"$ref": "Empty"
}
},
"unclaim": {
"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.",
"flatPath": "v1/customers/{customersId}/devices:unclaim",
"httpMethod": "POST",
"id": "androiddeviceprovisioning.customers.devices.unclaim",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The customer managing the device. An API resource name in the format `customers/[CUSTOMER_ID]`.",
"location": "path",
"pattern": "^customers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/devices:unclaim",
"request": {
"$ref": "CustomerUnclaimDeviceRequest"
},
"response": {
"$ref": "Empty"
}
}
}
},
"dpcs": {
"methods": {
"list": {
"description": "Lists the DPCs (device policy controllers) that support zero-touch enrollment.",
"flatPath": "v1/customers/{customersId}/dpcs",
"httpMethod": "GET",
"id": "androiddeviceprovisioning.customers.dpcs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The customer that can use the DPCs in configurations. An API resource name in the format `customers/[CUSTOMER_ID]`.",
"location": "path",
"pattern": "^customers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/dpcs",
"response": {
"$ref": "CustomerListDpcsResponse"
}
}
}
}
}
},
"operations": {
"methods": {
"get": {
"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.",
"flatPath": "v1/operations/{operationsId}",
"httpMethod": "GET",
"id": "androiddeviceprovisioning.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^operations/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
}
}
}
},
"partners": {
"resources": {
"customers": {
"methods": {
"create": {
"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.",
"flatPath": "v1/partners/{partnersId}/customers",
"httpMethod": "POST",
"id": "androiddeviceprovisioning.partners.customers.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource ID in the format `partners/[PARTNER_ID]` that identifies the reseller.",
"location": "path",
"pattern": "^partners/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/customers",
"request": {
"$ref": "CreateCustomerRequest"
},
"response": {
"$ref": "Company"
}
},
"list": {
"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.",
"flatPath": "v1/partners/{partnersId}/customers",
"httpMethod": "GET",
"id": "androiddeviceprovisioning.partners.customers.list",
"parameterOrder": [
"partnerId"
],
"parameters": {
"pageSize": {
"description": "The maximum number of results to be returned. If not specified or 0, all the records are returned.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results returned by the server.",
"location": "query",
"type": "string"
},
"partnerId": {
"description": "Required. The ID of the reseller partner.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/partners/{+partnerId}/customers",
"response": {
"$ref": "ListCustomersResponse"
}
}
}
},
"devices": {
"methods": {
"claim": {
"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.",
"flatPath": "v1/partners/{partnersId}/devices:claim",
"httpMethod": "POST",
"id": "androiddeviceprovisioning.partners.devices.claim",
"parameterOrder": [
"partnerId"
],
"parameters": {
"partnerId": {
"description": "Required. The ID of the reseller partner.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/partners/{+partnerId}/devices:claim",
"request": {
"$ref": "ClaimDeviceRequest"
},
"response": {
"$ref": "ClaimDeviceResponse"
}
},
"claimAsync": {
"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).",
"flatPath": "v1/partners/{partnersId}/devices:claimAsync",
"httpMethod": "POST",
"id": "androiddeviceprovisioning.partners.devices.claimAsync",
"parameterOrder": [
"partnerId"
],
"parameters": {
"partnerId": {
"description": "Required. The ID of the reseller partner.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/partners/{+partnerId}/devices:claimAsync",
"request": {
"$ref": "ClaimDevicesRequest"
},
"response": {
"$ref": "Operation"
}
},
"findByIdentifier": {
"description": "Finds devices by hardware identifiers, such as IMEI.",
"flatPath": "v1/partners/{partnersId}/devices:findByIdentifier",
"httpMethod": "POST",
"id": "androiddeviceprovisioning.partners.devices.findByIdentifier",
"parameterOrder": [
"partnerId"
],
"parameters": {
"partnerId": {
"description": "Required. The ID of the reseller partner.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/partners/{+partnerId}/devices:findByIdentifier",
"request": {
"$ref": "FindDevicesByDeviceIdentifierRequest"
},
"response": {
"$ref": "FindDevicesByDeviceIdentifierResponse"
}
},
"findByOwner": {
"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.",
"flatPath": "v1/partners/{partnersId}/devices:findByOwner",
"httpMethod": "POST",
"id": "androiddeviceprovisioning.partners.devices.findByOwner",
"parameterOrder": [
"partnerId"
],
"parameters": {
"partnerId": {
"description": "Required. The ID of the reseller partner.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/partners/{+partnerId}/devices:findByOwner",
"request": {
"$ref": "FindDevicesByOwnerRequest"
},
"response": {
"$ref": "FindDevicesByOwnerResponse"
}
},
"get": {
"description": "Gets a device.",
"flatPath": "v1/partners/{partnersId}/devices/{devicesId}",
"httpMethod": "GET",
"id": "androiddeviceprovisioning.partners.devices.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The device API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.",
"location": "path",
"pattern": "^partners/[^/]+/devices/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Device"
}
},
"metadata": {
"description": "Updates reseller metadata associated with the device. Android devices only.",
"flatPath": "v1/partners/{partnersId}/devices/{devicesId}/metadata",
"httpMethod": "POST",
"id": "androiddeviceprovisioning.partners.devices.metadata",
"parameterOrder": [
"metadataOwnerId",
"deviceId"
],
"parameters": {
"deviceId": {
"description": "Required. The ID of the device.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"metadataOwnerId": {
"description": "Required. The owner of the newly set metadata. Set this to the partner ID.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/partners/{+metadataOwnerId}/devices/{+deviceId}/metadata",
"request": {
"$ref": "UpdateDeviceMetadataRequest"
},
"response": {
"$ref": "DeviceMetadata"
}
},
"unclaim": {
"description": "Unclaims a device from a customer and removes it from zero-touch enrollment.",
"flatPath": "v1/partners/{partnersId}/devices:unclaim",
"httpMethod": "POST",
"id": "androiddeviceprovisioning.partners.devices.unclaim",
"parameterOrder": [
"partnerId"
],
"parameters": {
"partnerId": {
"description": "Required. The ID of the reseller partner.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/partners/{+partnerId}/devices:unclaim",
"request": {
"$ref": "UnclaimDeviceRequest"
},
"response": {
"$ref": "Empty"
}
},
"unclaimAsync": {
"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).",
"flatPath": "v1/partners/{partnersId}/devices:unclaimAsync",
"httpMethod": "POST",
"id": "androiddeviceprovisioning.partners.devices.unclaimAsync",
"parameterOrder": [
"partnerId"
],
"parameters": {
"partnerId": {
"description": "Required. The reseller partner ID.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/partners/{+partnerId}/devices:unclaimAsync",
"request": {
"$ref": "UnclaimDevicesRequest"
},
"response": {
"$ref": "Operation"
}
},
"updateMetadataAsync": {
"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). Android Devices only.",
"flatPath": "v1/partners/{partnersId}/devices:updateMetadataAsync",
"httpMethod": "POST",
"id": "androiddeviceprovisioning.partners.devices.updateMetadataAsync",
"parameterOrder": [
"partnerId"
],
"parameters": {
"partnerId": {
"description": "Required. The reseller partner ID.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/partners/{+partnerId}/devices:updateMetadataAsync",
"request": {
"$ref": "UpdateDeviceMetadataInBatchRequest"
},
"response": {
"$ref": "Operation"
}
}
}
},
"vendors": {
"methods": {
"list": {
"description": "Lists the vendors of the partner.",
"flatPath": "v1/partners/{partnersId}/vendors",
"httpMethod": "GET",
"id": "androiddeviceprovisioning.partners.vendors.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of results to be returned.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results returned by the server.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name in the format `partners/[PARTNER_ID]`.",
"location": "path",
"pattern": "^partners/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/vendors",
"response": {
"$ref": "ListVendorsResponse"
}
}
},
"resources": {
"customers": {
"methods": {
"list": {
"description": "Lists the customers of the vendor.",
"flatPath": "v1/partners/{partnersId}/vendors/{vendorsId}/customers",
"httpMethod": "GET",
"id": "androiddeviceprovisioning.partners.vendors.customers.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of results to be returned.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results returned by the server.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name in the format `partners/[PARTNER_ID]/vendors/[VENDOR_ID]`.",
"location": "path",
"pattern": "^partners/[^/]+/vendors/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/customers",
"response": {
"$ref": "ListVendorCustomersResponse"
}
}
}
}
}
}
}
}
},
"revision": "20221031",
"rootUrl": "https://androiddeviceprovisioning.googleapis.com/",
"schemas": {
"ClaimDeviceRequest": {
"description": "Request message to claim a device on behalf of a customer.",
"id": "ClaimDeviceRequest",
"properties": {
"customerId": {
"description": "The ID of the customer for whom the device is being claimed.",
"format": "int64",
"type": "string"
},
"deviceIdentifier": {
"$ref": "DeviceIdentifier",
"description": "Required. Required. The device identifier of the device to claim."
},
"deviceMetadata": {
"$ref": "DeviceMetadata",
"description": "Optional. The metadata to attach to the device."
},
"googleWorkspaceCustomerId": {
"description": "The Google Workspace customer ID.",
"type": "string"
},
"preProvisioningToken": {
"description": "Optional. Must and can only be set for Chrome OS devices.",
"type": "string"
},
"sectionType": {
"description": "Required. The section type of the device's provisioning record.",
"enum": [
"SECTION_TYPE_UNSPECIFIED",
"SECTION_TYPE_SIM_LOCK",
"SECTION_TYPE_ZERO_TOUCH"
],
"enumDescriptions": [
"Unspecified section type.",
"SIM-lock section type.",
"Zero-touch enrollment section type."
],
"type": "string"
},
"simlockProfileId": {
"description": "Optional. Must and can only be set when DeviceProvisioningSectionType is SECTION_TYPE_SIM_LOCK. The unique identifier of the SimLock profile (go/simlock/profiles).",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"ClaimDeviceResponse": {
"description": "Response message containing device id of the claim.",
"id": "ClaimDeviceResponse",
"properties": {
"deviceId": {
"description": "The device ID of the claimed device.",
"format": "int64",
"type": "string"
},
"deviceName": {
"description": "The resource name of the device in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.",
"type": "string"
}
},
"type": "object"
},
"ClaimDevicesRequest": {
"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.",
"id": "ClaimDevicesRequest",
"properties": {
"claims": {
"description": "Required. A list of device claims.",
"items": {
"$ref": "PartnerClaim"
},
"type": "array"
}
},
"type": "object"
},
"Company": {
"description": "A reseller, vendor, or customer in the zero-touch reseller and customer APIs.",
"id": "Company",
"properties": {
"adminEmails": {
"description": "Optional. Email address of customer's users in the admin role. Each email address must be associated with a Google Account.",
"items": {
"type": "string"
},
"type": "array"
},
"companyId": {
"description": "Output only. The ID of the company. Assigned by the server.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"companyName": {
"description": "Required. The name of the company. For example _XYZ Corp_. Displayed to the company's employees in the zero-touch enrollment portal.",
"type": "string"
},
"googleWorkspaceAccount": {
"$ref": "GoogleWorkspaceAccount",
"description": "Output only. The Google Workspace account associated with this customer. Only used for customer Companies.",
"readOnly": true
},
"languageCode": {
"description": "Input only. The preferred locale of the customer represented as a BCP47 language code. This field is validated on input and requests containing unsupported language codes will be rejected. Supported language codes: Arabic (ar) Chinese (Hong Kong) (zh-HK) Chinese (Simplified) (zh-CN) Chinese (Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (UK) (en-GB) English (US) (en-US) Filipino (fil) Finnish (fi) French (fr) German (de) Hebrew (iw) Hindi (hi) Hungarian (hu) Indonesian (id) Italian (it) Japanese (ja) Korean (ko) Norwegian (Bokmal) (no) Polish (pl) Portuguese (Brazil) (pt-BR) Portuguese (Portugal) (pt-PT) Russian (ru) Spanish (es) Spanish (Latin America) (es-419) Swedish (sv) Thai (th) Turkish (tr) Ukrainian (uk) Vietnamese (vi)",
"type": "string"
},
"name": {
"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.",
"readOnly": true,
"type": "string"
},
"ownerEmails": {
"description": "Required. Input only. Email address of customer's users in the owner role. At least one `owner_email` is required. Owners share the same access as admins but can also add, delete, and edit your organization's portal users.",
"items": {
"type": "string"
},
"type": "array"
},
"skipWelcomeEmail": {
"description": "Input only. If set to true, welcome email will not be sent to the customer. It is recommended to skip the welcome email if devices will be claimed with additional DEVICE_PROTECTION service, as the customer will receive separate emails at device claim time. This field is ignored if this is not a Zero-touch customer.",
"type": "boolean"
},
"termsStatus": {
"description": "Output only. Whether any user from the company has accepted the latest Terms of Service (ToS). See TermsStatus.",
"enum": [
"TERMS_STATUS_UNSPECIFIED",
"TERMS_STATUS_NOT_ACCEPTED",
"TERMS_STATUS_ACCEPTED",
"TERMS_STATUS_STALE"
],
"enumDescriptions": [
"Default value. This value should never be set if the enum is present.",
"None of the company's users have accepted the ToS.",
"One (or more) of the company's users has accepted the ToS.",
"None of the company's users has accepted the current ToS but at least one user accepted a previous ToS."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"Configuration": {
"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.",
"id": "Configuration",
"properties": {
"companyName": {
"description": "Required. The name of the organization. Zero-touch enrollment shows this organization name to device users during device provisioning.",
"type": "string"
},
"configurationId": {
"description": "Output only. The ID of the configuration. Assigned by the server.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"configurationName": {
"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.",
"type": "string"
},
"contactEmail": {
"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.",
"type": "string"
},
"contactPhone": {
"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.",
"type": "string"
},
"customMessage": {