Method: enterprises.devices.issueCommand

Gibt einen Befehl an ein Gerät aus. Die zurückgegebene Ressource Operation enthält ein Command im Feld metadata. Verwenden Sie die Vorgangsmethode "get", 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 Übersicht über OAuth 2.0.

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 Typ des Befehls.
createTime

string (Timestamp format)

Der Zeitstempel, zu dem der Befehl erstellt wurde. Der Zeitstempel wird automatisch vom Server 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 während dieser Zeit nicht vom Gerät ausgeführt wird. Wenn keine Angabe gemacht wird, 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}. Sie wird basierend auf dem Gerät, an das der Befehl gesendet wird, automatisch vom Server generiert.
errorCode

enum (CommandErrorCode)

Wenn der Befehl fehlgeschlagen ist, wird ein Fehlercode angezeigt, der den Fehler erklärt. Dies ist nicht festgelegt, wenn der Befehl vom Aufrufer abgebrochen wird.
newPassword

string

Gibt für Befehle vom Typ RESET_PASSWORD das neue Passwort (optional) an. Hinweis: Bei Geräten mit Android 14 muss das neue Passwort mindestens 6 Zeichen lang sein, wenn es numerisch ist. Andernfalls schlägt der Befehl mit INVALID_VALUE fehl.
resetPasswordFlags[]

enum (ResetPasswordFlag)

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

Union-Feld params. Parameterspezifische Parameter für den Befehl. Beachten Sie, dass es bei einigen Befehlen nicht verwendet wird, insbesondere LOCK, RESET_PASSWORD, REBOOT und RELINQUISH_OWNERSHIP. In Zukunft können diese Befehle auch diese verwenden.

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

object (ClearAppsDataParams)

Parameter für den Befehl CLEAR_APP_DATA, mit dem die Daten bestimmter Apps vom Gerät gelöscht werden. ClearAppsDataParams ansehen. Wenn dieser Parameter festgelegt ist, sollte type nicht festgelegt werden. 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, mit dem das Gerät in den Verloren-Modus versetzt wird. StartLostModeParams ansehen. Wenn dieser Parameter festgelegt ist, sollte type nicht festgelegt werden. 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, mit dem das Gerät aus dem Verloren-Modus beendet wird. StopLostModeParams ansehen. Wenn dieser Parameter festgelegt ist, sollte type nicht festgelegt werden. In diesem Fall wird der Wert vom Server automatisch auf STOP_LOST_MODE gesetzt. Es ist auch akzeptabel, type explizit auf STOP_LOST_MODE festzulegen.
Union-Feld status. Spezifischer Status des Befehls. Beachten Sie, dass es bei einigen Befehlen nicht verwendet wird, insbesondere LOCK, RESET_PASSWORD, REBOOT und RELINQUISH_OWNERSHIP. In Zukunft können diese Befehle auch diese verwenden. 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 bestimmter Apps vom Gerät. ClearAppsDataStatus ansehen.
startLostModeStatus

object (StartLostModeStatus)

Nur Ausgabe. Status des Befehls START_LOST_MODE, mit dem das Gerät in den Verloren-Modus versetzt wird. StartLostModeStatus ansehen.
stopLostModeStatus

object (StopLostModeStatus)

Nur Ausgabe. Status des Befehls STOP_LOST_MODE, mit dem der Verloren-Modus für das Gerät beendet wird. StopLostModeStatus ansehen.

CommandType

Arten von Befehlen.

Enums
COMMAND_TYPE_UNSPECIFIED Dieser Wert ist nicht zulässig.
LOCK Sperren Sie das Gerät, als wäre das Zeitlimit 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 Auf einem unternehmenseigenen Gerät mit Android 8.0 oder höher werden das Arbeitsprofil und alle Richtlinien entfernt. Das Gerät wird dann nicht mehr privat genutzt. 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 Löscht die App-Daten der angegebenen Apps Diese Funktion wird auf Geräten mit Android 9 und höher unterstützt. Beachten Sie, dass eine Anwendung Daten außerhalb ihrer Anwendungsdaten speichern kann, z. B. in einem externen Speicher oder in einem Nutzerwörterbuch. Siehe auch clearAppsDataParams.
START_LOST_MODE Versetzt das Gerät in den Verloren-Modus Wird nur auf vollständig verwalteten Geräten oder auf organisationseigenen Geräten mit einem verwalteten Profil unterstützt. Siehe auch startLostModeParams.
STOP_LOST_MODE Dadurch wird der Verloren-Modus auf dem Gerät beendet. Wird nur auf vollständig verwalteten Geräten oder auf organisationseigenen Geräten mit einem verwalteten Profil unterstützt. Siehe auch stopLostModeParams.

CommandErrorCode

Ein 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 Der API-Level des Geräts unterstützt diesen Befehl nicht.
MANAGEMENT_MODE Der Verwaltungsmodus (Profilinhaber, Geräteinhaber usw.) unterstützt den Befehl nicht.
INVALID_VALUE Der Befehl enthält einen ungültigen Parameterwert.
UNSUPPORTED Das Gerät unterstützt den Befehl nicht. Das Problem lässt sich möglicherweise beheben, indem Sie die Android Device Policy auf die neueste Version aktualisieren.

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 dann wieder ändern, wenn der Nutzer es eingegeben hat.
DO_NOT_ASK_CREDENTIALS_ON_BOOT Beim Starten des Geräts nicht nach Nutzeranmeldedaten fragen.
LOCK_NOW Gerät nach dem Zurücksetzen des Passworts sperren

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. Es muss mindestens einer der Parameter ohne den Namen der Organisation 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 gewählt wird, wenn sich das Gerät im Verloren-Modus befindet und auf die Schaltfläche zum Anrufen des Eigentümers 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 bestimmter Apps vom Gerät.

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

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

Die Ergebnisse pro App – eine Zuordnung der Paketnamen zum jeweiligen Löschen-Ergebnis.

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 Unbekanntes Ergebnis.
SUCCESS Die Daten dieser App wurden gelöscht.
APP_NOT_FOUND Die Daten dieser App konnten nicht gelöscht werden, weil die App nicht gefunden wurde.
APP_PROTECTED Die Daten dieser App konnten nicht gelöscht werden, da die App geschützt ist. Das gilt beispielsweise für Apps, die für die Funktionsfähigkeit des Geräts entscheidend sind, z. B. den Google Play Store.
API_LEVEL Die Daten dieser App konnten nicht gelöscht werden, weil das API-Level des Geräts diesen Befehl nicht unterstützt.

StartLostModeStatus

Status des Befehls START_LOST_MODE, mit dem das Gerät in den Verloren-Modus versetzt wird.

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, weil 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, mit dem der Verloren-Modus für das Gerät beendet wird.

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 Das Gerät wurde aus dem Verloren-Modus entfernt.
NOT_IN_LOST_MODE Das Gerät befindet sich nicht im Verloren-Modus.