Show / Hide Table of Contents

Class DevicesResource.DeviceUsersResource

The "deviceUsers" collection of methods.

Inheritance
object
DevicesResource.DeviceUsersResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudIdentity.v1beta1
Assembly: Google.Apis.CloudIdentity.v1beta1.dll
Syntax
public class DevicesResource.DeviceUsersResource

Constructors

DeviceUsersResource(IClientService)

Constructs a new resource.

Declaration
public DeviceUsersResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

ClientStates

Gets the ClientStates resource.

Declaration
public virtual DevicesResource.DeviceUsersResource.ClientStatesResource ClientStates { get; }
Property Value
Type Description
DevicesResource.DeviceUsersResource.ClientStatesResource

Methods

Approve(ApproveDeviceUserRequest, string)

Approves device to access user data.

Declaration
public virtual DevicesResource.DeviceUsersResource.ApproveRequest Approve(ApproveDeviceUserRequest body, string name)
Parameters
Type Name Description
ApproveDeviceUserRequest body

The body of the request.

string name

Required. Resource name of the Device in format: devices/{device_id}/deviceUsers/{device_user_id}, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

Returns
Type Description
DevicesResource.DeviceUsersResource.ApproveRequest

Block(BlockDeviceUserRequest, string)

Blocks device from accessing user data

Declaration
public virtual DevicesResource.DeviceUsersResource.BlockRequest Block(BlockDeviceUserRequest body, string name)
Parameters
Type Name Description
BlockDeviceUserRequest body

The body of the request.

string name

Required. Resource name of the Device in format: devices/{device_id}/deviceUsers/{device_user_id}, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

Returns
Type Description
DevicesResource.DeviceUsersResource.BlockRequest

CancelWipe(CancelWipeDeviceUserRequest, string)

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.

Declaration
public virtual DevicesResource.DeviceUsersResource.CancelWipeRequest CancelWipe(CancelWipeDeviceUserRequest body, string name)
Parameters
Type Name Description
CancelWipeDeviceUserRequest body

The body of the request.

string name

Required. Resource name of the Device in format: devices/{device_id}/deviceUsers/{device_user_id}, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

Returns
Type Description
DevicesResource.DeviceUsersResource.CancelWipeRequest

Delete(string)

Deletes the specified DeviceUser. This also revokes the user's access to device data.

Declaration
public virtual DevicesResource.DeviceUsersResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. Resource name of the Device in format: devices/{device_id}/deviceUsers/{device_user_id}, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

Returns
Type Description
DevicesResource.DeviceUsersResource.DeleteRequest

Get(string)

Retrieves the specified DeviceUser

Declaration
public virtual DevicesResource.DeviceUsersResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. Resource name of the Device in format: devices/{device_id}/deviceUsers/{device_user_id}, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

Returns
Type Description
DevicesResource.DeviceUsersResource.GetRequest

List(string)

Lists/Searches DeviceUsers.

Declaration
public virtual DevicesResource.DeviceUsersResource.ListRequest List(string parent)
Parameters
Type Name Description
string 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
Type Description
DevicesResource.DeviceUsersResource.ListRequest

Lookup(string)

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.

Declaration
public virtual DevicesResource.DeviceUsersResource.LookupRequest Lookup(string parent)
Parameters
Type Name Description
string parent

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

Returns
Type Description
DevicesResource.DeviceUsersResource.LookupRequest

Wipe(WipeDeviceUserRequest, string)

Wipes the user's account on a device.

Declaration
public virtual DevicesResource.DeviceUsersResource.WipeRequest Wipe(WipeDeviceUserRequest body, string name)
Parameters
Type Name Description
WipeDeviceUserRequest body

The body of the request.

string name

Required. Resource name of the Device in format: devices/{device_id}/deviceUsers/{device_user_id}, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

Returns
Type Description
DevicesResource.DeviceUsersResource.WipeRequest
In this article
Back to top Generated by DocFX