Method: customer.devices.chromeos.batchChangeStatus

Modifie l'état d'un lot d'appareils ChromeOS. Pour en savoir plus sur la modification de l'état d'un appareil ChromeOS, consultez Faire réparer des appareils ChromeOS, modifier leur affectation ou les supprimer.

Requête HTTP

POST https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
customerId

string

Obligatoire. ID immuable du compte Google Workspace.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON
{
  "deviceIds": [
    string
  ],
  "changeChromeOsDeviceStatusAction": enum (ChangeChromeOsDeviceStatusAction),
  "deprovisionReason": enum (DeprovisionReason)
}
Champs
deviceIds[]

string

Obligatoire. Liste des ID des appareils ChromeOS à modifier. 50 maximum.

changeChromeOsDeviceStatusAction

enum (ChangeChromeOsDeviceStatusAction)

Obligatoire. Action à effectuer sur l'appareil ChromeOS pour modifier son état.

deprovisionReason

enum (DeprovisionReason)

Facultatif. Motif de la déprovisionnement d'un appareil. Doit être fourni si "changeChromeOsDeviceStatusAction" est défini sur "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION". Sinon, omettez ce champ.

Corps de la réponse

Réponse à la modification de l'état d'un lot d'appareils ChromeOS.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON
{
  "changeChromeOsDeviceStatusResults": [
    {
      object (ChangeChromeOsDeviceStatusResult)
    }
  ]
}
Champs
changeChromeOsDeviceStatusResults[]

object (ChangeChromeOsDeviceStatusResult)

Résultats pour chacun des appareils ChromeOS fournis dans la requête.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/admin.directory.device.chromeos

Pour en savoir plus, consultez le guide d'autorisation.

ChangeChromeOsDeviceStatusAction

Action à effectuer pour modifier l'état d'un appareil ChromeOS.

Enums
CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_UNSPECIFIED Valeur par défaut. La valeur n'est pas utilisée.
CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION Déprovisionne un appareil ChromeOS. Si des appareils ChromeOS ne sont plus utilisés au sein de votre organisation, vous devez les déprovisionner pour ne plus avoir à les gérer. Lorsque vous déprovisionnez un appareil, toutes les règles qui s'y appliquaient en sont supprimées, de même que les imprimantes qui y étaient installées. De plus, l'appareil ne pourra plus être utilisé en tant que kiosque. En fonction de la mise à niveau associée à l'appareil, cette action peut libérer la licence dans le pool de licences, ce qui vous permet de l'utiliser sur un autre appareil.
CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE Désactive un appareil ChromeOS. Utilisez cette action si un utilisateur perd son appareil ou s'il est volé. L'appareil reste géré et continue de recevoir des règles, mais personne ne peut l'utiliser. En fonction de la mise à niveau associée à l'appareil, cette action peut libérer la licence dans le pool de licences, ce qui vous permet de l'utiliser sur un autre appareil.
CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_REENABLE Réactive l'utilisation d'un appareil ChromeOS après sa désactivation. Réactive l'appareil une fois qu'il n'est plus perdu ou qu'il a été récupéré. L'appareil peut alors être réutilisé. Selon la mise à niveau associée à l'appareil, une licence du pool de licences peut être consommée. Par conséquent, si le nombre de licences disponibles est insuffisant, l'opération échouera.

ChangeChromeOsDeviceStatusResult

Résultat d'un seul appareil ChromeOS pour une opération de modification d'état.

Représentation JSON
{
  "deviceId": string,

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    object (ChangeChromeOsDeviceStatusSucceeded)
  }
  // End of list of possible types for union field result.
}
Champs
deviceId

string

Identifiant unique de l'appareil ChromeOS.

Champ d'union result.

result ne peut être qu'un des éléments suivants :

error

object (Status)

Résultat d'erreur de l'opération en cas d'échec.

response

object (ChangeChromeOsDeviceStatusSucceeded)

L'appareil a bien pu modifier son état.

État

Le type Status définit un modèle d'erreur logique adapté aux différents environnements de programmation, y compris les API REST et RPC. Il est utilisé par le protocole gRPC. Chaque message Status contient trois éléments de données : un code d'erreur, un message d'erreur et les détails de l'erreur.

Pour en savoir plus sur ce modèle d'erreur et sur son utilisation, consultez le Guide de conception d'API.

Représentation JSON
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Champs
code

integer

Code d'état, qui doit être une valeur d'énumération de google.rpc.Code.

message

string

Message d'erreur destiné au développeur, qui doit être en anglais. Tout message d'erreur destiné aux utilisateurs doit être localisé et envoyé dans le champ google.rpc.Status.details, ou localisé par le client.

details[]

object

Liste de messages comportant les détails de l'erreur. Il existe un ensemble commun de types de message utilisable par les API.

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

ChangeChromeOsDeviceStatusSucceeded

Ce type ne comporte aucun champ.

Réponse en cas de changement d'état réussi de l'appareil ChromeOS.