class Users extends Resource (View source)

The "users" collection of methods.

Typical usage is:

 $androidenterpriseService = new Google\Service\AndroidEnterprise(...);
 $users = $androidenterpriseService->users;

Methods

delete(string $enterpriseId, string $userId, array $optParams = [])

Deleted an EMM-managed user. (users.delete)

generateAuthenticationToken(string $enterpriseId, string $userId, array $optParams = [])

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.

get(string $enterpriseId, string $userId, array $optParams = [])

Retrieves a user's details. (users.get)

getAvailableProductSet(string $enterpriseId, string $userId, array $optParams = [])

Retrieves the set of products a user is entitled to access. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations. (users.getAvailableProductSet)

insert(string $enterpriseId, User $postBody, array $optParams = [])

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. (users.insert)

listUsers(string $enterpriseId, string $email, array $optParams = [])

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.

revokeDeviceAccess(string $enterpriseId, string $userId, array $optParams = [])

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.

setAvailableProductSet(string $enterpriseId, string $userId, ProductSet $postBody, array $optParams = [])

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.

update(string $enterpriseId, string $userId, User $postBody, array $optParams = [])

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.

Details

delete(string $enterpriseId, string $userId, array $optParams = [])

Deleted an EMM-managed user. (users.delete)

Parameters

string $enterpriseId

The ID of the enterprise.

string $userId

The ID of the user.

array $optParams

Optional parameters.

Exceptions

Exception

AuthenticationToken generateAuthenticationToken(string $enterpriseId, string $userId, array $optParams = [])

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.

(users.generateAuthenticationToken)

Parameters

string $enterpriseId

The ID of the enterprise.

string $userId

The ID of the user.

array $optParams

Optional parameters.

Return Value

AuthenticationToken

Exceptions

Exception

User get(string $enterpriseId, string $userId, array $optParams = [])

Retrieves a user's details. (users.get)

Parameters

string $enterpriseId

The ID of the enterprise.

string $userId

The ID of the user.

array $optParams

Optional parameters.

Return Value

User

Exceptions

Exception

ProductSet getAvailableProductSet(string $enterpriseId, string $userId, array $optParams = [])

Retrieves the set of products a user is entitled to access. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations. (users.getAvailableProductSet)

Parameters

string $enterpriseId

The ID of the enterprise.

string $userId

The ID of the user.

array $optParams

Optional parameters.

Return Value

ProductSet

Exceptions

Exception

User insert(string $enterpriseId, User $postBody, array $optParams = [])

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. (users.insert)

Parameters

string $enterpriseId

The ID of the enterprise.

User $postBody
array $optParams

Optional parameters.

Return Value

User

Exceptions

Exception

UsersListResponse listUsers(string $enterpriseId, string $email, array $optParams = [])

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.

(users.listUsers)

Parameters

string $enterpriseId

The ID of the enterprise.

string $email

Required. The exact primary email address of the user to look up.

array $optParams

Optional parameters.

Return Value

UsersListResponse

Exceptions

Exception

revokeDeviceAccess(string $enterpriseId, string $userId, array $optParams = [])

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.

(users.revokeDeviceAccess)

Parameters

string $enterpriseId

The ID of the enterprise.

string $userId

The ID of the user.

array $optParams

Optional parameters.

Exceptions

Exception

ProductSet setAvailableProductSet(string $enterpriseId, string $userId, ProductSet $postBody, array $optParams = [])

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.

Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations. (users.setAvailableProductSet)

Parameters

string $enterpriseId

The ID of the enterprise.

string $userId

The ID of the user.

ProductSet $postBody
array $optParams

Optional parameters.

Return Value

ProductSet

Exceptions

Exception

User update(string $enterpriseId, string $userId, User $postBody, array $optParams = [])

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. (users.update)

Parameters

string $enterpriseId

The ID of the enterprise.

string $userId

The ID of the user.

User $postBody
array $optParams

Optional parameters.

Return Value

User

Exceptions

Exception