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
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="admin_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.mobiledevices.html">mobiledevices</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#action">action(customerId, resourceId, body)</a></code></p>
<p class="firstline">Take action on Mobile Device</p>
<p class="toc_element">
<code><a href="#delete">delete(customerId, resourceId)</a></code></p>
<p class="firstline">Delete Mobile Device</p>
<p class="toc_element">
<code><a href="#get">get(customerId, resourceId, projection=None)</a></code></p>
<p class="firstline">Retrieve Mobile Device</p>
<p class="toc_element">
<code><a href="#list">list(customerId, orderBy=None, projection=None, pageToken=None, maxResults=None, sortOrder=None, query=None)</a></code></p>
<p class="firstline">Retrieve all Mobile Devices of a customer (paginated)</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="action">action(customerId, resourceId, body)</code>
<pre>Take action on Mobile Device
Args:
customerId: string, Immutable ID of the G Suite account (required)
resourceId: string, Immutable ID of Mobile Device (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON request template for firing commands on Mobile Device in Directory Devices API.
"action": "A String", # Action to be taken on the Mobile Device
}
</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(customerId, resourceId)</code>
<pre>Delete Mobile Device
Args:
customerId: string, Immutable ID of the G Suite account (required)
resourceId: string, Immutable ID of Mobile Device (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(customerId, resourceId, projection=None)</code>
<pre>Retrieve Mobile Device
Args:
customerId: string, Immutable ID of the G Suite account (required)
resourceId: string, Immutable ID of Mobile Device (required)
projection: string, Restrict information returned to a set of selected fields.
Allowed values
BASIC - Includes only the basic metadata fields (e.g., deviceId, model, status, type, and status)
FULL - Includes all metadata fields
Returns:
An object of the form:
{ # JSON template for Mobile Device resource in Directory API.
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)
"deviceCompromisedStatus": "A String", # Mobile Device compromised status (Read-only)
"resourceId": "A String", # Unique identifier of Mobile Device (Read-only)
"defaultLanguage": "A String", # The default locale used on the Mobile Device (Read-only)
"hardware": "A String", # Mobile Device Hardware (Read-only)
"userAgent": "A String", # Mobile Device user agent
"firstSync": "A String", # Date and time the device was first synchronized with the policy settings in the G Suite administrator control panel (Read-only)
"otherAccountsInfo": [ # List of accounts added on device (Read-only)
"A String",
],
"releaseVersion": "A String", # Mobile Device release version version (Read-only)
"hardwareId": "A String", # Mobile Device Hardware Id (Read-only)
"etag": "A String", # ETag of the resource.
"securityPatchLevel": "A String", # Mobile Device Security patch level (Read-only)
"privilege": "A String", # DMAgentPermission (Read-only)
"encryptionStatus": "A String", # Mobile Device Encryption Status (Read-only)
"type": "A String", # The type of device (Read-only)
"email": [ # List of owner user's email addresses (Read-only)
"A String",
],
"devicePasswordStatus": "A String", # DevicePasswordStatus (Read-only)
"kernelVersion": "A String", # Mobile Device Kernel version (Read-only)
"brand": "A String", # Mobile Device Brand (Read-only)
"meid": "A String", # Mobile Device MEID number (Read-only)
"buildNumber": "A String", # Mobile Device Build number (Read-only)
"applications": [ # List of applications installed on Mobile Device
{
"versionCode": 42, # Version code of application
"packageName": "A String", # Package name of application
"displayName": "A String", # Display name of application
"versionName": "A String", # Version name of application
"permission": [ # List of Permissions for application
"A String",
],
},
],
"deviceId": "A String", # Mobile Device serial number (Read-only)
"imei": "A String", # Mobile Device IMEI number (Read-only)
"adbStatus": True or False, # Adb (USB debugging) enabled or disabled on device (Read-only)
"bootloaderVersion": "A String", # Mobile Device Bootloader version (Read-only)
"manufacturer": "A String", # Mobile Device manufacturer (Read-only)
"basebandVersion": "A String", # Mobile Device Baseband version (Read-only)
"kind": "admin#directory#mobiledevice", # Kind of resource this is.
"developerOptionsStatus": True or False, # Developer options enabled or disabled on device (Read-only)
"name": [ # List of owner user's names (Read-only)
"A String",
],
"serialNumber": "A String", # Mobile Device SSN or Serial Number (Read-only)
"supportsWorkProfile": True or False, # Work profile supported on device (Read-only)
"networkOperator": "A String", # Mobile Device mobile or network operator (if available) (Read-only)
"status": "A String", # Status of the device (Read-only)
"unknownSourcesStatus": True or False, # Unknown sources enabled or disabled on device (Read-only)
"managedAccountIsOnOwnerProfile": True or False, # Boolean indicating if this account is on owner/primary profile or not (Read-only)
"model": "A String", # Name of the model of the device
"os": "A String", # Name of the mobile operating system
"wifiMacAddress": "A String", # Mobile Device WiFi MAC address (Read-only)
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(customerId, orderBy=None, projection=None, pageToken=None, maxResults=None, sortOrder=None, query=None)</code>
<pre>Retrieve all Mobile Devices of a customer (paginated)
Args:
customerId: string, Immutable ID of the G Suite account (required)
orderBy: string, Column to use for sorting results
Allowed values
deviceId - Mobile Device serial number.
email - Owner user email.
lastSync - Last policy settings sync date time of the device.
model - Mobile Device model.
name - Owner user name.
os - Mobile operating system.
status - Status of the device.
type - Type of the device.
projection: string, Restrict information returned to a set of selected fields.
Allowed values
BASIC - Includes only the basic metadata fields (e.g., deviceId, model, status, type, and status)
FULL - Includes all metadata fields
pageToken: string, Token to specify next page in the list
maxResults: integer, Maximum number of results to return. Default is 100
sortOrder: string, Whether to return results in ascending or descending order. Only of use when orderBy is also used
Allowed values
ASCENDING - Ascending order.
DESCENDING - Descending order.
query: string, Search string in the format given at http://support.google.com/a/bin/answer.py?answer=1408863#search
Returns:
An object of the form:
{ # JSON response template for List Mobile Devices operation in Directory API.
"nextPageToken": "A String", # Token used to access next page of this result.
"kind": "admin#directory#mobiledevices", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"mobiledevices": [ # List of Mobile Device objects.
{ # JSON template for Mobile Device resource in Directory API.
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)
"deviceCompromisedStatus": "A String", # Mobile Device compromised status (Read-only)
"resourceId": "A String", # Unique identifier of Mobile Device (Read-only)
"defaultLanguage": "A String", # The default locale used on the Mobile Device (Read-only)
"hardware": "A String", # Mobile Device Hardware (Read-only)
"userAgent": "A String", # Mobile Device user agent
"firstSync": "A String", # Date and time the device was first synchronized with the policy settings in the G Suite administrator control panel (Read-only)
"otherAccountsInfo": [ # List of accounts added on device (Read-only)
"A String",
],
"releaseVersion": "A String", # Mobile Device release version version (Read-only)
"hardwareId": "A String", # Mobile Device Hardware Id (Read-only)
"etag": "A String", # ETag of the resource.
"securityPatchLevel": "A String", # Mobile Device Security patch level (Read-only)
"privilege": "A String", # DMAgentPermission (Read-only)
"encryptionStatus": "A String", # Mobile Device Encryption Status (Read-only)
"type": "A String", # The type of device (Read-only)
"email": [ # List of owner user's email addresses (Read-only)
"A String",
],
"devicePasswordStatus": "A String", # DevicePasswordStatus (Read-only)
"kernelVersion": "A String", # Mobile Device Kernel version (Read-only)
"brand": "A String", # Mobile Device Brand (Read-only)
"meid": "A String", # Mobile Device MEID number (Read-only)
"buildNumber": "A String", # Mobile Device Build number (Read-only)
"applications": [ # List of applications installed on Mobile Device
{
"versionCode": 42, # Version code of application
"packageName": "A String", # Package name of application
"displayName": "A String", # Display name of application
"versionName": "A String", # Version name of application
"permission": [ # List of Permissions for application
"A String",
],
},
],
"deviceId": "A String", # Mobile Device serial number (Read-only)
"imei": "A String", # Mobile Device IMEI number (Read-only)
"adbStatus": True or False, # Adb (USB debugging) enabled or disabled on device (Read-only)
"bootloaderVersion": "A String", # Mobile Device Bootloader version (Read-only)
"manufacturer": "A String", # Mobile Device manufacturer (Read-only)
"basebandVersion": "A String", # Mobile Device Baseband version (Read-only)
"kind": "admin#directory#mobiledevice", # Kind of resource this is.
"developerOptionsStatus": True or False, # Developer options enabled or disabled on device (Read-only)
"name": [ # List of owner user's names (Read-only)
"A String",
],
"serialNumber": "A String", # Mobile Device SSN or Serial Number (Read-only)
"supportsWorkProfile": True or False, # Work profile supported on device (Read-only)
"networkOperator": "A String", # Mobile Device mobile or network operator (if available) (Read-only)
"status": "A String", # Status of the device (Read-only)
"unknownSourcesStatus": True or False, # Unknown sources enabled or disabled on device (Read-only)
"managedAccountIsOnOwnerProfile": True or False, # Boolean indicating if this account is on owner/primary profile or not (Read-only)
"model": "A String", # Name of the model of the device
"os": "A String", # Name of the mobile operating system
"wifiMacAddress": "A String", # Mobile Device WiFi MAC address (Read-only)
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
