- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Comando
- CommandType
- CommandErrorCode
- ResetPasswordFlag
- ClearAppsDataParams
- StartLostModeParams
- StopLostModeParams
- ClearAppsDataStatus
- PerAppResult
- ClearingResult
- StartLostModeStatus
- Status
- StopLostModeStatus
- Status
- Faça um teste
Emite um comando para um dispositivo. O recurso Operation
retornado contém uma 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 |
O nome do dispositivo no formato |
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 ( |
Campos | |
---|---|
type |
O tipo de comando. |
createTime |
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 RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
duration |
Por quanto tempo o comando é válido. 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 10 minutos. Não há duração máxima. Duração em segundos com até nove dígitos fracionários, terminando em " |
userName |
O nome de recurso do usuário proprietário do dispositivo no formato |
errorCode |
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 |
Para comandos do tipo |
resetPasswordFlags[] |
Para comandos do tipo |
Campo de união Se esse valor for definido, os campos |
|
clearAppsDataParams |
Parâmetros do comando |
startLostModeParams |
Parâmetros do comando |
stopLostModeParams |
Parâmetros do comando |
Campo de união status . Status específico do comando. Alguns comandos não usam isso, em especial , , e . No futuro, esses comandos também poderão usar isso. status pode ser apenas de um dos tipos a seguir: |
|
clearAppsDataStatus |
Apenas saída. Status do comando |
startLostModeStatus |
Apenas saída. Status do comando |
stopLostModeStatus |
Apenas saída. Status do comando |
CommandType
Tipos de comandos.
Enums | |
---|---|
COMMAND_TYPE_UNSPECIFIED |
Este valor não é permitido. |
LOCK |
Bloqueie o dispositivo como se o tempo limite da tela de bloqueio tivesse expirado. |
RESET_PASSWORD |
redefinir a senha do usuário; |
REBOOT |
Reinicialize o dispositivo. Disponível apenas em dispositivos totalmente gerenciados que executam o Android 7.0 (nível 24 da API) ou versões mais recentes. |
RELINQUISH_OWNERSHIP |
Remove o perfil de trabalho e todas as políticas de um dispositivo Android 8.0 ou mais recente da empresa, permitindo o uso pessoal. Os apps e dados associados aos perfis pessoais são preservados. O dispositivo será excluído do servidor depois que ele confirmar o comando. |
CLEAR_APP_DATA |
Limpa os dados de apps especificados. Isso é compatível com o Android 9 e versões mais recentes. Um aplicativo pode armazenar dados fora dos dados do aplicativo, por exemplo, no armazenamento externo ou em um dicionário do usuário. Consulte também . |
START_LOST_MODE |
Coloca o dispositivo no Modo perdido. Compatível apenas com dispositivos totalmente gerenciados ou dispositivos da organização com um perfil gerenciado. Consulte também . |
STOP_LOST_MODE |
Tirar o dispositivo do Modo perdido. Compatível apenas com dispositivos totalmente gerenciados ou dispositivos da organização com um perfil gerenciado. Consulte também . |
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, proprietário 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 é compatível com o 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 permita que outros administradores alterem a senha novamente até que o usuário a digite. |
DO_NOT_ASK_CREDENTIALS_ON_BOOT |
Não solicite credenciais de 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
para limpar os dados de apps especificados do dispositivo.CLEAR_APP_DATA
Representação JSON |
---|
{ "packageNames": [ string ] } |
Campos | |
---|---|
packageNames[] |
Os nomes dos pacotes dos apps cujos dados serão apagados quando o comando for executado. |
StartLostModeParams
Parâmetros associados ao comando
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.START_LOST_MODE
Representação JSON |
---|
{ "lostMessage": { object ( |
Campos | |
---|---|
lostMessage |
Mensagem exibida ao usuário quando o dispositivo está no Modo perdido. |
lostPhoneNumber |
O número de telefone que será chamado quando o dispositivo estiver no Modo perdido e o botão para chamar o proprietário for tocado. |
lostEmailAddress |
O endereço de e-mail exibido ao usuário quando o dispositivo está no Modo perdido. |
lostStreetAddress |
O endereço exibido ao usuário quando o dispositivo está no Modo perdido. |
lostOrganization |
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
para tirar o dispositivo do Modo perdido.STOP_LOST_MODE
ClearAppsDataStatus
Status do comando
para limpar os dados de apps especificados do dispositivo.CLEAR_APP_DATA
Representação JSON |
---|
{
"results": {
string: {
object ( |
Campos | |
---|---|
results |
Os resultados por app, um mapeamento dos nomes dos pacotes para o respectivo resultado de limpeza. Um objeto com uma lista de pares |
PerAppResult
O resultado de uma tentativa de limpar os dados de um único app.
Representação JSON |
---|
{
"clearingResult": enum ( |
Campos | |
---|---|
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 desse app foram apagados. |
APP_NOT_FOUND |
Não foi possível limpar os dados desse app porque ele não foi encontrado. |
APP_PROTECTED |
Não foi possível limpar os dados desse 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 desse app porque o nível da API do dispositivo não é compatível com o comando. |
StartLostModeStatus
Status do comando
para colocar o dispositivo no Modo perdido.START_LOST_MODE
Representação JSON |
---|
{
"status": enum ( |
Campos | |
---|---|
status |
O status. Consulte |
Status
O status. Consulte
.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 do modo perdido recentemente. |
ALREADY_IN_LOST_MODE |
O dispositivo já está no Modo perdido. |
StopLostModeStatus
Status do comando
para tirar o dispositivo do Modo perdido.STOP_LOST_MODE
Representação JSON |
---|
{
"status": enum ( |
Campos | |
---|---|
status |
O status. Consulte |
Status
O status. Consulte
.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. |