Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / bf7066efaaa091e67f39440232ab73d38e51b5b1 / . / docs / dyn / androidenterprise_v1.enterprises.html
blob: 70930bd5ece115f69636eec22f09068bf71d6ad8 [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>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]79<p class="firstline">Deletes the binding between the EMM 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>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]80<p class="toc_element">
81 <code><a href="#enroll">enroll(token, body)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]82<p class="firstline">Enrolls an enterprise with the calling EMM.</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]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">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]87 <code><a href="#getStoreLayout">getStoreLayout(enterpriseId)</a></code></p>
88<p class="firstline">Returns the store layout resource.</p>
89<p class="toc_element">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]90 <code><a href="#insert">insert(token, body)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]91<p class="firstline">Establishes the binding between the EMM and an enterprise. This is now deprecated; use enroll instead.</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]92<p class="toc_element">
93 <code><a href="#list">list(domain)</a></code></p>
94<p class="firstline">Looks up an enterprise by domain name.</p>
95<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]96 <code><a href="#sendTestPushNotification">sendTestPushNotification(enterpriseId)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]97<p class="firstline">Sends a test push notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]98<p class="toc_element">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]99 <code><a href="#setAccount">setAccount(enterpriseId, body)</a></code></p>
100<p class="firstline">Set the account that will be used to authenticate to the API as the enterprise.</p>
101<p class="toc_element">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]102 <code><a href="#setStoreLayout">setStoreLayout(enterpriseId, body)</a></code></p>
103<p class="firstline">Sets the store layout resource.</p>
104<p class="toc_element">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]105 <code><a href="#unenroll">unenroll(enterpriseId)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]106<p class="firstline">Unenrolls an enterprise from the calling EMM.</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]107<h3>Method Details</h3>
108<div class="method">
109 <code class="details" id="delete">delete(enterpriseId)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]110 <pre>Deletes the binding between the EMM 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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]111
112Args:
113 enterpriseId: string, The ID of the enterprise. (required)
114</pre>
115</div>
116
117<div class="method">
118 <code class="details" id="enroll">enroll(token, body)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]119 <pre>Enrolls an enterprise with the calling EMM.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]120
121Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]122 token: string, The token provided by the enterprise to register the EMM. (required)
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]123 body: object, The request body. (required)
124 The object takes the form of:
125
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]126{ # An enterprise resource represents a binding between an organization and their EMM.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]127 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]128 # 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 EMM, who then supplies it to the enroll method. Until this is done the EMM will not have any access to the enterprise.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]129 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]130 # After calling enroll the EMM 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).
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]131 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]132 # The EMM 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 EMM'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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]133 #
134 # 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.
135 "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
136 "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
137 "id": "A String", # The unique ID for the enterprise.
138 "name": "A String", # The name of the enterprise, e.g. "Example Inc".
139 }
140
141
142Returns:
143 An object of the form:
144
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]145 { # An enterprise resource represents a binding between an organization and their EMM.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]146 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]147 # 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 EMM, who then supplies it to the enroll method. Until this is done the EMM will not have any access to the enterprise.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]148 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]149 # After calling enroll the EMM 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).
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]150 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]151 # The EMM 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 EMM'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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]152 #
153 # 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.
154 "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
155 "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
156 "id": "A String", # The unique ID for the enterprise.
157 "name": "A String", # The name of the enterprise, e.g. "Example Inc".
158 }</pre>
159</div>
160
161<div class="method">
162 <code class="details" id="get">get(enterpriseId)</code>
163 <pre>Retrieves the name and domain of an enterprise.
164
165Args:
166 enterpriseId: string, The ID of the enterprise. (required)
167
168Returns:
169 An object of the form:
170
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]171 { # An enterprise resource represents a binding between an organization and their EMM.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]172 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]173 # 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 EMM, who then supplies it to the enroll method. Until this is done the EMM will not have any access to the enterprise.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]174 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]175 # After calling enroll the EMM 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).
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]176 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]177 # The EMM 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 EMM'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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]178 #
179 # 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.
180 "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
181 "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
182 "id": "A String", # The unique ID for the enterprise.
183 "name": "A String", # The name of the enterprise, e.g. "Example Inc".
184 }</pre>
185</div>
186
187<div class="method">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]188 <code class="details" id="getStoreLayout">getStoreLayout(enterpriseId)</code>
189 <pre>Returns the store layout resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]190
191Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]192 enterpriseId: string, The ID of the enterprise. (required)
193
194Returns:
195 An object of the form:
196
197 { # General setting for the Google Play for Work store layout, currently only specifying the page to display the first time the store is opened.
198 "homepageId": "A String", # The ID of the store page to be used as the homepage. The homepage will be used as the first page shown in the Google Play for Work store.
199 #
200 # If there is no homepage set, an empty store is shown. The homepage can be unset (by not specifying it) to empty the store.
201 #
202 # If there exists at least one page, this field must be set to the ID of a valid page.
203 "kind": "androidenterprise#storeLayout", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayout".
204 }</pre>
205</div>
206
207<div class="method">
208 <code class="details" id="insert">insert(token, body)</code>
209 <pre>Establishes the binding between the EMM and an enterprise. This is now deprecated; use enroll instead.
210
211Args:
212 token: string, The token provided by the enterprise to register the EMM. (required)
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]213 body: object, The request body. (required)
214 The object takes the form of:
215
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]216{ # An enterprise resource represents a binding between an organization and their EMM.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]217 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]218 # 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 EMM, who then supplies it to the enroll method. Until this is done the EMM will not have any access to the enterprise.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]219 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]220 # After calling enroll the EMM 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).
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]221 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]222 # The EMM 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 EMM'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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]223 #
224 # 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.
225 "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
226 "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
227 "id": "A String", # The unique ID for the enterprise.
228 "name": "A String", # The name of the enterprise, e.g. "Example Inc".
229 }
230
231
232Returns:
233 An object of the form:
234
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]235 { # An enterprise resource represents a binding between an organization and their EMM.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]236 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]237 # 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 EMM, who then supplies it to the enroll method. Until this is done the EMM will not have any access to the enterprise.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]238 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]239 # After calling enroll the EMM 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).
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]240 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]241 # The EMM 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 EMM'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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]242 #
243 # 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.
244 "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
245 "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
246 "id": "A String", # The unique ID for the enterprise.
247 "name": "A String", # The name of the enterprise, e.g. "Example Inc".
248 }</pre>
249</div>
250
251<div class="method">
252 <code class="details" id="list">list(domain)</code>
253 <pre>Looks up an enterprise by domain name.
254
255Args:
256 domain: string, The exact primary domain name of the enterprise to look up. (required)
257
258Returns:
259 An object of the form:
260
261 { # The matching enterprise resources.
262 "kind": "androidenterprise#enterprisesListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprisesListResponse".
263 "enterprise": [ # An enterprise.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]264 { # An enterprise resource represents a binding between an organization and their EMM.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]265 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]266 # 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 EMM, who then supplies it to the enroll method. Until this is done the EMM will not have any access to the enterprise.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]267 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]268 # After calling enroll the EMM 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).
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]269 #
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]270 # The EMM 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 EMM'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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]271 #
272 # 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.
273 "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
274 "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
275 "id": "A String", # The unique ID for the enterprise.
276 "name": "A String", # The name of the enterprise, e.g. "Example Inc".
277 },
278 ],
279 }</pre>
280</div>
281
282<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]283 <code class="details" id="sendTestPushNotification">sendTestPushNotification(enterpriseId)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]284 <pre>Sends a test push notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]285
286Args:
287 enterpriseId: string, The ID of the enterprise. (required)
288
289Returns:
290 An object of the form:
291
292 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]293 "topicName": "A String", # The name of the Cloud Pub/Sub topic to which notifications for this enterprise's enrolled account will be sent.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]294 "messageId": "A String", # The message ID of the test push notification that was sent.
295 }</pre>
296</div>
297
298<div class="method">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]299 <code class="details" id="setAccount">setAccount(enterpriseId, body)</code>
300 <pre>Set the account that will be used to authenticate to the API as the enterprise.
301
302Args:
303 enterpriseId: string, The ID of the enterprise. (required)
304 body: object, The request body. (required)
305 The object takes the form of:
306
307{ # A service account that can be used to authenticate as the enterprise to API calls that require such authentication.
308 "kind": "androidenterprise#enterpriseAccount", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterpriseAccount".
309 "accountEmail": "A String", # The email address of the service account.
310 }
311
312
313Returns:
314 An object of the form:
315
316 { # A service account that can be used to authenticate as the enterprise to API calls that require such authentication.
317 "kind": "androidenterprise#enterpriseAccount", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterpriseAccount".
318 "accountEmail": "A String", # The email address of the service account.
319 }</pre>
320</div>
321
322<div class="method">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]323 <code class="details" id="setStoreLayout">setStoreLayout(enterpriseId, body)</code>
324 <pre>Sets the store layout resource.
325
326Args:
327 enterpriseId: string, The ID of the enterprise. (required)
328 body: object, The request body. (required)
329 The object takes the form of:
330
331{ # General setting for the Google Play for Work store layout, currently only specifying the page to display the first time the store is opened.
332 "homepageId": "A String", # The ID of the store page to be used as the homepage. The homepage will be used as the first page shown in the Google Play for Work store.
333 #
334 # If there is no homepage set, an empty store is shown. The homepage can be unset (by not specifying it) to empty the store.
335 #
336 # If there exists at least one page, this field must be set to the ID of a valid page.
337 "kind": "androidenterprise#storeLayout", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayout".
338}
339
340
341Returns:
342 An object of the form:
343
344 { # General setting for the Google Play for Work store layout, currently only specifying the page to display the first time the store is opened.
345 "homepageId": "A String", # The ID of the store page to be used as the homepage. The homepage will be used as the first page shown in the Google Play for Work store.
346 #
347 # If there is no homepage set, an empty store is shown. The homepage can be unset (by not specifying it) to empty the store.
348 #
349 # If there exists at least one page, this field must be set to the ID of a valid page.
350 "kind": "androidenterprise#storeLayout", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayout".
351 }</pre>
352</div>
353
354<div class="method">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]355 <code class="details" id="unenroll">unenroll(enterpriseId)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]356 <pre>Unenrolls an enterprise from the calling EMM.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]357
358Args:
359 enterpriseId: string, The ID of the enterprise. (required)
360</pre>
361</div>
362
363</body></html>