Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / androidenterprise_v1.users.html
blob: 5cfdddc6f4cc3eab835409dd0922828ac3eac93e [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">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]78 <code><a href="#delete">delete(enterpriseId, userId)</a></code></p>
79<p class="firstline">Deleted an EMM-managed user.</p>
80<p class="toc_element">
81 <code><a href="#generateAuthenticationToken">generateAuthenticationToken(enterpriseId, userId)</a></code></p>
82<p class="firstline">Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device. The generated token is single-use and expires after a few minutes.</p>
83<p class="toc_element">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]84 <code><a href="#generateToken">generateToken(enterpriseId, userId)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]85<p class="firstline">Generates a token (activation code) to allow this user to configure their managed account in the Android Setup Wizard. Revokes any previously generated token.</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]86<p class="toc_element">
87 <code><a href="#get">get(enterpriseId, userId)</a></code></p>
88<p class="firstline">Retrieves a user's details.</p>
89<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]90 <code><a href="#getAvailableProductSet">getAvailableProductSet(enterpriseId, userId)</a></code></p>
91<p class="firstline">Retrieves the set of products a user is entitled to access.</p>
92<p class="toc_element">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]93 <code><a href="#insert">insert(enterpriseId, body)</a></code></p>
94<p class="firstline">Creates a new EMM-managed user.</p>
95<p class="toc_element">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]96 <code><a href="#list">list(enterpriseId, email)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]97<p class="firstline">Looks up a user by primary email address. This is only supported for Google-managed users. Lookup of the id is not needed for EMM-managed users because the id is already returned in the result of the Users.insert call.</p>
98<p class="toc_element">
99 <code><a href="#patch">patch(enterpriseId, userId, body)</a></code></p>
100<p class="firstline">Updates the details of an EMM-managed user.</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]101<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]102 <code><a href="#revokeDeviceAccess">revokeDeviceAccess(enterpriseId, userId)</a></code></p>
103<p class="firstline">Revokes access to all devices currently provisioned to the user. The user will no longer be able to use the managed Play store on any of their managed devices.</p>
104<p class="toc_element">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]105 <code><a href="#revokeToken">revokeToken(enterpriseId, userId)</a></code></p>
106<p class="firstline">Revokes a previously generated token (activation code) for the user.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]107<p class="toc_element">
108 <code><a href="#setAvailableProductSet">setAvailableProductSet(enterpriseId, userId, body)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]109<p class="firstline">Modifies the set of products that a user is entitled to access (referred to as whitelisted products). Only products that are approved or products that were previously approved (products with revoked approval) can be whitelisted.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]110<p class="toc_element">
111 <code><a href="#update">update(enterpriseId, userId, body)</a></code></p>
112<p class="firstline">Updates the details of an EMM-managed user.</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]113<h3>Method Details</h3>
114<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]115 <code class="details" id="delete">delete(enterpriseId, userId)</code>
116 <pre>Deleted an EMM-managed user.
117
118Args:
119 enterpriseId: string, The ID of the enterprise. (required)
120 userId: string, The ID of the user. (required)
121</pre>
122</div>
123
124<div class="method">
125 <code class="details" id="generateAuthenticationToken">generateAuthenticationToken(enterpriseId, userId)</code>
126 <pre>Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device. The generated token is single-use and expires after a few minutes.
127
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]128You can provision a maximum of 10 devices per user.
129
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]130This call only works with EMM-managed accounts.
131
132Args:
133 enterpriseId: string, The ID of the enterprise. (required)
134 userId: string, The ID of the user. (required)
135
136Returns:
137 An object of the form:
138
139 { # An AuthenticationToken is used by the EMM's device policy client on a device to provision the given EMM-managed user on that device.
140 "kind": "androidenterprise#authenticationToken", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#authenticationToken".
141 "token": "A String", # The authentication token to be passed to the device policy client on the device where it can be used to provision the account for which this token was generated.
142 }</pre>
143</div>
144
145<div class="method">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]146 <code class="details" id="generateToken">generateToken(enterpriseId, userId)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]147 <pre>Generates a token (activation code) to allow this user to configure their managed account in the Android Setup Wizard. Revokes any previously generated token.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]148
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]149This call only works with Google managed accounts.
150
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]151Args:
152 enterpriseId: string, The ID of the enterprise. (required)
153 userId: string, The ID of the user. (required)
154
155Returns:
156 An object of the form:
157
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]158 { # A UserToken is used by a user when setting up a managed device or profile with their managed Google Play account on a device. When the user enters their email address and token (activation code) the appropriate EMM app can be automatically downloaded.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]159 "kind": "androidenterprise#userToken", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#userToken".
160 "userId": "A String", # The unique ID for the user.
161 "token": "A String", # The token (activation code) to be entered by the user. This consists of a sequence of decimal digits. Note that the leading digit may be 0.
162 }</pre>
163</div>
164
165<div class="method">
166 <code class="details" id="get">get(enterpriseId, userId)</code>
167 <pre>Retrieves a user's details.
168
169Args:
170 enterpriseId: string, The ID of the enterprise. (required)
171 userId: string, The ID of the user. (required)
172
173Returns:
174 An object of the form:
175
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]176 { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to managed Google Play only, or to other Google services, depending on the identity model:
177 # - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
178 # - The managed Google Play Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to managed Google Play.
179 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
180 "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
181 "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
182 "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
183 "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
184 "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
185 "id": "A String", # The unique ID for the user.
186 }</pre>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]187</div>
188
189<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]190 <code class="details" id="getAvailableProductSet">getAvailableProductSet(enterpriseId, userId)</code>
191 <pre>Retrieves the set of products a user is entitled to access.
192
193Args:
194 enterpriseId: string, The ID of the enterprise. (required)
195 userId: string, The ID of the user. (required)
196
197Returns:
198 An object of the form:
199
200 { # A set of products.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]201 "productVisibility": [ # Additional list of product IDs making up the product set. Unlike the productID array, in this list It's possible to specify which tracks (alpha, beta, production) of a product are visible to the user. See ProductVisibility and its fields for more information. Specifying the same product ID both here and in the productId array is not allowed and it will result in an error.
202 { # A product to be made visible to a user.
203 "trackIds": [ # Grants the user visibility to the specified product track(s), identified by trackIds.
204 "A String",
205 ],
206 "tracks": [ # Deprecated. Use trackIds instead.
207 "A String",
208 ],
209 "productId": "A String", # The product ID to make visible to the user. Required for each item in the productVisibility list.
210 },
211 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]212 "kind": "androidenterprise#productSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productSet".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]213 "productSetBehavior": "A String", # The interpretation of this product set. "unknown" should never be sent and is ignored if received. "whitelist" means that the user is entitled to access the product set. "includeAll" means that all products are accessible, including products that are approved, products with revoked approval, and products that have never been approved. "allApproved" means that the user is entitled to access all products that are approved for the enterprise. If the value is "allApproved" or "includeAll", the productId field is ignored. If no value is provided, it is interpreted as "whitelist" for backwards compatibility. Further "allApproved" or "includeAll" does not enable automatic visibility of "alpha" or "beta" tracks for Android app. Use ProductVisibility to enable "alpha" or "beta" tracks per user.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]214 "productId": [ # The list of product IDs making up the set of products.
215 "A String",
216 ],
217 }</pre>
218</div>
219
220<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]221 <code class="details" id="insert">insert(enterpriseId, body)</code>
222 <pre>Creates a new EMM-managed user.
223
224The Users resource passed in the body of the request should include an accountIdentifier and an accountType.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]225If a corresponding user already exists with the same account identifier, the user will be updated with the resource. In this case only the displayName field can be changed.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]226
227Args:
228 enterpriseId: string, The ID of the enterprise. (required)
229 body: object, The request body. (required)
230 The object takes the form of:
231
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]232{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to managed Google Play only, or to other Google services, depending on the identity model:
233 # - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
234 # - The managed Google Play Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to managed Google Play.
235 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
236 "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
237 "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
238 "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
239 "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
240 "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
241 "id": "A String", # The unique ID for the user.
242}
243
244
245Returns:
246 An object of the form:
247
248 { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to managed Google Play only, or to other Google services, depending on the identity model:
249 # - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
250 # - The managed Google Play Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to managed Google Play.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]251 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
252 "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
253 "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
254 "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
255 "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
256 "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
257 "id": "A String", # The unique ID for the user.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]258 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]259</div>
260
261<div class="method">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]262 <code class="details" id="list">list(enterpriseId, email)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]263 <pre>Looks up a user by primary email address. This is only supported for Google-managed users. Lookup of the id is not needed for EMM-managed users because the id is already returned in the result of the Users.insert call.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]264
265Args:
266 enterpriseId: string, The ID of the enterprise. (required)
267 email: string, The exact primary email address of the user to look up. (required)
268
269Returns:
270 An object of the form:
271
272 { # The matching user resources.
273 "kind": "androidenterprise#usersListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#usersListResponse".
274 "user": [ # A user of an enterprise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]275 { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to managed Google Play only, or to other Google services, depending on the identity model:
276 # - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
277 # - The managed Google Play Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to managed Google Play.
278 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
279 "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
280 "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
281 "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
282 "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
283 "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
284 "id": "A String", # The unique ID for the user.
285 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]286 ],
287 }</pre>
288</div>
289
290<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]291 <code class="details" id="patch">patch(enterpriseId, userId, body)</code>
292 <pre>Updates the details of an EMM-managed user.
293
294Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value. This method supports patch semantics.
295
296Args:
297 enterpriseId: string, The ID of the enterprise. (required)
298 userId: string, The ID of the user. (required)
299 body: object, The request body. (required)
300 The object takes the form of:
301
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]302{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to managed Google Play only, or to other Google services, depending on the identity model:
303 # - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
304 # - The managed Google Play Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to managed Google Play.
305 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
306 "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
307 "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
308 "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
309 "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
310 "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
311 "id": "A String", # The unique ID for the user.
312}
313
314
315Returns:
316 An object of the form:
317
318 { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to managed Google Play only, or to other Google services, depending on the identity model:
319 # - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
320 # - The managed Google Play Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to managed Google Play.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]321 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
322 "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
323 "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
324 "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
325 "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
326 "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
327 "id": "A String", # The unique ID for the user.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]328 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]329</div>
330
331<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]332 <code class="details" id="revokeDeviceAccess">revokeDeviceAccess(enterpriseId, userId)</code>
333 <pre>Revokes access to all devices currently provisioned to the user. The user will no longer be able to use the managed Play store on any of their managed devices.
334
335This call only works with EMM-managed accounts.
336
337Args:
338 enterpriseId: string, The ID of the enterprise. (required)
339 userId: string, The ID of the user. (required)
340</pre>
341</div>
342
343<div class="method">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]344 <code class="details" id="revokeToken">revokeToken(enterpriseId, userId)</code>
345 <pre>Revokes a previously generated token (activation code) for the user.
346
347Args:
348 enterpriseId: string, The ID of the enterprise. (required)
349 userId: string, The ID of the user. (required)
350</pre>
351</div>
352
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]353<div class="method">
354 <code class="details" id="setAvailableProductSet">setAvailableProductSet(enterpriseId, userId, body)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]355 <pre>Modifies the set of products that a user is entitled to access (referred to as whitelisted products). Only products that are approved or products that were previously approved (products with revoked approval) can be whitelisted.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]356
357Args:
358 enterpriseId: string, The ID of the enterprise. (required)
359 userId: string, The ID of the user. (required)
360 body: object, The request body. (required)
361 The object takes the form of:
362
363{ # A set of products.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]364 "productVisibility": [ # Additional list of product IDs making up the product set. Unlike the productID array, in this list It's possible to specify which tracks (alpha, beta, production) of a product are visible to the user. See ProductVisibility and its fields for more information. Specifying the same product ID both here and in the productId array is not allowed and it will result in an error.
365 { # A product to be made visible to a user.
366 "trackIds": [ # Grants the user visibility to the specified product track(s), identified by trackIds.
367 "A String",
368 ],
369 "tracks": [ # Deprecated. Use trackIds instead.
370 "A String",
371 ],
372 "productId": "A String", # The product ID to make visible to the user. Required for each item in the productVisibility list.
373 },
374 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]375 "kind": "androidenterprise#productSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productSet".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]376 "productSetBehavior": "A String", # The interpretation of this product set. "unknown" should never be sent and is ignored if received. "whitelist" means that the user is entitled to access the product set. "includeAll" means that all products are accessible, including products that are approved, products with revoked approval, and products that have never been approved. "allApproved" means that the user is entitled to access all products that are approved for the enterprise. If the value is "allApproved" or "includeAll", the productId field is ignored. If no value is provided, it is interpreted as "whitelist" for backwards compatibility. Further "allApproved" or "includeAll" does not enable automatic visibility of "alpha" or "beta" tracks for Android app. Use ProductVisibility to enable "alpha" or "beta" tracks per user.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]377 "productId": [ # The list of product IDs making up the set of products.
378 "A String",
379 ],
380 }
381
382
383Returns:
384 An object of the form:
385
386 { # A set of products.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]387 "productVisibility": [ # Additional list of product IDs making up the product set. Unlike the productID array, in this list It's possible to specify which tracks (alpha, beta, production) of a product are visible to the user. See ProductVisibility and its fields for more information. Specifying the same product ID both here and in the productId array is not allowed and it will result in an error.
388 { # A product to be made visible to a user.
389 "trackIds": [ # Grants the user visibility to the specified product track(s), identified by trackIds.
390 "A String",
391 ],
392 "tracks": [ # Deprecated. Use trackIds instead.
393 "A String",
394 ],
395 "productId": "A String", # The product ID to make visible to the user. Required for each item in the productVisibility list.
396 },
397 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]398 "kind": "androidenterprise#productSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productSet".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]399 "productSetBehavior": "A String", # The interpretation of this product set. "unknown" should never be sent and is ignored if received. "whitelist" means that the user is entitled to access the product set. "includeAll" means that all products are accessible, including products that are approved, products with revoked approval, and products that have never been approved. "allApproved" means that the user is entitled to access all products that are approved for the enterprise. If the value is "allApproved" or "includeAll", the productId field is ignored. If no value is provided, it is interpreted as "whitelist" for backwards compatibility. Further "allApproved" or "includeAll" does not enable automatic visibility of "alpha" or "beta" tracks for Android app. Use ProductVisibility to enable "alpha" or "beta" tracks per user.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]400 "productId": [ # The list of product IDs making up the set of products.
401 "A String",
402 ],
403 }</pre>
404</div>
405
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]406<div class="method">
407 <code class="details" id="update">update(enterpriseId, userId, body)</code>
408 <pre>Updates the details of an EMM-managed user.
409
410Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value.
411
412Args:
413 enterpriseId: string, The ID of the enterprise. (required)
414 userId: string, The ID of the user. (required)
415 body: object, The request body. (required)
416 The object takes the form of:
417
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]418{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to managed Google Play only, or to other Google services, depending on the identity model:
419 # - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
420 # - The managed Google Play Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to managed Google Play.
421 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
422 "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
423 "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
424 "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
425 "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
426 "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
427 "id": "A String", # The unique ID for the user.
428}
429
430
431Returns:
432 An object of the form:
433
434 { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to managed Google Play only, or to other Google services, depending on the identity model:
435 # - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
436 # - The managed Google Play Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to managed Google Play.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]437 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
438 "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
439 "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
440 "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
441 "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
442 "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
443 "id": "A String", # The unique ID for the user.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]444 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]445</div>
446
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]447</body></html>