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
|
<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 SDK 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=None, x__xgafv=None)</a></code></p>
<p class="firstline">Takes an action that affects a mobile device. For example, remotely wiping a device.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(customerId, resourceId, x__xgafv=None)</a></code></p>
<p class="firstline">Removes a mobile device.</p>
<p class="toc_element">
<code><a href="#get">get(customerId, resourceId, projection=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a mobile device's properties.</p>
<p class="toc_element">
<code><a href="#list">list(customerId, maxResults=None, orderBy=None, pageToken=None, projection=None, query=None, sortOrder=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a paginated list of all user-owned mobile devices for an account. To retrieve a list that includes company-owned devices, use the Cloud Identity [Devices API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</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=None, x__xgafv=None)</code>
<pre>Takes an action that affects a mobile device. For example, remotely wiping a device.
Args:
customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required)
resourceId: string, The unique ID the API service uses to identify the mobile device. (required)
body: object, The request body.
The object takes the form of:
{
"action": "A String", # The action to be performed on the device.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(customerId, resourceId, x__xgafv=None)</code>
<pre>Removes a mobile device.
Args:
customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required)
resourceId: string, The unique ID the API service uses to identify the mobile device. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(customerId, resourceId, projection=None, x__xgafv=None)</code>
<pre>Retrieves a mobile device's properties.
Args:
customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required)
resourceId: string, The unique ID the API service uses to identify the 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
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Google Workspace Mobile Management includes Android, [Google Sync](https://support.google.com/a/answer/135937), and iOS devices. For more information about common group mobile device API tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices.html).
"adbStatus": True or False, # Adb (USB debugging) enabled or disabled on device (Read-only)
"applications": [ # The list of applications installed on an Android mobile device. It is not applicable to Google Sync and iOS devices. The list includes any Android applications that access Google Workspace data. When updating an applications list, it is important to note that updates replace the existing list. If the Android device has two existing applications and the API updates the list with five applications, the is now the updated list of five applications.
{
"displayName": "A String", # The application's display name. An example is `Browser`.
"packageName": "A String", # The application's package name. An example is `com.android.browser`.
"permission": [ # The list of permissions of this application. These can be either a standard Android permission or one defined by the application, and are found in an application's [Android manifest](https://developer.android.com/guide/topics/manifest/uses-permission-element.html). Examples of a Calendar application's permissions are `READ_CALENDAR`, or `MANAGE_ACCOUNTS`.
"A String",
],
"versionCode": 42, # The application's version code. An example is `13`.
"versionName": "A String", # The application's version name. An example is `3.2-140714`.
},
],
"basebandVersion": "A String", # The device's baseband version.
"bootloaderVersion": "A String", # Mobile Device Bootloader version (Read-only)
"brand": "A String", # Mobile Device Brand (Read-only)
"buildNumber": "A String", # The device's operating system build number.
"defaultLanguage": "A String", # The default locale used on the device.
"developerOptionsStatus": True or False, # Developer options enabled or disabled on device (Read-only)
"deviceCompromisedStatus": "A String", # The compromised device status.
"deviceId": "A String", # The serial number for a Google Sync mobile device. For Android and iOS devices, this is a software generated unique identifier.
"devicePasswordStatus": "A String", # DevicePasswordStatus (Read-only)
"email": [ # The list of the owner's email addresses. If your application needs the current list of user emails, use the [get](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/get.html) method. For additional information, see the [retrieve a user](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#get_user) method.
"A String",
],
"encryptionStatus": "A String", # Mobile Device Encryption Status (Read-only)
"etag": "A String", # ETag of the resource.
"firstSync": "A String", # Date and time the device was first synchronized with the policy settings in the G Suite administrator control panel (Read-only)
"hardware": "A String", # Mobile Device Hardware (Read-only)
"hardwareId": "A String", # The IMEI/MEID unique identifier for Android hardware. It is not applicable to Google Sync devices. When adding an Android mobile device, this is an optional property. When updating one of these devices, this is a read-only property.
"imei": "A String", # The device's IMEI number.
"kernelVersion": "A String", # The device's kernel version.
"kind": "admin#directory#mobiledevice", # The type of the API resource. For Mobiledevices resources, the value is `admin#directory#mobiledevice`.
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)
"managedAccountIsOnOwnerProfile": True or False, # Boolean indicating if this account is on owner/primary profile or not.
"manufacturer": "A String", # Mobile Device manufacturer (Read-only)
"meid": "A String", # The device's MEID number.
"model": "A String", # The mobile device's model name, for example Nexus S. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile=devices#update_mobile_device).
"name": [ # The list of the owner's user names. If your application needs the current list of device owner names, use the [get](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/get.html) method. For more information about retrieving mobile device user information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#get_user).
"A String",
],
"networkOperator": "A String", # Mobile Device mobile or network operator (if available) (Read-only)
"os": "A String", # The mobile device's operating system, for example IOS 4.3 or Android 2.3.5. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices#update_mobile_device).
"otherAccountsInfo": [ # The list of accounts added on device (Read-only)
"A String",
],
"privilege": "A String", # DMAgentPermission (Read-only)
"releaseVersion": "A String", # Mobile Device release version version (Read-only)
"resourceId": "A String", # The unique ID the API service uses to identify the mobile device.
"securityPatchLevel": "A String", # Mobile Device Security patch level (Read-only)
"serialNumber": "A String", # The device's serial number.
"status": "A String", # The device's status.
"supportsWorkProfile": True or False, # Work profile supported on device (Read-only)
"type": "A String", # The type of mobile device.
"unknownSourcesStatus": True or False, # Unknown sources enabled or disabled on device (Read-only)
"userAgent": "A String", # Gives information about the device such as `os` version. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices#update_mobile_device).
"wifiMacAddress": "A String", # The device's MAC address on Wi-Fi networks.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(customerId, maxResults=None, orderBy=None, pageToken=None, projection=None, query=None, sortOrder=None, x__xgafv=None)</code>
<pre>Retrieves a paginated list of all user-owned mobile devices for an account. To retrieve a list that includes company-owned devices, use the Cloud Identity [Devices API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).
Args:
customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required)
maxResults: integer, Maximum number of results to return. Max allowed value is 100.
orderBy: string, Device property to use for sorting results.
Allowed values
deviceId - The serial number for a Google Sync mobile device. For Android devices, this is a software generated unique identifier.
email - The device owner's email address.
lastSync - Last policy settings sync date time of the device.
model - The mobile device's model.
name - The device owner's user name.
os - The device's operating system.
status - The device status.
type - Type of the device.
pageToken: string, Token to specify next page in the list
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
query: string, Search string in the format given at https://developers.google.com/workspace/admin/directory/v1/search-operators
sortOrder: string, Whether to return results in ascending or descending order. Must be used with the `orderBy` parameter.
Allowed values
ASCENDING - Ascending order.
DESCENDING - Descending order.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#mobiledevices", # Kind of resource this is.
"mobiledevices": [ # A list of Mobile Device objects.
{ # Google Workspace Mobile Management includes Android, [Google Sync](https://support.google.com/a/answer/135937), and iOS devices. For more information about common group mobile device API tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices.html).
"adbStatus": True or False, # Adb (USB debugging) enabled or disabled on device (Read-only)
"applications": [ # The list of applications installed on an Android mobile device. It is not applicable to Google Sync and iOS devices. The list includes any Android applications that access Google Workspace data. When updating an applications list, it is important to note that updates replace the existing list. If the Android device has two existing applications and the API updates the list with five applications, the is now the updated list of five applications.
{
"displayName": "A String", # The application's display name. An example is `Browser`.
"packageName": "A String", # The application's package name. An example is `com.android.browser`.
"permission": [ # The list of permissions of this application. These can be either a standard Android permission or one defined by the application, and are found in an application's [Android manifest](https://developer.android.com/guide/topics/manifest/uses-permission-element.html). Examples of a Calendar application's permissions are `READ_CALENDAR`, or `MANAGE_ACCOUNTS`.
"A String",
],
"versionCode": 42, # The application's version code. An example is `13`.
"versionName": "A String", # The application's version name. An example is `3.2-140714`.
},
],
"basebandVersion": "A String", # The device's baseband version.
"bootloaderVersion": "A String", # Mobile Device Bootloader version (Read-only)
"brand": "A String", # Mobile Device Brand (Read-only)
"buildNumber": "A String", # The device's operating system build number.
"defaultLanguage": "A String", # The default locale used on the device.
"developerOptionsStatus": True or False, # Developer options enabled or disabled on device (Read-only)
"deviceCompromisedStatus": "A String", # The compromised device status.
"deviceId": "A String", # The serial number for a Google Sync mobile device. For Android and iOS devices, this is a software generated unique identifier.
"devicePasswordStatus": "A String", # DevicePasswordStatus (Read-only)
"email": [ # The list of the owner's email addresses. If your application needs the current list of user emails, use the [get](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/get.html) method. For additional information, see the [retrieve a user](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#get_user) method.
"A String",
],
"encryptionStatus": "A String", # Mobile Device Encryption Status (Read-only)
"etag": "A String", # ETag of the resource.
"firstSync": "A String", # Date and time the device was first synchronized with the policy settings in the G Suite administrator control panel (Read-only)
"hardware": "A String", # Mobile Device Hardware (Read-only)
"hardwareId": "A String", # The IMEI/MEID unique identifier for Android hardware. It is not applicable to Google Sync devices. When adding an Android mobile device, this is an optional property. When updating one of these devices, this is a read-only property.
"imei": "A String", # The device's IMEI number.
"kernelVersion": "A String", # The device's kernel version.
"kind": "admin#directory#mobiledevice", # The type of the API resource. For Mobiledevices resources, the value is `admin#directory#mobiledevice`.
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)
"managedAccountIsOnOwnerProfile": True or False, # Boolean indicating if this account is on owner/primary profile or not.
"manufacturer": "A String", # Mobile Device manufacturer (Read-only)
"meid": "A String", # The device's MEID number.
"model": "A String", # The mobile device's model name, for example Nexus S. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile=devices#update_mobile_device).
"name": [ # The list of the owner's user names. If your application needs the current list of device owner names, use the [get](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/get.html) method. For more information about retrieving mobile device user information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#get_user).
"A String",
],
"networkOperator": "A String", # Mobile Device mobile or network operator (if available) (Read-only)
"os": "A String", # The mobile device's operating system, for example IOS 4.3 or Android 2.3.5. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices#update_mobile_device).
"otherAccountsInfo": [ # The list of accounts added on device (Read-only)
"A String",
],
"privilege": "A String", # DMAgentPermission (Read-only)
"releaseVersion": "A String", # Mobile Device release version version (Read-only)
"resourceId": "A String", # The unique ID the API service uses to identify the mobile device.
"securityPatchLevel": "A String", # Mobile Device Security patch level (Read-only)
"serialNumber": "A String", # The device's serial number.
"status": "A String", # The device's status.
"supportsWorkProfile": True or False, # Work profile supported on device (Read-only)
"type": "A String", # The type of mobile device.
"unknownSourcesStatus": True or False, # Unknown sources enabled or disabled on device (Read-only)
"userAgent": "A String", # Gives information about the device such as `os` version. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices#update_mobile_device).
"wifiMacAddress": "A String", # The device's MAC address on Wi-Fi networks.
},
],
"nextPageToken": "A String", # Token used to access next page of this result.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</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>
|
