Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c9b6cec70b2162b98d836f8100bc039f19fe23cb / . / docs / dyn / androidenterprise_v1.enterprises.html
blob: d8a180093d7e9f88b74491e775d78ccc2e77ad18 [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.enterprises.html">enterprises</a></h1>
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">
93 <code><a href="#setAccount">setAccount(enterpriseId, body)</a></code></p>
94<p class="firstline">Set the account that will be used to authenticate to the API as the enterprise.</p>
95<p class="toc_element">
96 <code><a href="#unenroll">unenroll(enterpriseId)</a></code></p>
97<p class="firstline">Unenrolls an enterprise from the calling MDM.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="delete">delete(enterpriseId)</code>
101 <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.
102
103Args:
104 enterpriseId: string, The ID of the enterprise. (required)
105</pre>
106</div>
107
108<div class="method">
109 <code class="details" id="enroll">enroll(token, body)</code>
110 <pre>Enrolls an enterprise with the calling MDM.
111
112Args:
113 token: string, The token provided by the enterprise to register the MDM. (required)
114 body: object, The request body. (required)
115 The object takes the form of:
116
117{ # An enterprise resource represents a binding between an organisation and their MDM.
118 #
119 # 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.
120 #
121 # 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).
122 #
123 # 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.
124 #
125 # 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.
126 "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
127 "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
128 "id": "A String", # The unique ID for the enterprise.
129 "name": "A String", # The name of the enterprise, e.g. "Example Inc".
130 }
131
132
133Returns:
134 An object of the form:
135
136 { # An enterprise resource represents a binding between an organisation and their MDM.
137 #
138 # 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.
139 #
140 # 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).
141 #
142 # 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.
143 #
144 # 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.
145 "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
146 "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
147 "id": "A String", # The unique ID for the enterprise.
148 "name": "A String", # The name of the enterprise, e.g. "Example Inc".
149 }</pre>
150</div>
151
152<div class="method">
153 <code class="details" id="get">get(enterpriseId)</code>
154 <pre>Retrieves the name and domain of an enterprise.
155
156Args:
157 enterpriseId: string, The ID of the enterprise. (required)
158
159Returns:
160 An object of the form:
161
162 { # An enterprise resource represents a binding between an organisation and their MDM.
163 #
164 # 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.
165 #
166 # 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).
167 #
168 # 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.
169 #
170 # 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.
171 "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
172 "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
173 "id": "A String", # The unique ID for the enterprise.
174 "name": "A String", # The name of the enterprise, e.g. "Example Inc".
175 }</pre>
176</div>
177
178<div class="method">
179 <code class="details" id="insert">insert(token, body)</code>
180 <pre>Establishes the binding between the MDM and an enterprise. This is now deprecated; use enroll instead.
181
182Args:
183 token: string, The token provided by the enterprise to register the MDM. (required)
184 body: object, The request body. (required)
185 The object takes the form of:
186
187{ # An enterprise resource represents a binding between an organisation and their MDM.
188 #
189 # 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.
190 #
191 # 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).
192 #
193 # 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.
194 #
195 # 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.
196 "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
197 "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
198 "id": "A String", # The unique ID for the enterprise.
199 "name": "A String", # The name of the enterprise, e.g. "Example Inc".
200 }
201
202
203Returns:
204 An object of the form:
205
206 { # An enterprise resource represents a binding between an organisation and their MDM.
207 #
208 # 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.
209 #
210 # 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).
211 #
212 # 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.
213 #
214 # 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.
215 "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
216 "primaryDomain": "A String", # The enterprise's primary domain, e.g. "example.com".
217 "id": "A String", # The unique ID for the enterprise.
218 "name": "A String", # The name of the enterprise, e.g. "Example Inc".
219 }</pre>
220</div>
221
222<div class="method">
223 <code class="details" id="list">list(domain)</code>
224 <pre>Looks up an enterprise by domain name.
225
226Args:
227 domain: string, The exact primary domain name of the enterprise to look up. (required)
228
229Returns:
230 An object of the form:
231
232 { # The matching enterprise resources.
233 "kind": "androidenterprise#enterprisesListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprisesListResponse".
234 "enterprise": [ # An enterprise.
235 { # An enterprise resource represents a binding between an organisation and their MDM.
236 #
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 MDM, who then supplies it to the enroll method. Until this is done the MDM will not have any access to the enterprise.
238 #
239 # 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).
240 #
241 # 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.
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 },
249 ],
250 }</pre>
251</div>
252
253<div class="method">
254 <code class="details" id="setAccount">setAccount(enterpriseId, body)</code>
255 <pre>Set the account that will be used to authenticate to the API as the enterprise.
256
257Args:
258 enterpriseId: string, The ID of the enterprise. (required)
259 body: object, The request body. (required)
260 The object takes the form of:
261
262{ # A service account that can be used to authenticate as the enterprise to API calls that require such authentication.
263 "kind": "androidenterprise#enterpriseAccount", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterpriseAccount".
264 "accountEmail": "A String", # The email address of the service account.
265 }
266
267
268Returns:
269 An object of the form:
270
271 { # A service account that can be used to authenticate as the enterprise to API calls that require such authentication.
272 "kind": "androidenterprise#enterpriseAccount", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterpriseAccount".
273 "accountEmail": "A String", # The email address of the service account.
274 }</pre>
275</div>
276
277<div class="method">
278 <code class="details" id="unenroll">unenroll(enterpriseId)</code>
279 <pre>Unenrolls an enterprise from the calling MDM.
280
281Args:
282 enterpriseId: string, The ID of the enterprise. (required)
283</pre>
284</div>
285
286</body></html>