Method: enterprises.devices.issueCommand

Gibt einen Befehl an ein Gerät aus. Die zurückgegebene Ressource Operation enthält im Feld metadata ein Command. Verwenden Sie die Methode „get operation“, um den Status des Befehls abzurufen.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Der Name des Geräts im Format enterprises/{enterpriseId}/devices/{deviceId}.

Anfragetext

Der Anfragetext enthält eine Instanz von Command.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Operation.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der OAuth 2.0-Übersicht.

Befehl

Einen Befehl.

JSON-Darstellung 
{
  "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.
}
Felder
type

enum (CommandType)

Der Befehlstyp.
createTime

string (Timestamp format)

Der Zeitstempel, zu dem der Befehl erstellt wurde. Der Zeitstempel wird vom Server automatisch generiert.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
duration

string (Duration format)

Die Dauer, für die der Befehl gültig ist. Der Befehl läuft ab, wenn er in diesem Zeitraum nicht vom Gerät ausgeführt wird. Wenn nicht angegeben, beträgt die Standarddauer zehn Minuten. Es gibt keine maximale Dauer.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".
userName

string

Der Ressourcenname des Nutzers, dem das Gerät gehört, im Format enterprises/{enterpriseId}/users/{userId}. Dieser wird vom Server automatisch basierend auf dem Gerät generiert, an das der Befehl gesendet wird.
errorCode

enum (CommandErrorCode)

Wenn der Befehl fehlgeschlagen ist, ein Fehlercode, der den Fehler erklärt. Dieser Wert wird nicht festgelegt, wenn der Befehl vom Anrufer abgebrochen wird.
newPassword

string

Gibt für Befehle vom Typ RESET_PASSWORD optional das neue Passwort an. Hinweis: Das neue Passwort muss bei Android 14-Geräten mindestens sechs Zeichen lang sein, wenn es nur aus Ziffern besteht. Andernfalls schlägt der Befehl mit INVALID_VALUE fehl.
resetPasswordFlags[]

enum (ResetPasswordFlag)

Für Befehle vom Typ RESET_PASSWORD können optional Flags angegeben werden.

Union-Feld params. Befehlsspezifische Parameter. Einige Befehle verwenden dies nicht, insbesondere LOCK, RESET_PASSWORD, REBOOT und RELINQUISH_OWNERSHIP. In Zukunft wird diese Funktion möglicherweise auch für diese Befehle verwendet.

Wenn diese Option festgelegt ist, dürfen die Felder new_password und reset_password_flags nicht festgelegt sein. Für params ist nur einer der folgenden Werte zulässig:
clearAppsDataParams

object (ClearAppsDataParams)

Parameter für den Befehl CLEAR_APP_DATA zum Löschen der Daten bestimmter Apps vom Gerät. ClearAppsDataParams ansehen. Wenn diese Option festgelegt ist, wird empfohlen, type nicht festzulegen. In diesem Fall wird der Wert vom Server automatisch auf CLEAR_APP_DATA gesetzt. Es ist auch akzeptabel, type explizit auf CLEAR_APP_DATA festzulegen.
startLostModeParams

object (StartLostModeParams)

Parameter für den Befehl START_LOST_MODE, um das Gerät in den Verloren-Modus zu versetzen. StartLostModeParams ansehen. Wenn diese Option festgelegt ist, wird empfohlen, type nicht festzulegen. In diesem Fall wird der Wert vom Server automatisch auf START_LOST_MODE gesetzt. Es ist auch akzeptabel, type explizit auf START_LOST_MODE festzulegen.
stopLostModeParams

object (StopLostModeParams)

Parameter für den Befehl STOP_LOST_MODE, um das Gerät aus dem Verloren-Modus zu entfernen. StopLostModeParams ansehen. Wenn dieser Parameter festgelegt ist, sollte type nicht festgelegt werden. In diesem Fall wird sie vom Server automatisch auf STOP_LOST_MODE festgelegt. Es ist auch akzeptabel, type explizit auf STOP_LOST_MODE festzulegen.
Union-Feld status. Befehlsspezifischer Status. Einige Befehle verwenden dies nicht, insbesondere LOCK, RESET_PASSWORD, REBOOT und RELINQUISH_OWNERSHIP. In Zukunft wird diese Funktion möglicherweise auch für diese Befehle verwendet. Für status ist nur einer der folgenden Werte zulässig:
clearAppsDataStatus

object (ClearAppsDataStatus)

Nur Ausgabe. Status des Befehls CLEAR_APP_DATA zum Löschen der Daten der angegebenen Apps vom Gerät. ClearAppsDataStatus ansehen.
startLostModeStatus

object (StartLostModeStatus)

Nur Ausgabe. Status des Befehls START_LOST_MODE, um das Gerät in den Verloren-Modus zu versetzen. StartLostModeStatus ansehen.
stopLostModeStatus

object (StopLostModeStatus)

Nur Ausgabe. Status des Befehls STOP_LOST_MODE, um das Gerät aus dem Verloren-Modus zu entfernen. StopLostModeStatus ansehen.

CommandType

Befehlstypen

Enums
COMMAND_TYPE_UNSPECIFIED Dieser Wert ist nicht zulässig.
LOCK Das Gerät wird gesperrt, als wäre die Zeitüberschreitung für den Sperrbildschirm abgelaufen.
RESET_PASSWORD Setzen Sie das Passwort des Nutzers zurück.
REBOOT Starten Sie das Gerät neu. Diese Option wird nur auf vollständig verwalteten Geräten mit Android 7.0 (API-Level 24) oder höher unterstützt.
RELINQUISH_OWNERSHIP Das Arbeitsprofil und alle Richtlinien werden von einem unternehmenseigenen Gerät mit Android 8.0 oder höher entfernt, sodass das Gerät für den privaten Gebrauch freigegeben wird. Mit den privaten Profilen verknüpfte Apps und Daten bleiben erhalten. Das Gerät wird vom Server gelöscht, nachdem der Befehl bestätigt wurde.
CLEAR_APP_DATA Die App-Daten der angegebenen Apps werden gelöscht. Diese Funktion wird auf Android 9 und höher unterstützt. Eine Anwendung kann Daten außerhalb ihrer Anwendungsdaten speichern, z. B. im externen Speicher oder in einem Nutzerwörterbuch. Siehe auch clearAppsDataParams.
START_LOST_MODE Das Gerät wird in den Verloren-Modus versetzt. Nur auf vollständig verwalteten Geräten oder unternehmenseigenen Geräten mit einem verwalteten Profil unterstützt. Siehe auch startLostModeParams.
STOP_LOST_MODE Der Verloren-Modus wird auf dem Gerät beendet. Nur auf vollständig verwalteten Geräten oder unternehmenseigenen Geräten mit einem verwalteten Profil unterstützt. Siehe auch stopLostModeParams.

CommandErrorCode

Einen Befehlsfehlercode. Dieses Feld ist schreibgeschützt und wird vom Server ausgefüllt.

Enums
COMMAND_ERROR_CODE_UNSPECIFIED Es ist kein Fehler aufgetreten.
UNKNOWN Ein unbekannter Fehler ist aufgetreten.
API_LEVEL Dieser Befehl wird vom API-Level des Geräts nicht unterstützt.
MANAGEMENT_MODE Der Befehl wird vom Verwaltungsmodus (Profilinhaber, Geräteinhaber usw.) nicht unterstützt.
INVALID_VALUE Der Befehl enthält einen ungültigen Parameterwert.
UNSUPPORTED Der Befehl wird vom Gerät nicht unterstützt. Das Problem kann möglicherweise durch ein Update der Android-Geräterichtlinien auf die neueste Version behoben werden.

ResetPasswordFlag

Flags, die für den Befehlstyp RESET_PASSWORD verwendet werden können.

Enums
RESET_PASSWORD_FLAG_UNSPECIFIED Dieser Wert wird ignoriert.
REQUIRE_ENTRY Andere Administratoren dürfen das Passwort erst wieder ändern, wenn der Nutzer es eingegeben hat.
DO_NOT_ASK_CREDENTIALS_ON_BOOT Fordern Sie beim Starten des Geräts keine Nutzeranmeldedaten an.
LOCK_NOW Sperren Sie das Gerät nach dem Zurücksetzen des Passworts.

ClearAppsDataParams

Parameter, die mit dem Befehl CLEAR_APP_DATA verknüpft sind, mit dem die Daten bestimmter Apps vom Gerät gelöscht werden.

JSON-Darstellung 
{
  "packageNames": [
    string
  ]
}
Felder
packageNames[]

string

Die Paketnamen der Apps, deren Daten bei Ausführung des Befehls gelöscht werden.

StartLostModeParams

Parameter, die mit dem Befehl START_LOST_MODE verknüpft sind, mit dem das Gerät in den Verloren-Modus versetzt wird. Mindestens einer der Parameter, ausgenommen der Name der Organisation, muss angegeben werden, damit das Gerät in den Verloren-Modus versetzt werden kann.

JSON-Darstellung 
{
  "lostMessage": {
    object (UserFacingMessage)
  },
  "lostPhoneNumber": {
    object (UserFacingMessage)
  },
  "lostEmailAddress": string,
  "lostStreetAddress": {
    object (UserFacingMessage)
  },
  "lostOrganization": {
    object (UserFacingMessage)
  }
}
Felder
lostMessage

object (UserFacingMessage)

Die Nachricht, die dem Nutzer angezeigt wird, wenn sich das Gerät im Verloren-Modus befindet.
lostPhoneNumber

object (UserFacingMessage)

Die Telefonnummer, die angerufen wird, wenn sich das Gerät im Verloren-Modus befindet und auf die Schaltfläche „Inhaber anrufen“ getippt wird.
lostEmailAddress

string

Die E-Mail-Adresse, die dem Nutzer angezeigt wird, wenn sich das Gerät im Verloren-Modus befindet.
lostStreetAddress

object (UserFacingMessage)

Die Adresse, die dem Nutzer angezeigt wird, wenn sich das Gerät im Verloren-Modus befindet.
lostOrganization

object (UserFacingMessage)

Der Name der Organisation, der dem Nutzer angezeigt wird, wenn sich das Gerät im Verloren-Modus befindet.

StopLostModeParams

Dieser Typ hat keine Felder.

Parameter, die mit dem Befehl STOP_LOST_MODE verknüpft sind, um das Gerät aus dem Verloren-Modus zu beenden.

ClearAppsDataStatus

Status des Befehls CLEAR_APP_DATA zum Löschen der Daten der angegebenen Apps vom Gerät.

JSON-Darstellung 
{
  "results": {
    string: {
      object (PerAppResult)
    },
    ...
  }
}
Felder
results

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

Die Ergebnisse pro App, eine Zuordnung von Paketnamen zum jeweiligen Ergebnis der Überprüfung.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

PerAppResult

Das Ergebnis eines Versuchs, die Daten einer einzelnen App zu löschen.

JSON-Darstellung 
{
  "clearingResult": enum (ClearingResult)
}
Felder
clearingResult

enum (ClearingResult)

Das Ergebnis eines Versuchs, die Daten einer einzelnen App zu löschen.

ClearingResult

Das Ergebnis eines Versuchs, die Daten einer einzelnen App zu löschen.

Enums
CLEARING_RESULT_UNSPECIFIED Nicht angegebenes Ergebnis.
SUCCESS Die Daten dieser App wurden gelöscht.
APP_NOT_FOUND Die Daten dieser App konnten nicht gelöscht werden, da die App nicht gefunden wurde.
APP_PROTECTED Die Daten dieser App konnten nicht gelöscht werden, da die App geschützt ist. Dies kann beispielsweise für Apps gelten, die für die Funktion des Geräts entscheidend sind, z. B. der Google Play Store.
API_LEVEL Die Daten dieser App konnten nicht gelöscht werden, da das API-Level des Geräts diesen Befehl nicht unterstützt.

StartLostModeStatus

Status des Befehls START_LOST_MODE, um das Gerät in den Verloren-Modus zu versetzen.

JSON-Darstellung 
{
  "status": enum (Status)
}
Felder
status

enum (Status)

Der Status. StartLostModeStatus ansehen.

Status

Der Status. StartLostModeStatus ansehen.

Enums
STATUS_UNSPECIFIED Nicht angegeben Dieser Wert wird nicht verwendet.
SUCCESS Das Gerät wurde in den Verloren-Modus versetzt.
RESET_PASSWORD_RECENTLY Das Gerät konnte nicht in den Verloren-Modus versetzt werden, da der Administrator das Passwort des Geräts vor Kurzem zurückgesetzt hat.
USER_EXIT_LOST_MODE_RECENTLY Das Gerät konnte nicht in den Verloren-Modus versetzt werden, da der Nutzer den Verloren-Modus vor Kurzem beendet hat.
ALREADY_IN_LOST_MODE Das Gerät befindet sich bereits im Verloren-Modus.

StopLostModeStatus

Status des Befehls STOP_LOST_MODE, um das Gerät aus dem Verloren-Modus zu entfernen.

JSON-Darstellung 
{
  "status": enum (Status)
}
Felder
status

enum (Status)

Der Status. StopLostModeStatus ansehen.

Status

Der Status. StopLostModeStatus ansehen.

Enums
STATUS_UNSPECIFIED Nicht angegeben Dieser Wert wird nicht verwendet.
SUCCESS Der Verloren-Modus wurde auf dem Gerät aufgehoben.
NOT_IN_LOST_MODE Das Gerät befindet sich nicht im Verloren-Modus.