Method: chromeosdevices.get

Retrieves a Chrome OS device's properties.

HTTP request

GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

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.

deviceId

string

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

Query parameters

Parameters
projection

enum (Projection)

Determines whether the response contains the full list of properties or only a subset.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ChromeOsDevice.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/admin.directory.device.chromeos
  • https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly

For more information, see the Authorization guide.

Projection

The type of projection to show for the device.

Enums
BASIC Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)
FULL Includes all metadata fields