Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4f877e562986034f25ea4246ad1256eabd339526 / . / docs / dyn / androidenterprise_v1.devices.html
blob: 0ce85f6dea429aec9e9e5065fe9e488542cda3cf [file] [log] [blame]
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]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
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]75<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.devices.html">devices</a></h1>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(enterpriseId, userId, deviceId)</a></code></p>
79<p class="firstline">Retrieves the details of a device.</p>
80<p class="toc_element">
81 <code><a href="#getState">getState(enterpriseId, userId, deviceId)</a></code></p>
82<p class="firstline">Retrieves whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services.</p>
83<p class="toc_element">
84 <code><a href="#list">list(enterpriseId, userId)</a></code></p>
85<p class="firstline">Retrieves the IDs of all of a user's devices.</p>
86<p class="toc_element">
87 <code><a href="#setState">setState(enterpriseId, userId, deviceId, body)</a></code></p>
88<p class="firstline">Sets whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="get">get(enterpriseId, userId, deviceId)</code>
92 <pre>Retrieves the details of a device.
93
94Args:
95 enterpriseId: string, The ID of the enterprise. (required)
96 userId: string, The ID of the user. (required)
97 deviceId: string, The ID of the device. (required)
98
99Returns:
100 An object of the form:
101
102 { # A device resource represents a mobile device managed by the MDM and belonging to a specific enterprise user.
103 #
104 # This collection cannot be modified via the API; it is automatically populated as devices are set up to be managed.
105 "kind": "androidenterprise#device", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#device".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]106 "managementType": "A String", # The mechanism by which this device is managed by the MDM. "managedDevice" means that the MDM's app is a device owner. "managedProfile" means that the MDM's app is the profile owner (and there is a separate personal profile which is not managed). "containerApp" means that the MDM's app is managing the Android for Work container app on the device.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]107 "androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string, e.g. "123456789abcdef0".
108 }</pre>
109</div>
110
111<div class="method">
112 <code class="details" id="getState">getState(enterpriseId, userId, deviceId)</code>
113 <pre>Retrieves whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services.
114
115Args:
116 enterpriseId: string, The ID of the enterprise. (required)
117 userId: string, The ID of the user. (required)
118 deviceId: string, The ID of the device. (required)
119
120Returns:
121 An object of the form:
122
123 { # The state of a user's device, as accessed by the getState and setState methods on device resources.
124 "kind": "androidenterprise#deviceState", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState".
125 "accountState": "A String", # The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state.
126 }</pre>
127</div>
128
129<div class="method">
130 <code class="details" id="list">list(enterpriseId, userId)</code>
131 <pre>Retrieves the IDs of all of a user's devices.
132
133Args:
134 enterpriseId: string, The ID of the enterprise. (required)
135 userId: string, The ID of the user. (required)
136
137Returns:
138 An object of the form:
139
140 { # The device resources for the user.
141 "device": [ # A managed device.
142 { # A device resource represents a mobile device managed by the MDM and belonging to a specific enterprise user.
143 #
144 # This collection cannot be modified via the API; it is automatically populated as devices are set up to be managed.
145 "kind": "androidenterprise#device", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#device".
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]146 "managementType": "A String", # The mechanism by which this device is managed by the MDM. "managedDevice" means that the MDM's app is a device owner. "managedProfile" means that the MDM's app is the profile owner (and there is a separate personal profile which is not managed). "containerApp" means that the MDM's app is managing the Android for Work container app on the device.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]147 "androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string, e.g. "123456789abcdef0".
148 },
149 ],
150 "kind": "androidenterprise#devicesListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#devicesListResponse".
151 }</pre>
152</div>
153
154<div class="method">
155 <code class="details" id="setState">setState(enterpriseId, userId, deviceId, body)</code>
156 <pre>Sets whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services.
157
158Args:
159 enterpriseId: string, The ID of the enterprise. (required)
160 userId: string, The ID of the user. (required)
161 deviceId: string, The ID of the device. (required)
162 body: object, The request body. (required)
163 The object takes the form of:
164
165{ # The state of a user's device, as accessed by the getState and setState methods on device resources.
166 "kind": "androidenterprise#deviceState", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState".
167 "accountState": "A String", # The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state.
168 }
169
170
171Returns:
172 An object of the form:
173
174 { # The state of a user's device, as accessed by the getState and setState methods on device resources.
175 "kind": "androidenterprise#deviceState", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState".
176 "accountState": "A String", # The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state.
177 }</pre>
178</div>
179
180</body></html>