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
|
<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.chromeosdevices.html">chromeosdevices</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 Chrome OS Device</p>
<p class="toc_element">
<code><a href="#get">get(customerId, deviceId, projection=None)</a></code></p>
<p class="firstline">Retrieve Chrome OS 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 Chrome OS 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>
<p class="toc_element">
<code><a href="#patch">patch(customerId, deviceId, body, projection=None)</a></code></p>
<p class="firstline">Update Chrome OS Device. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(customerId, deviceId, body, projection=None)</a></code></p>
<p class="firstline">Update Chrome OS Device</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="action">action(customerId, resourceId, body)</code>
<pre>Take action on Chrome OS Device
Args:
customerId: string, Immutable id of the Google Apps account (required)
resourceId: string, Immutable id of Chrome OS Device (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON request template for firing actions on ChromeOs Device in Directory Devices API.
"action": "A String", # Action to be taken on the ChromeOs Device
"deprovisionReason": "A String",
}
</pre>
</div>
<div class="method">
<code class="details" id="get">get(customerId, deviceId, projection=None)</code>
<pre>Retrieve Chrome OS Device
Args:
customerId: string, Immutable id of the Google Apps account (required)
deviceId: string, Immutable id of Chrome OS 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, serialNumber, status, and user)
FULL - Includes all metadata fields
Returns:
An object of the form:
{ # JSON template for Chrome Os Device resource in Directory API.
"macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
"orderNumber": "A String", # Chromebook order number (Read-only)
"annotatedLocation": "A String", # Address or location of the device as noted by the administrator
"activeTimeRanges": [ # List of active time ranges (Read-only)
{
"date": "A String", # Date of usage
"activeTime": 42, # Duration in milliseconds
},
],
"annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
"firmwareVersion": "A String", # Chromebook firmware version (Read-only)
"bootMode": "A String", # Chromebook boot mode (Read-only)
"etag": "A String", # ETag of the resource.
"orgUnitPath": "A String", # OrgUnit of the device
"recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
{
"type": "A String", # The type of the user
"email": "A String", # Email address of the user. Present only if the user type is managed
},
],
"willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
"ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
"meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
"annotatedUser": "A String", # User of the device
"deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
"platformVersion": "A String", # Chromebook platform version (Read-only)
"osVersion": "A String", # Chromebook Os Version (Read-only)
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"kind": "admin#directory#chromeosdevice", # Kind of resource this is.
"notes": "A String", # Notes added by the administrator
"serialNumber": "A String", # Chromebook serial number (Read-only)
"status": "A String", # status of the device (Read-only)
"supportEndDate": "A String", # Final date the device will be supported (Read-only)
"model": "A String", # Chromebook Model (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 Chrome OS Devices of a customer (paginated)
Args:
customerId: string, Immutable id of the Google Apps account (required)
orderBy: string, Column to use for sorting results
Allowed values
annotatedLocation - Chromebook location as annotated by the administrator.
annotatedUser - Chromebook user as annotated by administrator.
lastSync - Chromebook last sync.
notes - Chromebook notes as annotated by the administrator.
serialNumber - Chromebook Serial Number.
status - Chromebook status.
supportEndDate - Chromebook support end date.
projection: string, Restrict information returned to a set of selected fields.
Allowed values
BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)
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/chromeos/a/bin/answer.py?hl=en&answer=1698333
Returns:
An object of the form:
{ # JSON response template for List Chrome OS Devices operation in Directory API.
"nextPageToken": "A String", # Token used to access next page of this result.
"chromeosdevices": [ # List of Chrome OS Device objects.
{ # JSON template for Chrome Os Device resource in Directory API.
"macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
"orderNumber": "A String", # Chromebook order number (Read-only)
"annotatedLocation": "A String", # Address or location of the device as noted by the administrator
"activeTimeRanges": [ # List of active time ranges (Read-only)
{
"date": "A String", # Date of usage
"activeTime": 42, # Duration in milliseconds
},
],
"annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
"firmwareVersion": "A String", # Chromebook firmware version (Read-only)
"bootMode": "A String", # Chromebook boot mode (Read-only)
"etag": "A String", # ETag of the resource.
"orgUnitPath": "A String", # OrgUnit of the device
"recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
{
"type": "A String", # The type of the user
"email": "A String", # Email address of the user. Present only if the user type is managed
},
],
"willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
"ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
"meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
"annotatedUser": "A String", # User of the device
"deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
"platformVersion": "A String", # Chromebook platform version (Read-only)
"osVersion": "A String", # Chromebook Os Version (Read-only)
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"kind": "admin#directory#chromeosdevice", # Kind of resource this is.
"notes": "A String", # Notes added by the administrator
"serialNumber": "A String", # Chromebook serial number (Read-only)
"status": "A String", # status of the device (Read-only)
"supportEndDate": "A String", # Final date the device will be supported (Read-only)
"model": "A String", # Chromebook Model (Read-only)
},
],
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#chromeosdevices", # Kind of resource this is.
}</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>
<div class="method">
<code class="details" id="patch">patch(customerId, deviceId, body, projection=None)</code>
<pre>Update Chrome OS Device. This method supports patch semantics.
Args:
customerId: string, Immutable id of the Google Apps account (required)
deviceId: string, Immutable id of Chrome OS Device (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Chrome Os Device resource in Directory API.
"macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
"orderNumber": "A String", # Chromebook order number (Read-only)
"annotatedLocation": "A String", # Address or location of the device as noted by the administrator
"activeTimeRanges": [ # List of active time ranges (Read-only)
{
"date": "A String", # Date of usage
"activeTime": 42, # Duration in milliseconds
},
],
"annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
"firmwareVersion": "A String", # Chromebook firmware version (Read-only)
"bootMode": "A String", # Chromebook boot mode (Read-only)
"etag": "A String", # ETag of the resource.
"orgUnitPath": "A String", # OrgUnit of the device
"recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
{
"type": "A String", # The type of the user
"email": "A String", # Email address of the user. Present only if the user type is managed
},
],
"willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
"ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
"meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
"annotatedUser": "A String", # User of the device
"deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
"platformVersion": "A String", # Chromebook platform version (Read-only)
"osVersion": "A String", # Chromebook Os Version (Read-only)
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"kind": "admin#directory#chromeosdevice", # Kind of resource this is.
"notes": "A String", # Notes added by the administrator
"serialNumber": "A String", # Chromebook serial number (Read-only)
"status": "A String", # status of the device (Read-only)
"supportEndDate": "A String", # Final date the device will be supported (Read-only)
"model": "A String", # Chromebook Model (Read-only)
}
projection: string, Restrict information returned to a set of selected fields.
Allowed values
BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)
FULL - Includes all metadata fields
Returns:
An object of the form:
{ # JSON template for Chrome Os Device resource in Directory API.
"macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
"orderNumber": "A String", # Chromebook order number (Read-only)
"annotatedLocation": "A String", # Address or location of the device as noted by the administrator
"activeTimeRanges": [ # List of active time ranges (Read-only)
{
"date": "A String", # Date of usage
"activeTime": 42, # Duration in milliseconds
},
],
"annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
"firmwareVersion": "A String", # Chromebook firmware version (Read-only)
"bootMode": "A String", # Chromebook boot mode (Read-only)
"etag": "A String", # ETag of the resource.
"orgUnitPath": "A String", # OrgUnit of the device
"recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
{
"type": "A String", # The type of the user
"email": "A String", # Email address of the user. Present only if the user type is managed
},
],
"willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
"ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
"meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
"annotatedUser": "A String", # User of the device
"deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
"platformVersion": "A String", # Chromebook platform version (Read-only)
"osVersion": "A String", # Chromebook Os Version (Read-only)
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"kind": "admin#directory#chromeosdevice", # Kind of resource this is.
"notes": "A String", # Notes added by the administrator
"serialNumber": "A String", # Chromebook serial number (Read-only)
"status": "A String", # status of the device (Read-only)
"supportEndDate": "A String", # Final date the device will be supported (Read-only)
"model": "A String", # Chromebook Model (Read-only)
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(customerId, deviceId, body, projection=None)</code>
<pre>Update Chrome OS Device
Args:
customerId: string, Immutable id of the Google Apps account (required)
deviceId: string, Immutable id of Chrome OS Device (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Chrome Os Device resource in Directory API.
"macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
"orderNumber": "A String", # Chromebook order number (Read-only)
"annotatedLocation": "A String", # Address or location of the device as noted by the administrator
"activeTimeRanges": [ # List of active time ranges (Read-only)
{
"date": "A String", # Date of usage
"activeTime": 42, # Duration in milliseconds
},
],
"annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
"firmwareVersion": "A String", # Chromebook firmware version (Read-only)
"bootMode": "A String", # Chromebook boot mode (Read-only)
"etag": "A String", # ETag of the resource.
"orgUnitPath": "A String", # OrgUnit of the device
"recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
{
"type": "A String", # The type of the user
"email": "A String", # Email address of the user. Present only if the user type is managed
},
],
"willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
"ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
"meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
"annotatedUser": "A String", # User of the device
"deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
"platformVersion": "A String", # Chromebook platform version (Read-only)
"osVersion": "A String", # Chromebook Os Version (Read-only)
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"kind": "admin#directory#chromeosdevice", # Kind of resource this is.
"notes": "A String", # Notes added by the administrator
"serialNumber": "A String", # Chromebook serial number (Read-only)
"status": "A String", # status of the device (Read-only)
"supportEndDate": "A String", # Final date the device will be supported (Read-only)
"model": "A String", # Chromebook Model (Read-only)
}
projection: string, Restrict information returned to a set of selected fields.
Allowed values
BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)
FULL - Includes all metadata fields
Returns:
An object of the form:
{ # JSON template for Chrome Os Device resource in Directory API.
"macAddress": "A String", # Chromebook Mac Address on wifi network interface (Read-only)
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)
"orderNumber": "A String", # Chromebook order number (Read-only)
"annotatedLocation": "A String", # Address or location of the device as noted by the administrator
"activeTimeRanges": [ # List of active time ranges (Read-only)
{
"date": "A String", # Date of usage
"activeTime": 42, # Duration in milliseconds
},
],
"annotatedAssetId": "A String", # AssetId specified during enrollment or through later annotation
"firmwareVersion": "A String", # Chromebook firmware version (Read-only)
"bootMode": "A String", # Chromebook boot mode (Read-only)
"etag": "A String", # ETag of the resource.
"orgUnitPath": "A String", # OrgUnit of the device
"recentUsers": [ # List of recent device users, in descending order by last login time (Read-only)
{
"type": "A String", # The type of the user
"email": "A String", # Email address of the user. Present only if the user type is managed
},
],
"willAutoRenew": True or False, # Will Chromebook auto renew after support end date (Read-only)
"ethernetMacAddress": "A String", # Chromebook Mac Address on ethernet network interface (Read-only)
"meid": "A String", # Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)
"annotatedUser": "A String", # User of the device
"deviceId": "A String", # Unique identifier of Chrome OS Device (Read-only)
"platformVersion": "A String", # Chromebook platform version (Read-only)
"osVersion": "A String", # Chromebook Os Version (Read-only)
"lastEnrollmentTime": "A String", # Date and time the device was last enrolled (Read-only)
"kind": "admin#directory#chromeosdevice", # Kind of resource this is.
"notes": "A String", # Notes added by the administrator
"serialNumber": "A String", # Chromebook serial number (Read-only)
"status": "A String", # status of the device (Read-only)
"supportEndDate": "A String", # Final date the device will be supported (Read-only)
"model": "A String", # Chromebook Model (Read-only)
}</pre>
</div>
</body></html>
|
