Directory API:Chrome 裝置

,瞭解如何調查及移除這項存取權。

擷取帳戶的所有 Chrome 裝置

如要傳回已指派給帳戶的所有 Chrome 裝置清單,請使用下列 GET 要求,並包含 授權要求。為了方便閱讀 此程式碼範例包含換行:

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 是客戶 Google 帳戶的專屬 ID。
  • 身為帳戶管理員,您也可以使用 my_customer 字串: 代表帳戶的customerId。另一種取得 customerId 的方法 方法是使用「擷取使用者」 作業。請使用管理員電子郵件地址或管理員專屬使用者 (id) 值。userKey

如需查詢字串、要求和回應屬性的相關資訊,請參閱 API 參考資料

範例:依使用者篩選裝置

此範例使用 query=user:help desk 搜尋特定使用者。 回應會包含單一 chromeosdevice 資源,而 annotatedUserhelp desk

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

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"
}

範例:依序號篩選裝置

此範例會使用 query=id:123456,其中 123456 是 裝置的序號。以下顯示包含一則相符的回覆, serialNumber 屬性與搜尋值相符。

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

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"
}

這個回應範例包含 modelmeidmacAddress 屬性。如果裝置沒有這些屬性,就沒有 其他類別。如需完整詳細資料,請參閱 Chromeosdevices 資源表示法

匯出 MEID 清單

meid 是 3G 行動卡的行動設備識別碼 (MEID), 。將裝置新增至無線電信業者的服務時,通常會用到 MEID 使用後付費服務方案。如要匯出 MEID 清單,請使用下列 GET 要求和 nextPageToken 值,用於擷取 MEID 的完整清單。為了方便閱讀 程式碼範例包含換行:

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

擷取 Chrome 裝置

如要擷取 Chrome 裝置的屬性,請使用下列 GET 要求和 包含 授權要求。為了方便閱讀 此程式碼範例包含換行:

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • customerId 是客戶 Google 帳戶的專屬 ID。
  • 身為帳戶管理員,您也可以使用 my_customer 字串: 代表帳戶的customerId。另一種取得 customerId 的方法 方法是使用「擷取使用者」 作業。請使用管理員電子郵件地址或管理員專屬使用者 (id) 值。userKey
  • deviceId 是裝置的專屬 ID,可在 擷取所有 Chrome 裝置作業。

如需查詢字串、要求和回應屬性的相關資訊,請參閱 API 參考資料

JSON 要求

要求範例。為了方便閱讀,以下程式碼範例包含換行:
GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos/deviceId?projection=full

JSON 回應

如果要求成功,會傳回 HTTP 200 狀態碼。此外, 狀態碼,回應會傳回 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"
}

更新 Chrome 裝置

如要更新 Chrome 裝置,請使用以下 PUT 要求,並加入 授權程序 授權要求。為了方便閱讀 此程式碼範例包含換行:

PUT https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • customerId 是客戶 Google 帳戶的專屬 ID。
  • 身為帳戶管理員,您也可以使用 my_customer 字串: 代表帳戶的customerId。另一種取得 customerId 的方法 方法是使用「擷取使用者」 作業。請使用管理員電子郵件地址或管理員專屬使用者 (id) 值。userKey
  • deviceId 是裝置的專屬 ID,可在 擷取所有 Chrome 裝置作業。

如需查詢字串、要求和回應屬性的相關資訊,請參閱 API 參考資料

JSON 要求

以下 JSON 要求範例會更新 Chrome 裝置的 annotatedUserannotatedLocationannotatedAssetIdnotesorgUnitPath 屬性。為了方便閱讀,以下程式碼範例包含換行:

PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/deviceId?projection=full
要求主體範例:
{
  "deviceId": "device_id_value",
  "annotatedUser": "help desk",
  "annotatedLocation": "Mountain View help desk Chromebook",
  "annotatedAssetId": "1234567890",
  "notes": "Loaned from support",
  "orgUnitPath": "/corp/sales"
}

如果是更新要求,要求中只能包含含有更新值的屬性。

如果要求成功,會傳回 HTTP 200 狀態碼。此外, 狀態碼,回應會傳回更新版 Chrome 裝置的屬性。

取消佈建或停用 Chrome 裝置

如要取消佈建或停用 Chrome 裝置,請使用下列 POST 要求 並根據 授權要求。為了方便閱讀 此程式碼範例包含換行:

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

  • customerId 是客戶 Google 帳戶的專屬 ID。
  • 身為帳戶管理員,您也可以使用 my_customer 字串: 代表帳戶的customerId。另一種取得 customerId 的方法 方法是使用「擷取使用者」 作業。請使用管理員電子郵件地址或管理員專屬使用者 (id) 值。userKey

如需要求和回應屬性,請參閱 API 參考資料

JSON 要求

以下 JSON 要求顯示了取消佈建及停用方法的範例 Chrome 裝置:

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos:batchChangeStatus
取消佈建範例的要求主體如下:
{
  "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
  "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION",
  "deprovisionReason": "DEPROVISION_REASON_RETIRING_DEVICE"
}
停用要求主體如下:
  {
    "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
    "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE",
  }

如果要求成功,會傳回 HTTP 200 狀態碼

將 Chrome 裝置移至機構單位

如要將最多 50 部 Chrome 裝置移至機構單位,請使用下列工具 POST 要求,並包含 授權要求。為了方便閱讀 此程式碼範例包含換行:

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/moveDevicesToOu?orgUnitPath=/SomeOuName
  • customerId 是客戶 Google 帳戶的專屬 ID。
  • 身為帳戶管理員,您也可以使用 my_customer 字串: 代表帳戶的customerId。另一種取得 customerId 的方法 方法是使用擷取 user 作業。請使用管理員電子郵件地址或管理員不重複使用者 id 值。userKey

如需要求和回應屬性,請參閱 API 參考資料

JSON 要求

下列 JSON 要求範例顯示將 3 部 Chrome 裝置移至 名為「/Marketing」的機構單位:

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

裝置移動的要求主體為:

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

如果要求成功,會傳回 HTTP 200 狀態碼