Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0669410c6b2c48884ae31671b9d710a9ff6346c6 / . / docs / dyn / androidenterprise_v1.enterprises.html
blob: 6f25523d2762cd9dc95c97b4258404ff1e0c793d [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.enterprises.html">enterprises</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="#delete">delete(enterpriseId)</a></code></p>
79<p class="firstline">Deletes the binding between the MDM and enterprise. This is now deprecated; use this to unenroll customers that were previously enrolled with the 'insert' call, then enroll them again with the 'enroll' call.</p>
80<p class="toc_element">
81 <code><a href="#enroll">enroll(token, body)</a></code></p>
82<p class="firstline">Enrolls an enterprise with the calling MDM.</p>
83<p class="toc_element">
84 <code><a href="#get">get(enterpriseId)</a></code></p>
85<p class="firstline">Retrieves the name and domain of an enterprise.</p>
86<p class="toc_element">
87 <code><a href="#insert">insert(token, body)</a></code></p>
88<p class="firstline">Establishes the binding between the MDM and an enterprise. This is now deprecated; use enroll instead.</p>
89<p class="toc_element">
90 <code><a href="#list">list(domain)</a></code></p>
91<p class="firstline">Looks up an enterprise by domain name.</p>
92<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]93 <code><a href="#sendTestPushNotification">sendTestPushNotification(enterpriseId)</a></code></p>
94<p class="firstline">Sends a test push notification to validate the MDM integration with the Google Cloud Pubsub service for this enterprise.</p>
95<p class="toc_element">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]96 <code><a href="#setAccount">setAccount(enterpriseId, body)</a></code></p>
97<p class="firstline">Set the account that will be used to authenticate to the API as the enterprise.</p>
98<p class="toc_element">
99 <code><a href="#unenroll">unenroll(enterpriseId)</a></code></p>
100<p class="firstline">Unenrolls an enterprise from the calling MDM.</p>
101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="delete">delete(enterpriseId)</code>
104 <pre>Deletes the binding between the MDM and enterprise. This is now deprecated; use this to unenroll customers that were previously enrolled with the 'insert' call, then enroll them again with the 'enroll' call.
105
106Args:
107 enterpriseId: string, The ID of the enterprise. (required)
108</pre>
109</div>
110
111<div class="method">
112 <code class="details" id="enroll">enroll(token, body)</code>
113 <pre>Enrolls an enterprise with the calling MDM.
114
115Args:
116 token: string, The token provided by the enterprise to register the MDM. (required)
117 body: object, The request body. (required)
118 The object takes the form of:
119
120{ # An enterprise resource represents a binding between an organisation and their MDM.
121 #
122 # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the MDM, who then supplies it to the enroll method. Until this is done the MDM will not have any access to the enterprise.
123 #
124 # After calling enroll the MDM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token).
125 #
126 # The MDM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the MDM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call.
127 #
128 # The ID for an enterprise is an opaque string. It is returned by insert and enroll and can also be retrieved if the enterprise's primary domain is known using the list method.
129 "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
130 "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
131 "id": "A String", # The unique ID for the enterprise.
132 "name": "A String", # The name of the enterprise, e.g. "Example Inc".
133 }
134
135
136Returns:
137 An object of the form:
138
139 { # An enterprise resource represents a binding between an organisation and their MDM.
140 #
141 # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the MDM, who then supplies it to the enroll method. Until this is done the MDM will not have any access to the enterprise.
142 #
143 # After calling enroll the MDM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token).
144 #
145 # The MDM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the MDM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call.
146 #
147 # The ID for an enterprise is an opaque string. It is returned by insert and enroll and can also be retrieved if the enterprise's primary domain is known using the list method.
148 "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
149 "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
150 "id": "A String", # The unique ID for the enterprise.
151 "name": "A String", # The name of the enterprise, e.g. "Example Inc".
152 }</pre>
153</div>
154
155<div class="method">
156 <code class="details" id="get">get(enterpriseId)</code>
157 <pre>Retrieves the name and domain of an enterprise.
158
159Args:
160 enterpriseId: string, The ID of the enterprise. (required)
161
162Returns:
163 An object of the form:
164
165 { # An enterprise resource represents a binding between an organisation and their MDM.
166 #
167 # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the MDM, who then supplies it to the enroll method. Until this is done the MDM will not have any access to the enterprise.
168 #
169 # After calling enroll the MDM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token).
170 #
171 # The MDM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the MDM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call.
172 #
173 # The ID for an enterprise is an opaque string. It is returned by insert and enroll and can also be retrieved if the enterprise's primary domain is known using the list method.
174 "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
175 "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
176 "id": "A String", # The unique ID for the enterprise.
177 "name": "A String", # The name of the enterprise, e.g. "Example Inc".
178 }</pre>
179</div>
180
181<div class="method">
182 <code class="details" id="insert">insert(token, body)</code>
183 <pre>Establishes the binding between the MDM and an enterprise. This is now deprecated; use enroll instead.
184
185Args:
186 token: string, The token provided by the enterprise to register the MDM. (required)
187 body: object, The request body. (required)
188 The object takes the form of:
189
190{ # An enterprise resource represents a binding between an organisation and their MDM.
191 #
192 # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the MDM, who then supplies it to the enroll method. Until this is done the MDM will not have any access to the enterprise.
193 #
194 # After calling enroll the MDM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token).
195 #
196 # The MDM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the MDM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call.
197 #
198 # The ID for an enterprise is an opaque string. It is returned by insert and enroll and can also be retrieved if the enterprise's primary domain is known using the list method.
199 "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
200 "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
201 "id": "A String", # The unique ID for the enterprise.
202 "name": "A String", # The name of the enterprise, e.g. "Example Inc".
203 }
204
205
206Returns:
207 An object of the form:
208
209 { # An enterprise resource represents a binding between an organisation and their MDM.
210 #
211 # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the MDM, who then supplies it to the enroll method. Until this is done the MDM will not have any access to the enterprise.
212 #
213 # After calling enroll the MDM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token).
214 #
215 # The MDM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the MDM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call.
216 #
217 # The ID for an enterprise is an opaque string. It is returned by insert and enroll and can also be retrieved if the enterprise's primary domain is known using the list method.
218 "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
219 "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
220 "id": "A String", # The unique ID for the enterprise.
221 "name": "A String", # The name of the enterprise, e.g. "Example Inc".
222 }</pre>
223</div>
224
225<div class="method">
226 <code class="details" id="list">list(domain)</code>
227 <pre>Looks up an enterprise by domain name.
228
229Args:
230 domain: string, The exact primary domain name of the enterprise to look up. (required)
231
232Returns:
233 An object of the form:
234
235 { # The matching enterprise resources.
236 "kind": "androidenterprise#enterprisesListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprisesListResponse".
237 "enterprise": [ # An enterprise.
238 { # An enterprise resource represents a binding between an organisation and their MDM.
239 #
240 # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the MDM, who then supplies it to the enroll method. Until this is done the MDM will not have any access to the enterprise.
241 #
242 # After calling enroll the MDM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token).
243 #
244 # The MDM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the MDM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call.
245 #
246 # The ID for an enterprise is an opaque string. It is returned by insert and enroll and can also be retrieved if the enterprise's primary domain is known using the list method.
247 "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
248 "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
249 "id": "A String", # The unique ID for the enterprise.
250 "name": "A String", # The name of the enterprise, e.g. "Example Inc".
251 },
252 ],
253 }</pre>
254</div>
255
256<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]257 <code class="details" id="sendTestPushNotification">sendTestPushNotification(enterpriseId)</code>
258 <pre>Sends a test push notification to validate the MDM integration with the Google Cloud Pubsub service for this enterprise.
259
260Args:
261 enterpriseId: string, The ID of the enterprise. (required)
262
263Returns:
264 An object of the form:
265
266 {
267 "topicName": "A String", # The name of the Cloud Pubsub topic to which notifications for this enterprise's enrolled account will be sent.
268 "messageId": "A String", # The message ID of the test push notification that was sent.
269 }</pre>
270</div>
271
272<div class="method">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]273 <code class="details" id="setAccount">setAccount(enterpriseId, body)</code>
274 <pre>Set the account that will be used to authenticate to the API as the enterprise.
275
276Args:
277 enterpriseId: string, The ID of the enterprise. (required)
278 body: object, The request body. (required)
279 The object takes the form of:
280
281{ # A service account that can be used to authenticate as the enterprise to API calls that require such authentication.
282 "kind": "androidenterprise#enterpriseAccount", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterpriseAccount".
283 "accountEmail": "A String", # The email address of the service account.
284 }
285
286
287Returns:
288 An object of the form:
289
290 { # A service account that can be used to authenticate as the enterprise to API calls that require such authentication.
291 "kind": "androidenterprise#enterpriseAccount", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterpriseAccount".
292 "accountEmail": "A String", # The email address of the service account.
293 }</pre>
294</div>
295
296<div class="method">
297 <code class="details" id="unenroll">unenroll(enterpriseId)</code>
298 <pre>Unenrolls an enterprise from the calling MDM.
299
300Args:
301 enterpriseId: string, The ID of the enterprise. (required)
302</pre>
303</div>
304
305</body></html>