class DevicesDeviceUsers extends Resource (View source)

The "deviceUsers" collection of methods.

Typical usage is:

 $cloudidentityService = new Google\Service\CloudIdentity(...);
 $deviceUsers = $cloudidentityService->devices_deviceUsers;

Methods

approve(string $name, GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest $postBody, array $optParams = [])

Approves device to access user data. (deviceUsers.approve)

block(string $name, GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest $postBody, array $optParams = [])

Blocks device from accessing user data (deviceUsers.block)

cancelWipe(string $name, GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest $postBody, array $optParams = [])

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. (deviceUsers.cancelWipe)

delete(string $name, array $optParams = [])

Deletes the specified DeviceUser. This also revokes the user's access to device data. (deviceUsers.delete)

get(string $name, array $optParams = [])

Retrieves the specified DeviceUser (deviceUsers.get)

listDevicesDeviceUsers(string $parent, array $optParams = [])

Lists/Searches DeviceUsers. (deviceUsers.listDevicesDeviceUsers)

lookup(string $parent, array $optParams = [])

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.

wipe(string $name, GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest $postBody, array $optParams = [])

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. (deviceUsers.wipe)

Details

Operation approve(string $name, GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest $postBody, array $optParams = [])

Approves device to access user data. (deviceUsers.approve)

Parameters

string $name

Required. Resource name 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.

GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation block(string $name, GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest $postBody, array $optParams = [])

Blocks device from accessing user data (deviceUsers.block)

Parameters

string $name

Required. Resource name 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.

GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation cancelWipe(string $name, GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest $postBody, array $optParams = [])

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. (deviceUsers.cancelWipe)

Parameters

string $name

Required. Resource name 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.

GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation delete(string $name, array $optParams = [])

Deletes the specified DeviceUser. This also revokes the user's access to device data. (deviceUsers.delete)

Parameters

string $name

Required. Resource name 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.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

GoogleAppsCloudidentityDevicesV1DeviceUser get(string $name, array $optParams = [])

Retrieves the specified DeviceUser (deviceUsers.get)

Parameters

string $name

Required. Resource name 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.

array $optParams

Optional parameters.

Return Value

GoogleAppsCloudidentityDevicesV1DeviceUser

Exceptions

Exception

GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse listDevicesDeviceUsers(string $parent, array $optParams = [])

Lists/Searches DeviceUsers. (deviceUsers.listDevicesDeviceUsers)

Parameters

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}

array $optParams

Optional parameters.

Return Value

GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse

Exceptions

Exception

GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse lookup(string $parent, array $optParams = [])

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.

(deviceUsers.lookup)

Parameters

string $parent

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

array $optParams

Optional parameters.

Return Value

GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse

Exceptions

Exception

Operation wipe(string $name, GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest $postBody, array $optParams = [])

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. (deviceUsers.wipe)

Parameters

string $name

Required. Resource name 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.

GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception