class Devices extends Resource (View source)

The "devices" collection of methods.

Typical usage is:

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

Methods

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

Cancels an unfinished device wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped. This operation is possible when the device is in a "pending wipe" state. The device enters the "pending wipe" state when a wipe device command is issued, but has not yet been sent to the device. The cancel wipe will fail if the wipe command has already been issued to the device.

create(GoogleAppsCloudidentityDevicesV1Device $postBody, array $optParams = [])

Creates a device. Only company-owned device may be created. Note: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity Premium (devices.create)

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

Deletes the specified device. (devices.delete)

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

Retrieves the specified device. (devices.get)

listDevices(array $optParams = [])

Lists/Searches devices. (devices.listDevices)

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

Wipes all data on the specified device. (devices.wipe)

Details

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

Cancels an unfinished device wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped. This operation is possible when the device is in a "pending wipe" state. The device enters the "pending wipe" state when a wipe device command is issued, but has not yet been sent to the device. The cancel wipe will fail if the wipe command has already been issued to the device.

(devices.cancelWipe)

Parameters

string $name

Required. Resource name of the Device in format: devices/{device}, where device is the unique ID assigned to the Device.

GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation create(GoogleAppsCloudidentityDevicesV1Device $postBody, array $optParams = [])

Creates a device. Only company-owned device may be created. Note: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity Premium (devices.create)

Parameters

GoogleAppsCloudidentityDevicesV1Device $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Deletes the specified device. (devices.delete)

Parameters

string $name

Required. Resource name of the Device in format: devices/{device}, where device is the unique ID assigned to the Device.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Retrieves the specified device. (devices.get)

Parameters

string $name

Required. Resource name of the Device in the format: devices/{device}, where device is the unique ID assigned to the Device.

array $optParams

Optional parameters.

Return Value

GoogleAppsCloudidentityDevicesV1Device

Exceptions

Exception

GoogleAppsCloudidentityDevicesV1ListDevicesResponse listDevices(array $optParams = [])

Lists/Searches devices. (devices.listDevices)

Parameters

array $optParams

Optional parameters.

Return Value

GoogleAppsCloudidentityDevicesV1ListDevicesResponse

Exceptions

Exception

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

Wipes all data on the specified device. (devices.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.

GoogleAppsCloudidentityDevicesV1WipeDeviceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception