Cette page a été traduite par l'API Cloud Translation.

API Directory: appareils Chrome

Récupérer tous les appareils Chrome pour un compte
1. Exporter une liste de MEID
Récupérer un appareil Chrome
Mettre à jour un appareil Chrome
Effectuer une action sur un appareil Chrome
Déplacer des appareils Chrome vers une unité organisationnelle

Récupérer tous les appareils Chrome pour 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. Des retours à la ligne ont été inclus dans cet exemple de code pour le rendre plus lisible:

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

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. Vous pouvez également obtenir la valeur customerId à l'aide de l'opération Retrieve a user (Récupérer un utilisateur). Utilisez votre adresse e-mail d'administrateur ou la valeur de votre id 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, la requête et les propriétés 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 est le numéro de série de l'appareil. La réponse ci-dessous ne contient qu'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 de la ressource Chromeosdevices.

Exporter une liste de MEID

meid correspond à l'identifiant MEID (Mobile Equipment Identifier) de la carte mobile 3G d'un appareil Chrome. Un MEID est généralement utilisé pour ajouter un appareil au forfait avec post-paiement d'un opérateur de téléphonie mobile. 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. Des retours à la ligne ont été inclus dans cet exemple de code pour le rendre plus lisible:

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 Autoriser les requêtes. Des retours à la ligne ont été inclus dans cet exemple de code pour le rendre plus lisible:

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}

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. Vous pouvez également obtenir la valeur customerId à l'aide de l'opération Retrieve a user (Récupérer un utilisateur). Utilisez votre adresse e-mail d'administrateur ou la valeur de votre id utilisateur unique d'administrateur dans le paramètre de chemin d'accès userKey de l'opération.
deviceId est un identifiant unique pour un appareil. Il se trouve dans la réponse à l'opération Récupérer tous les appareils Chrome.

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

Requête JSON

Exemple de requête. Des retours à la ligne ont été inclus dans cet exemple de code pour le rendre plus lisible:

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. En plus du 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. Des retours à la ligne ont été inclus dans cet exemple de code pour le rendre plus lisible:

PUT https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}

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. Vous pouvez également obtenir la valeur customerId à l'aide de l'opération Retrieve a user (Récupérer un utilisateur). Utilisez votre adresse e-mail d'administrateur ou la valeur de votre id utilisateur unique d'administrateur dans le paramètre de chemin d'accès userKey de l'opération.
deviceId est un identifiant unique pour un appareil. Il se trouve dans la réponse à l'opération Récupérer tous les appareils Chrome.

Pour en savoir plus sur les chaînes de requête, la requête et les propriétés 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. Des retours à la ligne ont été inclus dans cet exemple de code pour le rendre plus lisible:

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, n'incluez que les propriétés dont les valeurs ont été modifiées.

Remarque:L'API ne peut modifier que les propriétés annotatedUser, annotatedLocation, annotatedAssetId, notes et orgUnitPath.

Une requête réussie renvoie un code d'état HTTP 200. En plus du code d'état, la réponse renvoie les propriétés de l'appareil Chrome mis à jour.

Déprovisionner ou désactiver des appareils Chrome

Pour désprovisionner 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. Des retours à la ligne ont été inclus dans cet exemple de code pour le rendre plus lisible:

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

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. Vous pouvez également obtenir la valeur customerId à l'aide de l'opération Retrieve a user (Récupérer un utilisateur). Utilisez votre adresse e-mail d'administrateur ou la valeur de votre id 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 requête et de réponse, consultez la documentation de référence de l'API.

Requête JSON

La requête JSON suivante montre un exemple de requête pour déprovisionner et 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 de 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. Des retours à la ligne ont été inclus dans cet exemple de code pour le rendre plus lisible:

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

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. Vous pouvez également obtenir la valeur customerId à l'aide de l'opération Retrieve a user (Récupérer un utilisateur). Utilisez votre adresse e-mail d'administrateur ou la valeur de votre id 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 requête et de réponse, consultez la documentation de référence de l'API.

Requête JSON

La requête JSON suivante montre un exemple de requête visant à 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.