Method: enterprises.devices.issueCommand

Émet une commande à un appareil. La ressource Operation renvoyée contient un Command dans son champ metadata. Utilisez la méthode d'opération get pour obtenir l'état de la commande.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Nom de l'appareil au format enterprises/{enterpriseId}/devices/{deviceId}.

Corps de la requête

Le corps de la requête contient une instance de Command.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Operation.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

Commande

Une commande

Représentation 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)
  }
  // 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.
}
Champs
type

enum (CommandType)

Type de la commande.
createTime

string (Timestamp format)

Horodatage de la création de la commande. Le code temporel est généré automatiquement par le serveur.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
duration

string (Duration format)

Durée pendant laquelle la commande est valide. La commande expirera si elle n'est pas exécutée par l'appareil pendant ce laps de temps. Si aucune valeur n'est spécifiée, la durée par défaut est de 10 minutes. Il n'y a pas de durée maximale.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
userName

string

Nom de ressource de l'utilisateur propriétaire de l'appareil, au format enterprises/{enterpriseId}/users/{userId}. Il est généré automatiquement par le serveur en fonction de l'appareil auquel la commande est envoyée.
errorCode

enum (CommandErrorCode)

Si la commande a échoué, un code d'erreur expliquant l'échec. Cette valeur n'est pas définie lorsque la commande est annulée par l'appelant.
newPassword

string

Pour les commandes de type RESET_PASSWORD, spécifie éventuellement le nouveau mot de passe. Remarque: Le nouveau mot de passe doit comporter au moins six caractères s'il s'agit d'une valeur numérique pour les appareils Android 14. Sinon, la commande échouera avec INVALID_VALUE.
resetPasswordFlags[]

enum (ResetPasswordFlag)

Pour les commandes de type RESET_PASSWORD, spécifie éventuellement des indicateurs.

Champ d'union params. Paramètres spécifiques à la commande. Notez que certaines commandes ne l'utilisent pas, en particulier LOCK, RESET_PASSWORD, REBOOT et RELINQUISH_OWNERSHIP. À l'avenir, ces commandes pourront également l'utiliser.

Si cette option est définie, les champs new_password et reset_password_flags ne doivent pas l'être. La params ne peut être qu'un des éléments suivants :
clearAppsDataParams

object (ClearAppsDataParams)

Paramètres de la commande CLEAR_APP_DATA permettant d'effacer de l'appareil les données des applications spécifiées. Consultez les ClearAppsDataParams. Si c'est le cas, nous suggérons de ne pas définir type. Dans ce cas, le serveur le définit automatiquement sur CLEAR_APP_DATA. Vous pouvez également définir explicitement type sur CLEAR_APP_DATA.
startLostModeParams

object (StartLostModeParams)

Paramètres de la commande START_LOST_MODE permettant de faire passer l'appareil en mode Perdu. Consultez les StartLostModeParams. Si c'est le cas, nous suggérons de ne pas définir type. Dans ce cas, le serveur le définit automatiquement sur START_LOST_MODE. Vous pouvez également définir explicitement type sur START_LOST_MODE.
stopLostModeParams

object (StopLostModeParams)

Paramètres de la commande STOP_LOST_MODE permettant de sortir l'appareil du mode Perdu. Consultez les StopLostModeParams. Si c'est le cas, nous suggérons de ne pas définir type. Dans ce cas, le serveur le définit automatiquement sur STOP_LOST_MODE. Vous pouvez également définir explicitement type sur STOP_LOST_MODE.
Champ d'union status. État spécifique à la commande. Notez que certaines commandes ne l'utilisent pas, en particulier LOCK, RESET_PASSWORD, REBOOT et RELINQUISH_OWNERSHIP. À l'avenir, ces commandes pourront également l'utiliser. status ne peut être que l'un des éléments suivants:
clearAppsDataStatus

object (ClearAppsDataStatus)

Uniquement en sortie. État de la commande CLEAR_APP_DATA permettant d'effacer de l'appareil les données des applications spécifiées. Consultez les ClearAppsDataStatus.
startLostModeStatus

object (StartLostModeStatus)

Uniquement en sortie. État de la commande START_LOST_MODE permettant de mettre l'appareil en mode Perdu. Consultez les StartLostModeStatus.
stopLostModeStatus

object (StopLostModeStatus)

Uniquement en sortie. État de la commande STOP_LOST_MODE permettant de sortir l'appareil du mode Perdu. Consultez les StopLostModeStatus.

CommandType

Types de commandes.

Enums
COMMAND_TYPE_UNSPECIFIED Cette valeur n'est pas autorisée.
LOCK Verrouillez l'appareil comme si le délai de verrouillage de l'écran avait expiré.
RESET_PASSWORD Réinitialisez le mot de passe de l'utilisateur.
REBOOT Redémarrez l'appareil. Disponible uniquement sur les appareils entièrement gérés équipés d'Android 7.0 (niveau d'API 24) ou version ultérieure.
RELINQUISH_OWNERSHIP Supprime le profil professionnel et toutes les règles d'un appareil Android 8.0 (ou version ultérieure) détenu par l'entreprise, ce qui permet à l'appareil d'être utilisé à des fins personnelles. Les applications et les données associées aux profils personnels sont conservées. L'appareil sera supprimé du serveur après avoir pris connaissance de la commande.
CLEAR_APP_DATA Efface les données des applications spécifiées. Cette fonctionnalité est compatible avec Android 9 ou version ultérieure. Notez qu'une application peut stocker des données en dehors de ses données d'application, par exemple dans un espace de stockage externe ou dans un dictionnaire utilisateur. Voir aussi clearAppsDataParams.
START_LOST_MODE Passe l'appareil en mode Perdu. Compatible uniquement avec les appareils entièrement gérés ou les appareils détenus par l'organisation disposant d'un profil géré. Voir aussi startLostModeParams.
STOP_LOST_MODE Désactive le mode Perdu sur l'appareil. Compatible uniquement avec les appareils entièrement gérés ou les appareils détenus par l'organisation disposant d'un profil géré. Voir aussi stopLostModeParams.

CommandErrorCode

Code d'erreur de la commande. Ce champ en lecture seule est renseigné par le serveur.

Enums
COMMAND_ERROR_CODE_UNSPECIFIED Aucune erreur ne s'est produite.
UNKNOWN Une erreur inconnue s'est produite.
API_LEVEL Le niveau d'API de l'appareil n'est pas compatible avec cette commande.
MANAGEMENT_MODE Le mode de gestion (propriétaire du profil, propriétaire de l'appareil, etc.) n'est pas compatible avec la commande.
INVALID_VALUE La commande comporte une valeur de paramètre non valide.
UNSUPPORTED L'appareil n'est pas compatible avec la commande. Vous pouvez résoudre le problème en installant la dernière version d'Android Device Policy.

ResetPasswordFlag

Indicateurs disponibles pour le type de commande RESET_PASSWORD.

Enums
RESET_PASSWORD_FLAG_UNSPECIFIED Cette valeur est ignorée.
REQUIRE_ENTRY N'autorisez pas les autres administrateurs à modifier à nouveau le mot de passe tant que l'utilisateur ne l'a pas saisi.
DO_NOT_ASK_CREDENTIALS_ON_BOOT Ne demandez pas d'identifiants utilisateur au démarrage de l'appareil.
LOCK_NOW Verrouillez l'appareil après la réinitialisation du mot de passe.

ClearAppsDataParams

Paramètres associés à la commande CLEAR_APP_DATA pour effacer de l'appareil les données des applications spécifiées.

Représentation JSON 
{
  "packageNames": [
    string
  ]
}
Champs
packageNames[]

string

Noms des packages des applications dont les données seront effacées lors de l'exécution de la commande.

StartLostModeParams

Paramètres associés à la commande START_LOST_MODE pour mettre l'appareil en mode Perdu. Au moins l'un des paramètres doit être fourni, à l'exception du nom de l'organisation, pour que l'appareil passe en mode Perdu.

Représentation JSON 
{
  "lostMessage": {
    object (UserFacingMessage)
  },
  "lostPhoneNumber": {
    object (UserFacingMessage)
  },
  "lostEmailAddress": string,
  "lostStreetAddress": {
    object (UserFacingMessage)
  },
  "lostOrganization": {
    object (UserFacingMessage)
  }
}
Champs
lostMessage

object (UserFacingMessage)

Message affiché lorsque l'appareil est en mode Perdu.
lostPhoneNumber

object (UserFacingMessage)

Numéro de téléphone appelé lorsque l'appareil est en mode Perdu et que l'utilisateur appuie sur le bouton du propriétaire de l'appel.
lostEmailAddress

string

Adresse e-mail présentée à l'utilisateur lorsque l'appareil est en mode Perdu.
lostStreetAddress

object (UserFacingMessage)

Adresse postale affichée à l'utilisateur lorsque l'appareil est en mode Perdu.
lostOrganization

object (UserFacingMessage)

Nom de l'organisation qui s'affiche pour l'utilisateur lorsque l'appareil est en mode Perdu.

StopLostModeParams

Ce type ne comporte aucun champ.

Paramètres associés à la commande STOP_LOST_MODE pour sortir l'appareil du mode Perdu.

ClearAppsDataStatus

État de la commande CLEAR_APP_DATA permettant d'effacer de l'appareil les données des applications spécifiées.

Représentation JSON 
{
  "results": {
    string: {
      object (PerAppResult)
    },
    ...
  }
}
Champs
results

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

Résultats par application, mappage des noms des packages au résultat d'effacement correspondant.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

PerAppResult

Résultat d'une tentative d'effacement des données d'une seule application.

Représentation JSON 
{
  "clearingResult": enum (ClearingResult)
}
Champs
clearingResult

enum (ClearingResult)

Résultat d'une tentative d'effacement des données d'une seule application.

ClearingResult

Résultat d'une tentative d'effacement des données d'une seule application.

Enums
CLEARING_RESULT_UNSPECIFIED Résultat non spécifié.
SUCCESS Les données de cette application ont bien été effacées.
APP_NOT_FOUND Impossible d'effacer les données de cette application, car elle est introuvable.
APP_PROTECTED Impossible d'effacer les données de cette application, car celle-ci est protégée. Par exemple, cela peut s'appliquer à des applications essentielles au fonctionnement de l'appareil, telles que le Google Play Store.
API_LEVEL Impossible d'effacer les données de cette application, car le niveau d'API de l'appareil n'est pas compatible avec cette commande.

StartLostModeStatus

État de la commande START_LOST_MODE permettant de mettre l'appareil en mode Perdu.

Représentation JSON 
{
  "status": enum (Status)
}
Champs
status

enum (Status)

État. Consultez les StartLostModeStatus.

État

État. Consultez les StartLostModeStatus.

Enums
STATUS_UNSPECIFIED Non spécifié. Cette valeur n'est pas utilisée.
SUCCESS L'appareil est passé en mode Perdu.
RESET_PASSWORD_RECENTLY Impossible de faire passer l'appareil en mode Perdu, car l'administrateur a récemment réinitialisé le mot de passe de l'appareil.
USER_EXIT_LOST_MODE_RECENTLY L'appareil n'a pas pu être mis en mode Perdu, car l'utilisateur a récemment quitté ce mode.
ALREADY_IN_LOST_MODE L'appareil est déjà en mode Perdu.

StopLostModeStatus

État de la commande STOP_LOST_MODE permettant de sortir l'appareil du mode Perdu.

Représentation JSON 
{
  "status": enum (Status)
}
Champs
status

enum (Status)

État. Consultez les StopLostModeStatus.

État

État. Consultez les StopLostModeStatus.

Enums
STATUS_UNSPECIFIED Non spécifié. Cette valeur n'est pas utilisée.
SUCCESS L'appareil a été sorti du mode Perdu.
NOT_IN_LOST_MODE L'appareil n'est pas en mode Perdu.