1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.users.html">users</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(enterpriseId, userId, x__xgafv=None)</a></code></p> 82<p class="firstline">Deleted an EMM-managed user.</p> 83<p class="toc_element"> 84 <code><a href="#generateAuthenticationToken">generateAuthenticationToken(enterpriseId, userId, x__xgafv=None)</a></code></p> 85<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> 86<p class="toc_element"> 87 <code><a href="#get">get(enterpriseId, userId, x__xgafv=None)</a></code></p> 88<p class="firstline">Retrieves a user's details.</p> 89<p class="toc_element"> 90 <code><a href="#getAvailableProductSet">getAvailableProductSet(enterpriseId, userId, x__xgafv=None)</a></code></p> 91<p class="firstline">Retrieves the set of products a user is entitled to access.</p> 92<p class="toc_element"> 93 <code><a href="#insert">insert(enterpriseId, body=None, x__xgafv=None)</a></code></p> 94<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> 95<p class="toc_element"> 96 <code><a href="#list">list(enterpriseId, email, x__xgafv=None)</a></code></p> 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="#revokeDeviceAccess">revokeDeviceAccess(enterpriseId, userId, x__xgafv=None)</a></code></p> 100<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> 101<p class="toc_element"> 102 <code><a href="#setAvailableProductSet">setAvailableProductSet(enterpriseId, userId, body=None, x__xgafv=None)</a></code></p> 103<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> 104<p class="toc_element"> 105 <code><a href="#update">update(enterpriseId, userId, body=None, x__xgafv=None)</a></code></p> 106<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> 107<h3>Method Details</h3> 108<div class="method"> 109 <code class="details" id="close">close()</code> 110 <pre>Close httplib2 connections.</pre> 111</div> 112 113<div class="method"> 114 <code class="details" id="delete">delete(enterpriseId, userId, x__xgafv=None)</code> 115 <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) 120 x__xgafv: string, V1 error format. 121 Allowed values 122 1 - v1 error format 123 2 - v2 error format 124</pre> 125</div> 126 127<div class="method"> 128 <code class="details" id="generateAuthenticationToken">generateAuthenticationToken(enterpriseId, userId, x__xgafv=None)</code> 129 <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. 130 131Args: 132 enterpriseId: string, The ID of the enterprise. (required) 133 userId: string, The ID of the user. (required) 134 x__xgafv: string, V1 error format. 135 Allowed values 136 1 - v1 error format 137 2 - v2 error format 138 139Returns: 140 An object of the form: 141 142 { # An AuthenticationToken is used by the EMM's device policy client on a device to provision the given EMM-managed user on that device. 143 "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. 144}</pre> 145</div> 146 147<div class="method"> 148 <code class="details" id="get">get(enterpriseId, userId, x__xgafv=None)</code> 149 <pre>Retrieves a user's details. 150 151Args: 152 enterpriseId: string, The ID of the enterprise. (required) 153 userId: string, The ID of the user. (required) 154 x__xgafv: string, V1 error format. 155 Allowed values 156 1 - v1 error format 157 2 - v2 error format 158 159Returns: 160 An object of the form: 161 162 { # 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. 163 "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. 164 "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. 165 "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. @mutable androidenterprise.users.update 166 "id": "A String", # The unique ID for the user. 167 "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. 168 "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. 169}</pre> 170</div> 171 172<div class="method"> 173 <code class="details" id="getAvailableProductSet">getAvailableProductSet(enterpriseId, userId, x__xgafv=None)</code> 174 <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) 179 x__xgafv: string, V1 error format. 180 Allowed values 181 1 - v1 error format 182 2 - v2 error format 183 184Returns: 185 An object of the form: 186 187 { # A set of products. 188 "productId": [ # The list of product IDs making up the set of products. 189 "A String", 190 ], 191 "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. 192 "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. 193 { # A product to be made visible to a user. 194 "productId": "A String", # The product ID to make visible to the user. Required for each item in the productVisibility list. 195 "trackIds": [ # Grants the user visibility to the specified product track(s), identified by trackIds. 196 "A String", 197 ], 198 "tracks": [ # Deprecated. Use trackIds instead. 199 "A String", 200 ], 201 }, 202 ], 203}</pre> 204</div> 205 206<div class="method"> 207 <code class="details" id="insert">insert(enterpriseId, body=None, x__xgafv=None)</code> 208 <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. 209 210Args: 211 enterpriseId: string, The ID of the enterprise. (required) 212 body: object, The request body. 213 The object takes the form of: 214 215{ # 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. 216 "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. 217 "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. 218 "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. @mutable androidenterprise.users.update 219 "id": "A String", # The unique ID for the user. 220 "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. 221 "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. 222} 223 224 x__xgafv: string, V1 error format. 225 Allowed values 226 1 - v1 error format 227 2 - v2 error format 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: - 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. 233 "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. 234 "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. 235 "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. @mutable androidenterprise.users.update 236 "id": "A String", # The unique ID for the user. 237 "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. 238 "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. 239}</pre> 240</div> 241 242<div class="method"> 243 <code class="details" id="list">list(enterpriseId, email, x__xgafv=None)</code> 244 <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. 245 246Args: 247 enterpriseId: string, The ID of the enterprise. (required) 248 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 253 254Returns: 255 An object of the form: 256 257 { 258 "user": [ # A user of an enterprise. 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: - 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. 260 "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. 261 "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. 262 "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. @mutable androidenterprise.users.update 263 "id": "A String", # The unique ID for the user. 264 "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. 265 "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. 266 }, 267 ], 268}</pre> 269</div> 270 271<div class="method"> 272 <code class="details" id="revokeDeviceAccess">revokeDeviceAccess(enterpriseId, userId, x__xgafv=None)</code> 273 <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. 274 275Args: 276 enterpriseId: string, The ID of the enterprise. (required) 277 userId: string, The ID of the user. (required) 278 x__xgafv: string, V1 error format. 279 Allowed values 280 1 - v1 error format 281 2 - v2 error format 282</pre> 283</div> 284 285<div class="method"> 286 <code class="details" id="setAvailableProductSet">setAvailableProductSet(enterpriseId, userId, body=None, x__xgafv=None)</code> 287 <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. 288 289Args: 290 enterpriseId: string, The ID of the enterprise. (required) 291 userId: string, The ID of the user. (required) 292 body: object, The request body. 293 The object takes the form of: 294 295{ # A set of products. 296 "productId": [ # The list of product IDs making up the set of products. 297 "A String", 298 ], 299 "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. 300 "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. 301 { # A product to be made visible to a user. 302 "productId": "A String", # The product ID to make visible to the user. Required for each item in the productVisibility list. 303 "trackIds": [ # Grants the user visibility to the specified product track(s), identified by trackIds. 304 "A String", 305 ], 306 "tracks": [ # Deprecated. Use trackIds instead. 307 "A String", 308 ], 309 }, 310 ], 311} 312 313 x__xgafv: string, V1 error format. 314 Allowed values 315 1 - v1 error format 316 2 - v2 error format 317 318Returns: 319 An object of the form: 320 321 { # A set of products. 322 "productId": [ # The list of product IDs making up the set of products. 323 "A String", 324 ], 325 "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. 326 "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. 327 { # A product to be made visible to a user. 328 "productId": "A String", # The product ID to make visible to the user. Required for each item in the productVisibility list. 329 "trackIds": [ # Grants the user visibility to the specified product track(s), identified by trackIds. 330 "A String", 331 ], 332 "tracks": [ # Deprecated. Use trackIds instead. 333 "A String", 334 ], 335 }, 336 ], 337}</pre> 338</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. 351 "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. 352 "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. 353 "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. @mutable androidenterprise.users.update 354 "id": "A String", # The unique ID for the user. 355 "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. 356 "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. 357} 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. 368 "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. 369 "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. 370 "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. @mutable androidenterprise.users.update 371 "id": "A String", # The unique ID for the user. 372 "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. 373 "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. 374}</pre> 375</div> 376 377</body></html>