com.google.api.services.cloudidentity.v1

Class CloudIdentity.Devices.DeviceUsers

java.lang.Object

com.google.api.services.cloudidentity.v1.CloudIdentity.Devices.DeviceUsers

Enclosing class:

CloudIdentity.Devices

public class CloudIdentity.Devices.DeviceUsers
extends Object

The "deviceUsers" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudIdentity.Devices.DeviceUsers.Approve
class	CloudIdentity.Devices.DeviceUsers.Block
class	CloudIdentity.Devices.DeviceUsers.CancelWipe
class	CloudIdentity.Devices.DeviceUsers.ClientStates The "clientStates" collection of methods.
class	CloudIdentity.Devices.DeviceUsers.Delete
class	CloudIdentity.Devices.DeviceUsers.Get
class	CloudIdentity.Devices.DeviceUsers.List
class	CloudIdentity.Devices.DeviceUsers.Lookup
class	CloudIdentity.Devices.DeviceUsers.Wipe

Constructor Summary

Constructors

Constructor and Description
DeviceUsers()

Method Summary

Modifier and Type	Method and Description
CloudIdentity.Devices.DeviceUsers.Approve	approve(String name, GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest content) Approves device to access user data.
CloudIdentity.Devices.DeviceUsers.Block	block(String name, GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest content) Blocks device from accessing user data Create a request for the method "deviceUsers.block".
CloudIdentity.Devices.DeviceUsers.CancelWipe	cancelWipe(String name, GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest content) Cancels an unfinished user account wipe.
CloudIdentity.Devices.DeviceUsers.ClientStates	clientStates() An accessor for creating requests from the ClientStates collection.
CloudIdentity.Devices.DeviceUsers.Delete	delete(String name) Deletes the specified DeviceUser.
CloudIdentity.Devices.DeviceUsers.Get	get(String name) Retrieves the specified DeviceUser Create a request for the method "deviceUsers.get".
CloudIdentity.Devices.DeviceUsers.List	list(String parent) Lists/Searches DeviceUsers.
CloudIdentity.Devices.DeviceUsers.Lookup	lookup(String parent) Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request.
CloudIdentity.Devices.DeviceUsers.Wipe	wipe(String name, GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest content) Wipes the user's account on a device.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceUsers

public DeviceUsers()

Method Detail

approve

public CloudIdentity.Devices.DeviceUsers.Approve approve(String name,
                                                         GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest content)
                                                  throws IOException

Approves device to access user data. Create a request for the method "deviceUsers.approve". This request holds the parameters needed by the cloudidentity server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device}/deviceUsers/{device_user}`, where device is the unique ID assigned to the Device, and device_user is the unique ID assigned to the User.

content - the GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest

Returns:

the request

Throws:

IOException

block

public CloudIdentity.Devices.DeviceUsers.Block block(String name,
                                                     GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest content)
                                              throws IOException

Blocks device from accessing user data Create a request for the method "deviceUsers.block". This request holds the parameters needed by the cloudidentity server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device}/deviceUsers/{device_user}`, where device is the unique ID assigned to the Device, and device_user is the unique ID assigned to the User.

content - the GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest

Returns:

the request

Throws:

IOException

cancelWipe

public CloudIdentity.Devices.DeviceUsers.CancelWipe cancelWipe(String name,
                                                               GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest content)
                                                        throws IOException

Cancels an unfinished user account wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped. Create a request for the method "deviceUsers.cancelWipe". This request holds the parameters needed by the cloudidentity server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device}/deviceUsers/{device_user}`, where device is the unique ID assigned to the Device, and device_user is the unique ID assigned to the User.

content - the GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest

Returns:

the request

Throws:

IOException

delete

public CloudIdentity.Devices.DeviceUsers.Delete delete(String name)
                                                throws IOException

Deletes the specified DeviceUser. This also revokes the user's access to device data. Create a request for the method "deviceUsers.delete". This request holds the parameters needed by the cloudidentity server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device}/deviceUsers/{device_user}`, where device is the unique ID assigned to the Device, and device_user is the unique ID assigned to the User.

Returns:

the request

Throws:

IOException

get

public CloudIdentity.Devices.DeviceUsers.Get get(String name)
                                          throws IOException

Retrieves the specified DeviceUser Create a request for the method "deviceUsers.get". This request holds the parameters needed by the cloudidentity server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device}/deviceUsers/{device_user}`, where device is the unique ID assigned to the Device, and device_user is the unique ID assigned to the User.

Returns:

the request

Throws:

IOException

list

public CloudIdentity.Devices.DeviceUsers.List list(String parent)
                                            throws IOException

Lists/Searches DeviceUsers. Create a request for the method "deviceUsers.list". This request holds the parameters needed by the cloudidentity server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. To list all DeviceUsers, set this to "devices/-". To list all DeviceUsers owned by a device, set this to the resource name of the device. Format: devices/{device}

Returns:

the request

Throws:

IOException

lookup

public CloudIdentity.Devices.DeviceUsers.Lookup lookup(String parent)
                                                throws IOException

Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required. Create a request for the method "deviceUsers.lookup". This request holds the parameters needed by the cloudidentity server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the user.

Returns:

the request

Throws:

IOException

wipe

public CloudIdentity.Devices.DeviceUsers.Wipe wipe(String name,
                                                   GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest content)
                                            throws IOException

Wipes the user's account on a device. Other data on the device that is not associated with the user's work account is not affected. For example, if a Gmail app is installed on a device that is used for personal and work purposes, and the user is logged in to the Gmail app with their personal account as well as their work account, wiping the "deviceUser" by their work administrator will not affect their personal account within Gmail or other apps such as Photos. Create a request for the method "deviceUsers.wipe". This request holds the parameters needed by the cloudidentity server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device}/deviceUsers/{device_user}`, where device is the unique ID assigned to the Device, and device_user is the unique ID assigned to the User.

content - the GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest

Returns:

the request

Throws:

IOException

clientStates

public CloudIdentity.Devices.DeviceUsers.ClientStates clientStates()

An accessor for creating requests from the ClientStates collection.

The typical use is:

    CloudIdentity cloudidentity = new CloudIdentity(...);
    CloudIdentity.ClientStates.List request = cloudidentity.clientStates().list(parameters ...)
 

Returns:

the resource collection