Method: enterprises.devices.issueCommand

Invia un comando a un dispositivo. La risorsa Operation restituita contiene un Command nel campo metadata. Utilizza il metodo di operazione get per ottenere lo stato del comando.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

Il nome del dispositivo nel formato enterprises/{enterpriseId}/devices/{deviceId}.

Corpo della richiesta

Il corpo della richiesta contiene un'istanza di Command.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Operation.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la sezione OAuth 2.0 Overview.

Comando

Un comando.

Rappresentazione 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)
  },
  "requestDeviceInfoParams": {
    object (RequestDeviceInfoParams)
  }
  // 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)
  },
  "requestDeviceInfoStatus": {
    object (RequestDeviceInfoStatus)
  }
  // End of list of possible types for union field status.
}
Campi
type

enum (CommandType)

Il tipo di comando.
createTime

string (Timestamp format)

Il timestamp della creazione del comando. Il timestamp viene generato automaticamente dal server.

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
duration

string (Duration format)

La durata di validità del comando. Il comando scadrà se non viene eseguito dal dispositivo durante questo periodo di tempo. Se non specificato, la durata predefinita è di dieci minuti. Non è prevista una durata massima.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
userName

string

Il nome della risorsa dell'utente proprietario del dispositivo nel formato enterprises/{enterpriseId}/users/{userId}. Viene generato automaticamente dal server in base al dispositivo a cui viene inviato il comando.
errorCode

enum (CommandErrorCode)

Se il comando non è riuscito, viene visualizzato un codice di errore che spiega il problema. Questo valore non viene impostato quando il comando viene annullato dall'utente che ha effettuato la chiamata. Per dedurre gli errori dei comandi, preferisci i campi nel seguente ordine (il più preferito per primo): 1. Campi specifici del comando come clearAppsDataStatus, startLostModeStatus o simili, se esistono. 2. Questo campo, se impostato. 3. Il campo error generico in Operation che inserisce un a capo nel comando.
newPassword

string

Per i comandi di tipo RESET_PASSWORD, specifica facoltativamente la nuova password. Nota: la nuova password deve contenere almeno 6 caratteri se è numerica nel caso di dispositivi Android 14. In caso contrario, il comando avrà esito negativo e restituirà INVALID_VALUE.
resetPasswordFlags[]

enum (ResetPasswordFlag)

Per i comandi di tipo RESET_PASSWORD, specifica facoltativamente i flag.

Campo unione params. Parametri specifici del comando. Tieni presente che alcuni comandi non lo utilizzano, in particolare LOCK, RESET_PASSWORD, REBOOT e RELINQUISH_OWNERSHIP. In futuro, anche questi comandi potrebbero utilizzarlo.

Se questo valore è impostato, i campi new_password e reset_password_flags non devono essere impostati. params può essere solo uno dei seguenti:
clearAppsDataParams

object (ClearAppsDataParams)

Parametri per il comando CLEAR_APP_DATA per cancellare i dati delle app specificate dal dispositivo. Leggi i ClearAppsDataParams. Se questo valore è impostato, si consiglia di non impostare type. In questo caso, il server lo imposta automaticamente su CLEAR_APP_DATA. È anche accettabile impostare esplicitamente type su CLEAR_APP_DATA.
startLostModeParams

object (StartLostModeParams)

Parametri per il comando START_LOST_MODE per mettere il dispositivo in modalità Dispositivo smarrito. Leggi i StartLostModeParams. Se questo valore è impostato, si consiglia di non impostare type. In questo caso, il server lo imposta automaticamente su START_LOST_MODE. È anche accettabile impostare esplicitamente type su START_LOST_MODE.
stopLostModeParams

object (StopLostModeParams)

Parametri per il comando STOP_LOST_MODE per rimuovere il dispositivo dalla modalità Dispositivo smarrito. Leggi i StopLostModeParams. Se questo valore è impostato, si consiglia di non impostare type. In questo caso, il server lo imposta automaticamente su STOP_LOST_MODE. È anche accettabile impostare esplicitamente type su STOP_LOST_MODE.
requestDeviceInfoParams

object (RequestDeviceInfoParams)

Facoltativo. Parametri per il comando REQUEST_DEVICE_INFO per ottenere informazioni relative al dispositivo. Se questo valore è impostato, si consiglia di non impostare type. In questo caso, il server lo imposta automaticamente su REQUEST_DEVICE_INFO . È anche accettabile impostare esplicitamente type su REQUEST_DEVICE_INFO.
Campo unione status. Stato specifico del comando. Tieni presente che alcuni comandi non lo utilizzano, in particolare LOCK, RESET_PASSWORD, REBOOT e RELINQUISH_OWNERSHIP. In futuro, anche questi comandi potrebbero utilizzarlo. status può essere solo uno dei seguenti:
clearAppsDataStatus

object (ClearAppsDataStatus)

Solo output. Stato del comando CLEAR_APP_DATA per cancellare i dati delle app specificate dal dispositivo. Leggi i ClearAppsDataStatus.
startLostModeStatus

object (StartLostModeStatus)

Solo output. Stato del comando START_LOST_MODE per mettere il dispositivo in modalità Dispositivo smarrito. Leggi i StartLostModeStatus.
stopLostModeStatus

object (StopLostModeStatus)

Solo output. Stato del comando STOP_LOST_MODE per rimuovere il dispositivo dalla modalità Dispositivo smarrito. Leggi i StopLostModeStatus.
requestDeviceInfoStatus

object (RequestDeviceInfoStatus)

Solo output. Stato del comando REQUEST_DEVICE_INFO.

CommandType

Tipi di comandi.

Enum
COMMAND_TYPE_UNSPECIFIED Questo valore non è consentito.
LOCK Blocca il dispositivo, come se il timeout della schermata di blocco fosse scaduto.
RESET_PASSWORD Reimposta la password dell'utente.
REBOOT Riavvia il dispositivo. Supportato solo su dispositivi completamente gestiti con Android 7.0 (livello API 24) o versioni successive.
RELINQUISH_OWNERSHIP Rimuove il profilo di lavoro e tutti i criteri da un dispositivo Android 8.0 o versioni successive di proprietà dell'azienda, liberando il dispositivo per uso personale. Le app e i dati associati ai profili personali vengono conservati. Il dispositivo verrà eliminato dal server dopo aver confermato il comando.
CLEAR_APP_DATA Cancella i dati delle app specificate. Questa funzionalità è supportata su Android 9 e versioni successive. Tieni presente che un'applicazione può archiviare dati al di fuori dei suoi dati di applicazione, ad esempio in uno spazio di archiviazione esterno o in un dizionario utente. Vedi anche clearAppsDataParams.
START_LOST_MODE Mette il dispositivo in modalità Dispositivo smarrito. Supportato solo su dispositivi completamente gestiti o di proprietà dell'organizzazione con un profilo gestito. Vedi anche startLostModeParams.
STOP_LOST_MODE Il dispositivo esce dalla modalità Dispositivo smarrito. Supportato solo su dispositivi completamente gestiti o di proprietà dell'organizzazione con un profilo gestito. Vedi anche stopLostModeParams.
REQUEST_DEVICE_INFO Richiedi informazioni relative al dispositivo.

CommandErrorCode

Un codice di errore del comando. Questo è un campo di sola lettura compilato dal server.

Enum
COMMAND_ERROR_CODE_UNSPECIFIED Non si è verificato alcun errore.
UNKNOWN Si è verificato un errore sconosciuto.
API_LEVEL Il livello API del dispositivo non supporta questo comando.
MANAGEMENT_MODE La modalità di gestione (proprietario del profilo, proprietario del dispositivo e così via) non supporta il comando.
INVALID_VALUE Il comando ha un valore di parametro non valido.
UNSUPPORTED Il dispositivo non supporta il comando. L'aggiornamento di Android Device Policy alla versione più recente potrebbe risolvere il problema.

ResetPasswordFlag

Flag che possono essere utilizzati per il tipo di comando RESET_PASSWORD.

Enum
RESET_PASSWORD_FLAG_UNSPECIFIED Questo valore viene ignorato.
REQUIRE_ENTRY Non consentire ad altri amministratori di modificare di nuovo la password finché l'utente non l'ha inserita.
DO_NOT_ASK_CREDENTIALS_ON_BOOT Non chiedere le credenziali utente all'avvio del dispositivo.
LOCK_NOW Blocca il dispositivo dopo il ripristino della password.

ClearAppsDataParams

Parametri associati al comando CLEAR_APP_DATA per cancellare i dati di app specifiche dal dispositivo.

Rappresentazione JSON 
{
  "packageNames": [
    string
  ]
}
Campi
packageNames[]

string

I nomi dei pacchetti delle app di cui verranno cancellati i dati quando viene eseguito il comando.

StartLostModeParams

Parametri associati al comando START_LOST_MODE per attivare la modalità Dispositivo smarrito sul dispositivo. Per poter mettere il dispositivo in modalità Dispositivo smarrito, è necessario fornire almeno uno dei parametri, escluso il nome dell'organizzazione.

Rappresentazione JSON 
{
  "lostMessage": {
    object (UserFacingMessage)
  },
  "lostPhoneNumber": {
    object (UserFacingMessage)
  },
  "lostEmailAddress": string,
  "lostStreetAddress": {
    object (UserFacingMessage)
  },
  "lostOrganization": {
    object (UserFacingMessage)
  }
}
Campi
lostMessage

object (UserFacingMessage)

Il messaggio visualizzato all'utente quando il dispositivo è in modalità Dispositivo smarrito.
lostPhoneNumber

object (UserFacingMessage)

Il numero di telefono che verrà chiamato quando il dispositivo è in modalità Dispositivo smarrito e viene toccato il pulsante Chiama proprietario.
lostEmailAddress

string

L'indirizzo email visualizzato all'utente quando il dispositivo è in modalità Dispositivo smarrito.
lostStreetAddress

object (UserFacingMessage)

L'indirizzo visualizzato all'utente quando il dispositivo è in modalità Dispositivo smarrito.
lostOrganization

object (UserFacingMessage)

Il nome dell'organizzazione visualizzato all'utente quando il dispositivo è in modalità Dispositivo smarrito.

StopLostModeParams

Questo tipo non contiene campi.

Parametri associati al comando STOP_LOST_MODE per rimuovere il dispositivo dalla modalità Dispositivo smarrito.

RequestDeviceInfoParams

Parametri associati al comando REQUEST_DEVICE_INFO per ottenere informazioni relative al dispositivo.

Rappresentazione JSON 
{
  "deviceInfo": enum (DeviceInfo)
}
Campi
deviceInfo

enum (DeviceInfo)

Obbligatorio. Tipo di informazioni sul dispositivo da richiedere.

DeviceInfo

Tipo di informazioni sul dispositivo da richiedere.

Enum
DEVICE_INFO_UNSPECIFIED Questo valore non è consentito.
EID Richiedi l'identificatore per l'eSIM. Prima che il risultato possa essere restituito, all'utente verrà chiesto di approvare la divulgazione delle informazioni. Se l'utente non approva l'informativa, verrà restituito USER_DECLINED. Questa opzione è supportata solo per i dispositivi di proprietà personale con profili di lavoro e versioni di Android 13 e successive.

ClearAppsDataStatus

Stato del comando CLEAR_APP_DATA per cancellare i dati delle app specificate dal dispositivo.

Rappresentazione JSON 
{
  "results": {
    string: {
      object (PerAppResult)
    },
    ...
  }
}
Campi
results

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

I risultati per app, una mappatura dai nomi dei pacchetti al rispettivo risultato di approvazione.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

PerAppResult

Il risultato di un tentativo di cancellare i dati di una singola app.

Rappresentazione JSON 
{
  "clearingResult": enum (ClearingResult)
}
Campi
clearingResult

enum (ClearingResult)

Il risultato di un tentativo di cancellare i dati di una singola app.

ClearingResult

Il risultato di un tentativo di cancellare i dati di una singola app.

Enum
CLEARING_RESULT_UNSPECIFIED Risultato non specificato.
SUCCESS I dati di questa app sono stati cancellati correttamente.
APP_NOT_FOUND Non è stato possibile cancellare i dati di questa app perché non è stata trovata.
APP_PROTECTED Impossibile cancellare i dati di questa app perché è protetta. Ad esempio, questo potrebbe valere per le app fondamentali per il funzionamento del dispositivo, come il Google Play Store.
API_LEVEL Non è stato possibile cancellare i dati di questa app perché il livello API del dispositivo non supporta questo comando.

StartLostModeStatus

Stato del comando START_LOST_MODE per mettere il dispositivo in modalità Dispositivo smarrito.

Rappresentazione JSON 
{
  "status": enum (Status)
}
Campi
status

enum (Status)

Lo stato. Leggi i StartLostModeStatus.

Stato

Lo stato. Leggi i StartLostModeStatus.

Enum
STATUS_UNSPECIFIED Non specificato. Questo valore non viene utilizzato.
SUCCESS Il dispositivo è stato messo in modalità Dispositivo smarrito.
RESET_PASSWORD_RECENTLY Non è stato possibile mettere il dispositivo in modalità Dispositivo smarrito perché l'amministratore ha reimpostato di recente la password del dispositivo.
USER_EXIT_LOST_MODE_RECENTLY Non è stato possibile mettere il dispositivo in modalità Dispositivo smarrito perché l'utente è uscito di recente da questa modalità.
ALREADY_IN_LOST_MODE Il dispositivo è già in modalità Dispositivo smarrito.

StopLostModeStatus

Stato del comando STOP_LOST_MODE per rimuovere il dispositivo dalla modalità Dispositivo smarrito.

Rappresentazione JSON 
{
  "status": enum (Status)
}
Campi
status

enum (Status)

Lo stato. Leggi i StopLostModeStatus.

Stato

Lo stato. Leggi i StopLostModeStatus.

Enum
STATUS_UNSPECIFIED Non specificato. Questo valore non viene utilizzato.
SUCCESS Il dispositivo è stato rimosso dalla modalità Dispositivo smarrito.
NOT_IN_LOST_MODE Il dispositivo non è in modalità Dispositivo smarrito.

RequestDeviceInfoStatus

Stato del comando REQUEST_DEVICE_INFO.

Rappresentazione JSON 
{
  "status": enum (Status),

  // Union field device_info can be only one of the following:
  "eidInfo": {
    object (EidInfo)
  }
  // End of list of possible types for union field device_info.
}
Campi
status

enum (Status)

Solo output. Stato di un comando REQUEST_DEVICE_INFO.
Campo unione device_info. Dettagli delle informazioni sul dispositivo richieste dall'amministratore. Questo campo viene compilato solo quando status è SUCCEEDED. device_info può essere solo uno dei seguenti:
eidInfo

object (EidInfo)

Informazioni relative agli EID del dispositivo.

Stato

Stato di un comando REQUEST_DEVICE_INFO.

Enum
STATUS_UNSPECIFIED Non specificato. Questo valore non viene utilizzato.
SUCCEEDED Le informazioni sul dispositivo sono state inviate correttamente.
PENDING_USER_ACTION L'utente non ha completato le azioni necessarie per condividere le informazioni del dispositivo.
USER_DECLINED L'utente ha rifiutato di condividere le informazioni del dispositivo.
UNSUPPORTED Le informazioni sul dispositivo richieste non sono supportate su questo dispositivo, ad esempio la eSIM non è supportata sul dispositivo.

EidInfo

Informazioni relative agli EID del dispositivo.

Rappresentazione JSON 
{
  "eids": [
    {
      object (Eid)
    }
  ]
}
Campi
eids[]

object (Eid)

Solo output. Informazioni sull'EID per ogni chip eUICC.

Eid

Informazioni sull'EID per ogni chip eUICC.

Rappresentazione JSON 
{
  "eid": string
}
Campi
eid

string

Solo output. L'EID