使用 Chrome Browser Enrollment Token API

授權

如要使用 Enrollment Token API，使用者必須執行與 Chrome Enterprise Core's Takeout API Service Script 相同的授權步驟，然後擷取存取權杖。

ChromeEnrollmentToken

ChromeEnrollmentToken 是用來識別 Chrome 瀏覽器註冊的字串。

資源表示法

下列 JSON 範本適用於 Directory API 中的 ChromeEnrollmentToken 資源：

{

"kind": "admin#directory#chromeEnrollmentToken",

"orgUnitPath": string,

"token": string,

"tokenPermanentId": string,

"customerId": string,

"orgUnitPath": string,

"state": enum {
    "active",

    "expired",

    "revoked",

}

"expiration": oneof {

    "expireTime": dateTime,

    "ttl": duration

  }

"creatorId": string,

"creationTime": dateTime,

"revokerId": string,

"revokeTime": dateTime,

"tokenType": enum {

    "chromeBrowser"

  }

}

呼叫 API

列出帳戶的所有註冊權杖

如要列出機構單位中某個帳戶的所有 Chrome 註冊權杖，請使用下列 GET 要求，並附上根據以下「Authorization」區段所獲得的存取權杖。

注意：為了方便閱讀，本程式碼範例包含換行。

GET
https://www.googleapis.com/admin/directory/v1.1beta1/customer/
{my_customer|customerId}/chrome/enrollmentTokens?query=
{query_string}&pageSize={number_of_results_to_return}
&pageToken={page_token_from_previous_request}&orgUnitPath={/org-unit-path}

• customerId 是客戶 Google 帳戶的專屬 ID。
• 如要以帳戶管理員的身分操作，您也可以使用 my_customer 字串來代表您帳戶的 customerId，或使用擷取使用者作業來取得 customerId 值。您可以在作業的 userKey 路徑參數中，使用您的管理員電子郵件地址或管理員專屬使用者 ID 值。

以下參考資料說明可在要求中使用的所有酬載參數：

參數	是否必要	類型	說明
orgUnitPath	選用	字串	僅列出在特定機構單位中建立的註冊權杖。如未指定這個欄位，則會列出該客戶的所有註冊權杖。
pageSize	選用	整數	一頁的結果數上限。最大值和預設值為 100。
pageToken	選用	字串	pageToken 查詢參數可用來要求下一頁的查詢結果。後續要求的 pageToken 查詢參數就是您前一次回應的 nextPageToken。注意：如果要求含有 page_token 欄位，其查詢內容和 org_unit_path 欄位值必須和產生 page_token 的要求相同。
query	選用	字串	搜尋字串以篩選已列出的權杖。下節 (篩選查詢語言) 將說明清單頁面查詢語言的格式。

範例

要求範例

GET https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/chrome/enrollmentTokens?pageSize=1&orgUnitPath=”/Org-unit-path”

JSON 回應

成功的要求會傳回 HTTP 200 狀態碼。除了狀態碼，回應還會傳回 Chrome 註冊權杖的屬性：

{
  kind: "admin#directory#chromeEnrollmentTokens",
  "chrome_enrollment_tokens": [
    {
      "tokenId": "token_id_value",
      "tokenPermanentId": "token_Permanent_id_value",
      "kind": "admin#directory#chromeEnrollmentToken",
      "orgUnitPath": "/Org-unit-path",
      "state": "active",
      "creator_id": “unique_id_of_user",
      "create_time": "2020-04-30T19:22:44Z",
      "tokenType": "chromeBrowser",
    }
  ],
  "nextPageToken": "abcdefghijkl123"
}

篩選查詢語言

在清單要求中使用「query」參數時，查詢中的每個字詞都必須符合下列其中一項參數，其結果才會視為相符。您可以指定縮小傳回權杖的範圍，以符合字詞的欄位值。如果您在查詢中未指定運算子 (欄位)，搜尋作業將找出所有註冊權杖。

舉例來說，如果您的查詢是：
{URL}?query="device_type:CHROME_BROWSER+token_state:REVOKED",
系統會傳回的註冊權杖如下：

{
  "tokenId": "token_id_value",
  "tokenPermanentId": "token_Permanent_id_value",
  "kind": "admin#directory#chromeEnrollmentToken",
  "orgUnitPath": "/Org-unit-path",
  “tokenState”: “revoked”,
  “creatorId”: “unique_id_of_user”,
  "create_time": "2020-04-30T19:22:44Z",
  "tokenType": "chromeBrowser",
}

您可以指定下列欄位，將您的搜尋指定到特定欄位：

欄位	說明
device_type	註冊權杖適用的裝置類型。目前僅支援 CHROME_BROWSER。
token_state	註冊權杖的狀態。支援的值為 REVOKED、ACTIVE 或 EXPIRED。

建立註冊權杖

如要在機構單位中建立 Chrome 註冊權杖，請使用下列 POST 要求，並附上根據以下「Authorization」區段所獲得的存取權杖。

注意：為了方便閱讀，本程式碼範例包含換行。

POST
https://www.googleapis.com/admin/directory/v1.1beta1/customer/
{my_customer|customerId}/chrome/enrollmentTokens

• customerId 是客戶 Google 帳戶的專屬 ID。
• 如要以帳戶管理員的身分操作，您也可以使用 my_customer 字串來代表您帳戶的 customerId，或使用擷取使用者作業來取得 customerId 值。您可以在作業的 userKey 路徑參數中，使用您的管理員電子郵件地址或管理員專屬使用者 ID 值。

以下參考資料說明可在要求中使用的所有酬載參數：

參數	是否必要	類型	說明
expire_time	選用	字串	已建立註冊權杖的到期時間，格式為「yyyy-MM-ddThh:mm:ssZ」。如未指定這個欄位，註冊權杖會持續有效，直到使用者撤銷為止。
org_unit_path	選用	字串	要為其建立註冊權杖的機構單位。如未指定這個欄位，系統會為根機構單位建立註冊權杖。
token_type	是否必要	字串	要為其建立註冊權杖的 Chrome 裝置類型。目前僅支援「CHROME_BROWSER」。
ttl	選用	字串	已建立註冊權杖的可用期限，以「s」尾碼進行編碼 (以秒為單位)。 例如，要讓權杖在 1 小時後到期，這個欄位應設為「3600s」。如未指定這個欄位，註冊權杖則會持續有效，直到使用者撤銷為止。

範例

要求範例

POST https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/chrome/enrollmentTokens
{
  "token_type": "CHROME_BROWSER",
  "org_unit_path": "/org-unit-path",
  "expire_time": "2021-04-30T19:22:44Z",
}

JSON 回應

成功的要求會傳回 HTTP 200 狀態碼。除了狀態碼，回應還會傳回 Chrome 註冊權杖的屬性：

{
  "tokenId": "token_id_value",
  "tokenPermanentId": "token_Permanent_id_value",
  "kind": "admin#directory#chromeEnrollmentToken",
  "orgUnitPath": "/Org-unit-path",
  "state": "active",
  "creatorId”: "unique_id_of_user",
  "create_time": "2020-04-30T19:22:44Z",
  "expire_time": "2021-04-30T19:22:44Z",
  "tokenType": "chromeBrowser",
}

撤銷註冊權杖

如要撤銷註冊權杖，請使用下列 POST 要求，並附上根據以下「Authorization」區段所獲得的存取權杖。

注意：為了方便閱讀，本程式碼範例包含換行。

POST
https://www.googleapis.com/admin/directory/v1.1beta1/customer/
{my_customer|customerId}/chrome/enrollmentTokens/{tokenPermanentId}:revoke

• customerId 是客戶 Google 帳戶的專屬 ID。
• 如要以帳戶管理員的身分操作，您也可以使用 my_customer 字串來代表您帳戶的 customerId，或使用擷取使用者作業來取得 customerId 值。您可以在作業的 userKey 路徑參數中，使用您的管理員電子郵件地址或管理員專屬使用者 ID 值。
• tokenPermanentId 是註冊權杖的專屬 ID，會出現在「List」或「Create」回應的「tokenPermanentId」欄位中。

範例

要求範例

POST https://www.googleapis.com/admin/directory/v1.1beta1/customer/my_customer/chrome/enrollmentTokens/token_permanent_id_value:revoke

JSON 回應

成功的要求會傳回 HTTP 200 狀態碼。