- Richiesta HTTP
- Parametri del percorso
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- Comando
- CommandType
- CommandErrorCode
- ResetPasswordFlag
- ClearAppsDataParams
- StartLostModeParams
- StopLostModeParams
- AddEsimParams
- ActivationState
- RemoveEsimParams
- RequestDeviceInfoParams
- DeviceInfo
- WipeParams
- ClearAppsDataStatus
- PerAppResult
- ClearingResult
- StartLostModeStatus
- Stato
- StopLostModeStatus
- Stato
- EsimCommandStatus
- Stato
- InternalErrorDetails
- OperationCodeDetail
- ErrorCodeDetail
- EsimInfo
- RequestDeviceInfoStatus
- Stato
- EidInfo
- Eid
- Prova!
Invia un comando a un dispositivo. La risorsa Operation
restituita contiene un Command
nel campo metadata
. Utilizza il metodo get operation 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 |
Il nome del dispositivo nel formato |
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 OAuth 2.0 Overview.
Comando
Un comando.
Rappresentazione JSON |
---|
{ "type": enum ( |
Campi | |
---|---|
type |
Il tipo di comando. |
createTime |
Timestamp di creazione del comando. Il timestamp viene generato automaticamente dal server. Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
duration |
La durata di validità del comando. Il comando scadrà se non viene eseguito dal dispositivo durante questo periodo. La durata predefinita, se non specificata, è di 10 minuti. Non esiste una durata massima. Una durata in secondi con un massimo di nove cifre frazionarie, che termina con " |
userName |
Il nome della risorsa dell'utente proprietario del dispositivo nel formato |
errorCode |
Se il comando non è riuscito, un codice di errore che spiega il motivo. Questo valore non viene impostato quando il comando viene annullato dal chiamante. Per il ragionamento sugli errori dei comandi, preferisci i campi nel seguente ordine (il più preferito per primo): 1. Campi specifici del comando come |
newPassword |
Per i comandi di tipo |
resetPasswordFlags[] |
Per i comandi di tipo |
Campo unione Se questo campo è impostato, i campi |
|
clearAppsDataParams |
Parametri per il comando |
startLostModeParams |
Parametri per il comando |
stopLostModeParams |
Parametri per il comando |
addEsimParams |
(Facoltativo) Parametri per il comando |
removeEsimParams |
(Facoltativo) Parametri per il comando |
requestDeviceInfoParams |
(Facoltativo) Parametri per il comando |
wipeParams |
(Facoltativo) Parametri per il comando |
Campo unione status . Stato specifico del comando. Tieni presente che alcuni comandi non lo utilizzano, in particolare , , e . In futuro, anche questi comandi potrebbero utilizzare questa funzionalità. status può essere solo uno dei seguenti: |
|
clearAppsDataStatus |
Solo output. Stato del comando |
startLostModeStatus |
Solo output. Stato del comando |
stopLostModeStatus |
Solo output. Stato del comando |
esimStatus |
Solo output. Stato di un comando |
requestDeviceInfoStatus |
Solo output. Stato del comando |
CommandType
Tipi di comandi.
Enum | |
---|---|
COMMAND_TYPE_UNSPECIFIED |
Questo valore non è consentito. |
LOCK |
Blocca il dispositivo come se il timeout del blocco schermo 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+ di proprietà aziendale, rinunciando al dispositivo per uso personale. Le app e i dati associati ai profili personali vengono conservati. Il dispositivo verrà eliminato dal server dopo aver ricevuto la conferma del comando. |
CLEAR_APP_DATA |
Cancella i dati delle applicazioni specificate. Questa funzionalità è supportata su Android 9 e versioni successive. Tieni presente che un'applicazione può archiviare dati al di fuori dei propri dati, ad esempio in un archivio esterno o in un dizionario utente. Vedi anche . |
START_LOST_MODE |
Attiva la modalità Dispositivo smarrito. Supportato solo su dispositivi completamente gestiti o di proprietà dell'organizzazione con un profilo gestito. Vedi anche . |
STOP_LOST_MODE |
Disattiva la modalità smarrito sul dispositivo. Supportato solo su dispositivi completamente gestiti o di proprietà dell'organizzazione con un profilo gestito. Vedi anche . |
ADD_ESIM |
Aggiunge un profilo eSIM al dispositivo. Questa funzionalità è supportata su Android 15 e versioni successive. Vedi anche . Per rimuovere un profilo eSIM, utilizza il comando . Per determinare cosa succede al profilo eSIM quando un dispositivo viene cancellato, imposta nel criterio. Nota: per eseguire il provisioning di più eSIM su un singolo dispositivo, è consigliabile introdurre un ritardo di alcuni minuti tra le esecuzioni successive del comando. |
REMOVE_ESIM |
Rimuove un profilo eSIM dal dispositivo. Questa funzionalità è supportata su Android 15 e versioni successive. Vedi anche . |
REQUEST_DEVICE_INFO |
Richiedi informazioni relative al dispositivo. |
WIPE |
Cancella i dati del dispositivo tramite un ripristino dei dati di fabbrica per un dispositivo di proprietà dell'azienda o eliminando il profilo di lavoro per un dispositivo di proprietà personale con profilo di lavoro. La cancellazione viene eseguita solo dopo che il dispositivo ha riconosciuto il comando. Il comando può essere annullato prima di questa data. |
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 all'ultima versione 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 nuovamente 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
per cancellare i dati delle app specificate dal dispositivo.CLEAR_APP_DATA
Rappresentazione JSON |
---|
{ "packageNames": [ string ] } |
Campi | |
---|---|
packageNames[] |
I nomi dei pacchetti delle app i cui dati verranno cancellati quando viene eseguito il comando. |
StartLostModeParams
Parametri associati al comando
per attivare la modalità Dispositivo smarrito. Per attivare la modalità smarrimento sul dispositivo, è necessario fornire almeno uno dei parametri, escluso il nome dell'organizzazione.START_LOST_MODE
Rappresentazione JSON |
---|
{ "lostMessage": { object ( |
Campi | |
---|---|
lostMessage |
Il messaggio visualizzato dall'utente quando il dispositivo è in modalità Dispositivo smarrito. |
lostPhoneNumber |
Il numero di telefono che verrà chiamato quando il dispositivo è in modalità Dispositivo smarrito e viene toccato il pulsante Chiama proprietario. |
lostEmailAddress |
L'indirizzo email visualizzato dall'utente quando il dispositivo è in modalità smarrito. |
lostStreetAddress |
L'indirizzo visualizzato dall'utente quando il dispositivo è in modalità Dispositivo smarrito. |
lostOrganization |
Il nome dell'organizzazione visualizzato dall'utente quando il dispositivo è in modalità Dispositivo smarrito. |
StopLostModeParams
Questo tipo non contiene campi.
Parametri associati al comando
per disattivare la modalità smarrimento sul dispositivo.STOP_LOST_MODE
AddEsimParams
Parametri associati al comando
per aggiungere un profilo eSIM al dispositivo.ADD_ESIM
Rappresentazione JSON |
---|
{
"activationCode": string,
"activationState": enum ( |
Campi | |
---|---|
activationCode |
Obbligatorio. Il codice di attivazione per il profilo eSIM. |
activationState |
Obbligatorio. Lo stato di attivazione del profilo eSIM una volta scaricato. |
ActivationState
Lo stato di attivazione del profilo eSIM una volta scaricato.
Enum | |
---|---|
ACTIVATION_STATE_UNSPECIFIED |
Lo stato di attivazione dell'eSIM non è specificato. Per impostazione predefinita, il profilo eSIM è sui dispositivi personali e sui dispositivi di proprietà aziendale. |
ACTIVATED |
L'eSIM viene attivata automaticamente dopo il download. Se imposti questo stato di attivazione per i dispositivi di proprietà personale, il comando verrà rifiutato. |
NOT_ACTIVATED |
Il profilo eSIM è stato scaricato, ma non attivato. In questo caso, l'utente dovrà attivare manualmente l'eSIM sul dispositivo. |
RemoveEsimParams
Parametri associati al comando
per rimuovere un profilo eSIM dal dispositivo.REMOVE_ESIM
Rappresentazione JSON |
---|
{ "iccId": string } |
Campi | |
---|---|
iccId |
Obbligatorio. ICC ID del profilo eSIM da eliminare. |
RequestDeviceInfoParams
Parametri associati al comando
per ottenere informazioni relative al dispositivo.REQUEST_DEVICE_INFO
Rappresentazione JSON |
---|
{
"deviceInfo": enum ( |
Campi | |
---|---|
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. All'utente verrà chiesto di approvare la divulgazione delle informazioni prima che il risultato possa essere restituito. Se l'utente non approva la divulgazione, verrà restituito. Questa funzionalità è supportata solo per i dispositivi di proprietà personale con profili di lavoro e Android 13 e versioni successive. |
WipeParams
Parametri associati al comando
per cancellare i dati del dispositivo.WIPE
Rappresentazione JSON |
---|
{ "wipeDataFlags": [ enum ( |
Campi | |
---|---|
wipeDataFlags[] |
(Facoltativo) Flag per determinare quali dati cancellare. |
wipeReason |
(Facoltativo) Un breve messaggio visualizzato dall'utente prima della cancellazione del profilo di lavoro sui dispositivi personali. Ciò non influisce sui dispositivi di proprietà aziendale. La lunghezza massima del messaggio è di 200 caratteri. |
ClearAppsDataStatus
Stato del comando
per cancellare i dati delle app specificate dal dispositivo.CLEAR_APP_DATA
Rappresentazione JSON |
---|
{
"results": {
string: {
object ( |
Campi | |
---|---|
results |
I risultati per app, una mappatura dai nomi dei pacchetti al rispettivo risultato di cancellazione. Un oggetto contenente un elenco di coppie |
PerAppResult
Il risultato di un tentativo di cancellare i dati di una singola app.
Rappresentazione JSON |
---|
{
"clearingResult": enum ( |
Campi | |
---|---|
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 |
Impossibile cancellare i dati di questa app perché non è stata trovata. |
APP_PROTECTED |
I dati di questa app non possono essere cancellati perché l'app è protetta. Ad esempio, questo potrebbe valere per le app essenziali 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
per attivare la modalità smarrito sul dispositivo.START_LOST_MODE
Rappresentazione JSON |
---|
{
"status": enum ( |
Campi | |
---|---|
status |
Lo stato. Leggi i |
Stato
Lo stato. Leggi i
.StartLostModeStatus
Enum | |
---|---|
STATUS_UNSPECIFIED |
Non specificato. Questo valore non viene utilizzato. |
SUCCESS |
Il dispositivo è stato messo in modalità Smarrito. |
RESET_PASSWORD_RECENTLY |
Non è stato possibile impostare la modalità smarrimento per il dispositivo perché l'amministratore ha reimpostato di recente la password del dispositivo. |
USER_EXIT_LOST_MODE_RECENTLY |
Non è stato possibile attivare la modalità smarrimento sul dispositivo perché l'utente l'ha disattivata di recente. |
ALREADY_IN_LOST_MODE |
Il dispositivo è già in modalità smarrito. |
StopLostModeStatus
Stato del comando
per disattivare la modalità Dispositivo smarrito.STOP_LOST_MODE
Rappresentazione JSON |
---|
{
"status": enum ( |
Campi | |
---|---|
status |
Lo stato. Leggi i |
Stato
Lo stato. Leggi i
.StopLostModeStatus
Enum | |
---|---|
STATUS_UNSPECIFIED |
Non specificato. Questo valore non viene utilizzato. |
SUCCESS |
Il dispositivo è stato disattivato dalla modalità smarrito. |
NOT_IN_LOST_MODE |
Il dispositivo non è in modalità smarrito. |
EsimCommandStatus
Stato e dettagli dell'errore (se presenti) di un comando
o ADD_ESIM
.REMOVE_ESIM
Rappresentazione JSON |
---|
{ "status": enum ( |
Campi | |
---|---|
status |
Solo output. Stato di un comando |
esimInfo |
Solo output. Informazioni sulla eSIM aggiunta o rimossa. Questo campo viene compilato solo quando l'operazione eSIM |
Campo unione status_details . Dettagli sullo stato di un comando o . status_details può essere solo uno dei seguenti: |
|
internalErrorDetails |
Solo output. Dettagli dell'errore se |
Stato
Stato di un comando
o ADD_ESIM
.REMOVE_ESIM
Enum | |
---|---|
STATUS_UNSPECIFIED |
Non specificato. Questo valore non viene utilizzato. |
SUCCESS |
L'operazione eSIM è stata eseguita correttamente sul dispositivo. |
IN_PROGRESS |
L'operazione eSIM è in corso. |
PENDING_USER_ACTION |
L'utente deve intraprendere un'azione per procedere con l'operazione eSIM. |
ERROR_SETUP_IN_PROGRESS |
L'operazione eSIM non può essere eseguita durante la configurazione. |
ERROR_USER_DENIED |
L'utente ha negato l'operazione eSIM. |
INTERNAL_ERROR |
Si è verificato un errore durante il tentativo di aggiungere o rimuovere l'eSIM sul dispositivo. Vedi . |
ERROR_ICC_ID_NOT_FOUND |
Per un comando , il della eSIM da rimuovere non è stato trovato sul dispositivo. Questo potrebbe significare che l'eSIM non appartiene all'azienda o che l'eSIM corrispondente a non è presente sul dispositivo. |
ERROR_MULTIPLE_ACTIVE_ESIMS_NO_AVAILABLE_SLOT |
Il comando non è riuscito durante il tentativo di aggiungere una nuova eSIM con lo stato di attivazione impostato su perché più slot eSIM sul dispositivo contengono profili eSIM attivi e non è disponibile alcuno slot eSIM libero. Per risolvere il problema, la nuova eSIM può essere aggiunta con lo stato di attivazione per l'attivazione manuale successiva oppure l'utente deve prima disattivare un'eSIM attiva esistente per procedere con l'operazione. |
InternalErrorDetails
Dettagli dell'errore interno, se presenti, per il comando
o ADD_ESIM
.REMOVE_ESIM
Rappresentazione JSON |
---|
{ "operationCode": string, "errorCode": string, "operationCodeDetail": enum ( |
Campi | |
---|---|
operationCode |
Solo output. Rappresentazione intera del codice operazione come specificato qui. Per maggiori dettagli, consulta |
errorCode |
Solo output. Rappresentazione intera del codice di errore specificato qui. Vedi anche |
operationCodeDetail |
Solo output. Il dettaglio del codice operazione corrispondente a |
errorCodeDetail |
Solo output. I dettagli del codice di errore corrispondenti a |
OperationCodeDetail
Il dettaglio del codice operazione corrispondente a
.operationCode
Enum | |
---|---|
OPERATION_CODE_DETAIL_UNSPECIFIED |
Il dettaglio del codice di operazione non è specificato. L' non è riconosciuto dall'API Android Management. Tuttavia, consulta . |
OPERATION_SYSTEM |
Per maggiori dettagli, vedi EuiccManager.OPERATION_SYSTEM. |
OPERATION_SIM_SLOT |
Per maggiori dettagli, vedi EuiccManager.OPERATION_SIM_SLOT. |
OPERATION_EUICC_CARD |
Per maggiori dettagli, vedi EuiccManager.OPERATION_EUICC_CARD. |
OPERATION_SMDX |
Per informazioni dettagliate, consulta EuiccManager.OPERATION_SMDX. |
OPERATION_SWITCH |
Per maggiori dettagli, consulta EuiccManager.OPERATION_SWITCH. |
OPERATION_DOWNLOAD |
Per informazioni dettagliate, vedi EuiccManager.OPERATION_DOWNLOAD. |
OPERATION_METADATA |
Per maggiori dettagli, consulta EuiccManager.OPERATION_METADATA. |
OPERATION_EUICC_GSMA |
Per maggiori dettagli, vedi EuiccManager.OPERATION_EUICC_GSMA. |
OPERATION_APDU |
Per maggiori dettagli, consulta EuiccManager.OPERATION_APDU. |
OPERATION_SMDX_SUBJECT_REASON_CODE |
Per maggiori dettagli, consulta EuiccManager.OPERATION_SMDX_SUBJECT_REASON_CODE. Tieni presente che, in questo caso, sono i 3 byte meno significativi di EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE che specificano il codice del soggetto e il codice del motivo, come indicato qui. Il byte più significativo dell'intero è azzerato. Ad esempio, un codice soggetto 8.11.1 e un codice motivo 5.1 sono rappresentati in come 0000 0000 1000 1011 0001 0000 0101 0001 in formato binario, ovvero 9113681 in formato decimale. |
OPERATION_HTTP |
Per maggiori dettagli, consulta EuiccManager.OPERATION_HTTP. |
ErrorCodeDetail
Dettagli del codice di errore corrispondenti a
.errorCode
Enum | |
---|---|
ERROR_CODE_DETAIL_UNSPECIFIED |
I dettagli del codice di errore non sono specificati. L' non è riconosciuto dall'API Android Management. Tuttavia, consulta
|
ERROR_TIME_OUT |
Per informazioni dettagliate, consulta EuiccManager.ERROR_TIME_OUT. |
ERROR_EUICC_MISSING |
Per maggiori dettagli, vedi EuiccManager.ERROR_EUICC_MISSING. |
ERROR_UNSUPPORTED_VERSION |
Per maggiori dettagli, vedi EuiccManager.ERROR_UNSUPPORTED_VERSION. |
ERROR_ADDRESS_MISSING |
Per informazioni dettagliate, consulta EuiccManager.ERROR_ADDRESS_MISSING. |
ERROR_INVALID_CONFIRMATION_CODE |
Per maggiori dettagli, vedi EuiccManager.ERROR_INVALID_CONFIRMATION_CODE. |
ERROR_CERTIFICATE_ERROR |
Per informazioni dettagliate, vedi EuiccManager.ERROR_CERTIFICATE_ERROR. |
ERROR_NO_PROFILES_AVAILABLE |
Per informazioni dettagliate, consulta EuiccManager.ERROR_NO_PROFILES_AVAILABLE. |
ERROR_CONNECTION_ERROR |
Per informazioni dettagliate, vedi EuiccManager.ERROR_CONNECTION_ERROR. |
ERROR_INVALID_RESPONSE |
Per maggiori dettagli, consulta EuiccManager.ERROR_INVALID_RESPONSE. |
ERROR_CARRIER_LOCKED |
Per informazioni dettagliate, vedi EuiccManager.ERROR_CARRIER_LOCKED. |
ERROR_DISALLOWED_BY_PPR |
Per maggiori dettagli, consulta EuiccManager.ERROR_DISALLOWED_BY_PPR. |
ERROR_INVALID_ACTIVATION_CODE |
Per maggiori dettagli, consulta EuiccManager.ERROR_INVALID_ACTIVATION_CODE. |
ERROR_INCOMPATIBLE_CARRIER |
Per informazioni dettagliate, vedi EuiccManager.ERROR_INCOMPATIBLE_CARRIER. |
ERROR_OPERATION_BUSY |
Per maggiori dettagli, vedi EuiccManager.ERROR_OPERATION_BUSY. |
ERROR_INSTALL_PROFILE |
Per maggiori dettagli, consulta EuiccManager.ERROR_INSTALL_PROFILE. |
ERROR_EUICC_INSUFFICIENT_MEMORY |
Per informazioni dettagliate, consulta EuiccManager.ERROR_EUICC_INSUFFICIENT_MEMORY. |
ERROR_INVALID_PORT |
Per maggiori dettagli, vedi EuiccManager.ERROR_INVALID_PORT. |
ERROR_SIM_MISSING |
Per maggiori dettagli, vedi EuiccManager.ERROR_SIM_MISSING. |
EsimInfo
Dettagli della eSIM aggiunta o rimossa.
Rappresentazione JSON |
---|
{ "iccId": string } |
Campi | |
---|---|
iccId |
Solo output. ICC ID dell'eSIM. |
RequestDeviceInfoStatus
Stato del comando
.REQUEST_DEVICE_INFO
Rappresentazione JSON |
---|
{ "status": enum ( |
Campi | |
---|---|
status |
Solo output. Stato di un comando |
Campo unione device_info . Dettagli delle informazioni sul dispositivo richieste dall'amministratore. Questo campo viene compilato solo quando è . device_info può essere solo uno dei seguenti: |
|
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 richieste per condividere le informazioni sul dispositivo. |
USER_DECLINED |
L'utente ha rifiutato di condividere le informazioni sul dispositivo. |
UNSUPPORTED |
Le informazioni sul dispositivo richieste non sono supportate su questo dispositivo, ad esempio la eSIM non è supportata. |
EidInfo
Informazioni relative agli EID del dispositivo.
Rappresentazione JSON |
---|
{
"eids": [
{
object ( |
Campi | |
---|---|
eids[] |
Solo output. Informazioni sull'EID per ogni chip eUICC. |
Eid
Informazioni sull'EID per ogni chip eUICC.
Rappresentazione JSON |
---|
{ "eid": string } |
Campi | |
---|---|
eid |
Solo output. L'EID |