Users

  • A Users resource represents an account associated with an enterprise, which can be device-specific or for an individual user across devices.

  • User accounts can provide access to managed Google Play only or other Google services, depending on whether they follow the Google managed domain or managed Google Play Accounts identity model.

  • The User resource representation includes properties such as id, managementType, accountType, primaryEmail, accountIdentifier, and displayName.

  • ThemanagementType property indicates whether the user is managed by Google (googleManaged) or the EMM (emmManaged).

  • Various methods are available for interacting with User resources, including deleting, generating authentication tokens, getting details, inserting new users, listing users, revoking device access, and updating user details.

For a list ofmethods for this resource, see the end of this page.

Resource representations

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 (viaprimaryEmail).
  • 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.

{  "kind": "androidenterprise#user",  "id":string,  "managementType":string,  "accountType":string,  "primaryEmail":string,  "accountIdentifier":string,  "displayName":string}
Property nameValueDescriptionNotes
accountIdentifierstringA 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.
accountTypestringThe type of account that this user represents. AuserAccount can be installed on multiple devices, but adeviceAccount 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 auserAccount.

Acceptable values are:
  • "deviceAccount"
  • "userAccount"
displayNamestringThe 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. writable
idstringThe unique ID for the user.

kindstring
managementTypestringThe entity that manages the user. WithgoogleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. WithemmManaged users, the EMM is in charge.

Acceptable values are:
  • "emmManaged"
  • "googleManaged"
primaryEmailstringThe 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.

Methods

delete
Deleted an EMM-managed user.
generateAuthenticationToken
Generates an authentication token which the device policy client can use toprovision 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.
get
Retrieves a user's details.
getAvailableProductSet
Deprecated: New integrations cannot use this method and can refer toour newrecommendations.
This method will no longer be accessible byanyone after September 30, 2025.Retrieves the set of products a user is entitled to access.
insert
Creates a new EMM-managed user.

TheUsers resourcepassed in the body of the request should include anaccountIdentifier and anaccountType.

If a corresponding user already exists with the same account identifier,the user will be updated with the resource. In this case only thedisplayName field can be changed.

list
Looks up a user by primary email address.This is only supported for Google-managed users. Lookup of the id is notneeded for EMM-managed users because the id is already returned in theresult of the Users.insert call.
revokeDeviceAccess
Revokes access to all devices currently provisioned to the user. The userwill no longer be able to use the managed Play store on any of theirmanaged devices.

This call only works with EMM-managed accounts.
setAvailableProductSet
Deprecated: New integrations cannot use this method and can refer toour newrecommendations.
This method will no longer be accessible byanyone after September 30, 2025.Modifies the set of products that a user is entitled to access (referred toaswhitelisted products). Only products that areapprovedor products that were previously approved (products with revoked approval)can be whitelisted.
update
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 theUsersresource in the request body. Only thedisplayName fieldcan be changed. Other fields must either be unset or have thecurrently active value.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-10-31 UTC.