target.apidocs.com.google.api.services.androidenterprise.AndroidEnterprise.Users.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-androidenterprise Show documentation

The newest version!







AndroidEnterprise.Users (Google Play EMM API v1-rev20240820-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








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.Get 


class 
AndroidEnterprise.Users.GetAvailableProductSet 


class 
AndroidEnterprise.Users.Insert 


class 
AndroidEnterprise.Users.List 


class 
AndroidEnterprise.Users.RevokeDeviceAccess 


class 
AndroidEnterprise.Users.SetAvailableProductSet 


class 
AndroidEnterprise.Users.Update 









Constructor Summary

Constructors 

Constructor and Description


Users() 









Method Summary

All Methods Instance Methods Concrete Methods 

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.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.RevokeDeviceAccess
revokeDeviceAccess(String enterpriseId,
                  String userId)
Revokes access to all devices currently provisioned to 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








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. **Note:** This item has been
 deprecated. New integrations cannot use this method and can refer to our new recommendations.

 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 - Required. The exact primary email address of the user to look up.
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








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. **Note:** This item has been deprecated. New
 integrations cannot use this method and can refer to our new recommendations.

 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














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

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

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.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.RevokeDeviceAccess`	`revokeDeviceAccess(String enterpriseId, String userId)` Revokes access to all devices currently provisioned to 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.