blob: c4c4b4911836b451696f408dec4ecc1ffea2d30c [file] [log] [blame]
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +00001<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 +000075<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 +000076<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070081 <code><a href="#delete">delete(enterpriseId, userId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -070082<p class="firstline">Deleted an EMM-managed user.</p>
83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070084 <code><a href="#generateAuthenticationToken">generateAuthenticationToken(enterpriseId, userId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085<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. You can provision a maximum of 10 devices per user. This call only works with EMM-managed accounts.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -070086<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070087 <code><a href="#get">get(enterpriseId, userId, x__xgafv=None)</a></code></p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +000088<p class="firstline">Retrieves a user's details.</p>
89<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070090 <code><a href="#getAvailableProductSet">getAvailableProductSet(enterpriseId, userId, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -070091<p class="firstline">Retrieves the set of products a user is entitled to access.</p>
92<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070093 <code><a href="#insert">insert(enterpriseId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070094<p class="firstline">Creates a new EMM-managed user. The Users resource passed in the body of the request should include an accountIdentifier and an accountType. If 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.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -070095<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070096 <code><a href="#list">list(enterpriseId, email, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097<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>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -070098<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070099 <code><a href="#revokeDeviceAccess">revokeDeviceAccess(enterpriseId, userId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700100<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. This call only works with EMM-managed accounts.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700101<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700102 <code><a href="#setAvailableProductSet">setAvailableProductSet(enterpriseId, userId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700103<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>
Takashi Matsuo06694102015-09-11 13:55:40 -0700104<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700105 <code><a href="#update">update(enterpriseId, userId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700106<p class="firstline">Updates the details of an EMM-managed user. Can 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.</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000107<h3>Method Details</h3>
108<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700109 <code class="details" id="close">close()</code>
110 <pre>Close httplib2 connections.</pre>
111</div>
112
113<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700114 <code class="details" id="delete">delete(enterpriseId, userId, x__xgafv=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700115 <pre>Deleted an EMM-managed user.
116
117Args:
118 enterpriseId: string, The ID of the enterprise. (required)
119 userId: string, The ID of the user. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700120 x__xgafv: string, V1 error format.
121 Allowed values
122 1 - v1 error format
123 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700124</pre>
125</div>
126
127<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700128 <code class="details" id="generateAuthenticationToken">generateAuthenticationToken(enterpriseId, userId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700129 <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. You can provision a maximum of 10 devices per user. This call only works with EMM-managed accounts.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700130
131Args:
132 enterpriseId: string, The ID of the enterprise. (required)
133 userId: string, The ID of the user. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700134 x__xgafv: string, V1 error format.
135 Allowed values
136 1 - v1 error format
137 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700138
139Returns:
140 An object of the form:
141
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700142 { # An AuthenticationToken is used by the EMM&#x27;s device policy client on a device to provision the given EMM-managed user on that device.
143 &quot;token&quot;: &quot;A String&quot;, # 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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700144 }</pre>
145</div>
146
147<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700148 <code class="details" id="get">get(enterpriseId, userId, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700149 <pre>Retrieves a user&#x27;s details.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000150
151Args:
152 enterpriseId: string, The ID of the enterprise. (required)
153 userId: string, The ID of the user. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700154 x__xgafv: string, V1 error format.
155 Allowed values
156 1 - v1 error format
157 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000158
159Returns:
160 An object of the form:
161
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700162 { # 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: - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). - 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800163 &quot;accountType&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800164 &quot;managementType&quot;: &quot;A String&quot;, # 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.
165 &quot;displayName&quot;: &quot;A String&quot;, # 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 &quot;Example, Inc.&quot;) or your name (as EMM). Not used for Google-managed user accounts. @mutable androidenterprise.users.update
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800166 &quot;accountIdentifier&quot;: &quot;A String&quot;, # A unique identifier you create for this user, such as &quot;user342&quot; or &quot;asset#44418&quot;. Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
167 &quot;primaryEmail&quot;: &quot;A String&quot;, # The user&#x27;s primary email address, for example, &quot;jsmith@example.com&quot;. Will always be set for Google managed users and not set for EMM managed users.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800168 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the user.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400169 }</pre>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000170</div>
171
172<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700173 <code class="details" id="getAvailableProductSet">getAvailableProductSet(enterpriseId, userId, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700174 <pre>Retrieves the set of products a user is entitled to access.
175
176Args:
177 enterpriseId: string, The ID of the enterprise. (required)
178 userId: string, The ID of the user. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700179 x__xgafv: string, V1 error format.
180 Allowed values
181 1 - v1 error format
182 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700183
184Returns:
185 An object of the form:
186
187 { # A set of products.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800188 &quot;productVisibility&quot;: [ # Additional list of product IDs making up the product set. Unlike the productID array, in this list It&#x27;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.
189 { # A product to be made visible to a user.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800190 &quot;tracks&quot;: [ # Deprecated. Use trackIds instead.
191 &quot;A String&quot;,
192 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800193 &quot;productId&quot;: &quot;A String&quot;, # The product ID to make visible to the user. Required for each item in the productVisibility list.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800194 &quot;trackIds&quot;: [ # Grants the user visibility to the specified product track(s), identified by trackIds.
195 &quot;A String&quot;,
196 ],
197 },
198 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800199 &quot;productSetBehavior&quot;: &quot;A String&quot;, # The interpretation of this product set. &quot;unknown&quot; should never be sent and is ignored if received. &quot;whitelist&quot; means that the user is entitled to access the product set. &quot;includeAll&quot; means that all products are accessible, including products that are approved, products with revoked approval, and products that have never been approved. &quot;allApproved&quot; means that the user is entitled to access all products that are approved for the enterprise. If the value is &quot;allApproved&quot; or &quot;includeAll&quot;, the productId field is ignored. If no value is provided, it is interpreted as &quot;whitelist&quot; for backwards compatibility. Further &quot;allApproved&quot; or &quot;includeAll&quot; does not enable automatic visibility of &quot;alpha&quot; or &quot;beta&quot; tracks for Android app. Use ProductVisibility to enable &quot;alpha&quot; or &quot;beta&quot; tracks per user.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800200 &quot;productId&quot;: [ # The list of product IDs making up the set of products.
201 &quot;A String&quot;,
202 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800203 }</pre>
Takashi Matsuo06694102015-09-11 13:55:40 -0700204</div>
205
206<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700207 <code class="details" id="insert">insert(enterpriseId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700208 <pre>Creates a new EMM-managed user. The Users resource passed in the body of the request should include an accountIdentifier and an accountType. If 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 -0700209
210Args:
211 enterpriseId: string, The ID of the enterprise. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700212 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700213 The object takes the form of:
214
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700215{ # 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: - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). - 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800216 &quot;accountType&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800217 &quot;managementType&quot;: &quot;A String&quot;, # 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.
218 &quot;displayName&quot;: &quot;A String&quot;, # 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 &quot;Example, Inc.&quot;) or your name (as EMM). Not used for Google-managed user accounts. @mutable androidenterprise.users.update
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800219 &quot;accountIdentifier&quot;: &quot;A String&quot;, # A unique identifier you create for this user, such as &quot;user342&quot; or &quot;asset#44418&quot;. Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
220 &quot;primaryEmail&quot;: &quot;A String&quot;, # The user&#x27;s primary email address, for example, &quot;jsmith@example.com&quot;. Will always be set for Google managed users and not set for EMM managed users.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800221 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the user.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400222}
223
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700224 x__xgafv: string, V1 error format.
225 Allowed values
226 1 - v1 error format
227 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400228
229Returns:
230 An object of the form:
231
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700232 { # 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: - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). - 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800233 &quot;accountType&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800234 &quot;managementType&quot;: &quot;A String&quot;, # 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.
235 &quot;displayName&quot;: &quot;A String&quot;, # 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 &quot;Example, Inc.&quot;) or your name (as EMM). Not used for Google-managed user accounts. @mutable androidenterprise.users.update
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800236 &quot;accountIdentifier&quot;: &quot;A String&quot;, # A unique identifier you create for this user, such as &quot;user342&quot; or &quot;asset#44418&quot;. Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
237 &quot;primaryEmail&quot;: &quot;A String&quot;, # The user&#x27;s primary email address, for example, &quot;jsmith@example.com&quot;. Will always be set for Google managed users and not set for EMM managed users.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800238 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the user.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400239 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700240</div>
241
242<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700243 <code class="details" id="list">list(enterpriseId, email, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700244 <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 +0000245
246Args:
247 enterpriseId: string, The ID of the enterprise. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700248 email: string, Required. The exact primary email address of the user to look up. (required)
249 x__xgafv: string, V1 error format.
250 Allowed values
251 1 - v1 error format
252 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000253
254Returns:
255 An object of the form:
256
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700257 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700258 &quot;user&quot;: [ # A user of an enterprise.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700259 { # 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: - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). - 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800260 &quot;accountType&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800261 &quot;managementType&quot;: &quot;A String&quot;, # 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.
262 &quot;displayName&quot;: &quot;A String&quot;, # 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 &quot;Example, Inc.&quot;) or your name (as EMM). Not used for Google-managed user accounts. @mutable androidenterprise.users.update
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800263 &quot;accountIdentifier&quot;: &quot;A String&quot;, # A unique identifier you create for this user, such as &quot;user342&quot; or &quot;asset#44418&quot;. Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
264 &quot;primaryEmail&quot;: &quot;A String&quot;, # The user&#x27;s primary email address, for example, &quot;jsmith@example.com&quot;. Will always be set for Google managed users and not set for EMM managed users.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800265 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the user.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400266 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000267 ],
268 }</pre>
269</div>
270
271<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700272 <code class="details" id="revokeDeviceAccess">revokeDeviceAccess(enterpriseId, userId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700273 <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. This call only works with EMM-managed accounts.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700274
275Args:
276 enterpriseId: string, The ID of the enterprise. (required)
277 userId: string, The ID of the user. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700278 x__xgafv: string, V1 error format.
279 Allowed values
280 1 - v1 error format
281 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700282</pre>
283</div>
284
285<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700286 <code class="details" id="setAvailableProductSet">setAvailableProductSet(enterpriseId, userId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700287 <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 -0700288
289Args:
290 enterpriseId: string, The ID of the enterprise. (required)
291 userId: string, The ID of the user. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700292 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700293 The object takes the form of:
294
295{ # A set of products.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800296 &quot;productVisibility&quot;: [ # Additional list of product IDs making up the product set. Unlike the productID array, in this list It&#x27;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.
297 { # A product to be made visible to a user.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800298 &quot;tracks&quot;: [ # Deprecated. Use trackIds instead.
299 &quot;A String&quot;,
300 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800301 &quot;productId&quot;: &quot;A String&quot;, # The product ID to make visible to the user. Required for each item in the productVisibility list.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800302 &quot;trackIds&quot;: [ # Grants the user visibility to the specified product track(s), identified by trackIds.
303 &quot;A String&quot;,
304 ],
305 },
306 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800307 &quot;productSetBehavior&quot;: &quot;A String&quot;, # The interpretation of this product set. &quot;unknown&quot; should never be sent and is ignored if received. &quot;whitelist&quot; means that the user is entitled to access the product set. &quot;includeAll&quot; means that all products are accessible, including products that are approved, products with revoked approval, and products that have never been approved. &quot;allApproved&quot; means that the user is entitled to access all products that are approved for the enterprise. If the value is &quot;allApproved&quot; or &quot;includeAll&quot;, the productId field is ignored. If no value is provided, it is interpreted as &quot;whitelist&quot; for backwards compatibility. Further &quot;allApproved&quot; or &quot;includeAll&quot; does not enable automatic visibility of &quot;alpha&quot; or &quot;beta&quot; tracks for Android app. Use ProductVisibility to enable &quot;alpha&quot; or &quot;beta&quot; tracks per user.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800308 &quot;productId&quot;: [ # The list of product IDs making up the set of products.
309 &quot;A String&quot;,
310 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800311 }
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400312
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700313 x__xgafv: string, V1 error format.
314 Allowed values
315 1 - v1 error format
316 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400317
318Returns:
319 An object of the form:
320
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700321 { # A set of products.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800322 &quot;productVisibility&quot;: [ # Additional list of product IDs making up the product set. Unlike the productID array, in this list It&#x27;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.
323 { # A product to be made visible to a user.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800324 &quot;tracks&quot;: [ # Deprecated. Use trackIds instead.
325 &quot;A String&quot;,
326 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800327 &quot;productId&quot;: &quot;A String&quot;, # The product ID to make visible to the user. Required for each item in the productVisibility list.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800328 &quot;trackIds&quot;: [ # Grants the user visibility to the specified product track(s), identified by trackIds.
329 &quot;A String&quot;,
330 ],
331 },
332 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800333 &quot;productSetBehavior&quot;: &quot;A String&quot;, # The interpretation of this product set. &quot;unknown&quot; should never be sent and is ignored if received. &quot;whitelist&quot; means that the user is entitled to access the product set. &quot;includeAll&quot; means that all products are accessible, including products that are approved, products with revoked approval, and products that have never been approved. &quot;allApproved&quot; means that the user is entitled to access all products that are approved for the enterprise. If the value is &quot;allApproved&quot; or &quot;includeAll&quot;, the productId field is ignored. If no value is provided, it is interpreted as &quot;whitelist&quot; for backwards compatibility. Further &quot;allApproved&quot; or &quot;includeAll&quot; does not enable automatic visibility of &quot;alpha&quot; or &quot;beta&quot; tracks for Android app. Use ProductVisibility to enable &quot;alpha&quot; or &quot;beta&quot; tracks per user.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800334 &quot;productId&quot;: [ # The list of product IDs making up the set of products.
335 &quot;A String&quot;,
336 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800337 }</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700338</div>
339
340<div class="method">
341 <code class="details" id="update">update(enterpriseId, userId, body=None, x__xgafv=None)</code>
342 <pre>Updates the details of an EMM-managed user. Can 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.
343
344Args:
345 enterpriseId: string, The ID of the enterprise. (required)
346 userId: string, The ID of the user. (required)
347 body: object, The request body.
348 The object takes the form of:
349
350{ # 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: - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). - 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800351 &quot;accountType&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800352 &quot;managementType&quot;: &quot;A String&quot;, # 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.
353 &quot;displayName&quot;: &quot;A String&quot;, # 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 &quot;Example, Inc.&quot;) or your name (as EMM). Not used for Google-managed user accounts. @mutable androidenterprise.users.update
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800354 &quot;accountIdentifier&quot;: &quot;A String&quot;, # A unique identifier you create for this user, such as &quot;user342&quot; or &quot;asset#44418&quot;. Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
355 &quot;primaryEmail&quot;: &quot;A String&quot;, # The user&#x27;s primary email address, for example, &quot;jsmith@example.com&quot;. Will always be set for Google managed users and not set for EMM managed users.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800356 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the user.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700357}
358
359 x__xgafv: string, V1 error format.
360 Allowed values
361 1 - v1 error format
362 2 - v2 error format
363
364Returns:
365 An object of the form:
366
367 { # 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: - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). - 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800368 &quot;accountType&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800369 &quot;managementType&quot;: &quot;A String&quot;, # 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.
370 &quot;displayName&quot;: &quot;A String&quot;, # 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 &quot;Example, Inc.&quot;) or your name (as EMM). Not used for Google-managed user accounts. @mutable androidenterprise.users.update
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800371 &quot;accountIdentifier&quot;: &quot;A String&quot;, # A unique identifier you create for this user, such as &quot;user342&quot; or &quot;asset#44418&quot;. Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
372 &quot;primaryEmail&quot;: &quot;A String&quot;, # The user&#x27;s primary email address, for example, &quot;jsmith@example.com&quot;. Will always be set for Google managed users and not set for EMM managed users.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800373 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the user.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400374 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700375</div>
376
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000377</body></html>