/
androidenterprise-api.json
4812 lines (4812 loc) · 193 KB
/
androidenterprise-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
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/androidenterprise": {
"description": "Manage corporate Android devices"
}
}
}
},
"basePath": "",
"baseUrl": "https://androidenterprise.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Android Enterprise",
"description": "Manages the deployment of apps to Android Enterprise devices.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/android/work/play/emm-api",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "androidenterprise:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://androidenterprise.mtls.googleapis.com/",
"name": "androidenterprise",
"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": {
"devices": {
"methods": {
"forceReportUpload": {
"description": "Uploads a report containing any changes in app states on the device since the last report was generated. You can call this method up to 3 times every 24 hours for a given device. If you exceed the quota, then the Google Play EMM API returns HTTP 429 Too Many Requests.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/forceReportUpload",
"httpMethod": "POST",
"id": "androidenterprise.devices.forceReportUpload",
"parameterOrder": [
"enterpriseId",
"userId",
"deviceId"
],
"parameters": {
"deviceId": {
"description": "The ID of the device.",
"location": "path",
"required": true,
"type": "string"
},
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/forceReportUpload",
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"get": {
"description": "Retrieves the details of a device.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}",
"httpMethod": "GET",
"id": "androidenterprise.devices.get",
"parameterOrder": [
"enterpriseId",
"userId",
"deviceId"
],
"parameters": {
"deviceId": {
"description": "The ID of the device.",
"location": "path",
"required": true,
"type": "string"
},
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}",
"response": {
"$ref": "Device"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"getState": {
"description": "Retrieves whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state",
"httpMethod": "GET",
"id": "androidenterprise.devices.getState",
"parameterOrder": [
"enterpriseId",
"userId",
"deviceId"
],
"parameters": {
"deviceId": {
"description": "The ID of the device.",
"location": "path",
"required": true,
"type": "string"
},
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state",
"response": {
"$ref": "DeviceState"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"list": {
"description": "Retrieves the IDs of all of a user's devices.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices",
"httpMethod": "GET",
"id": "androidenterprise.devices.list",
"parameterOrder": [
"enterpriseId",
"userId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices",
"response": {
"$ref": "DevicesListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"setState": {
"description": "Sets whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state",
"httpMethod": "PUT",
"id": "androidenterprise.devices.setState",
"parameterOrder": [
"enterpriseId",
"userId",
"deviceId"
],
"parameters": {
"deviceId": {
"description": "The ID of the device.",
"location": "path",
"required": true,
"type": "string"
},
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state",
"request": {
"$ref": "DeviceState"
},
"response": {
"$ref": "DeviceState"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"update": {
"description": "Updates the device policy. To ensure the policy is properly enforced, you need to prevent unmanaged accounts from accessing Google Play by setting the allowed_accounts in the managed configuration for the Google Play package. See restrict accounts in Google Play. When provisioning a new device, you should set the device policy using this method before adding the managed Google Play Account to the device, otherwise the policy will not be applied for a short period of time after adding the account to the device.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}",
"httpMethod": "PUT",
"id": "androidenterprise.devices.update",
"parameterOrder": [
"enterpriseId",
"userId",
"deviceId"
],
"parameters": {
"deviceId": {
"description": "The ID of the device.",
"location": "path",
"required": true,
"type": "string"
},
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Mask that identifies which fields to update. If not set, all modifiable fields will be modified. When set in a query parameter, this field should be specified as updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...",
"location": "query",
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}",
"request": {
"$ref": "Device"
},
"response": {
"$ref": "Device"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
}
}
},
"enterprises": {
"methods": {
"acknowledgeNotificationSet": {
"description": "Acknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications.",
"flatPath": "androidenterprise/v1/enterprises/acknowledgeNotificationSet",
"httpMethod": "POST",
"id": "androidenterprise.enterprises.acknowledgeNotificationSet",
"parameterOrder": [],
"parameters": {
"notificationSetId": {
"description": "The notification set ID as returned by Enterprises.PullNotificationSet. This must be provided.",
"location": "query",
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/acknowledgeNotificationSet",
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"completeSignup": {
"description": "Completes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token.",
"flatPath": "androidenterprise/v1/enterprises/completeSignup",
"httpMethod": "POST",
"id": "androidenterprise.enterprises.completeSignup",
"parameterOrder": [],
"parameters": {
"completionToken": {
"description": "The Completion token initially returned by GenerateSignupUrl.",
"location": "query",
"type": "string"
},
"enterpriseToken": {
"description": "The Enterprise token appended to the Callback URL.",
"location": "query",
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/completeSignup",
"response": {
"$ref": "Enterprise"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"createWebToken": {
"description": "Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/createWebToken",
"httpMethod": "POST",
"id": "androidenterprise.enterprises.createWebToken",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/createWebToken",
"request": {
"$ref": "AdministratorWebTokenSpec"
},
"response": {
"$ref": "AdministratorWebToken"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"enroll": {
"description": "Enrolls an enterprise with the calling EMM.",
"flatPath": "androidenterprise/v1/enterprises/enroll",
"httpMethod": "POST",
"id": "androidenterprise.enterprises.enroll",
"parameterOrder": [
"token"
],
"parameters": {
"token": {
"description": "Required. The token provided by the enterprise to register the EMM.",
"location": "query",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/enroll",
"request": {
"$ref": "Enterprise"
},
"response": {
"$ref": "Enterprise"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"generateSignupUrl": {
"description": "Generates a sign-up URL.",
"flatPath": "androidenterprise/v1/enterprises/signupUrl",
"httpMethod": "POST",
"id": "androidenterprise.enterprises.generateSignupUrl",
"parameterOrder": [],
"parameters": {
"callbackUrl": {
"description": "The callback URL to which the Admin will be redirected after successfully creating an enterprise. Before redirecting there the system will add a single query parameter to this URL named \"enterpriseToken\" which will contain an opaque token to be used for the CompleteSignup request. Beware that this means that the URL will be parsed, the parameter added and then a new URL formatted, i.e. there may be some minor formatting changes and, more importantly, the URL must be well-formed so that it can be parsed.",
"location": "query",
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/signupUrl",
"response": {
"$ref": "SignupInfo"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"get": {
"description": "Retrieves the name and domain of an enterprise.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}",
"httpMethod": "GET",
"id": "androidenterprise.enterprises.get",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}",
"response": {
"$ref": "Enterprise"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"getServiceAccount": {
"description": "Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound. The credentials contain private key data and are not stored server-side. This method can only be called after calling Enterprises.Enroll or Enterprises.CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error. Subsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials. Once the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/serviceAccount",
"httpMethod": "GET",
"id": "androidenterprise.enterprises.getServiceAccount",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"keyType": {
"description": "The type of credential to return with the service account. Required.",
"enum": [
"googleCredentials",
"pkcs12"
],
"enumDescriptions": [
"Google Credentials File format.",
"PKCS12 format. The password for the PKCS12 file is 'notasecret'. For more information, see https://tools.ietf.org/html/rfc7292. The data for keys of this type are base64 encoded according to RFC 4648 Section 4. See http://tools.ietf.org/html/rfc4648#section-4."
],
"location": "query",
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/serviceAccount",
"response": {
"$ref": "ServiceAccount"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"getStoreLayout": {
"description": "Returns the store layout for the enterprise. If the store layout has not been set, returns \"basic\" as the store layout type and no homepage.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout",
"httpMethod": "GET",
"id": "androidenterprise.enterprises.getStoreLayout",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout",
"response": {
"$ref": "StoreLayout"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"list": {
"description": "Looks up an enterprise by domain name. This is only supported for enterprises created via the Google-initiated creation flow. Lookup of the id is not needed for enterprises created via the EMM-initiated flow since the EMM learns the enterprise ID in the callback specified in the Enterprises.generateSignupUrl call.",
"flatPath": "androidenterprise/v1/enterprises",
"httpMethod": "GET",
"id": "androidenterprise.enterprises.list",
"parameterOrder": [
"domain"
],
"parameters": {
"domain": {
"description": "Required. The exact primary domain name of the enterprise to look up.",
"location": "query",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises",
"response": {
"$ref": "EnterprisesListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"pullNotificationSet": {
"description": "Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending. A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty. Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy. Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending. If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available.",
"flatPath": "androidenterprise/v1/enterprises/pullNotificationSet",
"httpMethod": "POST",
"id": "androidenterprise.enterprises.pullNotificationSet",
"parameterOrder": [],
"parameters": {
"requestMode": {
"description": "The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.",
"enum": [
"waitForNotifications",
"returnImmediately"
],
"enumDescriptions": [
"Wait until one or more notifications are present.",
"Returns immediately whether notifications are present or not."
],
"location": "query",
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/pullNotificationSet",
"response": {
"$ref": "NotificationSet"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"sendTestPushNotification": {
"description": "Sends a test notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/sendTestPushNotification",
"httpMethod": "POST",
"id": "androidenterprise.enterprises.sendTestPushNotification",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/sendTestPushNotification",
"response": {
"$ref": "EnterprisesSendTestPushNotificationResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"setAccount": {
"description": "Sets the account that will be used to authenticate to the API as the enterprise.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/account",
"httpMethod": "PUT",
"id": "androidenterprise.enterprises.setAccount",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/account",
"request": {
"$ref": "EnterpriseAccount"
},
"response": {
"$ref": "EnterpriseAccount"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"setStoreLayout": {
"description": "Sets the store layout for the enterprise. By default, storeLayoutType is set to \"basic\" and the basic store layout is enabled. The basic layout only contains apps approved by the admin, and that have been added to the available product set for a user (using the setAvailableProductSet call). Apps on the page are sorted in order of their product ID value. If you create a custom store layout (by setting storeLayoutType = \"custom\" and setting a homepage), the basic store layout is disabled.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout",
"httpMethod": "PUT",
"id": "androidenterprise.enterprises.setStoreLayout",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/storeLayout",
"request": {
"$ref": "StoreLayout"
},
"response": {
"$ref": "StoreLayout"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"unenroll": {
"description": "Unenrolls an enterprise from the calling EMM.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/unenroll",
"httpMethod": "POST",
"id": "androidenterprise.enterprises.unenroll",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/unenroll",
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
}
}
},
"entitlements": {
"methods": {
"delete": {
"description": "Removes an entitlement to an app for a user.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
"httpMethod": "DELETE",
"id": "androidenterprise.entitlements.delete",
"parameterOrder": [
"enterpriseId",
"userId",
"entitlementId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"entitlementId": {
"description": "The ID of the entitlement (a product ID), e.g. \"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"get": {
"description": "Retrieves details of an entitlement.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
"httpMethod": "GET",
"id": "androidenterprise.entitlements.get",
"parameterOrder": [
"enterpriseId",
"userId",
"entitlementId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"entitlementId": {
"description": "The ID of the entitlement (a product ID), e.g. \"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
"response": {
"$ref": "Entitlement"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"list": {
"description": "Lists all entitlements for the specified user. Only the ID is set.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements",
"httpMethod": "GET",
"id": "androidenterprise.entitlements.list",
"parameterOrder": [
"enterpriseId",
"userId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements",
"response": {
"$ref": "EntitlementsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"update": {
"description": "Adds or updates an entitlement to an app for a user.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
"httpMethod": "PUT",
"id": "androidenterprise.entitlements.update",
"parameterOrder": [
"enterpriseId",
"userId",
"entitlementId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"entitlementId": {
"description": "The ID of the entitlement (a product ID), e.g. \"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
},
"install": {
"description": "Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.",
"location": "query",
"type": "boolean"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
"request": {
"$ref": "Entitlement"
},
"response": {
"$ref": "Entitlement"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
}
}
},
"grouplicenses": {
"methods": {
"get": {
"description": "Retrieves details of an enterprise's group license for a product.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}",
"httpMethod": "GET",
"id": "androidenterprise.grouplicenses.get",
"parameterOrder": [
"enterpriseId",
"groupLicenseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"groupLicenseId": {
"description": "The ID of the product the group license is for, e.g. \"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}",
"response": {
"$ref": "GroupLicense"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"list": {
"description": "Retrieves IDs of all products for which the enterprise has a group license.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/groupLicenses",
"httpMethod": "GET",
"id": "androidenterprise.grouplicenses.list",
"parameterOrder": [
"enterpriseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/groupLicenses",
"response": {
"$ref": "GroupLicensesListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
}
}
},
"grouplicenseusers": {
"methods": {
"list": {
"description": "Retrieves the IDs of the users who have been granted entitlements under the license.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}/users",
"httpMethod": "GET",
"id": "androidenterprise.grouplicenseusers.list",
"parameterOrder": [
"enterpriseId",
"groupLicenseId"
],
"parameters": {
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"groupLicenseId": {
"description": "The ID of the product the group license is for, e.g. \"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}/users",
"response": {
"$ref": "GroupLicenseUsersListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
}
}
},
"installs": {
"methods": {
"delete": {
"description": "Requests to remove an app from a device. A call to get or list will still show the app as installed on the device until it is actually removed.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
"httpMethod": "DELETE",
"id": "androidenterprise.installs.delete",
"parameterOrder": [
"enterpriseId",
"userId",
"deviceId",
"installId"
],
"parameters": {
"deviceId": {
"description": "The Android ID of the device.",
"location": "path",
"required": true,
"type": "string"
},
"enterpriseId": {
"description": "The ID of the enterprise.",
"location": "path",
"required": true,
"type": "string"
},
"installId": {
"description": "The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"get": {
"description": "Retrieves details of an installation of an app on a device.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
"httpMethod": "GET",
"id": "androidenterprise.installs.get",
"parameterOrder": [
"enterpriseId",
"userId",
"deviceId",