Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5cbe5baf3fad3d67e05b9387e8d81de7ce99aeb9 / . / docs / dyn / androidenterprise_v1.devices.html
blob: 8347a454731859645ed66195aa7547218daa903b [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
75<h1><a href="androidenterprise_v1.html">Google Play MDM API</a> . <a href="androidenterprise_v1.devices.html">devices</a></h1>
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".
106 "androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string, e.g. "123456789abcdef0".
107 }</pre>
108</div>
109
110<div class="method">
111 <code class="details" id="getState">getState(enterpriseId, userId, deviceId)</code>
112 <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.
113
114Args:
115 enterpriseId: string, The ID of the enterprise. (required)
116 userId: string, The ID of the user. (required)
117 deviceId: string, The ID of the device. (required)
118
119Returns:
120 An object of the form:
121
122 { # The state of a user's device, as accessed by the getState and setState methods on device resources.
123 "kind": "androidenterprise#deviceState", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState".
124 "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.
125 }</pre>
126</div>
127
128<div class="method">
129 <code class="details" id="list">list(enterpriseId, userId)</code>
130 <pre>Retrieves the IDs of all of a user's devices.
131
132Args:
133 enterpriseId: string, The ID of the enterprise. (required)
134 userId: string, The ID of the user. (required)
135
136Returns:
137 An object of the form:
138
139 { # The device resources for the user.
140 "device": [ # A managed device.
141 { # A device resource represents a mobile device managed by the MDM and belonging to a specific enterprise user.
142 #
143 # This collection cannot be modified via the API; it is automatically populated as devices are set up to be managed.
144 "kind": "androidenterprise#device", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#device".
145 "androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string, e.g. "123456789abcdef0".
146 },
147 ],
148 "kind": "androidenterprise#devicesListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#devicesListResponse".
149 }</pre>
150</div>
151
152<div class="method">
153 <code class="details" id="setState">setState(enterpriseId, userId, deviceId, body)</code>
154 <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.
155
156Args:
157 enterpriseId: string, The ID of the enterprise. (required)
158 userId: string, The ID of the user. (required)
159 deviceId: string, The ID of the device. (required)
160 body: object, The request body. (required)
161 The object takes the form of:
162
163{ # The state of a user's device, as accessed by the getState and setState methods on device resources.
164 "kind": "androidenterprise#deviceState", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState".
165 "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.
166 }
167
168
169Returns:
170 An object of the form:
171
172 { # The state of a user's device, as accessed by the getState and setState methods on device resources.
173 "kind": "androidenterprise#deviceState", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState".
174 "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.
175 }</pre>
176</div>
177
178</body></html>