• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="admin_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.mobiledevices.html">mobiledevices</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#action">action(customerId, resourceId, body)</a></code></p>
79<p class="firstline">Take action on Mobile Device</p>
80<p class="toc_element">
81  <code><a href="#delete">delete(customerId, resourceId)</a></code></p>
82<p class="firstline">Delete Mobile Device</p>
83<p class="toc_element">
84  <code><a href="#get">get(customerId, resourceId, projection=None)</a></code></p>
85<p class="firstline">Retrieve Mobile Device</p>
86<p class="toc_element">
87  <code><a href="#list">list(customerId, orderBy=None, projection=None, pageToken=None, maxResults=None, sortOrder=None, query=None)</a></code></p>
88<p class="firstline">Retrieve all Mobile Devices of a customer (paginated)</p>
89<p class="toc_element">
90  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94    <code class="details" id="action">action(customerId, resourceId, body)</code>
95  <pre>Take action on Mobile Device
96
97Args:
98  customerId: string, Immutable ID of the G Suite account (required)
99  resourceId: string, Immutable ID of Mobile Device (required)
100  body: object, The request body. (required)
101    The object takes the form of:
102
103{ # JSON request template for firing commands on Mobile Device in Directory Devices API.
104    "action": "A String", # Action to be taken on the Mobile Device
105  }
106
107</pre>
108</div>
109
110<div class="method">
111    <code class="details" id="delete">delete(customerId, resourceId)</code>
112  <pre>Delete Mobile Device
113
114Args:
115  customerId: string, Immutable ID of the G Suite account (required)
116  resourceId: string, Immutable ID of Mobile Device (required)
117</pre>
118</div>
119
120<div class="method">
121    <code class="details" id="get">get(customerId, resourceId, projection=None)</code>
122  <pre>Retrieve Mobile Device
123
124Args:
125  customerId: string, Immutable ID of the G Suite account (required)
126  resourceId: string, Immutable ID of Mobile Device (required)
127  projection: string, Restrict information returned to a set of selected fields.
128    Allowed values
129      BASIC - Includes only the basic metadata fields (e.g., deviceId, model, status, type, and status)
130      FULL - Includes all metadata fields
131
132Returns:
133  An object of the form:
134
135    { # JSON template for Mobile Device resource in Directory API.
136    "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)
137    "deviceCompromisedStatus": "A String", # Mobile Device compromised status (Read-only)
138    "resourceId": "A String", # Unique identifier of Mobile Device (Read-only)
139    "defaultLanguage": "A String", # The default locale used on the Mobile Device (Read-only)
140    "hardware": "A String", # Mobile Device Hardware (Read-only)
141    "userAgent": "A String", # Mobile Device user agent
142    "firstSync": "A String", # Date and time the device was first synchronized with the policy settings in the G Suite administrator control panel (Read-only)
143    "otherAccountsInfo": [ # List of accounts added on device (Read-only)
144      "A String",
145    ],
146    "releaseVersion": "A String", # Mobile Device release version version (Read-only)
147    "hardwareId": "A String", # Mobile Device Hardware Id (Read-only)
148    "etag": "A String", # ETag of the resource.
149    "securityPatchLevel": "A String", # Mobile Device Security patch level (Read-only)
150    "privilege": "A String", # DMAgentPermission (Read-only)
151    "encryptionStatus": "A String", # Mobile Device Encryption Status (Read-only)
152    "type": "A String", # The type of device (Read-only)
153    "email": [ # List of owner user's email addresses (Read-only)
154      "A String",
155    ],
156    "devicePasswordStatus": "A String", # DevicePasswordStatus (Read-only)
157    "kernelVersion": "A String", # Mobile Device Kernel version (Read-only)
158    "brand": "A String", # Mobile Device Brand (Read-only)
159    "meid": "A String", # Mobile Device MEID number (Read-only)
160    "buildNumber": "A String", # Mobile Device Build number (Read-only)
161    "applications": [ # List of applications installed on Mobile Device
162      {
163        "versionCode": 42, # Version code of application
164        "packageName": "A String", # Package name of application
165        "displayName": "A String", # Display name of application
166        "versionName": "A String", # Version name of application
167        "permission": [ # List of Permissions for application
168          "A String",
169        ],
170      },
171    ],
172    "deviceId": "A String", # Mobile Device serial number (Read-only)
173    "imei": "A String", # Mobile Device IMEI number (Read-only)
174    "adbStatus": True or False, # Adb (USB debugging) enabled or disabled on device (Read-only)
175    "bootloaderVersion": "A String", # Mobile Device Bootloader version (Read-only)
176    "manufacturer": "A String", # Mobile Device manufacturer (Read-only)
177    "basebandVersion": "A String", # Mobile Device Baseband version (Read-only)
178    "kind": "admin#directory#mobiledevice", # Kind of resource this is.
179    "developerOptionsStatus": True or False, # Developer options enabled or disabled on device (Read-only)
180    "name": [ # List of owner user's names (Read-only)
181      "A String",
182    ],
183    "serialNumber": "A String", # Mobile Device SSN or Serial Number (Read-only)
184    "supportsWorkProfile": True or False, # Work profile supported on device (Read-only)
185    "networkOperator": "A String", # Mobile Device mobile or network operator (if available) (Read-only)
186    "status": "A String", # Status of the device (Read-only)
187    "unknownSourcesStatus": True or False, # Unknown sources enabled or disabled on device (Read-only)
188    "managedAccountIsOnOwnerProfile": True or False, # Boolean indicating if this account is on owner/primary profile or not (Read-only)
189    "model": "A String", # Name of the model of the device
190    "os": "A String", # Name of the mobile operating system
191    "wifiMacAddress": "A String", # Mobile Device WiFi MAC address (Read-only)
192  }</pre>
193</div>
194
195<div class="method">
196    <code class="details" id="list">list(customerId, orderBy=None, projection=None, pageToken=None, maxResults=None, sortOrder=None, query=None)</code>
197  <pre>Retrieve all Mobile Devices of a customer (paginated)
198
199Args:
200  customerId: string, Immutable ID of the G Suite account (required)
201  orderBy: string, Column to use for sorting results
202    Allowed values
203      deviceId - Mobile Device serial number.
204      email - Owner user email.
205      lastSync - Last policy settings sync date time of the device.
206      model - Mobile Device model.
207      name - Owner user name.
208      os - Mobile operating system.
209      status - Status of the device.
210      type - Type of the device.
211  projection: string, Restrict information returned to a set of selected fields.
212    Allowed values
213      BASIC - Includes only the basic metadata fields (e.g., deviceId, model, status, type, and status)
214      FULL - Includes all metadata fields
215  pageToken: string, Token to specify next page in the list
216  maxResults: integer, Maximum number of results to return. Default is 100
217  sortOrder: string, Whether to return results in ascending or descending order. Only of use when orderBy is also used
218    Allowed values
219      ASCENDING - Ascending order.
220      DESCENDING - Descending order.
221  query: string, Search string in the format given at http://support.google.com/a/bin/answer.py?answer=1408863#search
222
223Returns:
224  An object of the form:
225
226    { # JSON response template for List Mobile Devices operation in Directory API.
227    "nextPageToken": "A String", # Token used to access next page of this result.
228    "kind": "admin#directory#mobiledevices", # Kind of resource this is.
229    "etag": "A String", # ETag of the resource.
230    "mobiledevices": [ # List of Mobile Device objects.
231      { # JSON template for Mobile Device resource in Directory API.
232        "lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only)
233        "deviceCompromisedStatus": "A String", # Mobile Device compromised status (Read-only)
234        "resourceId": "A String", # Unique identifier of Mobile Device (Read-only)
235        "defaultLanguage": "A String", # The default locale used on the Mobile Device (Read-only)
236        "hardware": "A String", # Mobile Device Hardware (Read-only)
237        "userAgent": "A String", # Mobile Device user agent
238        "firstSync": "A String", # Date and time the device was first synchronized with the policy settings in the G Suite administrator control panel (Read-only)
239        "otherAccountsInfo": [ # List of accounts added on device (Read-only)
240          "A String",
241        ],
242        "releaseVersion": "A String", # Mobile Device release version version (Read-only)
243        "hardwareId": "A String", # Mobile Device Hardware Id (Read-only)
244        "etag": "A String", # ETag of the resource.
245        "securityPatchLevel": "A String", # Mobile Device Security patch level (Read-only)
246        "privilege": "A String", # DMAgentPermission (Read-only)
247        "encryptionStatus": "A String", # Mobile Device Encryption Status (Read-only)
248        "type": "A String", # The type of device (Read-only)
249        "email": [ # List of owner user's email addresses (Read-only)
250          "A String",
251        ],
252        "devicePasswordStatus": "A String", # DevicePasswordStatus (Read-only)
253        "kernelVersion": "A String", # Mobile Device Kernel version (Read-only)
254        "brand": "A String", # Mobile Device Brand (Read-only)
255        "meid": "A String", # Mobile Device MEID number (Read-only)
256        "buildNumber": "A String", # Mobile Device Build number (Read-only)
257        "applications": [ # List of applications installed on Mobile Device
258          {
259            "versionCode": 42, # Version code of application
260            "packageName": "A String", # Package name of application
261            "displayName": "A String", # Display name of application
262            "versionName": "A String", # Version name of application
263            "permission": [ # List of Permissions for application
264              "A String",
265            ],
266          },
267        ],
268        "deviceId": "A String", # Mobile Device serial number (Read-only)
269        "imei": "A String", # Mobile Device IMEI number (Read-only)
270        "adbStatus": True or False, # Adb (USB debugging) enabled or disabled on device (Read-only)
271        "bootloaderVersion": "A String", # Mobile Device Bootloader version (Read-only)
272        "manufacturer": "A String", # Mobile Device manufacturer (Read-only)
273        "basebandVersion": "A String", # Mobile Device Baseband version (Read-only)
274        "kind": "admin#directory#mobiledevice", # Kind of resource this is.
275        "developerOptionsStatus": True or False, # Developer options enabled or disabled on device (Read-only)
276        "name": [ # List of owner user's names (Read-only)
277          "A String",
278        ],
279        "serialNumber": "A String", # Mobile Device SSN or Serial Number (Read-only)
280        "supportsWorkProfile": True or False, # Work profile supported on device (Read-only)
281        "networkOperator": "A String", # Mobile Device mobile or network operator (if available) (Read-only)
282        "status": "A String", # Status of the device (Read-only)
283        "unknownSourcesStatus": True or False, # Unknown sources enabled or disabled on device (Read-only)
284        "managedAccountIsOnOwnerProfile": True or False, # Boolean indicating if this account is on owner/primary profile or not (Read-only)
285        "model": "A String", # Name of the model of the device
286        "os": "A String", # Name of the mobile operating system
287        "wifiMacAddress": "A String", # Mobile Device WiFi MAC address (Read-only)
288      },
289    ],
290  }</pre>
291</div>
292
293<div class="method">
294    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
295  <pre>Retrieves the next page of results.
296
297Args:
298  previous_request: The request for the previous page. (required)
299  previous_response: The response from the request for the previous page. (required)
300
301Returns:
302  A request object that you can call 'execute()' on to request the next
303  page. Returns None if there are no more items in the collection.
304    </pre>
305</div>
306
307</body></html>