- 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
- AddEsimParams
- ActivationState
- RemoveEsimParams
- RequestDeviceInfoParams
- DeviceInfo
- WipeParams
- ClearAppsDataStatus
- PerAppResult
- ClearingResult
- StartLostModeStatus
- Status
- StopLostModeStatus
- Status
- EsimCommandStatus
- Status
- InternalErrorDetails
- OperationCodeDetail
- ErrorCodeDetail
- EsimInfo
- RequestDeviceInfoStatus
- Status
- EidInfo
- Eid
- Faça um teste
Envia um comando para um dispositivo. O recurso Operation retornado contém um Command no campo metadata. Use o método "get operation" para conferir 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 o OAuth 2.0 Overview.
Comando
Um comando.
| Representação JSON | 
|---|
| { "type": enum ( | 
| Campos | |
|---|---|
| type | 
 O tipo do comando. | 
| createTime | 
 O carimbo de data/hora em que o comando foi criado. O carimbo de data/hora é gerado automaticamente pelo servidor. Usa RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Outros ajustes também são aceitos. Por exemplo,  | 
| duration | 
 A duração da validade do comando. O comando vai expirar se não for executado pelo dispositivo durante esse período. A duração padrão, se não for especificada, é de dez minutos. Não há uma duração máxima. Duração em segundos com até nove dígitos fracionários, terminando em " | 
| userName | 
 O nome do recurso do usuário proprietário do dispositivo no formato  | 
| errorCode | 
 Se o comando falhar, um código de erro explicando a falha. Não é definido quando o comando é cancelado pelo autor da chamada. Para raciocinar sobre erros de comando, prefira campos na seguinte ordem (primeiro os mais preferidos): 1. Campos específicos do comando, como  | 
| newPassword | 
 Para comandos do tipo  | 
| resetPasswordFlags[] | 
 Para comandos do tipo  | 
| Campo de união  Se esse campo for definido, os campos  | |
| clearAppsDataParams | 
 Parâmetros do comando  | 
| startLostModeParams | 
 Parâmetros do comando  | 
| stopLostModeParams | 
 Parâmetros para o comando  | 
| addEsimParams | 
 Opcional. Parâmetros do comando  | 
| removeEsimParams | 
 Opcional. Parâmetros do comando  | 
| requestDeviceInfoParams | 
 Opcional. Parâmetros do comando  | 
| wipeParams | 
 Opcional. Parâmetros para o comando  | 
| Campo de união status. Status específico do comando. Alguns comandos não usam isso, principalmente,,e. No futuro, esses comandos também poderão usar isso.statuspode 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  | 
| esimStatus | 
 Apenas saída. Status de um comando  | 
| requestDeviceInfoStatus | 
 Apenas saída. Status do comando  | 
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. Só é compatível com 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, liberando o dispositivo para uso pessoal. Os apps e dados associados aos perfis pessoais são preservados. O dispositivo será excluído do servidor depois que reconhecer o comando. | 
| CLEAR_APP_DATA | Limpa os dados de apps especificados. Essa opção está disponível no Android 9 e versões mais recentes. Um aplicativo pode armazenar dados fora dos dados dele, por exemplo, em um armazenamento externo ou em um dicionário do usuário. Consulte também . | 
| START_LOST_MODE | Coloca o dispositivo no modo perdido. Disponível apenas em dispositivos totalmente gerenciados ou de propriedade da organização com um perfil gerenciado. Consulte também . | 
| STOP_LOST_MODE | Remove o dispositivo do modo perdido. Disponível apenas em dispositivos totalmente gerenciados ou de propriedade da organização com um perfil gerenciado. Consulte também . | 
| ADD_ESIM | Adiciona um perfil de eSIM ao dispositivo. Essa opção é aceita no Android 15 e versões mais recentes. Consulte também . Para remover um perfil de eSIM, use o comando. Para determinar o que acontece com o perfil do eSIM quando um dispositivo é limpo, definana política. Observação: para provisionar vários eSIMs em um único dispositivo, é recomendável introduzir um atraso de alguns minutos entre as execuções sucessivas do comando. | 
| REMOVE_ESIM | Remove um perfil de eSIM do dispositivo. Essa opção é aceita no Android 15 e versões mais recentes. Consulte também . | 
| REQUEST_DEVICE_INFO | Solicitar informações relacionadas ao dispositivo. | 
| WIPE | Limpa o dispositivo com uma redefinição de fábrica em um dispositivo da empresa ou excluindo o perfil de trabalho em um dispositivo pessoal com perfil de trabalho. A limpeza só ocorre quando o dispositivo reconhece o comando. O comando pode ser cancelado antes disso. | 
CommandErrorCode
Um código de erro de comando. Este é um campo somente leitura preenchido pelo servidor.
| Enums | |
|---|---|
| COMMAND_ERROR_CODE_UNSPECIFIED | Não ocorreu 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 a Política do dispositivo Android 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 mudem a senha novamente até que o usuário a insira. | 
| DO_NOT_ASK_CREDENTIALS_ON_BOOT | Não peça as credenciais do usuário na inicialização do dispositivo. | 
| LOCK_NOW | Bloqueie o dispositivo após a redefinição da senha. | 
ClearAppsDataParams
Parâmetros associados ao comando CLEAR_APP_DATA
| Representação JSON | 
|---|
| { "packageNames": [ string ] } | 
| Campos | |
|---|---|
| packageNames[] | 
 Os nomes de pacote dos apps cujos dados serão apagados quando o comando for executado. | 
StartLostModeParams
Parâmetros associados ao comando START_LOST_MODE
| Representação JSON | 
|---|
| { "lostMessage": { object ( | 
| Campos | |
|---|---|
| lostMessage | 
 A 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 "Ligar para 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 mostrado ao usuário quando o dispositivo está no modo perdido. | 
| lostOrganization | 
 O nome da organização exibido ao usuário quando o dispositivo está no modo perdido. | 
StopLostModeParams
Esse tipo não tem campos.
Parâmetros associados ao comando STOP_LOST_MODE
AddEsimParams
Parâmetros associados ao comando ADD_ESIM
| Representação JSON | 
|---|
| {
  "activationCode": string,
  "activationState": enum ( | 
| Campos | |
|---|---|
| activationCode | 
 Obrigatório. O código de ativação do perfil de eSIM. | 
| activationState | 
 Obrigatório. O estado de ativação do perfil de eSIM depois que ele é baixado. | 
ActivationState
O estado de ativação do perfil de eSIM depois que ele é baixado.
| Enums | |
|---|---|
| ACTIVATION_STATE_UNSPECIFIED | O estado de ativação do eSIM não foi especificado. Por padrão, o perfil do eSIM é em dispositivos pessoais eem dispositivos corporativos. | 
| ACTIVATED | O eSIM é ativado automaticamente após o download. Definir isso como o estado de ativação para dispositivos pessoais vai resultar na rejeição do comando. | 
| NOT_ACTIVATED | O perfil do eSIM é baixado, mas não ativado. Nesse caso, o usuário precisa ativar o eSIM manualmente no dispositivo. | 
RemoveEsimParams
Parâmetros associados ao comando REMOVE_ESIM
| Representação JSON | 
|---|
| { "iccId": string } | 
| Campos | |
|---|---|
| iccId | 
 Obrigatório. ICCID do perfil do eSIM a ser excluído. | 
RequestDeviceInfoParams
Parâmetros associados ao comando REQUEST_DEVICE_INFO
| Representação JSON | 
|---|
| {
  "deviceInfo": enum ( | 
| Campos | |
|---|---|
| deviceInfo | 
 Obrigatório. Tipo de informação do dispositivo a ser solicitada. | 
DeviceInfo
Tipo de informação do dispositivo a ser solicitada.
| Enums | |
|---|---|
| DEVICE_INFO_UNSPECIFIED | Esse valor não é permitido. | 
| EID | Solicita o identificador do eSIM. O usuário vai precisar aprovar a divulgação das informações antes que o resultado seja retornado. Se o usuário não aprovar a declaração, será retornado. Essa opção só está disponível em dispositivos pessoais com perfis de trabalho e versões do Android 13 ou mais recentes. | 
WipeParams
Parâmetros associados ao comando WIPE
| Representação JSON | 
|---|
| { "wipeDataFlags": [ enum ( | 
| Campos | |
|---|---|
| wipeDataFlags[] | 
 Opcional. Flags para determinar quais dados serão apagados. | 
| wipeReason | 
 Opcional. Uma mensagem curta exibida ao usuário antes da exclusão permanente do perfil de trabalho em dispositivos pessoais. Isso não afeta os dispositivos da empresa. O tamanho máximo da mensagem é de 200 caracteres. | 
ClearAppsDataStatus
Status do comando CLEAR_APP_DATA
| Representação JSON | 
|---|
| {
  "results": {
    string: {
      object ( | 
| Campos | |
|---|---|
| results | 
 Os resultados por app, um mapeamento de nomes de 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 do 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 do app porque o nível da API do dispositivo não é compatível com esse comando. | 
StartLostModeStatus
Status do comando 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 dele recentemente. | 
| USER_EXIT_LOST_MODE_RECENTLY | Não foi possível colocar o dispositivo no modo perdido porque o usuário saiu desse modo recentemente. | 
| ALREADY_IN_LOST_MODE | O dispositivo já está no modo perdido. | 
StopLostModeStatus
Status do comando 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 saiu do modo perdido. | 
| NOT_IN_LOST_MODE | O dispositivo não está no modo perdido. | 
EsimCommandStatus
Status e detalhes do erro (se houver) de um comando ADD_ESIMREMOVE_ESIM
| Representação JSON | 
|---|
| { "status": enum ( | 
| Campos | |
|---|---|
| status | 
 Apenas saída. Status de um comando  | 
| esimInfo | 
 Apenas saída. Informações sobre o eSIM adicionado ou removido. Esse campo só é preenchido quando a operação do eSIM  | 
| Campo de união status_details. Detalhes do status de um comandoou.status_detailspode ser apenas um dos seguintes: | |
| internalErrorDetails | 
 Apenas saída. Detalhes do erro se  | 
Status
Status de um comando ADD_ESIMREMOVE_ESIM
| Enums | |
|---|---|
| STATUS_UNSPECIFIED | Não especificado. Esse valor não é usado. | 
| SUCCESS | A operação do eSIM foi realizada com sucesso no dispositivo. | 
| IN_PROGRESS | A operação do eSIM está em andamento. | 
| PENDING_USER_ACTION | O usuário precisa realizar uma ação para que a operação do eSIM seja concluída. | 
| ERROR_SETUP_IN_PROGRESS | A operação do eSIM não pode ser executada enquanto a configuração está em andamento. | 
| ERROR_USER_DENIED | O usuário negou a operação do eSIM. | 
| INTERNAL_ERROR | Ocorreu um erro ao tentar adicionar ou remover o eSIM no dispositivo. Consulte . | 
| ERROR_ICC_ID_NOT_FOUND | Para um comando , odo eSIM a ser removido não foi encontrado no dispositivo. Isso pode significar que o eSIM não pertence à empresa ou que o eSIM correspondente aonão está presente no dispositivo. | 
| ERROR_MULTIPLE_ACTIVE_ESIMS_NO_AVAILABLE_SLOT | O comando falhou ao tentar adicionar um novo eSIM com o estado de ativação definido comoporque vários slots de eSIM no dispositivo contêm perfis de eSIM ativos e não há um slot de eSIM livre disponível. Para resolver isso, o novo eSIM pode ser adicionado com o estado de ativação comopara ativação manual posterior. Outra opção é o usuário desativar um eSIM ativo para que a operação prossiga. | 
InternalErrorDetails
Detalhes do erro interno, se presentes, para o comando ADD_ESIMREMOVE_ESIM
| Representação JSON | 
|---|
| { "operationCode": string, "errorCode": string, "operationCodeDetail": enum ( | 
| Campos | |
|---|---|
| operationCode | 
 Apenas saída. Representação de número inteiro do código da operação, conforme especificado aqui. Veja  | 
| errorCode | 
 Apenas saída. Representação de número inteiro do código de erro, conforme especificado aqui. Consulte também  | 
| operationCodeDetail | 
 Apenas saída. O detalhe do código da operação correspondente ao  | 
| errorCodeDetail | 
 Apenas saída. O detalhe do código de erro correspondente ao  | 
OperationCodeDetail
O detalhe do código da operação correspondente ao operationCode
| Enums | |
|---|---|
| OPERATION_CODE_DETAIL_UNSPECIFIED | O detalhe do código da operação não foi especificado. O não é reconhecido pela API Android Management. No entanto, consulte. | 
| OPERATION_SYSTEM | Consulte EuiccManager.OPERATION_SYSTEM para mais detalhes. | 
| OPERATION_SIM_SLOT | Consulte EuiccManager.OPERATION_SIM_SLOT para mais detalhes. | 
| OPERATION_EUICC_CARD | Consulte EuiccManager.OPERATION_EUICC_CARD para mais detalhes. | 
| OPERATION_SMDX | Consulte EuiccManager.OPERATION_SMDX para mais detalhes. | 
| OPERATION_SWITCH | Consulte EuiccManager.OPERATION_SWITCH para mais detalhes. | 
| OPERATION_DOWNLOAD | Consulte EuiccManager.OPERATION_DOWNLOAD para mais detalhes. | 
| OPERATION_METADATA | Consulte EuiccManager.OPERATION_METADATA para mais detalhes. | 
| OPERATION_EUICC_GSMA | Consulte EuiccManager.OPERATION_EUICC_GSMA para mais detalhes. | 
| OPERATION_APDU | Consulte EuiccManager.OPERATION_APDU para mais detalhes. | 
| OPERATION_SMDX_SUBJECT_REASON_CODE | Consulte EuiccManager.OPERATION_SMDX_SUBJECT_REASON_CODE para mais detalhes. Nesse caso, são os três bytes menos significativos doEXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODEque especificam o código do assunto e o código do motivo, conforme indicado aqui. O byte mais significativo do número inteiro é zerado. Por exemplo, um código de assunto 8.11.1 e um código de motivo 5.1 são representados emcomo 0000 0000 1000 1011 0001 0000 0101 0001 em binário, que é 9113681 em decimal. | 
| OPERATION_HTTP | Consulte EuiccManager.OPERATION_HTTP para mais detalhes. | 
ErrorCodeDetail
Detalhes do código de erro correspondente ao errorCode
| Enums | |
|---|---|
| ERROR_CODE_DETAIL_UNSPECIFIED | O detalhe do código de erro não foi especificado. O não é reconhecido pela API Android Management. No entanto, consulte | 
| ERROR_TIME_OUT | Consulte EuiccManager.ERROR_TIME_OUT para mais detalhes. | 
| ERROR_EUICC_MISSING | Consulte EuiccManager.ERROR_EUICC_MISSING para mais detalhes. | 
| ERROR_UNSUPPORTED_VERSION | Consulte EuiccManager.ERROR_UNSUPPORTED_VERSION para mais detalhes. | 
| ERROR_ADDRESS_MISSING | Consulte EuiccManager.ERROR_ADDRESS_MISSING para mais detalhes. | 
| ERROR_INVALID_CONFIRMATION_CODE | Consulte EuiccManager.ERROR_INVALID_CONFIRMATION_CODE para mais detalhes. | 
| ERROR_CERTIFICATE_ERROR | Consulte EuiccManager.ERROR_CERTIFICATE_ERROR para mais detalhes. | 
| ERROR_NO_PROFILES_AVAILABLE | Consulte EuiccManager.ERROR_NO_PROFILES_AVAILABLE para mais detalhes. | 
| ERROR_CONNECTION_ERROR | Consulte EuiccManager.ERROR_CONNECTION_ERROR para mais detalhes. | 
| ERROR_INVALID_RESPONSE | Consulte EuiccManager.ERROR_INVALID_RESPONSE para mais detalhes. | 
| ERROR_CARRIER_LOCKED | Consulte EuiccManager.ERROR_CARRIER_LOCKED para mais detalhes. | 
| ERROR_DISALLOWED_BY_PPR | Consulte EuiccManager.ERROR_DISALLOWED_BY_PPR para mais detalhes. | 
| ERROR_INVALID_ACTIVATION_CODE | Consulte EuiccManager.ERROR_INVALID_ACTIVATION_CODE para saber mais detalhes. | 
| ERROR_INCOMPATIBLE_CARRIER | Consulte EuiccManager.ERROR_INCOMPATIBLE_CARRIER para mais detalhes. | 
| ERROR_OPERATION_BUSY | Consulte EuiccManager.ERROR_OPERATION_BUSY para mais detalhes. | 
| ERROR_INSTALL_PROFILE | Consulte EuiccManager.ERROR_INSTALL_PROFILE para mais detalhes. | 
| ERROR_EUICC_INSUFFICIENT_MEMORY | Consulte EuiccManager.ERROR_EUICC_INSUFFICIENT_MEMORY para mais detalhes. | 
| ERROR_INVALID_PORT | Consulte EuiccManager.ERROR_INVALID_PORT para mais detalhes. | 
| ERROR_SIM_MISSING | Consulte EuiccManager.ERROR_SIM_MISSING para mais detalhes. | 
EsimInfo
Detalhes do eSIM adicionado ou removido.
| Representação JSON | 
|---|
| { "iccId": string } | 
| Campos | |
|---|---|
| iccId | 
 Apenas saída. ICCID do eSIM. | 
RequestDeviceInfoStatus
Status do comando REQUEST_DEVICE_INFO
| Representação JSON | 
|---|
| { "status": enum ( | 
| Campos | |
|---|---|
| status | 
 Apenas saída. Status de um comando  | 
| Campo de união device_info. Detalhes das informações do dispositivo solicitadas pelo administrador. Isso só será preenchido quandofor.device_infopode ser apenas um dos seguintes: | |
| eidInfo | 
 Informações relacionadas aos EIDs do dispositivo. | 
Status
Status de um comando REQUEST_DEVICE_INFO
| Enums | |
|---|---|
| STATUS_UNSPECIFIED | Não especificado. Esse valor não é usado. | 
| SUCCEEDED | As informações do dispositivo foram entregues. | 
| PENDING_USER_ACTION | O usuário não concluiu as ações necessárias para compartilhar informações do dispositivo. | 
| USER_DECLINED | O usuário recusou o compartilhamento de informações do dispositivo. | 
| UNSUPPORTED | As informações solicitadas não são compatíveis com este dispositivo. Por exemplo, o eSIM não é compatível com o dispositivo. | 
EidInfo
Informações relacionadas aos EIDs do dispositivo.
| Representação JSON | 
|---|
| {
  "eids": [
    {
      object ( | 
| Campos | |
|---|---|
| eids[] | 
 Apenas saída. Informações de EID para cada chip eUICC. | 
Eid
Informações de EID para cada chip eUICC.
| Representação JSON | 
|---|
| { "eid": string } | 
| Campos | |
|---|---|
| eid | 
 Apenas saída. O EID | 
