Method: customer.devices.chromeos.batchChangeStatus

Muda o status de um lote de dispositivos ChromeOS. Saiba mais sobre como mudar o estado de um dispositivo ChromeOS em Consertar, reutilizar ou desativar dispositivos ChromeOS.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
customerId

string

Obrigatório. ID imutável da conta do Google Workspace.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "deviceIds": [
    string
  ],
  "changeChromeOsDeviceStatusAction": enum (ChangeChromeOsDeviceStatusAction),
  "deprovisionReason": enum (DeprovisionReason)
}
Campos
deviceIds[]

string

Obrigatório. Lista dos IDs dos dispositivos ChromeOS que vão mudar. Máximo de 50.
changeChromeOsDeviceStatusAction

enum (ChangeChromeOsDeviceStatusAction)

Obrigatório. A ação a ser realizada no dispositivo ChromeOS para mudar o status dele.
deprovisionReason

enum (DeprovisionReason)

Opcional. O motivo do desprovisionamento de um dispositivo. Precisa ser fornecido se "changeChromeOsDeviceStatusAction" estiver definido como "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION". Caso contrário, omita esse campo.

Corpo da resposta

A resposta de mudança do status de um lote de dispositivos ChromeOS.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "changeChromeOsDeviceStatusResults": [
    {
      object (ChangeChromeOsDeviceStatusResult)
    }
  ]
}
Campos
changeChromeOsDeviceStatusResults[]

object (ChangeChromeOsDeviceStatusResult)

Os resultados de cada um dos dispositivos ChromeOS fornecidos na solicitação.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte o guia de autorização.

ChangeChromeOsDeviceStatusAction

Ação a ser realizada para mudar o status de um dispositivo ChromeOS.

Enums
CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_UNSPECIFIED Valor padrão. O valor não é usado.
CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION Desprovisiona um dispositivo ChromeOS. Se houver dispositivos ChromeOS que não são mais usados na organização, é importante desprovisioná-los para que você não os gerencie mais. O desprovisionamento remove todas as políticas e impressoras do dispositivo, além da capacidade de usá-lo como um quiosque. Dependendo do upgrade associado ao dispositivo, essa ação pode liberar a licença de volta ao conjunto de licenças, o que permite que você use a licença em outro dispositivo.
CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE Desativa um dispositivo ChromeOS. Use essa ação se um usuário perder ou tiver o dispositivo roubado. Assim, o dispositivo ainda será gerenciado e continuará recebendo políticas, mas ninguém poderá usá-lo. Dependendo do upgrade associado ao dispositivo, essa ação pode liberar a licença de volta ao conjunto de licenças, o que permite que você use a licença em outro dispositivo.
CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_REENABLE Permite que um dispositivo ChromeOS seja usado novamente após ter sido desativado. Reativa o dispositivo quando ele não está mais perdido ou foi recuperado. Isso permite que o dispositivo seja usado novamente. Dependendo do upgrade associado ao dispositivo, isso pode consumir uma licença do conjunto de licenças. Isso significa que, se não houver licenças suficientes disponíveis, a operação vai falhar.

ChangeChromeOsDeviceStatusResult

O resultado de um único dispositivo ChromeOS para uma operação de mudança de estado.

Representação JSON 
{
  "deviceId": string,

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    object (ChangeChromeOsDeviceStatusSucceeded)
  }
  // End of list of possible types for union field result.
}
Campos
deviceId

string

O ID exclusivo do dispositivo ChromeOS.

Campo de união result.

result pode ser apenas de um dos tipos a seguir:
error

object (Status)

O resultado do erro da operação em caso de falha.
response

object (ChangeChromeOsDeviceStatusSucceeded)

O dispositivo conseguiu mudar o status.

Status

O tipo Status define um modelo de erro lógico que é adequado a diferentes ambientes de programação, incluindo APIs REST e RPC. É usado por gRPC (em inglês). Cada mensagem Status contém três partes de dados: código do erro, mensagem de erro e detalhes do erro.

É possível descobrir mais sobre esse modelo de erro e como trabalhar com ele no Guia de design de API.

Representação JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Campos
code

integer

O código de status, que precisa ser um valor de enumeração de google.rpc.Code.
message

string

Uma mensagem de erro em inglês para o desenvolvedor. Qualquer mensagem de erro para o usuário precisa ser localizada e enviada no campo google.rpc.Status.details, ou localizada pelo cliente.
details[]

object

Uma lista de mensagens com os detalhes do erro. Há um conjunto comum de tipos de mensagens para as APIs usarem.

Um objeto contendo campos de um tipo arbitrário. Um campo adicional "@type" contém uma URI que identifica o tipo. Exemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

ChangeChromeOsDeviceStatusSucceeded

Esse tipo não tem campos.

Resposta para uma mudança de status bem-sucedida do dispositivo ChromeOS.