com.google.api.services.androidenterprise

Class AndroidEnterprise.Users

java.lang.Object

com.google.api.services.androidenterprise.AndroidEnterprise.Users

Enclosing class:

AndroidEnterprise

public class AndroidEnterprise.Users
extends Object

The "users" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AndroidEnterprise.Users.Delete
class	AndroidEnterprise.Users.GenerateAuthenticationToken
class	AndroidEnterprise.Users.GenerateToken
class	AndroidEnterprise.Users.Get
class	AndroidEnterprise.Users.GetAvailableProductSet
class	AndroidEnterprise.Users.Insert
class	AndroidEnterprise.Users.List
class	AndroidEnterprise.Users.Patch
class	AndroidEnterprise.Users.RevokeDeviceAccess
class	AndroidEnterprise.Users.RevokeToken
class	AndroidEnterprise.Users.SetAvailableProductSet
class	AndroidEnterprise.Users.Update

Constructor Summary

Constructors

Constructor and Description
Users()

Method Summary

Modifier and Type	Method and Description
AndroidEnterprise.Users.Delete	delete(String enterpriseId, String userId) Deleted an EMM-managed user.
AndroidEnterprise.Users.GenerateAuthenticationToken	generateAuthenticationToken(String enterpriseId, String userId) Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device.
AndroidEnterprise.Users.GenerateToken	generateToken(String enterpriseId, String userId) Generates a token (activation code) to allow this user to configure their managed account in the Android Setup Wizard.
AndroidEnterprise.Users.Get	get(String enterpriseId, String userId) Retrieves a user's details.
AndroidEnterprise.Users.GetAvailableProductSet	getAvailableProductSet(String enterpriseId, String userId) Retrieves the set of products a user is entitled to access.
AndroidEnterprise.Users.Insert	insert(String enterpriseId, User content) Creates a new EMM-managed user.
AndroidEnterprise.Users.List	list(String enterpriseId, String email) Looks up a user by primary email address.
AndroidEnterprise.Users.Patch	patch(String enterpriseId, String userId, User content) Updates the details of an EMM-managed user.
AndroidEnterprise.Users.RevokeDeviceAccess	revokeDeviceAccess(String enterpriseId, String userId) Revokes access to all devices currently provisioned to the user.
AndroidEnterprise.Users.RevokeToken	revokeToken(String enterpriseId, String userId) Revokes a previously generated token (activation code) for the user.
AndroidEnterprise.Users.SetAvailableProductSet	setAvailableProductSet(String enterpriseId, String userId, ProductSet content) Modifies the set of products that a user is entitled to access (referred to as whitelisted products).
AndroidEnterprise.Users.Update	update(String enterpriseId, String userId, User content) Updates the details of an EMM-managed user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Users

public Users()

Method Detail

delete

public AndroidEnterprise.Users.Delete delete(String enterpriseId,
                                             String userId)
                                      throws IOException

Deleted an EMM-managed user. Create a request for the method "users.delete". This request holds the parameters needed by the androidenterprise server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

enterpriseId - The ID of the enterprise.

userId - The ID of the user.

Returns:

the request

Throws:

IOException

generateAuthenticationToken

public AndroidEnterprise.Users.GenerateAuthenticationToken generateAuthenticationToken(String enterpriseId,
                                                                                       String userId)
                                                                                throws IOException

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. Create a request for the method "users.generateAuthenticationToken". This request holds the parameters needed by the androidenterprise server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

enterpriseId - The ID of the enterprise.

userId - The ID of the user.

Returns:

the request

Throws:

IOException

generateToken

public AndroidEnterprise.Users.GenerateToken generateToken(String enterpriseId,
                                                           String userId)
                                                    throws IOException

Generates a token (activation code) to allow this user to configure their managed account in the Android Setup Wizard. Revokes any previously generated token. This call only works with Google managed accounts. Create a request for the method "users.generateToken". This request holds the parameters needed by the androidenterprise server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

enterpriseId - The ID of the enterprise.

userId - The ID of the user.

Returns:

the request

Throws:

IOException

get

public AndroidEnterprise.Users.Get get(String enterpriseId,
                                       String userId)
                                throws IOException

Retrieves a user's details. Create a request for the method "users.get". This request holds the parameters needed by the androidenterprise server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

enterpriseId - The ID of the enterprise.

userId - The ID of the user.

Returns:

the request

Throws:

IOException

getAvailableProductSet

public AndroidEnterprise.Users.GetAvailableProductSet getAvailableProductSet(String enterpriseId,
                                                                             String userId)
                                                                      throws IOException

Retrieves the set of products a user is entitled to access. Create a request for the method "users.getAvailableProductSet". This request holds the parameters needed by the androidenterprise server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

enterpriseId - The ID of the enterprise.

userId - The ID of the user.

Returns:

the request

Throws:

IOException

insert

public AndroidEnterprise.Users.Insert insert(String enterpriseId,
                                             User content)
                                      throws IOException

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. Create a request for the method "users.insert". This request holds the parameters needed by the androidenterprise server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

enterpriseId - The ID of the enterprise.

content - the User

Returns:

the request

Throws:

IOException

list

public AndroidEnterprise.Users.List list(String enterpriseId,
                                         String email)
                                  throws IOException

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. Create a request for the method "users.list". This request holds the parameters needed by the androidenterprise server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

enterpriseId - The ID of the enterprise.

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

Returns:

the request

Throws:

IOException

patch

public AndroidEnterprise.Users.Patch patch(String enterpriseId,
                                           String userId,
                                           User content)
                                    throws IOException

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. This method supports patch semantics. Create a request for the method "users.patch". This request holds the parameters needed by the androidenterprise server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

enterpriseId - The ID of the enterprise.

userId - The ID of the user.

content - the User

Returns:

the request

Throws:

IOException

revokeDeviceAccess

public AndroidEnterprise.Users.RevokeDeviceAccess revokeDeviceAccess(String enterpriseId,
                                                                     String userId)
                                                              throws IOException

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. Create a request for the method "users.revokeDeviceAccess". This request holds the parameters needed by the androidenterprise server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

enterpriseId - The ID of the enterprise.

userId - The ID of the user.

Returns:

the request

Throws:

IOException

revokeToken

public AndroidEnterprise.Users.RevokeToken revokeToken(String enterpriseId,
                                                       String userId)
                                                throws IOException

Revokes a previously generated token (activation code) for the user. Create a request for the method "users.revokeToken". This request holds the parameters needed by the androidenterprise server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

enterpriseId - The ID of the enterprise.

userId - The ID of the user.

Returns:

the request

Throws:

IOException

setAvailableProductSet

public AndroidEnterprise.Users.SetAvailableProductSet setAvailableProductSet(String enterpriseId,
                                                                             String userId,
                                                                             ProductSet content)
                                                                      throws IOException

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. Create a request for the method "users.setAvailableProductSet". This request holds the parameters needed by the androidenterprise server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

enterpriseId - The ID of the enterprise.

userId - The ID of the user.

content - the ProductSet

Returns:

the request

Throws:

IOException

update

public AndroidEnterprise.Users.Update update(String enterpriseId,
                                             String userId,
                                             User content)
                                      throws IOException

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. Create a request for the method "users.update". This request holds the parameters needed by the androidenterprise server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

enterpriseId - The ID of the enterprise.

userId - The ID of the user.

content - the User

Returns:

the request

Throws:

IOException