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 la requête GET suivante et incluez l'autorisation décrite dans la section Autoriser les requêtes. Pour des raisons de lisibilité, les retours à la ligne de cet exemple de code sont les suivants: 

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

Pour en savoir plus sur les chaînes de requête et 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 réponse contient une seule ressource chromeosdevice, où annotatedUser est 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 à l'aide de query=id:123456, où 123456 correspond au numéro de série de l'appareil. La réponse affichée ci-dessous contient une seule réponse correspondante, où 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 propriétés model, meid et macAddress. Si un appareil ne possède pas ces propriétés, elles ne sont pas incluses dans la réponse. Pour en savoir plus, consultez la représentation des ressources ChromeOS.

Exporter une liste de MEID

Le meid est l'identifiant MEID (Mobile Equipment Identifier) de la carte mobile 3G d'un appareil Chrome. Le code MEID est généralement utilisé lors de l'ajout d'un appareil au forfait avec post-paiement d'un opérateur sans fil. Pour exporter la liste des MEID, utilisez la requête GET suivante et les valeurs nextPageToken pour récupérer la liste complète des MEID. Pour des raisons de lisibilité, cet 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 Chrome

Pour récupérer les propriétés d'un appareil Chrome, utilisez la requête GET suivante et incluez l'autorisation décrite dans la section Autoriser les requêtes. Pour des raisons de lisibilité, les retours à la ligne de cet exemple de code sont les suivants: 

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

Pour en savoir plus sur les chaînes de requête et 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 plus de lisibilité, 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

Une requête réussie renvoie un code d'état HTTP 200. Avec 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 Chrome

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

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

Pour en savoir plus sur les chaînes de requête et 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 les propriétés annotatedUser, annotatedLocation, annotatedAssetId, notes et orgUnitPath d'un appareil Chrome. Pour une meilleure lisibilité, 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 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, n'incluez que les propriétés avec des valeurs mises à jour dans votre requête.

Une requête réussie renvoie un code d'état HTTP 200. Avec 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 la section Autoriser les requêtes. Pour des raisons de lisibilité, les retours à la ligne de cet exemple de code sont les suivants: 

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

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

Pour en savoir plus sur les propriétés de la requête et de la réponse, consultez la 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éprovisionner et de désactiver des appareils 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 est le suivant : 
{
  "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 pour la désactivation est le suivant : 
  {
    "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
    "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE",
  }

Une requête réussie renvoie un 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 la requête POST suivante et incluez l'autorisation décrite dans la section Autoriser les requêtes. Pour des raisons de lisibilité, les retours à la ligne de cet exemple de code sont les suivants: 

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

Pour en savoir plus sur les propriétés de la requête et de la réponse, consultez la documentation de référence de l'API.

Requête JSON

Voici un exemple de requête JSON pour déplacer trois appareils Chrome vers une 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 de déplacement de l'appareil est le suivant:

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

Une requête réussie renvoie un code d'état HTTP 200.