Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 02bae1c909ec28088ebbc4007f3ef9b968b55e0a / . / docs / dyn / androidenterprise_v1.users.html
blob: c1faa5b365eada1166c789ca8ce76c706b50ae12 [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">
102 <code><a href="#revokeToken">revokeToken(enterpriseId, userId)</a></code></p>
103<p class="firstline">Revokes a previously generated token (activation code) for the user.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]104<p class="toc_element">
105 <code><a href="#setAvailableProductSet">setAvailableProductSet(enterpriseId, userId, body)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]106<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]107<p class="toc_element">
108 <code><a href="#update">update(enterpriseId, userId, body)</a></code></p>
109<p class="firstline">Updates the details of an EMM-managed user.</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]110<h3>Method Details</h3>
111<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]112 <code class="details" id="delete">delete(enterpriseId, userId)</code>
113 <pre>Deleted an EMM-managed user.
114
115Args:
116 enterpriseId: string, The ID of the enterprise. (required)
117 userId: string, The ID of the user. (required)
118</pre>
119</div>
120
121<div class="method">
122 <code class="details" id="generateAuthenticationToken">generateAuthenticationToken(enterpriseId, userId)</code>
123 <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.
124
125This call only works with EMM-managed accounts.
126
127Args:
128 enterpriseId: string, The ID of the enterprise. (required)
129 userId: string, The ID of the user. (required)
130
131Returns:
132 An object of the form:
133
134 { # An AuthenticationToken is used by the EMM's device policy client on a device to provision the given EMM-managed user on that device.
135 "kind": "androidenterprise#authenticationToken", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#authenticationToken".
136 "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.
137 }</pre>
138</div>
139
140<div class="method">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]141 <code class="details" id="generateToken">generateToken(enterpriseId, userId)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]142 <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]143
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]144This call only works with Google managed accounts.
145
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]146Args:
147 enterpriseId: string, The ID of the enterprise. (required)
148 userId: string, The ID of the user. (required)
149
150Returns:
151 An object of the form:
152
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]153 { # 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]154 "kind": "androidenterprise#userToken", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#userToken".
155 "userId": "A String", # The unique ID for the user.
156 "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.
157 }</pre>
158</div>
159
160<div class="method">
161 <code class="details" id="get">get(enterpriseId, userId)</code>
162 <pre>Retrieves a user's details.
163
164Args:
165 enterpriseId: string, The ID of the enterprise. (required)
166 userId: string, The ID of the user. (required)
167
168Returns:
169 An object of the form:
170
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]171 { # 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:
172 # - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
173 # - 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.
174 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
175 "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.
176 "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.
177 "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.
178 "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.
179 "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.
180 "id": "A String", # The unique ID for the user.
181 }</pre>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]182</div>
183
184<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]185 <code class="details" id="getAvailableProductSet">getAvailableProductSet(enterpriseId, userId)</code>
186 <pre>Retrieves the set of products a user is entitled to access.
187
188Args:
189 enterpriseId: string, The ID of the enterprise. (required)
190 userId: string, The ID of the user. (required)
191
192Returns:
193 An object of the form:
194
195 { # A set of products.
196 "kind": "androidenterprise#productSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productSet".
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]197 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]198 "productId": [ # The list of product IDs making up the set of products.
199 "A String",
200 ],
201 }</pre>
202</div>
203
204<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]205 <code class="details" id="insert">insert(enterpriseId, body)</code>
206 <pre>Creates a new EMM-managed user.
207
208The 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]209If 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]210
211Args:
212 enterpriseId: string, The ID of the enterprise. (required)
213 body: object, The request body. (required)
214 The object takes the form of:
215
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]216{ # 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:
217 # - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
218 # - 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.
219 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
220 "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.
221 "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.
222 "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.
223 "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.
224 "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.
225 "id": "A String", # The unique ID for the user.
226}
227
228
229Returns:
230 An object of the form:
231
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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]242 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]243</div>
244
245<div class="method">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]246 <code class="details" id="list">list(enterpriseId, email)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]247 <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]248
249Args:
250 enterpriseId: string, The ID of the enterprise. (required)
251 email: string, The exact primary email address of the user to look up. (required)
252
253Returns:
254 An object of the form:
255
256 { # The matching user resources.
257 "kind": "androidenterprise#usersListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#usersListResponse".
258 "user": [ # A user of an enterprise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]259 { # 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:
260 # - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
261 # - 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.
262 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
263 "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.
264 "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.
265 "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.
266 "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.
267 "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.
268 "id": "A String", # The unique ID for the user.
269 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]270 ],
271 }</pre>
272</div>
273
274<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]275 <code class="details" id="patch">patch(enterpriseId, userId, body)</code>
276 <pre>Updates the details of an EMM-managed user.
277
278Can 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.
279
280Args:
281 enterpriseId: string, The ID of the enterprise. (required)
282 userId: string, The ID of the user. (required)
283 body: object, The request body. (required)
284 The object takes the form of:
285
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]286{ # 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:
287 # - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
288 # - 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.
289 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
290 "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.
291 "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.
292 "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.
293 "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.
294 "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.
295 "id": "A String", # The unique ID for the user.
296}
297
298
299Returns:
300 An object of the form:
301
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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]312 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]313</div>
314
315<div class="method">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]316 <code class="details" id="revokeToken">revokeToken(enterpriseId, userId)</code>
317 <pre>Revokes a previously generated token (activation code) for the user.
318
319Args:
320 enterpriseId: string, The ID of the enterprise. (required)
321 userId: string, The ID of the user. (required)
322</pre>
323</div>
324
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]325<div class="method">
326 <code class="details" id="setAvailableProductSet">setAvailableProductSet(enterpriseId, userId, body)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]327 <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]328
329Args:
330 enterpriseId: string, The ID of the enterprise. (required)
331 userId: string, The ID of the user. (required)
332 body: object, The request body. (required)
333 The object takes the form of:
334
335{ # A set of products.
336 "kind": "androidenterprise#productSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productSet".
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]337 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]338 "productId": [ # The list of product IDs making up the set of products.
339 "A String",
340 ],
341 }
342
343
344Returns:
345 An object of the form:
346
347 { # A set of products.
348 "kind": "androidenterprise#productSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productSet".
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]349 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]350 "productId": [ # The list of product IDs making up the set of products.
351 "A String",
352 ],
353 }</pre>
354</div>
355
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]356<div class="method">
357 <code class="details" id="update">update(enterpriseId, userId, body)</code>
358 <pre>Updates the details of an EMM-managed user.
359
360Can 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.
361
362Args:
363 enterpriseId: string, The ID of the enterprise. (required)
364 userId: string, The ID of the user. (required)
365 body: object, The request body. (required)
366 The object takes the form of:
367
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]368{ # 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:
369 # - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
370 # - 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.
371 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
372 "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.
373 "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.
374 "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.
375 "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.
376 "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.
377 "id": "A String", # The unique ID for the user.
378}
379
380
381Returns:
382 An object of the form:
383
384 { # 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:
385 # - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
386 # - 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]387 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
388 "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.
389 "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.
390 "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.
391 "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.
392 "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.
393 "id": "A String", # The unique ID for the user.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]394 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]395</div>
396
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]397</body></html>