Method: customer.devices.chromeos.issueCommand

Issues a command for the device to execute.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Immutable. ID of the Google Workspace account.

deviceId

string

Immutable. ID of Chrome OS Device.

Request body

The request body contains data with the following structure:

JSON representation
{
  "commandType": enum (CommandType),
  "payload": string
}
Fields
commandType

enum (CommandType)

The type of command.

payload

string

The payload for the command, provide it only if command supports it. The following commands support adding payload:

  • SET_VOLUME: Payload is a stringified JSON object in the form: { "volume": 50 }. The volume has to be an integer in the range [0,100].
  • DEVICE_START_CRD_SESSION: Payload is optionally a stringified JSON object in the form: { "ackedUserPresence": true }. ackedUserPresence is a boolean. By default, ackedUserPresence is set to false. To start a Chrome Remote Desktop session for an active device, set ackedUserPresence to true.

Response body

If successful, the response body contains data with the following structure:

A response for issuing a command.

JSON representation
{
  "commandId": string
}
Fields
commandId

string (int64 format)

The unique ID of the issued command, used to retrieve the command status.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.