API Directory: appareils Chrome

Récupérer tous les appareils Chrome d'un compte

Pour renvoyer la liste de tous les appareils Chrome attribués à un compte, utilisez le code suivant : GET et inclure l'autorisation décrite dans Autoriser les requêtes Pour une meilleure lisibilité, cet exemple de code comporte des retours à la ligne: 

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos?projection={BASIC|FULL}&query=query
&orderBy=orderBy category&sortOrder={ASCENDING|DESCENDING}
&pageToken=token for next results page, if applicable
&maxResults=max number of results per page

  • Le customerId est un identifiant unique du compte Google du client.
  • En tant qu'administrateur de compte, vous pouvez également utiliser la chaîne my_customer, qui représente l'customerId de votre compte. Une autre façon d'obtenir le customerId consiste à utiliser la valeur Récupérer un utilisateur opération. Utilisez votre adresse e-mail d'administrateur ou votre compte administrateur unique id dans le paramètre de chemin userKey de l'opération.

Pour les chaînes de requête, ainsi que les propriétés de requête et de réponse, consultez la Documentation de référence de l'API

Exemple: Filtrer les appareils par utilisateur

Cet exemple recherche un utilisateur spécifique à l'aide de query=user:help desk. La contient une seule ressource chromeosdevice, où annotatedUser correspond à help desk:

Requête JSON

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos?projection=FULL&query=user:help desk&orderBy=status
&sortOrder=ASCENDING&maxResults=100

Réponse JSON

{
  "kind": "directory#chromeosdevices",
  "chromeosdevices": [
     {
       "kind": "directory#chromeosdevice",
       "etag": "1234567890"
       "deviceId": "def456",
       "serialNumber": "234567",
       "status": "ACTIVE",
       "lastSync": "2013-03-05T17:30:04.325Z",
       "supportEndDate": "2014-04-05T17:30:04.325Z",
       "annotatedUser": "help desk",
       "annotatedLocation": "Mountain View help desk Chromebook",
       "annotatedAssetId": "1234567890",
       "notes": "Loaned from support",
       "orderNumber": "1234",
       "willAutoRenew": true,
       "osVersion": "Browser Version 18.0",
       "platformVersion": "Platform Version 1415.2.0",
       "firmwareVersion": "Firmware Version 1.2.3.4",
       "bootMode": "validated",
       "lastEnrollmentTime": "2012-04-05T17:30:04.325Z",
       "orgUnitPath": "corp/engineering",
       "recentUsers": [
         {
           "type": "USER_TYPE_MANAGED",
           "email": "user@customer.com"
         }
       ],
       "activeTimeRanges": [
         {
           "date": "2012-04-05",
           "activeTime": "3600000"
         }
       ],
     }
  ],
  "nextPageToken": "abcdefghijkl123"
}

Exemple: Filtrer les appareils par numéro de série

Cet exemple recherche un numéro de série spécifique en utilisant query=id:123456, où 123456 correspond au numéro de série de l'appareil. La réponse ci-dessous contient une seule réponse correspondante, dans laquelle le La propriété serialNumber correspond à la valeur de recherche.

Requête JSON

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos?projection=FULL&query=id:123456&orderBy=status
&sortOrder=ASCENDING&maxResults=100

Réponse JSON

{
  "kind": "directory#chromeosdevices",
  "chromeosdevices": [
     {
       "kind": "directory#chromeosdevice",
       "deviceId": "abc123",
       "serialNumber": "123456",
       "status": "SHIPPED",
       "supportEndDate": "1404457200000",
       "model": "model_value",
       "meid": "meid_value",
       "macAddress": "mac_address_value",
       "orderNumber": "1234",
       "willAutoRenew": true
     }
  ],
  "nextPageToken": "abcdefghijkl123"
}

Cet exemple de réponse inclut les éléments model, meid et macAddress. Si un appareil ne possède pas ces propriétés, elles ne le sont pas incluses dans la réponse. Pour plus d'informations, consultez les Représentation des ressources ChromeOS :

Exporter une liste de MEID

Le meid correspond à l'identifiant MEID de la carte mobile 3G dans un Appareil Google Chrome. Le code MEID est généralement utilisé lors de l'ajout d'un appareil au réseau de services avec post-paiement. Pour exporter la liste des MEID, utilisez la requête GET suivante et les valeurs nextPageToken pour obtenir la liste complète des MEID. Pour une meilleure lisibilité, l'exemple de code comporte des retours à la ligne: 

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos?fields=nextPageToken,chromeosdevices(meid)

Récupérer un appareil Google Chrome

Pour récupérer les propriétés d'un appareil Chrome, utilisez la requête GET suivante et incluent l'autorisation décrite dans Autoriser les requêtes Pour une meilleure lisibilité, cet exemple de code comporte des retours à la ligne: 

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • Le customerId est un identifiant unique du compte Google du client.
  • En tant qu'administrateur de compte, vous pouvez également utiliser la chaîne my_customer, qui représente l'customerId de votre compte. Une autre façon d'obtenir le customerId consiste à utiliser la valeur Récupérer un utilisateur opération. Utilisez votre adresse e-mail d'administrateur ou votre compte administrateur unique id dans le paramètre de chemin userKey de l'opération.
  • Le deviceId est un identifiant unique pour un appareil. Il se trouve dans la réponse de l'opération Récupérer tous les appareils Chrome.

Pour les chaînes de requête, ainsi que les propriétés de requête et de réponse, consultez la Documentation de référence de l'API

Requête JSON

Exemple de requête Pour faciliter la lecture, cet exemple de code comporte des retours à la ligne: 
GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos/deviceId?projection=full

Réponse JSON

Si la requête aboutit, Code d'état HTTP 200 : ainsi que le code d'état, la réponse renvoie les propriétés de l'appareil Chrome: 

{
  "kind": "directory#chromeosdevice",
  "deviceId": "device_id_value",
  "serialNumber": "device_serial_number",
  "status": "ACTIVE",
  "lastSync": "2012-04-05T17:30:04.325Z",
  "supportEndDate": "2014-04-05T17:30:04.325Z",
  "annotatedUser": "help desk",
  "annotatedLocation": "Mountain View help desk Chromebook",
  "annotatedAssetId": "12345667890",
  "notes": "Loaned from support",
  "orderNumber": "123456",
  "willAutoRenew": true,
  "osVersion": "Browser Version 18.0",
  "platformVersion": "Platform Version 1415.2.0",
  "firmwareVersion": "Firmware Version 1.2.3.4",
  "bootMode": "validated"
  "lastEnrollmentTime": "2012-04-05T17:30:04.325Z",
  "orgUnitPath": "corp/engineering"
}

Mettre à jour un appareil Google Chrome

Pour mettre à jour un appareil Chrome, utilisez la requête PUT suivante et incluez les l'autorisation décrite dans Autoriser les requêtes Pour une meilleure lisibilité, cet exemple de code comporte des retours à la ligne: 

PUT https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • Le customerId est un identifiant unique du compte Google du client.
  • En tant qu'administrateur de compte, vous pouvez également utiliser la chaîne my_customer, qui représente l'customerId de votre compte. Une autre façon d'obtenir le customerId consiste à utiliser la valeur Récupérer un utilisateur opération. Utilisez votre adresse e-mail d'administrateur ou votre compte administrateur unique id dans le paramètre de chemin userKey de l'opération.
  • Le deviceId est un identifiant unique pour un appareil. Il se trouve dans la réponse de l'opération Récupérer tous les appareils Chrome.

Pour les chaînes de requête, ainsi que les propriétés de requête et de réponse, consultez la Documentation de référence de l'API

Requête JSON

L'exemple de requête JSON suivant met à jour l'annotatedUser d'un appareil Chrome : annotatedLocation, annotatedAssetId, notes et orgUnitPath. Pour faciliter la lecture, cet exemple de code comporte des retours à la ligne: 

PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/deviceId?projection=full
Exemple de corps de la requête: 
{
  "deviceId": "device_id_value",
  "annotatedUser": "help desk",
  "annotatedLocation": "Mountain View help desk Chromebook",
  "annotatedAssetId": "1234567890",
  "notes": "Loaned from support",
  "orgUnitPath": "/corp/sales"
}

Pour une requête de mise à jour, incluez uniquement les propriétés avec les valeurs mises à jour dans votre requête.

Si la requête aboutit, Code d'état HTTP 200 : ainsi que le code d'état, la réponse renvoie les propriétés de l'appareil Chrome mis à jour.

Déprovisionnement ou désactivation d'appareils Chrome

Pour déprovisionner ou désactiver des appareils Chrome, utilisez la requête POST suivante et incluez l'autorisation décrite dans Autoriser les requêtes Pour une meilleure lisibilité, cet exemple de code comporte des retours à la ligne: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer or customerId/
devices/chromeos:batchChangeStatus

  • Le customerId est un identifiant unique du compte Google du client.
  • En tant qu'administrateur de compte, vous pouvez également utiliser la chaîne my_customer, qui représente l'customerId de votre compte. Une autre façon d'obtenir le customerId consiste à utiliser la valeur Récupérer un utilisateur opération. Utilisez votre adresse e-mail d'administrateur ou votre compte administrateur unique id dans le paramètre de chemin userKey de l'opération.

Pour les propriétés de requête et de réponse, consultez les Documentation de référence de l'API

Requête JSON

La requête JSON suivante présente un exemple de requête de déprovisionnement et de désactivation Appareils Google Chrome: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos:batchChangeStatus
Le corps de la requête pour un exemple de déprovisionnement se présente comme suit: 
{
  "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
  "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION",
  "deprovisionReason": "DEPROVISION_REASON_RETIRING_DEVICE"
}
Le corps de la requête de désactivation est le suivant: 
  {
    "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
    "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE",
  }

Si la requête aboutit, Code d'état HTTP 200 :

Déplacer des appareils Chrome vers une unité organisationnelle

Pour déplacer jusqu'à 50 appareils Chrome vers une unité organisationnelle, utilisez l'adresse suivante : POST et inclure l'autorisation décrite dans Autoriser les requêtes Pour une meilleure lisibilité, cet exemple de code comporte des retours à la ligne: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/moveDevicesToOu?orgUnitPath=/SomeOuName
  • Le customerId est un identifiant unique du compte Google du client.
  • En tant qu'administrateur de compte, vous pouvez également utiliser la chaîne my_customer, qui représente l'customerId de votre compte. Une autre façon d'obtenir le customerId consiste à utiliser la fonction Récupérer opération utilisateur. Utilisez votre adresse e-mail d'administrateur ou votre compte administrateur unique Valeur id dans le paramètre de chemin userKey de l'opération.

Pour les propriétés de requête et de réponse, consultez les Documentation de référence de l'API

Requête JSON

La requête JSON suivante présente un exemple de requête permettant de déplacer trois appareils Chrome vers un Unité organisationnelle nommée /Marketing: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/chromeos/moveDevicesToOu?orgUnitPath=/Marketing

Le corps de la requête pour le déplacement de l'appareil est le suivant:

{
  "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"]
}

Si la requête aboutit, Code d'état HTTP 200 :