v1.d.ts
127 KB
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace androidmanagement_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* 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.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* 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.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Android Management API
*
* The Android Management API provides remote enterprise management of Android devices and apps.
*
* @example
* const {google} = require('googleapis');
* const androidmanagement = google.androidmanagement('v1');
*
* @namespace androidmanagement
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Androidmanagement
*/
export class Androidmanagement {
context: APIRequestContext;
enterprises: Resource$Enterprises;
signupUrls: Resource$Signupurls;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Configuration for an always-on VPN connection.
*/
export interface Schema$AlwaysOnVpnPackage {
/**
* Disallows networking when the VPN is not connected.
*/
lockdownEnabled?: boolean | null;
/**
* The package name of the VPN app.
*/
packageName?: string | null;
}
/**
* A compliance rule condition which is satisfied if the Android Framework API level on the device doesn't meet a minimum requirement. There can only be one rule with this type of condition per policy.
*/
export interface Schema$ApiLevelCondition {
/**
* The minimum desired Android Framework API level. If the device doesn't meet the minimum requirement, this condition is satisfied. Must be greater than zero.
*/
minApiLevel?: number | null;
}
/**
* Information about an app.
*/
export interface Schema$Application {
/**
* Application tracks visible to the enterprise.
*/
appTracks?: Schema$AppTrackInfo[];
/**
* The set of managed properties available to be pre-configured for the app.
*/
managedProperties?: Schema$ManagedProperty[];
/**
* The name of the app in the form enterprises/{enterpriseId}/applications/{package_name}.
*/
name?: string | null;
/**
* The permissions required by the app.
*/
permissions?: Schema$ApplicationPermission[];
/**
* The title of the app. Localized.
*/
title?: string | null;
}
/**
* An app-related event.
*/
export interface Schema$ApplicationEvent {
/**
* The creation time of the event.
*/
createTime?: string | null;
/**
* App event type.
*/
eventType?: string | null;
}
/**
* A permission required by the app.
*/
export interface Schema$ApplicationPermission {
/**
* A longer description of the permission, providing more detail on what it affects. Localized.
*/
description?: string | null;
/**
* The name of the permission. Localized.
*/
name?: string | null;
/**
* An opaque string uniquely identifying the permission. Not localized.
*/
permissionId?: string | null;
}
/**
* Policy for an individual app.
*/
export interface Schema$ApplicationPolicy {
/**
* List of the app’s track IDs that a device belonging to the enterprise can access. If the list contains multiple track IDs, devices receive the latest version among all accessible tracks. If the list contains no track IDs, devices only have access to the app’s production track. More details about each track are available in AppTrackInfo.
*/
accessibleTrackIds?: string[] | null;
/**
* The default policy for all permissions requested by the app. If specified, this overrides the policy-level default_permission_policy which applies to all apps. It does not override the permission_grants which applies to all apps.
*/
defaultPermissionPolicy?: string | null;
/**
* The scopes delegated to the app from Android Device Policy.
*/
delegatedScopes?: string[] | null;
/**
* Whether the app is disabled. When disabled, the app data is still preserved.
*/
disabled?: boolean | null;
/**
* The type of installation to perform.
*/
installType?: string | null;
/**
* Whether the app is allowed to lock itself in full-screen mode. DEPRECATED. Use InstallType KIOSK or kioskCustomLauncherEnabled to to configure a dedicated device.
*/
lockTaskAllowed?: boolean | null;
/**
* Managed configuration applied to the app. The format for the configuration is dictated by the ManagedProperty values supported by the app. Each field name in the managed configuration must match the key field of the ManagedProperty. The field value must be compatible with the type of the ManagedProperty: <table> <tr><td><i>type</i></td><td><i>JSON value</i></td></tr> <tr><td>BOOL</td><td>true or false</td></tr> <tr><td>STRING</td><td>string</td></tr> <tr><td>INTEGER</td><td>number</td></tr> <tr><td>CHOICE</td><td>string</td></tr> <tr><td>MULTISELECT</td><td>array of strings</td></tr> <tr><td>HIDDEN</td><td>string</td></tr> <tr><td>BUNDLE_ARRAY</td><td>array of objects</td></tr> </table>
*/
managedConfiguration?: {
[key: string]: any;
} | null;
/**
* The managed configurations template for the app, saved from the managed configurations iframe. This field is ignored if managed_configuration is set.
*/
managedConfigurationTemplate?: Schema$ManagedConfigurationTemplate;
/**
* The minimum version of the app that runs on the device. If set, the device attempts to update the app to at least this version code. If the app is not up-to-date, the device will contain a NonComplianceDetail with non_compliance_reason set to APP_NOT_UPDATED. The app must already be published to Google Play with a version code greater than or equal to this value. At most 20 apps may specify a minimum version code per policy.
*/
minimumVersionCode?: number | null;
/**
* The package name of the app. For example, com.google.android.youtube for the YouTube app.
*/
packageName?: string | null;
/**
* Explicit permission grants or denials for the app. These values override the default_permission_policy and permission_grants which apply to all apps.
*/
permissionGrants?: Schema$PermissionGrant[];
}
/**
* Information reported about an installed app.
*/
export interface Schema$ApplicationReport {
/**
* The source of the package.
*/
applicationSource?: string | null;
/**
* The display name of the app.
*/
displayName?: string | null;
/**
* List of app events. The most recent 20 events are stored in the list.
*/
events?: Schema$ApplicationEvent[];
/**
* The package name of the app that installed this app.
*/
installerPackageName?: string | null;
/**
* List of keyed app states reported by the app.
*/
keyedAppStates?: Schema$KeyedAppState[];
/**
* Package name of the app.
*/
packageName?: string | null;
/**
* The SHA-256 hash of the app's APK file, which can be used to verify the app hasn't been modified. Each byte of the hash value is represented as a two-digit hexadecimal number.
*/
packageSha256Hash?: string | null;
/**
* The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number.
*/
signingKeyCertFingerprints?: string[] | null;
/**
* Application state.
*/
state?: string | null;
/**
* The app version code, which can be used to determine whether one version is more recent than another.
*/
versionCode?: number | null;
/**
* The app version as displayed to the user.
*/
versionName?: string | null;
}
/**
* Settings controlling the behavior of application reports.
*/
export interface Schema$ApplicationReportingSettings {
/**
* Whether removed apps are included in application reports.
*/
includeRemovedApps?: boolean | null;
}
/**
* Id to name association of a app track.
*/
export interface Schema$AppTrackInfo {
/**
* The track name associated with the trackId, set in the Play Console. The name is modifiable from Play Console.
*/
trackAlias?: string | null;
/**
* The unmodifiable unique track identifier, taken from the releaseTrackId in the URL of the Play Console page that displays the app’s track information.
*/
trackId?: string | null;
}
/**
* An action to block access to apps and data on a fully managed device or in a work profile. This action also triggers a device or work profile to displays a user-facing notification with information (where possible) on how to correct the compliance issue. Note: wipeAction must also be specified.
*/
export interface Schema$BlockAction {
/**
* Number of days the policy is non-compliant before the device or work profile is blocked. To block access immediately, set to 0. blockAfterDays must be less than wipeAfterDays.
*/
blockAfterDays?: number | null;
}
/**
* A rule for automatically choosing a private key and certificate to authenticate the device to a server.
*/
export interface Schema$ChoosePrivateKeyRule {
/**
* The package names for which outgoing requests are subject to this rule. If no package names are specified, then the rule applies to all packages. For each package name listed, the rule applies to that package and all other packages that shared the same Android UID. The SHA256 hash of the signing key signatures of each package_name will be verified against those provided by Play
*/
packageNames?: string[] | null;
/**
* The alias of the private key to be used.
*/
privateKeyAlias?: string | null;
/**
* The URL pattern to match against the URL of the outgoing request. The pattern may contain asterisk (*) wildcards. Any URL is matched if unspecified.
*/
urlPattern?: string | null;
}
/**
* A command.
*/
export interface Schema$Command {
/**
* The timestamp at which the command was created. The timestamp is automatically generated by the server.
*/
createTime?: string | null;
/**
* The duration for which the command is valid. The command will expire if not executed by the device during this time. The default duration if unspecified is ten minutes. There is no maximum duration.
*/
duration?: string | null;
/**
* If the command failed, an error code explaining the failure. This is not set when the command is cancelled by the caller.
*/
errorCode?: string | null;
/**
* For commands of type RESET_PASSWORD, optionally specifies the new password.
*/
newPassword?: string | null;
/**
* For commands of type RESET_PASSWORD, optionally specifies flags.
*/
resetPasswordFlags?: string[] | null;
/**
* The type of the command.
*/
type?: string | null;
/**
* The resource name of the user that owns the device in the form enterprises/{enterpriseId}/users/{userId}. This is automatically generated by the server based on the device the command is sent to.
*/
userName?: string | null;
}
/**
* A rule declaring which mitigating actions to take when a device is not compliant with its policy. For every rule, there is always an implicit mitigating action to set policy_compliant to false for the Device resource, and display a message on the device indicating that the device is not compliant with its policy. Other mitigating actions may optionally be taken as well, depending on the field values in the rule.
*/
export interface Schema$ComplianceRule {
/**
* A condition which is satisfied if the Android Framework API level on the device doesn't meet a minimum requirement.
*/
apiLevelCondition?: Schema$ApiLevelCondition;
/**
* If set to true, the rule includes a mitigating action to disable apps so that the device is effectively disabled, but app data is preserved. If the device is running an app in locked task mode, the app will be closed and a UI showing the reason for non-compliance will be displayed.
*/
disableApps?: boolean | null;
/**
* A condition which is satisfied if there exists any matching NonComplianceDetail for the device.
*/
nonComplianceDetailCondition?: Schema$NonComplianceDetailCondition;
/**
* If set, the rule includes a mitigating action to disable apps specified in the list, but app data is preserved.
*/
packageNamesToDisable?: string[] | null;
}
/**
* A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch.
*/
export interface Schema$Device {
/**
* The API level of the Android platform version running on the device.
*/
apiLevel?: number | null;
/**
* Reports for apps installed on the device. This information is only available when application_reports_enabled is true in the device's policy.
*/
applicationReports?: Schema$ApplicationReport[];
/**
* The name of the policy currently applied to the device.
*/
appliedPolicyName?: string | null;
/**
* The version of the policy currently applied to the device.
*/
appliedPolicyVersion?: string | null;
/**
* The state currently applied to the device.
*/
appliedState?: string | null;
/**
* Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy.
*/
deviceSettings?: Schema$DeviceSettings;
/**
* If the device state is DISABLED, an optional message that is displayed on the device indicating the reason the device is disabled. This field can be modified by a patch request.
*/
disabledReason?: Schema$UserFacingMessage;
/**
* Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy.
*/
displays?: Schema$Display[];
/**
* The time of device enrollment.
*/
enrollmentTime?: string | null;
/**
* If the device was enrolled with an enrollment token with additional data provided, this field contains that data.
*/
enrollmentTokenData?: string | null;
/**
* If the device was enrolled with an enrollment token, this field contains the name of the token.
*/
enrollmentTokenName?: string | null;
/**
* Detailed information about the device hardware.
*/
hardwareInfo?: Schema$HardwareInfo;
/**
* Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy.
*/
hardwareStatusSamples?: Schema$HardwareStatus[];
/**
* Deprecated.
*/
lastPolicyComplianceReportTime?: string | null;
/**
* The last time the device fetched its policy.
*/
lastPolicySyncTime?: string | null;
/**
* The last time the device sent a status report.
*/
lastStatusReportTime?: string | null;
/**
* The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported.
*/
managementMode?: string | null;
/**
* Events related to memory and storage measurements in chronological order. This information is only available if memoryInfoEnabled is true in the device's policy.
*/
memoryEvents?: Schema$MemoryEvent[];
/**
* Memory information. This information is only available if memoryInfoEnabled is true in the device's policy.
*/
memoryInfo?: Schema$MemoryInfo;
/**
* The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
*/
name?: string | null;
/**
* Device network information. This information is only available if networkInfoEnabled is true in the device's policy.
*/
networkInfo?: Schema$NetworkInfo;
/**
* Details about policy settings that the device is not compliant with.
*/
nonComplianceDetails?: Schema$NonComplianceDetail[];
/**
* Whether the device is compliant with its policy.
*/
policyCompliant?: boolean | null;
/**
* The name of the policy applied to the device, in the form enterprises/{enterpriseId}/policies/{policyId}. If not specified, the policy_name for the device's user is applied. This field can be modified by a patch request. You can specify only the policyId when calling enterprises.devices.patch, as long as the policyId doesn’t contain any slashes. The rest of the policy name is inferred.
*/
policyName?: string | null;
/**
* Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy.
*/
powerManagementEvents?: Schema$PowerManagementEvent[];
/**
* If the same physical device has been enrolled multiple times, this field contains its previous device names. The serial number is used as the unique identifier to determine if the same physical device has enrolled previously. The names are in chronological order.
*/
previousDeviceNames?: string[] | null;
/**
* Device's security posture value that reflects how secure the device is.
*/
securityPosture?: Schema$SecurityPosture;
/**
* Detailed information about the device software. This information is only available if softwareInfoEnabled is true in the device's policy.
*/
softwareInfo?: Schema$SoftwareInfo;
/**
* The state to be applied to the device. This field can be modified by a patch request. Note that when calling enterprises.devices.patch, ACTIVE and DISABLED are the only allowable values. To enter the device into a DELETED state, call enterprises.devices.delete.
*/
state?: string | null;
/**
* Map of selected system properties name and value related to the device. This information is only available if systemPropertiesEnabled is true in the device's policy.
*/
systemProperties?: {
[key: string]: string;
} | null;
/**
* The user who owns the device.
*/
user?: Schema$User;
/**
* The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}.
*/
userName?: string | null;
}
/**
* Information about security related device settings on device.
*/
export interface Schema$DeviceSettings {
/**
* Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device.
*/
adbEnabled?: boolean | null;
/**
* Whether developer mode is enabled on the device.
*/
developmentSettingsEnabled?: boolean | null;
/**
* Encryption status from DevicePolicyManager.
*/
encryptionStatus?: string | null;
/**
* Whether the device is secured with PIN/password.
*/
isDeviceSecure?: boolean | null;
/**
* Whether the storage encryption is enabled.
*/
isEncrypted?: boolean | null;
/**
* Whether installing apps from unknown sources is enabled.
*/
unknownSourcesEnabled?: boolean | null;
/**
* Whether Verify Apps (Google Play Protect (https://support.google.com/googleplay/answer/2812853)) is enabled on the device.
*/
verifyAppsEnabled?: boolean | null;
}
/**
* Device display information.
*/
export interface Schema$Display {
/**
* Display density expressed as dots-per-inch.
*/
density?: number | null;
/**
* Unique display id.
*/
displayId?: number | null;
/**
* Display height in pixels.
*/
height?: number | null;
/**
* Name of the display.
*/
name?: string | null;
/**
* Refresh rate of the display in frames per second.
*/
refreshRate?: number | null;
/**
* State of the display.
*/
state?: string | null;
/**
* Display width in pixels.
*/
width?: number | null;
}
/**
* 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 {}.
*/
export interface Schema$Empty {
}
/**
* An enrollment token.
*/
export interface Schema$EnrollmentToken {
/**
* Optional, arbitrary data associated with the enrollment token. This could contain, for example, the ID of an org unit the device is assigned to after enrollment. After a device enrolls with the token, this data will be exposed in the enrollment_token_data field of the Device resource. The data must be 1024 characters or less; otherwise, the creation request will fail.
*/
additionalData?: string | null;
/**
* The length of time the enrollment token is valid, ranging from 1 minute to 30 days. If not specified, the default duration is 1 hour.
*/
duration?: string | null;
/**
* The expiration time of the token. This is a read-only field generated by the server.
*/
expirationTimestamp?: string | null;
/**
* The name of the enrollment token, which is generated by the server during creation, in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}.
*/
name?: string | null;
/**
* Whether the enrollment token is for one time use only. If the flag is set to true, only one device can use it for registration.
*/
oneTimeOnly?: boolean | null;
/**
* The name of the policy initially applied to the enrolled device, in the form enterprises/{enterpriseId}/policies/{policyId}. If not specified, the policy_name for the device’s user is applied. If user_name is also not specified, enterprises/{enterpriseId}/policies/default is applied by default. When updating this field, you can specify only the policyId as long as the policyId doesn’t contain any slashes. The rest of the policy name will be inferred.
*/
policyName?: string | null;
/**
* A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON.
*/
qrCode?: string | null;
/**
* The user associated with this enrollment token. If it's specified when the enrollment token is created and the user does not exist, the user will be created. This field must not contain personally identifiable information. Only the account_identifier field needs to be set.
*/
user?: Schema$User;
/**
* The token value that's passed to the device and authorizes the device to enroll. This is a read-only field generated by the server.
*/
value?: string | null;
}
/**
* The configuration applied to an enterprise.
*/
export interface Schema$Enterprise {
/**
* Deprecated and unused.
*/
appAutoApprovalEnabled?: boolean | null;
/**
* The types of Google Pub/Sub notifications enabled for the enterprise.
*/
enabledNotificationTypes?: string[] | null;
/**
* The name of the enterprise displayed to users.
*/
enterpriseDisplayName?: string | null;
/**
* An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng.
*/
logo?: Schema$ExternalData;
/**
* The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}.
*/
name?: string | null;
/**
* A color in RGB format that indicates the predominant color to display in the device management app UI. The color components are stored as follows: (red << 16) | (green << 8) | blue, where the value of each component is between 0 and 255, inclusive.
*/
primaryColor?: number | null;
/**
* The topic that Cloud Pub/Sub notifications are published to, in the form projects/{project}/topics/{topic}. This field is only required if Pub/Sub notifications are enabled.
*/
pubsubTopic?: string | null;
/**
* Sign-in details of the enterprise. Maximum of 1 SigninDetail is supported.
*/
signinDetails?: Schema$SigninDetail[];
/**
* Terms and conditions that must be accepted when provisioning a device for this enterprise. A page of terms is generated for each value in this list.
*/
termsAndConditions?: Schema$TermsAndConditions[];
}
/**
* Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash.
*/
export interface Schema$ExternalData {
/**
* The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data.
*/
sha256Hash?: string | null;
/**
* The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn't provide any credentials in the GET request, so the URL must be publicly accessible. Including a long, random component in the URL may be used to prevent attackers from discovering the URL.
*/
url?: string | null;
}
/**
* Information about device hardware. The fields related to temperature thresholds are only available if hardwareStatusEnabled is true in the device's policy.
*/
export interface Schema$HardwareInfo {
/**
* Battery shutdown temperature thresholds in Celsius for each battery on the device.
*/
batteryShutdownTemperatures?: number[] | null;
/**
* Battery throttling temperature thresholds in Celsius for each battery on the device.
*/
batteryThrottlingTemperatures?: number[] | null;
/**
* Brand of the device. For example, Google.
*/
brand?: string | null;
/**
* CPU shutdown temperature thresholds in Celsius for each CPU on the device.
*/
cpuShutdownTemperatures?: number[] | null;
/**
* CPU throttling temperature thresholds in Celsius for each CPU on the device.
*/
cpuThrottlingTemperatures?: number[] | null;
/**
* Baseband version. For example, MDM9625_104662.22.05.34p.
*/
deviceBasebandVersion?: string | null;
/**
* GPU shutdown temperature thresholds in Celsius for each GPU on the device.
*/
gpuShutdownTemperatures?: number[] | null;
/**
* GPU throttling temperature thresholds in Celsius for each GPU on the device.
*/
gpuThrottlingTemperatures?: number[] | null;
/**
* Name of the hardware. For example, Angler.
*/
hardware?: string | null;
/**
* Manufacturer. For example, Motorola.
*/
manufacturer?: string | null;
/**
* The model of the device. For example, Asus Nexus 7.
*/
model?: string | null;
/**
* The device serial number.
*/
serialNumber?: string | null;
/**
* Device skin shutdown temperature thresholds in Celsius.
*/
skinShutdownTemperatures?: number[] | null;
/**
* Device skin throttling temperature thresholds in Celsius.
*/
skinThrottlingTemperatures?: number[] | null;
}
/**
* Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health.
*/
export interface Schema$HardwareStatus {
/**
* Current battery temperatures in Celsius for each battery on the device.
*/
batteryTemperatures?: number[] | null;
/**
* Current CPU temperatures in Celsius for each CPU on the device.
*/
cpuTemperatures?: number[] | null;
/**
* CPU usages in percentage for each core available on the device. Usage is 0 for each unplugged core. Empty array implies that CPU usage is not supported in the system.
*/
cpuUsages?: number[] | null;
/**
* The time the measurements were taken.
*/
createTime?: string | null;
/**
* Fan speeds in RPM for each fan on the device. Empty array means that there are no fans or fan speed is not supported on the system.
*/
fanSpeeds?: number[] | null;
/**
* Current GPU temperatures in Celsius for each GPU on the device.
*/
gpuTemperatures?: number[] | null;
/**
* Current device skin temperatures in Celsius.
*/
skinTemperatures?: number[] | null;
}
/**
* Keyed app state reported by the app.
*/
export interface Schema$KeyedAppState {
/**
* The creation time of the app state on the device.
*/
createTime?: string | null;
/**
* Optionally, a machine-readable value to be read by the EMM. For example, setting values that the admin can choose to query against in the EMM console (e.g. “notify me if the battery_warning data < 10”).
*/
data?: string | null;
/**
* The key for the app state. Acts as a point of reference for what the app is providing state for. For example, when providing managed configuration feedback, this key could be the managed configuration key.
*/
key?: string | null;
/**
* The time the app state was most recently updated.
*/
lastUpdateTime?: string | null;
/**
* Optionally, a free-form message string to explain the app state. If the state was triggered by a particular value (e.g. a managed configuration value), it should be included in the message.
*/
message?: string | null;
/**
* The severity of the app state.
*/
severity?: string | null;
}
/**
* An action to launch an app.
*/
export interface Schema$LaunchAppAction {
/**
* Package name of app to be launched
*/
packageName?: string | null;
}
/**
* Response to a request to list devices for a given enterprise.
*/
export interface Schema$ListDevicesResponse {
/**
* The list of devices.
*/
devices?: Schema$Device[];
/**
* If there are more results, a token to retrieve next page of results.
*/
nextPageToken?: string | null;
}
/**
* The response message for Operations.ListOperations.
*/
export interface Schema$ListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$Operation[];
}
/**
* Response to a request to list policies for a given enterprise.
*/
export interface Schema$ListPoliciesResponse {
/**
* If there are more results, a token to retrieve next page of results.
*/
nextPageToken?: string | null;
/**
* The list of policies.
*/
policies?: Schema$Policy[];
}
/**
* Response to a request to list web apps for a given enterprise.
*/
export interface Schema$ListWebAppsResponse {
/**
* If there are more results, a token to retrieve next page of results.
*/
nextPageToken?: string | null;
/**
* The list of web apps.
*/
webApps?: Schema$WebApp[];
}
/**
* The managed configurations template for the app, saved from the managed configurations iframe.
*/
export interface Schema$ManagedConfigurationTemplate {
/**
* Optional, a map containing <key, value> configuration variables defined for the configuration.
*/
configurationVariables?: {
[key: string]: string;
} | null;
/**
* The ID of the managed configurations template.
*/
templateId?: string | null;
}
/**
* Managed property.
*/
export interface Schema$ManagedProperty {
/**
* The default value of the property. BUNDLE_ARRAY properties don't have a default value.
*/
defaultValue?: any | null;
/**
* A longer description of the property, providing more detail of what it affects. Localized.
*/
description?: string | null;
/**
* For CHOICE or MULTISELECT properties, the list of possible entries.
*/
entries?: Schema$ManagedPropertyEntry[];
/**
* The unique key that the app uses to identify the property, e.g. "com.google.android.gm.fieldname".
*/
key?: string | null;
/**
* For BUNDLE_ARRAY properties, the list of nested properties. A BUNDLE_ARRAY property is at most two levels deep.
*/
nestedProperties?: Schema$ManagedProperty[];
/**
* The name of the property. Localized.
*/
title?: string | null;
/**
* The type of the property.
*/
type?: string | null;
}
/**
* An entry of a managed property.
*/
export interface Schema$ManagedPropertyEntry {
/**
* The human-readable name of the value. Localized.
*/
name?: string | null;
/**
* The machine-readable value of the entry, which should be used in the configuration. Not localized.
*/
value?: string | null;
}
/**
* An event related to memory and storage measurements.
*/
export interface Schema$MemoryEvent {
/**
* The number of free bytes in the medium, or for EXTERNAL_STORAGE_DETECTED, the total capacity in bytes of the storage medium.
*/
byteCount?: string | null;
/**
* The creation time of the event.
*/
createTime?: string | null;
/**
* Event type.
*/
eventType?: string | null;
}
/**
* Information about device memory and storage.
*/
export interface Schema$MemoryInfo {
/**
* Total internal storage on device in bytes.
*/
totalInternalStorage?: string | null;
/**
* Total RAM on device in bytes.
*/
totalRam?: string | null;
}
/**
* Device network info.
*/
export interface Schema$NetworkInfo {
/**
* IMEI number of the GSM device. For example, A1000031212.
*/
imei?: string | null;
/**
* MEID number of the CDMA device. For example, A00000292788E1.
*/
meid?: string | null;
/**
* Alphabetic name of current registered operator. For example, Vodafone.
*/
networkOperatorName?: string | null;
/**
* Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11.
*/
wifiMacAddress?: string | null;
}
/**
* Provides detail about non-compliance with a policy setting.
*/
export interface Schema$NonComplianceDetail {
/**
* If the policy setting could not be applied, the current value of the setting on the device.
*/
currentValue?: any | null;
/**
* For settings with nested fields, if a particular nested field is out of compliance, this specifies the full path to the offending field. The path is formatted in the same way the policy JSON field would be referenced in JavaScript, that is: 1) For object-typed fields, the field name is followed by a dot then by a subfield name. 2) For array-typed fields, the field name is followed by the array index enclosed in brackets. For example, to indicate a problem with the url field in the externalData field in the 3rd application, the path would be applications[2].externalData.url
*/
fieldPath?: string | null;
/**
* If package_name is set and the non-compliance reason is APP_NOT_INSTALLED or APP_NOT_UPDATED, the detailed reason the app can't be installed or updated.
*/
installationFailureReason?: string | null;
/**
* The reason the device is not in compliance with the setting.
*/
nonComplianceReason?: string | null;
/**
* The package name indicating which app is out of compliance, if applicable.
*/
packageName?: string | null;
/**
* The name of the policy setting. This is the JSON field name of a top-level Policy field.
*/
settingName?: string | null;
}
/**
* A compliance rule condition which is satisfied if there exists any matching NonComplianceDetail for the device. A NonComplianceDetail matches a NonComplianceDetailCondition if all the fields which are set within the NonComplianceDetailCondition match the corresponding NonComplianceDetail fields.
*/
export interface Schema$NonComplianceDetailCondition {
/**
* The reason the device is not in compliance with the setting. If not set, then this condition matches any reason.
*/
nonComplianceReason?: string | null;
/**
* The package name of the app that's out of compliance. If not set, then this condition matches any package name.
*/
packageName?: string | null;
/**
* The name of the policy setting. This is the JSON field name of a top-level Policy field. If not set, then this condition matches any setting name.
*/
settingName?: string | null;
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
* 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.
*/
done?: boolean | null;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* 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}.
*/
name?: string | null;
/**
* The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
*/
response?: {
[key: string]: any;
} | null;
}
/**
* A list of package names.
*/
export interface Schema$PackageNameList {
/**
* A list of package names.
*/
packageNames?: string[] | null;
}
/**
* Requirements for the password used to unlock a device.
*/
export interface Schema$PasswordRequirements {
/**
* Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction.
*/
maximumFailedPasswordsForWipe?: number | null;
/**
* Password expiration timeout.
*/
passwordExpirationTimeout?: string | null;
/**
* The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction.
*/
passwordHistoryLength?: number | null;
/**
* The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX.
*/
passwordMinimumLength?: number | null;
/**
* Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX.
*/
passwordMinimumLetters?: number | null;
/**
* Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX.
*/
passwordMinimumLowerCase?: number | null;
/**
* Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX.
*/
passwordMinimumNonLetter?: number | null;
/**
* Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX.
*/
passwordMinimumNumeric?: number | null;
/**
* Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX.
*/
passwordMinimumSymbols?: number | null;
/**
* Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX.
*/
passwordMinimumUpperCase?: number | null;
/**
* The required password quality.
*/
passwordQuality?: string | null;
/**
* The scope that the password requirement applies to.
*/
passwordScope?: string | null;
}
/**
* Configuration for an Android permission and its grant state.
*/
export interface Schema$PermissionGrant {
/**
* The Android permission or group, e.g. android.permission.READ_CALENDAR or android.permission_group.CALENDAR.
*/
permission?: string | null;
/**
* The policy for granting the permission.
*/
policy?: string | null;
}
/**
* A default activity for handling intents that match a particular intent filter. Note: To set up a kiosk, use InstallType to KIOSK rather than use persistent preferred activities.
*/
export interface Schema$PersistentPreferredActivity {
/**
* The intent actions to match in the filter. If any actions are included in the filter, then an intent's action must be one of those values for it to match. If no actions are included, the intent action is ignored.
*/
actions?: string[] | null;
/**
* The intent categories to match in the filter. An intent includes the categories that it requires, all of which must be included in the filter in order to match. In other words, adding a category to the filter has no impact on matching unless that category is specified in the intent.
*/
categories?: string[] | null;
/**
* The activity that should be the default intent handler. This should be an Android component name, e.g. com.android.enterprise.app/.MainActivity. Alternatively, the value may be the package name of an app, which causes Android Device Policy to choose an appropriate activity from the app to handle the intent.
*/
receiverActivity?: string | null;
}
/**
* A policy resource represents a group of settings that govern the behavior of a managed device and the apps installed on it.
*/
export interface Schema$Policy {
/**
* Account types that can't be managed by the user.
*/
accountTypesWithManagementDisabled?: string[] | null;
/**
* Whether adding new users and profiles is disabled.
*/
addUserDisabled?: boolean | null;
/**
* Whether adjusting the master volume is disabled.
*/
adjustVolumeDisabled?: boolean | null;
/**
* Configuration for an always-on VPN connection. Use with vpn_config_disabled to prevent modification of this setting.
*/
alwaysOnVpnPackage?: Schema$AlwaysOnVpnPackage;
/**
* The app tracks for Android Device Policy the device can access. The device receives the latest version among all accessible tracks. If no tracks are specified, then the device only uses the production track.
*/
androidDevicePolicyTracks?: string[] | null;
/**
* The app auto update policy, which controls when automatic app updates can be applied.
*/
appAutoUpdatePolicy?: string | null;
/**
* Policy applied to apps.
*/
applications?: Schema$ApplicationPolicy[];
/**
* Whether auto time is required, which prevents the user from manually setting the date and time.
*/
autoTimeRequired?: boolean | null;
/**
* Whether applications other than the ones configured in applications are blocked from being installed. When set, applications that were installed under a previous policy but no longer appear in the policy are automatically uninstalled.
*/
blockApplicationsEnabled?: boolean | null;
/**
* Whether configuring bluetooth is disabled.
*/
bluetoothConfigDisabled?: boolean | null;
/**
* Whether bluetooth contact sharing is disabled.
*/
bluetoothContactSharingDisabled?: boolean | null;
/**
* Whether bluetooth is disabled. Prefer this setting over bluetooth_config_disabled because bluetooth_config_disabled can be bypassed by the user.
*/
bluetoothDisabled?: boolean | null;
/**
* Whether all cameras on the device are disabled.
*/
cameraDisabled?: boolean | null;
/**
* Whether configuring cell broadcast is disabled.
*/
cellBroadcastsConfigDisabled?: boolean | null;
/**
* Rules for automatically choosing a private key and certificate to authenticate the device to a server. The rules are ordered by increasing precedence, so if an outgoing request matches more than one rule, the last rule defines which private key to use.
*/
choosePrivateKeyRules?: Schema$ChoosePrivateKeyRule[];
/**
* Rules declaring which mitigating actions to take when a device is not compliant with its policy. When the conditions for multiple rules are satisfied, all of the mitigating actions for the rules are taken. There is a maximum limit of 100 rules. Use policy enforcement rules instead.
*/
complianceRules?: Schema$ComplianceRule[];
/**
* Whether creating windows besides app windows is disabled.
*/
createWindowsDisabled?: boolean | null;
/**
* Whether configuring user credentials is disabled.
*/
credentialsConfigDisabled?: boolean | null;
/**
* Whether roaming data services are disabled.
*/
dataRoamingDisabled?: boolean | null;
/**
* Whether the user is allowed to enable debugging features.
*/
debuggingFeaturesAllowed?: boolean | null;
/**
* The default permission policy for runtime permission requests.
*/
defaultPermissionPolicy?: string | null;
/**
* The device owner information to be shown on the lock screen.
*/
deviceOwnerLockScreenInfo?: Schema$UserFacingMessage;
/**
* Whether encryption is enabled
*/
encryptionPolicy?: string | null;
/**
* Whether app verification is force-enabled.
*/
ensureVerifyAppsEnabled?: boolean | null;
/**
* Whether factory resetting from settings is disabled.
*/
factoryResetDisabled?: boolean | null;
/**
* Email addresses of device administrators for factory reset protection. When the device is factory reset, it will require one of these admins to log in with the Google account email and password to unlock the device. If no admins are specified, the device won't provide factory reset protection.
*/
frpAdminEmails?: string[] | null;
/**
* Whether the user is allowed to have fun. Controls whether the Easter egg game in Settings is disabled.
*/
funDisabled?: boolean | null;
/**
* Whether user installation of apps is disabled.
*/
installAppsDisabled?: boolean | null;
/**
* Whether the user is allowed to enable the "Unknown Sources" setting, which allows installation of apps from unknown sources.
*/
installUnknownSourcesAllowed?: boolean | null;
/**
* Whether the keyguard is disabled.
*/
keyguardDisabled?: boolean | null;
/**
* Disabled keyguard customizations, such as widgets.
*/
keyguardDisabledFeatures?: string[] | null;
/**
* Whether the kiosk custom launcher is enabled. This replaces the home screen with a launcher that locks down the device to the apps installed via the applications setting. Apps appear on a single page in alphabetical order. The status bar is disabled when this is set.
*/
kioskCustomLauncherEnabled?: boolean | null;
/**
* The degree of location detection enabled. The user may change the value unless the user is otherwise blocked from accessing device settings.
*/
locationMode?: string | null;
/**
* A message displayed to the user in the device administators settings screen.
*/
longSupportMessage?: Schema$UserFacingMessage;
/**
* Maximum time in milliseconds for user activity until the device locks. A value of 0 means there is no restriction.
*/
maximumTimeToLock?: string | null;
/**
* The minimum allowed Android API level.
*/
minimumApiLevel?: number | null;
/**
* Whether configuring mobile networks is disabled.
*/
mobileNetworksConfigDisabled?: boolean | null;
/**
* Whether adding or removing accounts is disabled.
*/
modifyAccountsDisabled?: boolean | null;
/**
* Whether the user mounting physical external media is disabled.
*/
mountPhysicalMediaDisabled?: boolean | null;
/**
* The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}.
*/
name?: string | null;
/**
* Whether the network escape hatch is enabled. If a network connection can't be made at boot time, the escape hatch prompts the user to temporarily connect to a network in order to refresh the device policy. After applying policy, the temporary network will be forgotten and the device will continue booting. This prevents being unable to connect to a network if there is no suitable network in the last policy and the device boots into an app in lock task mode, or the user is otherwise unable to reach device settings.
*/
networkEscapeHatchEnabled?: boolean | null;
/**
* Whether resetting network settings is disabled.
*/
networkResetDisabled?: boolean | null;
/**
* Network configuration for the device. See configure networks for more information.
*/
openNetworkConfiguration?: {
[key: string]: any;
} | null;
/**
* Whether using NFC to beam data from apps is disabled.
*/
outgoingBeamDisabled?: boolean | null;
/**
* Whether outgoing calls are disabled.
*/
outgoingCallsDisabled?: boolean | null;
/**
* Password requirement policies. Different policies can be set for work profile or fully managed devices by setting the password_scope field in the policy.
*/
passwordPolicies?: Schema$PasswordRequirements[];
/**
* Password requirements. DEPRECATED - Use password_policies
*/
passwordRequirements?: Schema$PasswordRequirements;
/**
* Explicit permission or group grants or denials for all apps. These values override the default_permission_policy.
*/
permissionGrants?: Schema$PermissionGrant[];
/**
* Specifies permitted accessibility services. If the field is not set, any accessibility service can be used. If the field is set, only the accessibility services in this list and the system's built-in accessibility service can be used. In particular, if the field is set to empty, only the system's built-in accessibility servicess can be used.
*/
permittedAccessibilityServices?: Schema$PackageNameList;
/**
* If present, only the input methods provided by packages in this list are permitted. If this field is present, but the list is empty, then only system input methods are permitted.
*/
permittedInputMethods?: Schema$PackageNameList;
/**
* Default intent handler activities.
*/
persistentPreferredActivities?: Schema$PersistentPreferredActivity[];
/**
* This mode controls which apps are available to the user in the Play Store and the behavior on the device when apps are removed from the policy.
*/
playStoreMode?: string | null;
/**
* Rules that define the behavior when a particular policy can not be applied on device
*/
policyEnforcementRules?: Schema$PolicyEnforcementRule[];
/**
* Allows showing UI on a device for a user to choose a private key alias if there are no matching rules in ChoosePrivateKeyRules. For devices below Android P, setting this may leave enterprise keys vulnerable.
*/
privateKeySelectionEnabled?: boolean | null;
/**
* The network-independent global HTTP proxy. Typically proxies should be configured per-network in open_network_configuration. However for unusual configurations like general internal filtering a global HTTP proxy may be useful. If the proxy is not accessible, network access may break. The global proxy is only a recommendation and some apps may ignore it.
*/
recommendedGlobalProxy?: Schema$ProxyInfo;
/**
* Whether removing other users is disabled.
*/
removeUserDisabled?: boolean | null;
/**
* Whether rebooting the device into safe boot is disabled.
*/
safeBootDisabled?: boolean | null;
/**
* Whether screen capture is disabled.
*/
screenCaptureDisabled?: boolean | null;
/**
* Actions to take during the setup process.
*/
setupActions?: Schema$SetupAction[];
/**
* Whether changing the user icon is disabled.
*/
setUserIconDisabled?: boolean | null;
/**
* Whether changing the wallpaper is disabled.
*/
setWallpaperDisabled?: boolean | null;
/**
* Whether location sharing is disabled.
*/
shareLocationDisabled?: boolean | null;
/**
* A message displayed to the user in the settings screen wherever functionality has been disabled by the admin.
*/
shortSupportMessage?: Schema$UserFacingMessage;
/**
* Flag to skip hints on the first use. Enterprise admin can enable the system recommendation for apps to skip their user tutorial and other introductory hints on first start-up.
*/
skipFirstUseHintsEnabled?: boolean | null;
/**
* Whether sending and receiving SMS messages is disabled.
*/
smsDisabled?: boolean | null;
/**
* Whether the status bar is disabled. This disables notifications, quick settings, and other screen overlays that allow escape from full-screen mode. DEPRECATED. To disable the status bar on a kiosk device, use InstallType KIOSK or kioskCustomLauncherEnabled.
*/
statusBarDisabled?: boolean | null;
/**
* Status reporting settings
*/
statusReportingSettings?: Schema$StatusReportingSettings;
/**
* The battery plugged in modes for which the device stays on. When using this setting, it is recommended to clear maximum_time_to_lock so that the device doesn't lock itself while it stays on.
*/
stayOnPluggedModes?: string[] | null;
/**
* The system update policy, which controls how OS updates are applied. If the update type is WINDOWED, the update window will automatically apply to Play app updates as well.
*/
systemUpdate?: Schema$SystemUpdate;
/**
* Whether configuring tethering and portable hotspots is disabled.
*/
tetheringConfigDisabled?: boolean | null;
/**
* Whether user uninstallation of applications is disabled.
*/
uninstallAppsDisabled?: boolean | null;
/**
* Whether the microphone is muted and adjusting microphone volume is disabled.
*/
unmuteMicrophoneDisabled?: boolean | null;
/**
* Whether transferring files over USB is disabled.
*/
usbFileTransferDisabled?: boolean | null;
/**
* Whether USB storage is enabled. Deprecated.
*/
usbMassStorageEnabled?: boolean | null;
/**
* The version of the policy. This is a read-only field. The version is incremented each time the policy is updated.
*/
version?: string | null;
/**
* Whether configuring VPN is disabled.
*/
vpnConfigDisabled?: boolean | null;
/**
* Whether configuring Wi-Fi access points is disabled.
*/
wifiConfigDisabled?: boolean | null;
/**
* DEPRECATED - Use wifi_config_disabled.
*/
wifiConfigsLockdownEnabled?: boolean | null;
}
/**
* A rule that defines the actions to take if a device or work profile is not compliant with the policy specified in settingName.
*/
export interface Schema$PolicyEnforcementRule {
/**
* An action to block access to apps and data on a fully managed device or in a work profile. This action also triggers a user-facing notification with information (where possible) on how to correct the compliance issue. Note: wipeAction must also be specified.
*/
blockAction?: Schema$BlockAction;
/**
* The top-level policy to enforce. For example, applications or passwordPolicies.
*/
settingName?: string | null;
/**
* An action to reset a fully managed device or delete a work profile. Note: blockAction must also be specified.
*/
wipeAction?: Schema$WipeAction;
}
/**
* Additional details regarding the security posture of the device.
*/
export interface Schema$PostureDetail {
/**
* Corresponding admin-facing advice to mitigate this security risk and improve the security posture of the device.
*/
advice?: Schema$UserFacingMessage[];
/**
* A specific security risk that negatively affects the security posture of the device.
*/
securityRisk?: string | null;
}
/**
* A power management event.
*/
export interface Schema$PowerManagementEvent {
/**
* For BATTERY_LEVEL_COLLECTED events, the battery level as a percentage.
*/
batteryLevel?: number | null;
/**
* The creation time of the event.
*/
createTime?: string | null;
/**
* Event type.
*/
eventType?: string | null;
}
/**
* Configuration info for an HTTP proxy. For a direct proxy, set the host, port, and excluded_hosts fields. For a PAC script proxy, set the pac_uri field.
*/
export interface Schema$ProxyInfo {
/**
* For a direct proxy, the hosts for which the proxy is bypassed. The host names may contain wildcards such as *.example.com.
*/
excludedHosts?: string[] | null;
/**
* The host of the direct proxy.
*/
host?: string | null;
/**
* The URI of the PAC script used to configure the proxy.
*/
pacUri?: string | null;
/**
* The port of the direct proxy.
*/
port?: number | null;
}
/**
* The security posture of the device, as determined by the current device state and the policies applied.
*/
export interface Schema$SecurityPosture {
/**
* Device's security posture value.
*/
devicePosture?: string | null;
/**
* Additional details regarding the security posture of the device.
*/
postureDetails?: Schema$PostureDetail[];
}
/**
* An action executed during setup.
*/
export interface Schema$SetupAction {
/**
* Description of this action.
*/
description?: Schema$UserFacingMessage;
/**
* An action to launch an app.
*/
launchApp?: Schema$LaunchAppAction;
/**
* Title of this action.
*/
title?: Schema$UserFacingMessage;
}
/**
* A resource containing sign in details for an enterprise.
*/
export interface Schema$SigninDetail {
/**
* A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON. This is a read-only field generated by the server.
*/
qrCode?: string | null;
/**
* An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server.
*/
signinEnrollmentToken?: string | null;
/**
* Sign-in URL for authentication when device is provisioned with a sign-in enrollment token. The sign-in endpoint should finish authentication flow with a URL in the form of https://enterprise.google.com/android/enroll?et=<token> for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login.
*/
signinUrl?: string | null;
}
/**
* An enterprise signup URL.
*/
export interface Schema$SignupUrl {
/**
* The name of the resource. Use this value in the signupUrl field when calling enterprises.create to complete the enterprise signup flow.
*/
name?: string | null;
/**
* A URL where an enterprise admin can register their enterprise. The page can't be rendered in an iframe.
*/
url?: string | null;
}
/**
* Information about device software.
*/
export interface Schema$SoftwareInfo {
/**
* Android build ID string meant for displaying to the user. For example, shamu-userdebug 6.0.1 MOB30I 2756745 dev-keys.
*/
androidBuildNumber?: string | null;
/**
* Build time.
*/
androidBuildTime?: string | null;
/**
* The Android Device Policy app version code.
*/
androidDevicePolicyVersionCode?: number | null;
/**
* The Android Device Policy app version as displayed to the user.
*/
androidDevicePolicyVersionName?: string | null;
/**
* The user-visible Android version string. For example, 6.0.1.
*/
androidVersion?: string | null;
/**
* The system bootloader version number, e.g. 0.6.7.
*/
bootloaderVersion?: string | null;
/**
* SHA-256 hash of android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the system package, which can be used to verify that the system build hasn't been modified.
*/
deviceBuildSignature?: string | null;
/**
* Kernel version, for example, 2.6.32.9-g103d848.
*/
deviceKernelVersion?: string | null;
/**
* An IETF BCP 47 language code for the primary locale on the device.
*/
primaryLanguageCode?: string | null;
/**
* Security patch level, e.g. 2016-05-01.
*/
securityPatchLevel?: string | null;
}
/**
* 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).
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}> | null;
/**
* 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.
*/
message?: string | null;
}
/**
* Settings controlling the behavior of status reports.
*/
export interface Schema$StatusReportingSettings {
/**
* Application reporting settings. Only applicable if application_reports_enabled is true.
*/
applicationReportingSettings?: Schema$ApplicationReportingSettings;
/**
* Whether app reports are enabled.
*/
applicationReportsEnabled?: boolean | null;
/**
* Whether device settings reporting is enabled.
*/
deviceSettingsEnabled?: boolean | null;
/**
* Whether displays reporting is enabled.
*/
displayInfoEnabled?: boolean | null;
/**
* Whether hardware status reporting is enabled.
*/
hardwareStatusEnabled?: boolean | null;
/**
* Whether memory reporting is enabled.
*/
memoryInfoEnabled?: boolean | null;
/**
* Whether network info reporting is enabled.
*/
networkInfoEnabled?: boolean | null;
/**
* Whether power management event reporting is enabled.
*/
powerManagementEventsEnabled?: boolean | null;
/**
* Whether software info reporting is enabled.
*/
softwareInfoEnabled?: boolean | null;
/**
* Whether system properties reporting is enabled.
*/
systemPropertiesEnabled?: boolean | null;
}
/**
* Configuration for managing system updates
*/
export interface Schema$SystemUpdate {
/**
* If the type is WINDOWED, the end of the maintenance window, measured as the number of minutes after midnight in device's local time. This value must be between 0 and 1439, inclusive. If this value is less than start_minutes, then the maintenance window spans midnight. If the maintenance window specified is smaller than 30 minutes, the actual window is extended to 30 minutes beyond the start time.
*/
endMinutes?: number | null;
/**
* If the type is WINDOWED, the start of the maintenance window, measured as the number of minutes after midnight in the device's local time. This value must be between 0 and 1439, inclusive.
*/
startMinutes?: number | null;
/**
* The type of system update to configure.
*/
type?: string | null;
}
/**
* A terms and conditions page to be accepted during provisioning.
*/
export interface Schema$TermsAndConditions {
/**
* A well-formatted HTML string. It will be parsed on the client with android.text.Html#fromHtml.
*/
content?: Schema$UserFacingMessage;
/**
* A short header which appears above the HTML content.
*/
header?: Schema$UserFacingMessage;
}
/**
* A user belonging to an enterprise.
*/
export interface Schema$User {
/**
* A unique identifier you create for this user, such as user342 or asset#44418. This field must be set when the user is created and can't be updated. This field must not contain personally identifiable information (PII). This identifier must be 1024 characters or less; otherwise, the update policy request will fail.
*/
accountIdentifier?: string | null;
}
/**
* Provides a user-facing message with locale info. The maximum message length is 4096 characters.
*/
export interface Schema$UserFacingMessage {
/**
* The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
*/
defaultMessage?: string | null;
/**
* A map containing <locale, message> pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
*/
localizedMessages?: {
[key: string]: string;
} | null;
}
/**
* A web app.
*/
export interface Schema$WebApp {
/**
* The display mode of the web app.
*/
displayMode?: string | null;
/**
* A list of icons for the web app. Must have at least one element.
*/
icons?: Schema$WebAppIcon[];
/**
* The name of the web app, which is generated by the server during creation in the form enterprises/{enterpriseId}/webApps/{packageName}.
*/
name?: string | null;
/**
* The start URL, i.e. the URL that should load when the user opens the application.
*/
startUrl?: string | null;
/**
* The title of the web app as displayed to the user (e.g., amongst a list of other applications, or as a label for an icon).
*/
title?: string | null;
/**
* The current version of the app.Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date.
*/
versionCode?: string | null;
}
/**
* An icon for a web app. Supported formats are: png, jpg and webp.
*/
export interface Schema$WebAppIcon {
/**
* The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe Alphabet"). <ul> <li>The image type can be png or jpg. <li>The image should ideally be square. <li>The image should ideally have a size of 512x512. </ul>
*/
imageData?: string | null;
}
/**
* A web token used to access the managed Google Play iframe.
*/
export interface Schema$WebToken {
/**
* The features to enable. Use this if you want to control exactly which feature(s) will be activated; leave empty to allow all features.Restrictions / things to note: <ul> <li> If no features are listed here, all features are enabled — this is the default behavior where you give access to all features to your admins. <li> This must not contain any FEATURE_UNSPECIFIED values. <li> Repeated values are ignored </ul>
*/
enabledFeatures?: string[] | null;
/**
* The name of the web token, which is generated by the server during creation in the form enterprises/{enterpriseId}/webTokens/{webTokenId}.
*/
name?: string | null;
/**
* The URL of the parent frame hosting the iframe with the embedded UI. To prevent XSS, the iframe may not be hosted at other URLs. The URL must use the https scheme.
*/
parentFrameUrl?: string | null;
/**
* Permissions available to an admin in the embedded UI. An admin must have all of these permissions in order to view the UI. This field is deprecated.
*/
permissions?: string[] | null;
/**
* The token value which is used in the hosting page to generate the iframe with the embedded UI. This is a read-only field generated by the server.
*/
value?: string | null;
}
/**
* An action to reset a fully managed device or delete a work profile. Note: blockAction must also be specified.
*/
export interface Schema$WipeAction {
/**
* Whether the factory-reset protection data is preserved on the device. This setting doesn’t apply to work profiles.
*/
preserveFrp?: boolean | null;
/**
* Number of days the policy is non-compliant before the device or work profile is wiped. wipeAfterDays must be greater than blockAfterDays.
*/
wipeAfterDays?: number | null;
}
export class Resource$Enterprises {
context: APIRequestContext;
applications: Resource$Enterprises$Applications;
devices: Resource$Enterprises$Devices;
enrollmentTokens: Resource$Enterprises$Enrollmenttokens;
policies: Resource$Enterprises$Policies;
webApps: Resource$Enterprises$Webapps;
webTokens: Resource$Enterprises$Webtokens;
constructor(context: APIRequestContext);
/**
* androidmanagement.enterprises.create
* @desc Creates an enterprise. This is the last step in the enterprise signup flow.
* @alias androidmanagement.enterprises.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.enterpriseToken The enterprise token appended to the callback URL.
* @param {string=} params.projectId The ID of the Google Cloud Platform project which will own the enterprise.
* @param {string=} params.signupUrlName The name of the SignupUrl used to sign up for the enterprise.
* @param {().Enterprise} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Enterprises$Create, options?: MethodOptions): GaxiosPromise<Schema$Enterprise>;
create(params: Params$Resource$Enterprises$Create, options: MethodOptions | BodyResponseCallback<Schema$Enterprise>, callback: BodyResponseCallback<Schema$Enterprise>): void;
create(params: Params$Resource$Enterprises$Create, callback: BodyResponseCallback<Schema$Enterprise>): void;
create(callback: BodyResponseCallback<Schema$Enterprise>): void;
/**
* androidmanagement.enterprises.get
* @desc Gets an enterprise.
* @alias androidmanagement.enterprises.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the enterprise in the form enterprises/{enterpriseId}.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Enterprises$Get, options?: MethodOptions): GaxiosPromise<Schema$Enterprise>;
get(params: Params$Resource$Enterprises$Get, options: MethodOptions | BodyResponseCallback<Schema$Enterprise>, callback: BodyResponseCallback<Schema$Enterprise>): void;
get(params: Params$Resource$Enterprises$Get, callback: BodyResponseCallback<Schema$Enterprise>): void;
get(callback: BodyResponseCallback<Schema$Enterprise>): void;
/**
* androidmanagement.enterprises.patch
* @desc Updates an enterprise.
* @alias androidmanagement.enterprises.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the enterprise in the form enterprises/{enterpriseId}.
* @param {string=} params.updateMask The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
* @param {().Enterprise} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Enterprises$Patch, options?: MethodOptions): GaxiosPromise<Schema$Enterprise>;
patch(params: Params$Resource$Enterprises$Patch, options: MethodOptions | BodyResponseCallback<Schema$Enterprise>, callback: BodyResponseCallback<Schema$Enterprise>): void;
patch(params: Params$Resource$Enterprises$Patch, callback: BodyResponseCallback<Schema$Enterprise>): void;
patch(callback: BodyResponseCallback<Schema$Enterprise>): void;
}
export interface Params$Resource$Enterprises$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The enterprise token appended to the callback URL.
*/
enterpriseToken?: string;
/**
* The ID of the Google Cloud Platform project which will own the enterprise.
*/
projectId?: string;
/**
* The name of the SignupUrl used to sign up for the enterprise.
*/
signupUrlName?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Enterprise;
}
export interface Params$Resource$Enterprises$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the enterprise in the form enterprises/{enterpriseId}.
*/
name?: string;
}
export interface Params$Resource$Enterprises$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the enterprise in the form enterprises/{enterpriseId}.
*/
name?: string;
/**
* The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Enterprise;
}
export class Resource$Enterprises$Applications {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* androidmanagement.enterprises.applications.get
* @desc Gets info about an application.
* @alias androidmanagement.enterprises.applications.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.languageCode The preferred language for localized application info, as a BCP47 tag (e.g. "en-US", "de"). If not specified the default language of the application will be used.
* @param {string} params.name The name of the application in the form enterprises/{enterpriseId}/applications/{package_name}.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Enterprises$Applications$Get, options?: MethodOptions): GaxiosPromise<Schema$Application>;
get(params: Params$Resource$Enterprises$Applications$Get, options: MethodOptions | BodyResponseCallback<Schema$Application>, callback: BodyResponseCallback<Schema$Application>): void;
get(params: Params$Resource$Enterprises$Applications$Get, callback: BodyResponseCallback<Schema$Application>): void;
get(callback: BodyResponseCallback<Schema$Application>): void;
}
export interface Params$Resource$Enterprises$Applications$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language for localized application info, as a BCP47 tag (e.g. "en-US", "de"). If not specified the default language of the application will be used.
*/
languageCode?: string;
/**
* The name of the application in the form enterprises/{enterpriseId}/applications/{package_name}.
*/
name?: string;
}
export class Resource$Enterprises$Devices {
context: APIRequestContext;
operations: Resource$Enterprises$Devices$Operations;
constructor(context: APIRequestContext);
/**
* androidmanagement.enterprises.devices.delete
* @desc Deletes a device. This operation wipes the device.
* @alias androidmanagement.enterprises.devices.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
* @param {string=} params.wipeDataFlags Optional flags that control the device wiping behavior.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Enterprises$Devices$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Enterprises$Devices$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Enterprises$Devices$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* androidmanagement.enterprises.devices.get
* @desc Gets a device.
* @alias androidmanagement.enterprises.devices.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Enterprises$Devices$Get, options?: MethodOptions): GaxiosPromise<Schema$Device>;
get(params: Params$Resource$Enterprises$Devices$Get, options: MethodOptions | BodyResponseCallback<Schema$Device>, callback: BodyResponseCallback<Schema$Device>): void;
get(params: Params$Resource$Enterprises$Devices$Get, callback: BodyResponseCallback<Schema$Device>): void;
get(callback: BodyResponseCallback<Schema$Device>): void;
/**
* androidmanagement.enterprises.devices.issueCommand
* @desc Issues a command to a device. The Operation resource returned contains a Command in its metadata field. Use the get operation method to get the status of the command.
* @alias androidmanagement.enterprises.devices.issueCommand
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
* @param {().Command} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
issueCommand(params?: Params$Resource$Enterprises$Devices$Issuecommand, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
issueCommand(params: Params$Resource$Enterprises$Devices$Issuecommand, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
issueCommand(params: Params$Resource$Enterprises$Devices$Issuecommand, callback: BodyResponseCallback<Schema$Operation>): void;
issueCommand(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* androidmanagement.enterprises.devices.list
* @desc Lists devices for a given enterprise.
* @alias androidmanagement.enterprises.devices.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The requested page size. The actual page size may be fixed to a min or max value.
* @param {string=} params.pageToken A token identifying a page of results returned by the server.
* @param {string} params.parent The name of the enterprise in the form enterprises/{enterpriseId}.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Enterprises$Devices$List, options?: MethodOptions): GaxiosPromise<Schema$ListDevicesResponse>;
list(params: Params$Resource$Enterprises$Devices$List, options: MethodOptions | BodyResponseCallback<Schema$ListDevicesResponse>, callback: BodyResponseCallback<Schema$ListDevicesResponse>): void;
list(params: Params$Resource$Enterprises$Devices$List, callback: BodyResponseCallback<Schema$ListDevicesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListDevicesResponse>): void;
/**
* androidmanagement.enterprises.devices.patch
* @desc Updates a device.
* @alias androidmanagement.enterprises.devices.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
* @param {string=} params.updateMask The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
* @param {().Device} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Enterprises$Devices$Patch, options?: MethodOptions): GaxiosPromise<Schema$Device>;
patch(params: Params$Resource$Enterprises$Devices$Patch, options: MethodOptions | BodyResponseCallback<Schema$Device>, callback: BodyResponseCallback<Schema$Device>): void;
patch(params: Params$Resource$Enterprises$Devices$Patch, callback: BodyResponseCallback<Schema$Device>): void;
patch(callback: BodyResponseCallback<Schema$Device>): void;
}
export interface Params$Resource$Enterprises$Devices$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
*/
name?: string;
/**
* Optional flags that control the device wiping behavior.
*/
wipeDataFlags?: string[];
}
export interface Params$Resource$Enterprises$Devices$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
*/
name?: string;
}
export interface Params$Resource$Enterprises$Devices$Issuecommand extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Command;
}
export interface Params$Resource$Enterprises$Devices$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The requested page size. The actual page size may be fixed to a min or max value.
*/
pageSize?: number;
/**
* A token identifying a page of results returned by the server.
*/
pageToken?: string;
/**
* The name of the enterprise in the form enterprises/{enterpriseId}.
*/
parent?: string;
}
export interface Params$Resource$Enterprises$Devices$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
*/
name?: string;
/**
* The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Device;
}
export class Resource$Enterprises$Devices$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* androidmanagement.enterprises.devices.operations.cancel
* @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
* @alias androidmanagement.enterprises.devices.operations.cancel
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource to be cancelled.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
cancel(params?: Params$Resource$Enterprises$Devices$Operations$Cancel, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
cancel(params: Params$Resource$Enterprises$Devices$Operations$Cancel, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
cancel(params: Params$Resource$Enterprises$Devices$Operations$Cancel, callback: BodyResponseCallback<Schema$Empty>): void;
cancel(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* androidmanagement.enterprises.devices.operations.delete
* @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
* @alias androidmanagement.enterprises.devices.operations.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource to be deleted.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Enterprises$Devices$Operations$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Enterprises$Devices$Operations$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Enterprises$Devices$Operations$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* androidmanagement.enterprises.devices.operations.get
* @desc 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.
* @alias androidmanagement.enterprises.devices.operations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Enterprises$Devices$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
get(params: Params$Resource$Enterprises$Devices$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
get(params: Params$Resource$Enterprises$Devices$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
get(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* androidmanagement.enterprises.devices.operations.list
* @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/x/operations. To override the binding, API services can add a binding such as "/v1/{name=users/x}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
* @alias androidmanagement.enterprises.devices.operations.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter The standard list filter.
* @param {string} params.name The name of the operation's parent resource.
* @param {integer=} params.pageSize The standard list page size.
* @param {string=} params.pageToken The standard list page token.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Enterprises$Devices$Operations$List, options?: MethodOptions): GaxiosPromise<Schema$ListOperationsResponse>;
list(params: Params$Resource$Enterprises$Devices$Operations$List, options: MethodOptions | BodyResponseCallback<Schema$ListOperationsResponse>, callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
list(params: Params$Resource$Enterprises$Devices$Operations$List, callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
}
export interface Params$Resource$Enterprises$Devices$Operations$Cancel extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource to be cancelled.
*/
name?: string;
}
export interface Params$Resource$Enterprises$Devices$Operations$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource to be deleted.
*/
name?: string;
}
export interface Params$Resource$Enterprises$Devices$Operations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource.
*/
name?: string;
}
export interface Params$Resource$Enterprises$Devices$Operations$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The standard list filter.
*/
filter?: string;
/**
* The name of the operation's parent resource.
*/
name?: string;
/**
* The standard list page size.
*/
pageSize?: number;
/**
* The standard list page token.
*/
pageToken?: string;
}
export class Resource$Enterprises$Enrollmenttokens {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* androidmanagement.enterprises.enrollmentTokens.create
* @desc Creates an enrollment token for a given enterprise.
* @alias androidmanagement.enterprises.enrollmentTokens.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent The name of the enterprise in the form enterprises/{enterpriseId}.
* @param {().EnrollmentToken} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Enterprises$Enrollmenttokens$Create, options?: MethodOptions): GaxiosPromise<Schema$EnrollmentToken>;
create(params: Params$Resource$Enterprises$Enrollmenttokens$Create, options: MethodOptions | BodyResponseCallback<Schema$EnrollmentToken>, callback: BodyResponseCallback<Schema$EnrollmentToken>): void;
create(params: Params$Resource$Enterprises$Enrollmenttokens$Create, callback: BodyResponseCallback<Schema$EnrollmentToken>): void;
create(callback: BodyResponseCallback<Schema$EnrollmentToken>): void;
/**
* androidmanagement.enterprises.enrollmentTokens.delete
* @desc Deletes an enrollment token. This operation invalidates the token, preventing its future use.
* @alias androidmanagement.enterprises.enrollmentTokens.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the enrollment token in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Enterprises$Enrollmenttokens$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Enterprises$Enrollmenttokens$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Enterprises$Enrollmenttokens$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
}
export interface Params$Resource$Enterprises$Enrollmenttokens$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the enterprise in the form enterprises/{enterpriseId}.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$EnrollmentToken;
}
export interface Params$Resource$Enterprises$Enrollmenttokens$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the enrollment token in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}.
*/
name?: string;
}
export class Resource$Enterprises$Policies {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* androidmanagement.enterprises.policies.delete
* @desc Deletes a policy. This operation is only permitted if no devices are currently referencing the policy.
* @alias androidmanagement.enterprises.policies.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Enterprises$Policies$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Enterprises$Policies$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Enterprises$Policies$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* androidmanagement.enterprises.policies.get
* @desc Gets a policy.
* @alias androidmanagement.enterprises.policies.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Enterprises$Policies$Get, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
get(params: Params$Resource$Enterprises$Policies$Get, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
get(params: Params$Resource$Enterprises$Policies$Get, callback: BodyResponseCallback<Schema$Policy>): void;
get(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* androidmanagement.enterprises.policies.list
* @desc Lists policies for a given enterprise.
* @alias androidmanagement.enterprises.policies.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The requested page size. The actual page size may be fixed to a min or max value.
* @param {string=} params.pageToken A token identifying a page of results returned by the server.
* @param {string} params.parent The name of the enterprise in the form enterprises/{enterpriseId}.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Enterprises$Policies$List, options?: MethodOptions): GaxiosPromise<Schema$ListPoliciesResponse>;
list(params: Params$Resource$Enterprises$Policies$List, options: MethodOptions | BodyResponseCallback<Schema$ListPoliciesResponse>, callback: BodyResponseCallback<Schema$ListPoliciesResponse>): void;
list(params: Params$Resource$Enterprises$Policies$List, callback: BodyResponseCallback<Schema$ListPoliciesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListPoliciesResponse>): void;
/**
* androidmanagement.enterprises.policies.patch
* @desc Updates or creates a policy.
* @alias androidmanagement.enterprises.policies.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}.
* @param {string=} params.updateMask The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
* @param {().Policy} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Enterprises$Policies$Patch, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
patch(params: Params$Resource$Enterprises$Policies$Patch, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
patch(params: Params$Resource$Enterprises$Policies$Patch, callback: BodyResponseCallback<Schema$Policy>): void;
patch(callback: BodyResponseCallback<Schema$Policy>): void;
}
export interface Params$Resource$Enterprises$Policies$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}.
*/
name?: string;
}
export interface Params$Resource$Enterprises$Policies$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}.
*/
name?: string;
}
export interface Params$Resource$Enterprises$Policies$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The requested page size. The actual page size may be fixed to a min or max value.
*/
pageSize?: number;
/**
* A token identifying a page of results returned by the server.
*/
pageToken?: string;
/**
* The name of the enterprise in the form enterprises/{enterpriseId}.
*/
parent?: string;
}
export interface Params$Resource$Enterprises$Policies$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}.
*/
name?: string;
/**
* The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Policy;
}
export class Resource$Enterprises$Webapps {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* androidmanagement.enterprises.webApps.create
* @desc Creates a web app.
* @alias androidmanagement.enterprises.webApps.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent The name of the enterprise in the form enterprises/{enterpriseId}.
* @param {().WebApp} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Enterprises$Webapps$Create, options?: MethodOptions): GaxiosPromise<Schema$WebApp>;
create(params: Params$Resource$Enterprises$Webapps$Create, options: MethodOptions | BodyResponseCallback<Schema$WebApp>, callback: BodyResponseCallback<Schema$WebApp>): void;
create(params: Params$Resource$Enterprises$Webapps$Create, callback: BodyResponseCallback<Schema$WebApp>): void;
create(callback: BodyResponseCallback<Schema$WebApp>): void;
/**
* androidmanagement.enterprises.webApps.delete
* @desc Deletes a web app.
* @alias androidmanagement.enterprises.webApps.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the web app in the form enterprises/{enterpriseId}/webApps/{packageName}.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Enterprises$Webapps$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Enterprises$Webapps$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Enterprises$Webapps$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* androidmanagement.enterprises.webApps.get
* @desc Gets a web app.
* @alias androidmanagement.enterprises.webApps.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the web app in the form enterprises/{enterpriseId}/webApp/{packageName}.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Enterprises$Webapps$Get, options?: MethodOptions): GaxiosPromise<Schema$WebApp>;
get(params: Params$Resource$Enterprises$Webapps$Get, options: MethodOptions | BodyResponseCallback<Schema$WebApp>, callback: BodyResponseCallback<Schema$WebApp>): void;
get(params: Params$Resource$Enterprises$Webapps$Get, callback: BodyResponseCallback<Schema$WebApp>): void;
get(callback: BodyResponseCallback<Schema$WebApp>): void;
/**
* androidmanagement.enterprises.webApps.list
* @desc Lists web apps for a given enterprise.
* @alias androidmanagement.enterprises.webApps.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The requested page size. The actual page size may be fixed to a min or max value.
* @param {string=} params.pageToken A token identifying a page of results returned by the server.
* @param {string} params.parent The name of the enterprise in the form enterprises/{enterpriseId}.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Enterprises$Webapps$List, options?: MethodOptions): GaxiosPromise<Schema$ListWebAppsResponse>;
list(params: Params$Resource$Enterprises$Webapps$List, options: MethodOptions | BodyResponseCallback<Schema$ListWebAppsResponse>, callback: BodyResponseCallback<Schema$ListWebAppsResponse>): void;
list(params: Params$Resource$Enterprises$Webapps$List, callback: BodyResponseCallback<Schema$ListWebAppsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListWebAppsResponse>): void;
/**
* androidmanagement.enterprises.webApps.patch
* @desc Updates a web app.
* @alias androidmanagement.enterprises.webApps.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the web app in the form enterprises/{enterpriseId}/webApps/{packageName}.
* @param {string=} params.updateMask The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
* @param {().WebApp} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Enterprises$Webapps$Patch, options?: MethodOptions): GaxiosPromise<Schema$WebApp>;
patch(params: Params$Resource$Enterprises$Webapps$Patch, options: MethodOptions | BodyResponseCallback<Schema$WebApp>, callback: BodyResponseCallback<Schema$WebApp>): void;
patch(params: Params$Resource$Enterprises$Webapps$Patch, callback: BodyResponseCallback<Schema$WebApp>): void;
patch(callback: BodyResponseCallback<Schema$WebApp>): void;
}
export interface Params$Resource$Enterprises$Webapps$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the enterprise in the form enterprises/{enterpriseId}.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$WebApp;
}
export interface Params$Resource$Enterprises$Webapps$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the web app in the form enterprises/{enterpriseId}/webApps/{packageName}.
*/
name?: string;
}
export interface Params$Resource$Enterprises$Webapps$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the web app in the form enterprises/{enterpriseId}/webApp/{packageName}.
*/
name?: string;
}
export interface Params$Resource$Enterprises$Webapps$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The requested page size. The actual page size may be fixed to a min or max value.
*/
pageSize?: number;
/**
* A token identifying a page of results returned by the server.
*/
pageToken?: string;
/**
* The name of the enterprise in the form enterprises/{enterpriseId}.
*/
parent?: string;
}
export interface Params$Resource$Enterprises$Webapps$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the web app in the form enterprises/{enterpriseId}/webApps/{packageName}.
*/
name?: string;
/**
* The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$WebApp;
}
export class Resource$Enterprises$Webtokens {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* androidmanagement.enterprises.webTokens.create
* @desc Creates a web token to access an embeddable managed Google Play web UI for a given enterprise.
* @alias androidmanagement.enterprises.webTokens.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent The name of the enterprise in the form enterprises/{enterpriseId}.
* @param {().WebToken} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Enterprises$Webtokens$Create, options?: MethodOptions): GaxiosPromise<Schema$WebToken>;
create(params: Params$Resource$Enterprises$Webtokens$Create, options: MethodOptions | BodyResponseCallback<Schema$WebToken>, callback: BodyResponseCallback<Schema$WebToken>): void;
create(params: Params$Resource$Enterprises$Webtokens$Create, callback: BodyResponseCallback<Schema$WebToken>): void;
create(callback: BodyResponseCallback<Schema$WebToken>): void;
}
export interface Params$Resource$Enterprises$Webtokens$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the enterprise in the form enterprises/{enterpriseId}.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$WebToken;
}
export class Resource$Signupurls {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* androidmanagement.signupUrls.create
* @desc Creates an enterprise signup URL.
* @alias androidmanagement.signupUrls.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.callbackUrl The callback URL that the admin will be redirected to after successfully creating an enterprise. Before redirecting there the system will add a query parameter to this URL named enterpriseToken which will contain an opaque token to be used for the create enterprise request. The URL will be parsed then reformatted in order to add the enterpriseToken parameter, so there may be some minor formatting changes.
* @param {string=} params.projectId The ID of the Google Cloud Platform project which will own the enterprise.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Signupurls$Create, options?: MethodOptions): GaxiosPromise<Schema$SignupUrl>;
create(params: Params$Resource$Signupurls$Create, options: MethodOptions | BodyResponseCallback<Schema$SignupUrl>, callback: BodyResponseCallback<Schema$SignupUrl>): void;
create(params: Params$Resource$Signupurls$Create, callback: BodyResponseCallback<Schema$SignupUrl>): void;
create(callback: BodyResponseCallback<Schema$SignupUrl>): void;
}
export interface Params$Resource$Signupurls$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The callback URL that the admin will be redirected to after successfully creating an enterprise. Before redirecting there the system will add a query parameter to this URL named enterpriseToken which will contain an opaque token to be used for the create enterprise request. The URL will be parsed then reformatted in order to add the enterpriseToken parameter, so there may be some minor formatting changes.
*/
callbackUrl?: string;
/**
* The ID of the Google Cloud Platform project which will own the enterprise.
*/
projectId?: string;
}
export {};
}