Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / androidenterprise_v1.users.html
blob: 783cb7957ad3fff71c03d25c6f5c0a4e318d50d6 [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.users.html">users</a></h1>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]78 <code><a href="#delete">delete(enterpriseId, userId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]79<p class="firstline">Deleted an EMM-managed user.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]81 <code><a href="#generateAuthenticationToken">generateAuthenticationToken(enterpriseId, userId, x__xgafv=None)</a></code></p>
82<p class="firstline">Generates an authentication token which the device policy client can use to</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]84 <code><a href="#get">get(enterpriseId, userId, x__xgafv=None)</a></code></p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]85<p class="firstline">Retrieves a user's details.</p>
86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]87 <code><a href="#getAvailableProductSet">getAvailableProductSet(enterpriseId, userId, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]88<p class="firstline">Retrieves the set of products a user is entitled to access.</p>
89<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]90 <code><a href="#insert">insert(enterpriseId, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]91<p class="firstline">Creates a new EMM-managed user.</p>
92<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]93 <code><a href="#list">list(enterpriseId, email, x__xgafv=None)</a></code></p>
94<p class="firstline">Looks up a user by primary email address.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]95<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]96 <code><a href="#revokeDeviceAccess">revokeDeviceAccess(enterpriseId, userId, x__xgafv=None)</a></code></p>
97<p class="firstline">Revokes access to all devices currently provisioned to the user. The user</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]99 <code><a href="#setAvailableProductSet">setAvailableProductSet(enterpriseId, userId, body=None, x__xgafv=None)</a></code></p>
100<p class="firstline">Modifies the set of products that a user is entitled to access (referred to</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]101<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]102 <code><a href="#update">update(enterpriseId, userId, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]103<p class="firstline">Updates the details of an EMM-managed user.</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]104<h3>Method Details</h3>
105<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]106 <code class="details" id="delete">delete(enterpriseId, userId, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]107 <pre>Deleted an EMM-managed user.
108
109Args:
110 enterpriseId: string, The ID of the enterprise. (required)
111 userId: string, The ID of the user. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]112 x__xgafv: string, V1 error format.
113 Allowed values
114 1 - v1 error format
115 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]116</pre>
117</div>
118
119<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]120 <code class="details" id="generateAuthenticationToken">generateAuthenticationToken(enterpriseId, userId, x__xgafv=None)</code>
121 <pre>Generates an authentication token which the device policy client can use to
122provision the given EMM-managed user account on a device.
123The generated token is single-use and expires after a few minutes.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]124
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125You can provision a maximum of 10 devices per user.
126
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]127This call only works with EMM-managed accounts.
128
129Args:
130 enterpriseId: string, The ID of the enterprise. (required)
131 userId: string, The ID of the user. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]132 x__xgafv: string, V1 error format.
133 Allowed values
134 1 - v1 error format
135 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]136
137Returns:
138 An object of the form:
139
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]140 { # An AuthenticationToken is used by the EMM&#x27;s device policy client on a device
141 # to provision the given EMM-managed user on that device.
142 &quot;token&quot;: &quot;A String&quot;, # The authentication token to be passed to the device policy client on the
143 # device where it can be used to provision the account for which this token
144 # was generated.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]145 }</pre>
146</div>
147
148<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]149 <code class="details" id="get">get(enterpriseId, userId, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]150 <pre>Retrieves a user&#x27;s details.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]151
152Args:
153 enterpriseId: string, The ID of the enterprise. (required)
154 userId: string, The ID of the user. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]155 x__xgafv: string, V1 error format.
156 Allowed values
157 1 - v1 error format
158 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]159
160Returns:
161 An object of the form:
162
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]163 { # A Users resource represents an account associated with an enterprise. The
164 # account may be specific to a device or to an individual user (who can then
165 # use the account across multiple devices). The account may provide access to
166 # managed Google Play only, or to other Google services, depending on the
167 # identity model:
168 # &lt;ul&gt;&lt;li&gt;The Google managed domain identity model requires synchronization to
169 # Google account sources (via &lt;code&gt;primaryEmail&lt;/code&gt;).&lt;/li&gt;
170 # &lt;li&gt;The managed Google Play Accounts identity model provides a dynamic means
171 # for enterprises to create user or device accounts as needed. These accounts
172 # provide access to managed Google Play.&lt;/li&gt;
173 # &lt;/ul&gt;
174 &quot;accountType&quot;: &quot;A String&quot;, # The type of account that this user represents. A &lt;code&gt;userAccount&lt;/code&gt;
175 # can be installed on multiple devices, but a &lt;code&gt;deviceAccount&lt;/code&gt; is
176 # specific to a single device. An EMM-managed user (&lt;code&gt;emmManaged&lt;/code&gt;)
177 # can be either type (&lt;code&gt;userAccount&lt;/code&gt;, &lt;code&gt;deviceAccount&lt;/code&gt;),
178 # but a Google-managed user (&lt;code&gt;googleManaged&lt;/code&gt;) is always a
179 # &lt;code&gt;userAccount&lt;/code&gt;.
180 &quot;managementType&quot;: &quot;A String&quot;, # The entity that manages the user. With &lt;code&gt;googleManaged&lt;/code&gt; users,
181 # the source of truth is Google so EMMs have to make sure a Google Account
182 # exists for the user. With &lt;code&gt;emmManaged&lt;/code&gt; users, the
183 # EMM is in charge.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]184 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the user.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]185 &quot;primaryEmail&quot;: &quot;A String&quot;, # The user&#x27;s primary email address, for example, &quot;jsmith@example.com&quot;.
186 # Will always be set for Google managed users and not set for EMM managed
187 # users.
188 &quot;displayName&quot;: &quot;A String&quot;, # The name that will appear in user interfaces. Setting this property is
189 # optional when creating EMM-managed users. If you do set this property,
190 # use something generic about the organization (such as &quot;Example, Inc.&quot;) or
191 # your name (as EMM).
192 # Not used for Google-managed user accounts.
193 # @mutable androidenterprise.users.update
194 &quot;accountIdentifier&quot;: &quot;A String&quot;, # A unique identifier you create for this user, such as &quot;user342&quot; or
195 # &quot;asset#44418&quot;. Do not use personally identifiable information (PII) for
196 # this property. Must always be set for EMM-managed users.
197 # Not set for Google-managed users.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]198 }</pre>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]199</div>
200
201<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]202 <code class="details" id="getAvailableProductSet">getAvailableProductSet(enterpriseId, userId, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]203 <pre>Retrieves the set of products a user is entitled to access.
204
205Args:
206 enterpriseId: string, The ID of the enterprise. (required)
207 userId: string, The ID of the user. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]208 x__xgafv: string, V1 error format.
209 Allowed values
210 1 - v1 error format
211 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]212
213Returns:
214 An object of the form:
215
216 { # A set of products.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]217 &quot;productId&quot;: [ # The list of product IDs making up the set of products.
218 &quot;A String&quot;,
219 ],
220 &quot;productVisibility&quot;: [ # Additional list of product IDs making up the product set.
221 # Unlike the productID array, in this list It&#x27;s possible to specify
222 # which tracks (alpha, beta, production) of a product are visible to the
223 # user. See ProductVisibility and its fields for more information. Specifying
224 # the same product ID both here and in the productId array is not allowed and
225 # it will result in an error.
226 { # A product to be made visible to a user.
227 &quot;trackIds&quot;: [ # Grants the user visibility to the specified product track(s), identified by
228 # &lt;code&gt;trackIds&lt;/code&gt;.
229 &quot;A String&quot;,
230 ],
231 &quot;productId&quot;: &quot;A String&quot;, # The product ID to make visible to the user.
232 # Required for each item in the productVisibility list.
233 &quot;tracks&quot;: [ # Deprecated. Use &lt;code&gt;trackIds&lt;/code&gt; instead.
234 &quot;A String&quot;,
235 ],
236 },
237 ],
238 &quot;productSetBehavior&quot;: &quot;A String&quot;, # The interpretation of this product set. &quot;unknown&quot; should never be sent and
239 # is ignored if received. &quot;whitelist&quot; means that the user is entitled to
240 # access the product set. &quot;includeAll&quot; means that all products are
241 # accessible, including products that are approved, products with revoked
242 # approval, and products that have never been approved. &quot;allApproved&quot; means
243 # that the user is entitled to access all products that are approved for the
244 # enterprise. If the value is &quot;allApproved&quot; or &quot;includeAll&quot;, the productId
245 # field is ignored. If no value is provided, it is interpreted as
246 # &quot;whitelist&quot; for backwards compatibility.
247 # Further &quot;allApproved&quot; or &quot;includeAll&quot; does not enable automatic
248 # visibility of &quot;alpha&quot; or &quot;beta&quot; tracks for Android app. Use
249 # ProductVisibility to enable &quot;alpha&quot; or &quot;beta&quot; tracks per user.
250 }</pre>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]251</div>
252
253<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]254 <code class="details" id="insert">insert(enterpriseId, body=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]255 <pre>Creates a new EMM-managed user.
256
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]257The &lt;a href=&quot;/android/work/play/emm-api/v1/users.html&quot;&gt;Users&lt;/a&gt; resource
258passed in the body of the request should include an
259&lt;code&gt;accountIdentifier&lt;/code&gt; and an &lt;code&gt;accountType&lt;/code&gt;.
260&lt;p&gt;If a corresponding user already exists with the same account identifier,
261the user will be updated with the resource. In this case only the
262&lt;code&gt;displayName&lt;/code&gt; field can be changed.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]263
264Args:
265 enterpriseId: string, The ID of the enterprise. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]266 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]267 The object takes the form of:
268
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]269{ # A Users resource represents an account associated with an enterprise. The
270 # account may be specific to a device or to an individual user (who can then
271 # use the account across multiple devices). The account may provide access to
272 # managed Google Play only, or to other Google services, depending on the
273 # identity model:
274 # &lt;ul&gt;&lt;li&gt;The Google managed domain identity model requires synchronization to
275 # Google account sources (via &lt;code&gt;primaryEmail&lt;/code&gt;).&lt;/li&gt;
276 # &lt;li&gt;The managed Google Play Accounts identity model provides a dynamic means
277 # for enterprises to create user or device accounts as needed. These accounts
278 # provide access to managed Google Play.&lt;/li&gt;
279 # &lt;/ul&gt;
280 &quot;accountType&quot;: &quot;A String&quot;, # The type of account that this user represents. A &lt;code&gt;userAccount&lt;/code&gt;
281 # can be installed on multiple devices, but a &lt;code&gt;deviceAccount&lt;/code&gt; is
282 # specific to a single device. An EMM-managed user (&lt;code&gt;emmManaged&lt;/code&gt;)
283 # can be either type (&lt;code&gt;userAccount&lt;/code&gt;, &lt;code&gt;deviceAccount&lt;/code&gt;),
284 # but a Google-managed user (&lt;code&gt;googleManaged&lt;/code&gt;) is always a
285 # &lt;code&gt;userAccount&lt;/code&gt;.
286 &quot;managementType&quot;: &quot;A String&quot;, # The entity that manages the user. With &lt;code&gt;googleManaged&lt;/code&gt; users,
287 # the source of truth is Google so EMMs have to make sure a Google Account
288 # exists for the user. With &lt;code&gt;emmManaged&lt;/code&gt; users, the
289 # EMM is in charge.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]290 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the user.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]291 &quot;primaryEmail&quot;: &quot;A String&quot;, # The user&#x27;s primary email address, for example, &quot;jsmith@example.com&quot;.
292 # Will always be set for Google managed users and not set for EMM managed
293 # users.
294 &quot;displayName&quot;: &quot;A String&quot;, # The name that will appear in user interfaces. Setting this property is
295 # optional when creating EMM-managed users. If you do set this property,
296 # use something generic about the organization (such as &quot;Example, Inc.&quot;) or
297 # your name (as EMM).
298 # Not used for Google-managed user accounts.
299 # @mutable androidenterprise.users.update
300 &quot;accountIdentifier&quot;: &quot;A String&quot;, # A unique identifier you create for this user, such as &quot;user342&quot; or
301 # &quot;asset#44418&quot;. Do not use personally identifiable information (PII) for
302 # this property. Must always be set for EMM-managed users.
303 # Not set for Google-managed users.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]304}
305
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]306 x__xgafv: string, V1 error format.
307 Allowed values
308 1 - v1 error format
309 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]310
311Returns:
312 An object of the form:
313
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]314 { # A Users resource represents an account associated with an enterprise. The
315 # account may be specific to a device or to an individual user (who can then
316 # use the account across multiple devices). The account may provide access to
317 # managed Google Play only, or to other Google services, depending on the
318 # identity model:
319 # &lt;ul&gt;&lt;li&gt;The Google managed domain identity model requires synchronization to
320 # Google account sources (via &lt;code&gt;primaryEmail&lt;/code&gt;).&lt;/li&gt;
321 # &lt;li&gt;The managed Google Play Accounts identity model provides a dynamic means
322 # for enterprises to create user or device accounts as needed. These accounts
323 # provide access to managed Google Play.&lt;/li&gt;
324 # &lt;/ul&gt;
325 &quot;accountType&quot;: &quot;A String&quot;, # The type of account that this user represents. A &lt;code&gt;userAccount&lt;/code&gt;
326 # can be installed on multiple devices, but a &lt;code&gt;deviceAccount&lt;/code&gt; is
327 # specific to a single device. An EMM-managed user (&lt;code&gt;emmManaged&lt;/code&gt;)
328 # can be either type (&lt;code&gt;userAccount&lt;/code&gt;, &lt;code&gt;deviceAccount&lt;/code&gt;),
329 # but a Google-managed user (&lt;code&gt;googleManaged&lt;/code&gt;) is always a
330 # &lt;code&gt;userAccount&lt;/code&gt;.
331 &quot;managementType&quot;: &quot;A String&quot;, # The entity that manages the user. With &lt;code&gt;googleManaged&lt;/code&gt; users,
332 # the source of truth is Google so EMMs have to make sure a Google Account
333 # exists for the user. With &lt;code&gt;emmManaged&lt;/code&gt; users, the
334 # EMM is in charge.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]335 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the user.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]336 &quot;primaryEmail&quot;: &quot;A String&quot;, # The user&#x27;s primary email address, for example, &quot;jsmith@example.com&quot;.
337 # Will always be set for Google managed users and not set for EMM managed
338 # users.
339 &quot;displayName&quot;: &quot;A String&quot;, # The name that will appear in user interfaces. Setting this property is
340 # optional when creating EMM-managed users. If you do set this property,
341 # use something generic about the organization (such as &quot;Example, Inc.&quot;) or
342 # your name (as EMM).
343 # Not used for Google-managed user accounts.
344 # @mutable androidenterprise.users.update
345 &quot;accountIdentifier&quot;: &quot;A String&quot;, # A unique identifier you create for this user, such as &quot;user342&quot; or
346 # &quot;asset#44418&quot;. Do not use personally identifiable information (PII) for
347 # this property. Must always be set for EMM-managed users.
348 # Not set for Google-managed users.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]349 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]350</div>
351
352<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]353 <code class="details" id="list">list(enterpriseId, email, x__xgafv=None)</code>
354 <pre>Looks up a user by primary email address.
355This is only supported for Google-managed users. Lookup of the id is not
356needed for EMM-managed users because the id is already returned in the
357result of the Users.insert call.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]358
359Args:
360 enterpriseId: string, The ID of the enterprise. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]361 email: string, Required. The exact primary email address of the user to look up. (required)
362 x__xgafv: string, V1 error format.
363 Allowed values
364 1 - v1 error format
365 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]366
367Returns:
368 An object of the form:
369
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]370 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]371 &quot;user&quot;: [ # A user of an enterprise.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]372 { # A Users resource represents an account associated with an enterprise. The
373 # account may be specific to a device or to an individual user (who can then
374 # use the account across multiple devices). The account may provide access to
375 # managed Google Play only, or to other Google services, depending on the
376 # identity model:
377 # &lt;ul&gt;&lt;li&gt;The Google managed domain identity model requires synchronization to
378 # Google account sources (via &lt;code&gt;primaryEmail&lt;/code&gt;).&lt;/li&gt;
379 # &lt;li&gt;The managed Google Play Accounts identity model provides a dynamic means
380 # for enterprises to create user or device accounts as needed. These accounts
381 # provide access to managed Google Play.&lt;/li&gt;
382 # &lt;/ul&gt;
383 &quot;accountType&quot;: &quot;A String&quot;, # The type of account that this user represents. A &lt;code&gt;userAccount&lt;/code&gt;
384 # can be installed on multiple devices, but a &lt;code&gt;deviceAccount&lt;/code&gt; is
385 # specific to a single device. An EMM-managed user (&lt;code&gt;emmManaged&lt;/code&gt;)
386 # can be either type (&lt;code&gt;userAccount&lt;/code&gt;, &lt;code&gt;deviceAccount&lt;/code&gt;),
387 # but a Google-managed user (&lt;code&gt;googleManaged&lt;/code&gt;) is always a
388 # &lt;code&gt;userAccount&lt;/code&gt;.
389 &quot;managementType&quot;: &quot;A String&quot;, # The entity that manages the user. With &lt;code&gt;googleManaged&lt;/code&gt; users,
390 # the source of truth is Google so EMMs have to make sure a Google Account
391 # exists for the user. With &lt;code&gt;emmManaged&lt;/code&gt; users, the
392 # EMM is in charge.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]393 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the user.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]394 &quot;primaryEmail&quot;: &quot;A String&quot;, # The user&#x27;s primary email address, for example, &quot;jsmith@example.com&quot;.
395 # Will always be set for Google managed users and not set for EMM managed
396 # users.
397 &quot;displayName&quot;: &quot;A String&quot;, # The name that will appear in user interfaces. Setting this property is
398 # optional when creating EMM-managed users. If you do set this property,
399 # use something generic about the organization (such as &quot;Example, Inc.&quot;) or
400 # your name (as EMM).
401 # Not used for Google-managed user accounts.
402 # @mutable androidenterprise.users.update
403 &quot;accountIdentifier&quot;: &quot;A String&quot;, # A unique identifier you create for this user, such as &quot;user342&quot; or
404 # &quot;asset#44418&quot;. Do not use personally identifiable information (PII) for
405 # this property. Must always be set for EMM-managed users.
406 # Not set for Google-managed users.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]407 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]408 ],
409 }</pre>
410</div>
411
412<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]413 <code class="details" id="revokeDeviceAccess">revokeDeviceAccess(enterpriseId, userId, x__xgafv=None)</code>
414 <pre>Revokes access to all devices currently provisioned to the user. The user
415will no longer be able to use the managed Play store on any of their
416managed devices.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]417
418This call only works with EMM-managed accounts.
419
420Args:
421 enterpriseId: string, The ID of the enterprise. (required)
422 userId: string, The ID of the user. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]423 x__xgafv: string, V1 error format.
424 Allowed values
425 1 - v1 error format
426 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]427</pre>
428</div>
429
430<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]431 <code class="details" id="setAvailableProductSet">setAvailableProductSet(enterpriseId, userId, body=None, x__xgafv=None)</code>
432 <pre>Modifies the set of products that a user is entitled to access (referred to
433as &lt;em&gt;whitelisted&lt;/em&gt; products). Only products that are
434&lt;a href=&quot;/android/work/play/emm-api/v1/products/approve&quot;&gt;approved&lt;/a&gt;
435or products that were previously approved (products with revoked approval)
436can be whitelisted.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]437
438Args:
439 enterpriseId: string, The ID of the enterprise. (required)
440 userId: string, The ID of the user. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]441 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]442 The object takes the form of:
443
444{ # A set of products.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]445 &quot;productId&quot;: [ # The list of product IDs making up the set of products.
446 &quot;A String&quot;,
447 ],
448 &quot;productVisibility&quot;: [ # Additional list of product IDs making up the product set.
449 # Unlike the productID array, in this list It&#x27;s possible to specify
450 # which tracks (alpha, beta, production) of a product are visible to the
451 # user. See ProductVisibility and its fields for more information. Specifying
452 # the same product ID both here and in the productId array is not allowed and
453 # it will result in an error.
454 { # A product to be made visible to a user.
455 &quot;trackIds&quot;: [ # Grants the user visibility to the specified product track(s), identified by
456 # &lt;code&gt;trackIds&lt;/code&gt;.
457 &quot;A String&quot;,
458 ],
459 &quot;productId&quot;: &quot;A String&quot;, # The product ID to make visible to the user.
460 # Required for each item in the productVisibility list.
461 &quot;tracks&quot;: [ # Deprecated. Use &lt;code&gt;trackIds&lt;/code&gt; instead.
462 &quot;A String&quot;,
463 ],
464 },
465 ],
466 &quot;productSetBehavior&quot;: &quot;A String&quot;, # The interpretation of this product set. &quot;unknown&quot; should never be sent and
467 # is ignored if received. &quot;whitelist&quot; means that the user is entitled to
468 # access the product set. &quot;includeAll&quot; means that all products are
469 # accessible, including products that are approved, products with revoked
470 # approval, and products that have never been approved. &quot;allApproved&quot; means
471 # that the user is entitled to access all products that are approved for the
472 # enterprise. If the value is &quot;allApproved&quot; or &quot;includeAll&quot;, the productId
473 # field is ignored. If no value is provided, it is interpreted as
474 # &quot;whitelist&quot; for backwards compatibility.
475 # Further &quot;allApproved&quot; or &quot;includeAll&quot; does not enable automatic
476 # visibility of &quot;alpha&quot; or &quot;beta&quot; tracks for Android app. Use
477 # ProductVisibility to enable &quot;alpha&quot; or &quot;beta&quot; tracks per user.
478 }
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]479
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]480 x__xgafv: string, V1 error format.
481 Allowed values
482 1 - v1 error format
483 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]484
485Returns:
486 An object of the form:
487
488 { # A set of products.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]489 &quot;productId&quot;: [ # The list of product IDs making up the set of products.
490 &quot;A String&quot;,
491 ],
492 &quot;productVisibility&quot;: [ # Additional list of product IDs making up the product set.
493 # Unlike the productID array, in this list It&#x27;s possible to specify
494 # which tracks (alpha, beta, production) of a product are visible to the
495 # user. See ProductVisibility and its fields for more information. Specifying
496 # the same product ID both here and in the productId array is not allowed and
497 # it will result in an error.
498 { # A product to be made visible to a user.
499 &quot;trackIds&quot;: [ # Grants the user visibility to the specified product track(s), identified by
500 # &lt;code&gt;trackIds&lt;/code&gt;.
501 &quot;A String&quot;,
502 ],
503 &quot;productId&quot;: &quot;A String&quot;, # The product ID to make visible to the user.
504 # Required for each item in the productVisibility list.
505 &quot;tracks&quot;: [ # Deprecated. Use &lt;code&gt;trackIds&lt;/code&gt; instead.
506 &quot;A String&quot;,
507 ],
508 },
509 ],
510 &quot;productSetBehavior&quot;: &quot;A String&quot;, # The interpretation of this product set. &quot;unknown&quot; should never be sent and
511 # is ignored if received. &quot;whitelist&quot; means that the user is entitled to
512 # access the product set. &quot;includeAll&quot; means that all products are
513 # accessible, including products that are approved, products with revoked
514 # approval, and products that have never been approved. &quot;allApproved&quot; means
515 # that the user is entitled to access all products that are approved for the
516 # enterprise. If the value is &quot;allApproved&quot; or &quot;includeAll&quot;, the productId
517 # field is ignored. If no value is provided, it is interpreted as
518 # &quot;whitelist&quot; for backwards compatibility.
519 # Further &quot;allApproved&quot; or &quot;includeAll&quot; does not enable automatic
520 # visibility of &quot;alpha&quot; or &quot;beta&quot; tracks for Android app. Use
521 # ProductVisibility to enable &quot;alpha&quot; or &quot;beta&quot; tracks per user.
522 }</pre>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]523</div>
524
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]525<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]526 <code class="details" id="update">update(enterpriseId, userId, body=None, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]527 <pre>Updates the details of an EMM-managed user.
528
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]529Can be used with EMM-managed users only (not Google managed users).
530Pass the new details in the
531&lt;a href=&quot;/android/work/play/emm-api/v1/users.html&quot;&gt;Users&lt;/a&gt;
532resource in the request body. Only the &lt;code&gt;displayName&lt;/code&gt; field
533can be changed. Other fields must either be unset or have the
534currently active value.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]535
536Args:
537 enterpriseId: string, The ID of the enterprise. (required)
538 userId: string, The ID of the user. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]539 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]540 The object takes the form of:
541
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]542{ # A Users resource represents an account associated with an enterprise. The
543 # account may be specific to a device or to an individual user (who can then
544 # use the account across multiple devices). The account may provide access to
545 # managed Google Play only, or to other Google services, depending on the
546 # identity model:
547 # &lt;ul&gt;&lt;li&gt;The Google managed domain identity model requires synchronization to
548 # Google account sources (via &lt;code&gt;primaryEmail&lt;/code&gt;).&lt;/li&gt;
549 # &lt;li&gt;The managed Google Play Accounts identity model provides a dynamic means
550 # for enterprises to create user or device accounts as needed. These accounts
551 # provide access to managed Google Play.&lt;/li&gt;
552 # &lt;/ul&gt;
553 &quot;accountType&quot;: &quot;A String&quot;, # The type of account that this user represents. A &lt;code&gt;userAccount&lt;/code&gt;
554 # can be installed on multiple devices, but a &lt;code&gt;deviceAccount&lt;/code&gt; is
555 # specific to a single device. An EMM-managed user (&lt;code&gt;emmManaged&lt;/code&gt;)
556 # can be either type (&lt;code&gt;userAccount&lt;/code&gt;, &lt;code&gt;deviceAccount&lt;/code&gt;),
557 # but a Google-managed user (&lt;code&gt;googleManaged&lt;/code&gt;) is always a
558 # &lt;code&gt;userAccount&lt;/code&gt;.
559 &quot;managementType&quot;: &quot;A String&quot;, # The entity that manages the user. With &lt;code&gt;googleManaged&lt;/code&gt; users,
560 # the source of truth is Google so EMMs have to make sure a Google Account
561 # exists for the user. With &lt;code&gt;emmManaged&lt;/code&gt; users, the
562 # EMM is in charge.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]563 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the user.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]564 &quot;primaryEmail&quot;: &quot;A String&quot;, # The user&#x27;s primary email address, for example, &quot;jsmith@example.com&quot;.
565 # Will always be set for Google managed users and not set for EMM managed
566 # users.
567 &quot;displayName&quot;: &quot;A String&quot;, # The name that will appear in user interfaces. Setting this property is
568 # optional when creating EMM-managed users. If you do set this property,
569 # use something generic about the organization (such as &quot;Example, Inc.&quot;) or
570 # your name (as EMM).
571 # Not used for Google-managed user accounts.
572 # @mutable androidenterprise.users.update
573 &quot;accountIdentifier&quot;: &quot;A String&quot;, # A unique identifier you create for this user, such as &quot;user342&quot; or
574 # &quot;asset#44418&quot;. Do not use personally identifiable information (PII) for
575 # this property. Must always be set for EMM-managed users.
576 # Not set for Google-managed users.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]577}
578
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]579 x__xgafv: string, V1 error format.
580 Allowed values
581 1 - v1 error format
582 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]583
584Returns:
585 An object of the form:
586
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]587 { # A Users resource represents an account associated with an enterprise. The
588 # account may be specific to a device or to an individual user (who can then
589 # use the account across multiple devices). The account may provide access to
590 # managed Google Play only, or to other Google services, depending on the
591 # identity model:
592 # &lt;ul&gt;&lt;li&gt;The Google managed domain identity model requires synchronization to
593 # Google account sources (via &lt;code&gt;primaryEmail&lt;/code&gt;).&lt;/li&gt;
594 # &lt;li&gt;The managed Google Play Accounts identity model provides a dynamic means
595 # for enterprises to create user or device accounts as needed. These accounts
596 # provide access to managed Google Play.&lt;/li&gt;
597 # &lt;/ul&gt;
598 &quot;accountType&quot;: &quot;A String&quot;, # The type of account that this user represents. A &lt;code&gt;userAccount&lt;/code&gt;
599 # can be installed on multiple devices, but a &lt;code&gt;deviceAccount&lt;/code&gt; is
600 # specific to a single device. An EMM-managed user (&lt;code&gt;emmManaged&lt;/code&gt;)
601 # can be either type (&lt;code&gt;userAccount&lt;/code&gt;, &lt;code&gt;deviceAccount&lt;/code&gt;),
602 # but a Google-managed user (&lt;code&gt;googleManaged&lt;/code&gt;) is always a
603 # &lt;code&gt;userAccount&lt;/code&gt;.
604 &quot;managementType&quot;: &quot;A String&quot;, # The entity that manages the user. With &lt;code&gt;googleManaged&lt;/code&gt; users,
605 # the source of truth is Google so EMMs have to make sure a Google Account
606 # exists for the user. With &lt;code&gt;emmManaged&lt;/code&gt; users, the
607 # EMM is in charge.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]608 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the user.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]609 &quot;primaryEmail&quot;: &quot;A String&quot;, # The user&#x27;s primary email address, for example, &quot;jsmith@example.com&quot;.
610 # Will always be set for Google managed users and not set for EMM managed
611 # users.
612 &quot;displayName&quot;: &quot;A String&quot;, # The name that will appear in user interfaces. Setting this property is
613 # optional when creating EMM-managed users. If you do set this property,
614 # use something generic about the organization (such as &quot;Example, Inc.&quot;) or
615 # your name (as EMM).
616 # Not used for Google-managed user accounts.
617 # @mutable androidenterprise.users.update
618 &quot;accountIdentifier&quot;: &quot;A String&quot;, # A unique identifier you create for this user, such as &quot;user342&quot; or
619 # &quot;asset#44418&quot;. Do not use personally identifiable information (PII) for
620 # this property. Must always be set for EMM-managed users.
621 # Not set for Google-managed users.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]622 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]623</div>
624
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]625</body></html>