/
v1.ts
4326 lines (4161 loc) · 162 KB
/
v1.ts
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
// 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,
createAPIRequest,
MethodOptions,
GlobalOptions,
BodyResponseCallback,
APIRequestContext,
} from 'googleapis-common';
import {GaxiosPromise} from 'gaxios';
// tslint:disable: no-any
// tslint:disable: class-name
// tslint:disable: variable-name
// tslint:disable: jsdoc-format
// tslint:disable: no-namespace
export 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) {
this.context = {
_options: options || {},
google,
};
this.enterprises = new Resource$Enterprises(this.context);
this.signupUrls = new Resource$Signupurls(this.context);
}
}
/**
* Security policies set to the most secure values by default. To maintain the security posture of a device, we don't recommend overriding any of the default values.
*/
export interface Schema$AdvancedSecurityOverrides {
/**
* The policy for untrusted apps (apps from unknown sources) enforced on the device. Replaces install_unknown_sources_allowed (deprecated).
*/
untrustedAppsPolicy?: string | null;
}
/**
* 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;
}
/**
* Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: A full date, with non-zero year, month and day values A month and day value, with a zero year, e.g. an anniversary A year on its own, with zero month and day values A year and month value, with a zero day, e.g. a credit card expiration dateRelated types are google.type.TimeOfDay and google.protobuf.Timestamp.
*/
export interface Schema$Date {
/**
* Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
*/
day?: number | null;
/**
* Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
*/
month?: number | null;
/**
* Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
*/
year?: number | 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.
*/
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;
}
/**
* A system freeze period. When a device’s clock is within the freeze period, all incoming system updates (including security patches) are blocked and won’t be installed. When a device is outside the freeze period, normal update behavior applies. Leap years are ignored in freeze period calculations, in particular: * If Feb. 29th is set as the start or end date of a freeze period, the freeze period will start or end on Feb. 28th instead. * When a device’s system clock reads Feb. 29th, it’s treated as Feb. 28th. * When calculating the number of days in a freeze period or the time between two freeze periods, Feb. 29th is ignored and not counted as a day.
*/
export interface Schema$FreezePeriod {
/**
* The end date (inclusive) of the freeze period. Must be no later than 90 days from the start date. If the end date is earlier than the start date, the freeze period is considered wrapping year-end. Note: year must not be set. For example, {"month": 1,"date": 30}.
*/
endDate?: Schema$Date;
/**
* The start date (inclusive) of the freeze period. Note: year must not be set. For example, {"month": 1,"date": 30}.
*/
startDate?: Schema$Date;
}
/**
* 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;
}
/**
* Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK.
*/
export interface Schema$KioskCustomization {
/**
* Sets the behavior of a device in kiosk mode when a user presses and holds (long-presses) the Power button.
*/
powerButtonActions?: string | null;
/**
* Specifies whether system info and notifications are disabled in kiosk mode.
*/
statusBar?: string | null;
/**
* Specifies whether system error dialogs for crashed or unresponsive apps are blocked in kiosk mode. When blocked, the system will force-stop the app as if the user chooses the "close app" option on the UI.
*/
systemErrorWarnings?: string | null;
/**
* Specifies which navigation features are enabled (e.g. Home, Overview buttons) in kiosk mode.
*/
systemNavigation?: 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.
*/