Method: enterprises.devices.issueCommand

Emite um comando para um dispositivo. O recurso Operation retornado contém um Command no campo metadata. Use o método de operação get para ver o status do comando.

Solicitação HTTP

POST https://androidmanagement.googleapis.com/v1/{name=enterprises/*/devices/*}:issueCommand

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

Parâmetros de caminho

Parâmetros
name

string

O nome do dispositivo no formato enterprises/{enterpriseId}/devices/{deviceId}.

Corpo da solicitação

O corpo da solicitação contém uma instância de Command.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/androidmanagement

Para mais informações, consulte a Visão geral do OAuth 2.0.

Comando

Um comando.

Representação JSON 
{
  "type": enum (CommandType),
  "createTime": string,
  "duration": string,
  "userName": string,
  "errorCode": enum (CommandErrorCode),
  "newPassword": string,
  "resetPasswordFlags": [
    enum (ResetPasswordFlag)
  ],

  // Union field params can be only one of the following:
  "clearAppsDataParams": {
    object (ClearAppsDataParams)
  },
  "startLostModeParams": {
    object (StartLostModeParams)
  },
  "stopLostModeParams": {
    object (StopLostModeParams)
  }
  // End of list of possible types for union field params.

  // Union field status can be only one of the following:
  "clearAppsDataStatus": {
    object (ClearAppsDataStatus)
  },
  "startLostModeStatus": {
    object (StartLostModeStatus)
  },
  "stopLostModeStatus": {
    object (StopLostModeStatus)
  }
  // End of list of possible types for union field status.
}
Campos
type

enum (CommandType)

O tipo do comando.
createTime

string (Timestamp format)

O carimbo de data/hora em que o comando foi criado. O carimbo de data/hora é gerado automaticamente pelo servidor.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
duration

string (Duration format)

O tempo de validade do comando. O comando vai expirar se não for executado pelo dispositivo durante esse período. Se não for especificada, a duração padrão será de dez minutos. Não há duração máxima.

Uma duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
userName

string

O nome do recurso do usuário proprietário do dispositivo no formato enterprises/{enterpriseId}/users/{userId}. Ele é gerado automaticamente pelo servidor com base no dispositivo ao qual o comando é enviado.
errorCode

enum (CommandErrorCode)

Se o comando falhar, um código de erro explicando a falha. Isso não é definido quando o comando é cancelado pelo autor da chamada.
newPassword

string

Para comandos do tipo RESET_PASSWORD, opcionalmente especifica a nova senha. Observação: a nova senha precisa ter pelo menos seis caracteres se for numérica no caso de dispositivos Android 14. Caso contrário, o comando falhará com INVALID_VALUE.
resetPasswordFlags[]

enum (ResetPasswordFlag)

Para comandos do tipo RESET_PASSWORD, opcionalmente especifica-se sinalizações.

Campo de união params. Parâmetros específicos do comando. Alguns comandos não usam isso, em especial LOCK, RESET_PASSWORD, REBOOT e RELINQUISH_OWNERSHIP. Futuramente, esses comandos também poderão usá-lo.

Se esse valor for definido, não será possível definir os campos new_password e reset_password_flags. params pode ser apenas de um dos tipos a seguir:
clearAppsDataParams

object (ClearAppsDataParams)

Parâmetros do comando CLEAR_APP_DATA para limpar os dados de apps especificados do dispositivo. Consulte os ClearAppsDataParams. Se esse valor for definido, é sugerido que type não seja definido. Nesse caso, o servidor a configura automaticamente como CLEAR_APP_DATA. Também é aceitável definir explicitamente type como CLEAR_APP_DATA.
startLostModeParams

object (StartLostModeParams)

Parâmetros do comando START_LOST_MODE para colocar o dispositivo no Modo perdido. Consulte os StartLostModeParams. Se esse valor for definido, é sugerido que type não seja definido. Nesse caso, o servidor a configura automaticamente como START_LOST_MODE. Também é aceitável definir explicitamente type como START_LOST_MODE.
stopLostModeParams

object (StopLostModeParams)

Parâmetros do comando STOP_LOST_MODE para tirar o dispositivo do Modo perdido. Consulte os StopLostModeParams. Se esse valor for definido, é sugerido que type não seja definido. Nesse caso, o servidor a configura automaticamente como STOP_LOST_MODE. Também é aceitável definir explicitamente type como STOP_LOST_MODE.
Campo de união status. Status específico do comando. Alguns comandos não usam isso, em especial LOCK, RESET_PASSWORD, REBOOT e RELINQUISH_OWNERSHIP. Futuramente, esses comandos também poderão usá-lo. status pode ser apenas de um dos tipos a seguir:
clearAppsDataStatus

object (ClearAppsDataStatus)

Apenas saída. Status do comando CLEAR_APP_DATA para limpar os dados de apps especificados do dispositivo. Consulte os ClearAppsDataStatus.
startLostModeStatus

object (StartLostModeStatus)

Apenas saída. Status do comando START_LOST_MODE para colocar o dispositivo no Modo perdido. Consulte os StartLostModeStatus.
stopLostModeStatus

object (StopLostModeStatus)

Apenas saída. Status do comando STOP_LOST_MODE para tirar o dispositivo do Modo perdido. Consulte os StopLostModeStatus.

CommandType

Tipos de comandos.

Enums
COMMAND_TYPE_UNSPECIFIED Esse valor não é permitido.
LOCK Bloqueie o dispositivo, como se o tempo limite da tela de bloqueio tivesse expirado.
RESET_PASSWORD Redefina a senha do usuário.
REBOOT Reinicialize o dispositivo. Compatível apenas com dispositivos totalmente gerenciados que executam o Android 7.0 (nível 24 da API) ou mais recente.
RELINQUISH_OWNERSHIP Remove o perfil de trabalho e todas as políticas de um dispositivo Android 8.0 ou mais recente da empresa, cedendo o dispositivo para uso pessoal. Os apps e dados associados aos perfis pessoais são preservados. O dispositivo será excluído do servidor depois de confirmar o comando.
CLEAR_APP_DATA Limpa os dados de apps especificados. Esse recurso pode ser usado no Android 9 e versões mais recentes. Observe que um aplicativo pode armazenar dados fora dos dados do aplicativo, por exemplo, em um armazenamento externo ou em um dicionário do usuário. Consulte também clearAppsDataParams.
START_LOST_MODE Coloca o dispositivo no Modo perdido. Compatível apenas com dispositivos totalmente gerenciados ou da organização com um perfil gerenciado. Consulte também startLostModeParams.
STOP_LOST_MODE Remove o dispositivo do Modo perdido. Compatível apenas com dispositivos totalmente gerenciados ou da organização com um perfil gerenciado. Consulte também stopLostModeParams.

CommandErrorCode

um código de erro de comando. Este é um campo somente leitura preenchido pelo servidor.

Enums
COMMAND_ERROR_CODE_UNSPECIFIED Não houve erro.
UNKNOWN Ocorreu um erro desconhecido.
API_LEVEL O nível da API do dispositivo não é compatível com esse comando.
MANAGEMENT_MODE O modo de gerenciamento (proprietário do perfil, do dispositivo etc.) não é compatível com o comando.
INVALID_VALUE O comando tem um valor de parâmetro inválido.
UNSUPPORTED O dispositivo não oferece suporte ao comando. Atualizar o Android Device Policy para a versão mais recente pode resolver o problema.

ResetPasswordFlag

Flags que podem ser usadas para o tipo de comando RESET_PASSWORD.

Enums
RESET_PASSWORD_FLAG_UNSPECIFIED Esse valor é ignorado.
REQUIRE_ENTRY Não permitir que outros administradores alterem a senha até que o usuário a tenha digitado.
DO_NOT_ASK_CREDENTIALS_ON_BOOT Não solicitar credenciais do usuário na inicialização do dispositivo.
LOCK_NOW Bloquear o dispositivo após a redefinição da senha.

ClearAppsDataParams

Parâmetros associados ao comando CLEAR_APP_DATA para limpar os dados de apps especificados do dispositivo.

Representação JSON 
{
  "packageNames": [
    string
  ]
}
Campos
packageNames[]

string

Os nomes dos pacotes dos apps cujos dados serão apagados quando o comando for executado.

StartLostModeParams

Parâmetros associados ao comando START_LOST_MODE para colocar o dispositivo no Modo perdido. Pelo menos um dos parâmetros, sem incluir o nome da organização, precisa ser fornecido para que o dispositivo seja colocado no Modo perdido.

Representação JSON 
{
  "lostMessage": {
    object (UserFacingMessage)
  },
  "lostPhoneNumber": {
    object (UserFacingMessage)
  },
  "lostEmailAddress": string,
  "lostStreetAddress": {
    object (UserFacingMessage)
  },
  "lostOrganization": {
    object (UserFacingMessage)
  }
}
Campos
lostMessage

object (UserFacingMessage)

A mensagem exibida ao usuário quando o dispositivo está no Modo perdido.
lostPhoneNumber

object (UserFacingMessage)

O número de telefone que será chamado quando o dispositivo estiver no Modo perdido e o botão "Ligar para o proprietário" for tocado.
lostEmailAddress

string

O endereço de e-mail exibido ao usuário quando o dispositivo está no Modo perdido.
lostStreetAddress

object (UserFacingMessage)

O endereço exibido ao usuário quando o dispositivo está no Modo perdido.
lostOrganization

object (UserFacingMessage)

O nome da organização exibido para o usuário quando o dispositivo está no Modo perdido.

StopLostModeParams

Esse tipo não tem campos.

Parâmetros associados ao comando STOP_LOST_MODE para tirar o dispositivo do Modo perdido.

ClearAppsDataStatus

Status do comando CLEAR_APP_DATA para limpar os dados de apps especificados do dispositivo.

Representação JSON 
{
  "results": {
    string: {
      object (PerAppResult)
    },
    ...
  }
}
Campos
results

map (key: string, value: object (PerAppResult))

Os resultados por app, um mapeamento dos nomes dos pacotes para o respectivo resultado de limpeza.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

PerAppResult

O resultado de uma tentativa de limpar os dados de um único app.

Representação JSON 
{
  "clearingResult": enum (ClearingResult)
}
Campos
clearingResult

enum (ClearingResult)

O resultado de uma tentativa de limpar os dados de um único app.

ClearingResult

O resultado de uma tentativa de limpar os dados de um único app.

Enums
CLEARING_RESULT_UNSPECIFIED Resultado não especificado.
SUCCESS Os dados deste app foram apagados.
APP_NOT_FOUND Não foi possível limpar os dados do app porque ele não foi encontrado.
APP_PROTECTED Não foi possível limpar os dados do app porque ele está protegido. Por exemplo, isso pode se aplicar a apps essenciais para o funcionamento do dispositivo, como a Google Play Store.
API_LEVEL Não foi possível limpar os dados deste app porque o nível da API do dispositivo não é compatível com o comando.

StartLostModeStatus

Status do comando START_LOST_MODE para colocar o dispositivo no Modo perdido.

Representação JSON 
{
  "status": enum (Status)
}
Campos
status

enum (Status)

O status. Consulte os StartLostModeStatus.

Status

O status. Consulte os StartLostModeStatus.

Enums
STATUS_UNSPECIFIED Não especificado. Esse valor não é usado.
SUCCESS O dispositivo foi colocado no Modo perdido.
RESET_PASSWORD_RECENTLY Não foi possível colocar o dispositivo no modo perdido porque o administrador redefiniu a senha do dispositivo recentemente.
USER_EXIT_LOST_MODE_RECENTLY Não foi possível colocar o dispositivo no Modo perdido porque o usuário saiu recentemente.
ALREADY_IN_LOST_MODE O dispositivo já está no Modo perdido.

StopLostModeStatus

Status do comando STOP_LOST_MODE para tirar o dispositivo do Modo perdido.

Representação JSON 
{
  "status": enum (Status)
}
Campos
status

enum (Status)

O status. Consulte os StopLostModeStatus.

Status

O status. Consulte os StopLostModeStatus.

Enums
STATUS_UNSPECIFIED Não especificado. Esse valor não é usado.
SUCCESS O dispositivo foi retirado do Modo perdido.
NOT_IN_LOST_MODE O dispositivo não está no Modo perdido.