class Chromeosdevices extends Resource (View source)

The "chromeosdevices" collection of methods.

Typical usage is:

 $adminService = new Google\Service\Directory(...);
 $chromeosdevices = $adminService->chromeosdevices;

Methods

action(string $customerId, string $resourceId, ChromeOsDeviceAction $postBody, array $optParams = [])

Use BatchChangeChromeOsDeviceStatus instead. Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices. Warning: Deprovisioning a device will stop device policy syncing and remove device- level printers. After a device is deprovisioned, it must be wiped before it can be re-enrolled. Lost or stolen devices should use the disable action. * Re-enabling a disabled device will consume a device license. If you do not have sufficient licenses available when completing the re-enable action, you will receive an error. For more information about deprovisioning and disabling devices, visit the help center.

get(string $customerId, string $deviceId, array $optParams = [])

Retrieves a Chrome OS device's properties. (chromeosdevices.get)

listChromeosdevices(string $customerId, array $optParams = [])

Retrieves a paginated list of Chrome OS devices within an account.

moveDevicesToOu(string $customerId, string $orgUnitPath, ChromeOsMoveDevicesToOu $postBody, array $optParams = [])

Moves or inserts multiple Chrome OS devices to an organizational unit. You can move up to 50 devices at once. (chromeosdevices.moveDevicesToOu)

patch(string $customerId, string $deviceId, ChromeOsDevice $postBody, array $optParams = [])

Updates a device's updatable properties, such as annotatedUser, annotatedLocation, notes, orgUnitPath, or annotatedAssetId. This method supports patch semantics. (chromeosdevices.patch)

update(string $customerId, string $deviceId, ChromeOsDevice $postBody, array $optParams = [])

Updates a device's updatable properties, such as annotatedUser, annotatedLocation, notes, orgUnitPath, or annotatedAssetId.

Details

action(string $customerId, string $resourceId, ChromeOsDeviceAction $postBody, array $optParams = [])

Use BatchChangeChromeOsDeviceStatus instead. Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices. Warning: Deprovisioning a device will stop device policy syncing and remove device- level printers. After a device is deprovisioned, it must be wiped before it can be re-enrolled. Lost or stolen devices should use the disable action. * Re-enabling a disabled device will consume a device license. If you do not have sufficient licenses available when completing the re-enable action, you will receive an error. For more information about deprovisioning and disabling devices, visit the help center.

(chromeosdevices.action)

Parameters

string $customerId

The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource.

string $resourceId

The unique ID of the device. The resourceIds are returned in the response from the chromeosdevices.list method.

ChromeOsDeviceAction $postBody
array $optParams

Optional parameters.

Exceptions

Exception

ChromeOsDevice get(string $customerId, string $deviceId, array $optParams = [])

Retrieves a Chrome OS device's properties. (chromeosdevices.get)

Parameters

string $customerId

The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource.

string $deviceId

The unique ID of the device. The deviceIds are returned in the response from the chromeosdevices.list method.

array $optParams

Optional parameters.

Return Value

ChromeOsDevice

Exceptions

Exception

ChromeOsDevices listChromeosdevices(string $customerId, array $optParams = [])

Retrieves a paginated list of Chrome OS devices within an account.

(chromeosdevices.listChromeosdevices)

Parameters

string $customerId

The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource.

array $optParams

Optional parameters.

Return Value

ChromeOsDevices

Exceptions

Exception

moveDevicesToOu(string $customerId, string $orgUnitPath, ChromeOsMoveDevicesToOu $postBody, array $optParams = [])

Moves or inserts multiple Chrome OS devices to an organizational unit. You can move up to 50 devices at once. (chromeosdevices.moveDevicesToOu)

Parameters

string $customerId

Immutable. ID of the Google Workspace account

string $orgUnitPath

Full path of the target organizational unit or its ID

ChromeOsMoveDevicesToOu $postBody
array $optParams

Optional parameters.

Exceptions

Exception

ChromeOsDevice patch(string $customerId, string $deviceId, ChromeOsDevice $postBody, array $optParams = [])

Updates a device's updatable properties, such as annotatedUser, annotatedLocation, notes, orgUnitPath, or annotatedAssetId. This method supports patch semantics. (chromeosdevices.patch)

Parameters

string $customerId

The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource.

string $deviceId

The unique ID of the device. The deviceIds are returned in the response from the chromeosdevices.list method.

ChromeOsDevice $postBody
array $optParams

Optional parameters.

Return Value

ChromeOsDevice

Exceptions

Exception

ChromeOsDevice update(string $customerId, string $deviceId, ChromeOsDevice $postBody, array $optParams = [])

Updates a device's updatable properties, such as annotatedUser, annotatedLocation, notes, orgUnitPath, or annotatedAssetId.

(chromeosdevices.update)

Parameters

string $customerId

The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource.

string $deviceId

The unique ID of the device. The deviceIds are returned in the response from the chromeosdevices.list method.

ChromeOsDevice $postBody
array $optParams

Optional parameters.

Return Value

ChromeOsDevice

Exceptions

Exception