使用 Chrome 浏览器 Enrollment Token API

授权

Chrome Browser Cloud Management'sTakeout API Service Script 指南详细介绍了访问 Enrollment Token API 所需的授权。用户需要按照相同的步骤检索访问令牌。

ChromeEnrollmentToken

ChromeEnrollmentToken 是一个字符串，用于标识 Chrome 浏览器的注册状态。

资源表示法

Directory API 中的 ChromeEnrollmentToken 资源使用以下 JSON 模板：

{

"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 请求，并包含按照“授权”部分获取的访问令牌。

注意：为了方便阅读，此代码示例使用回车断行。

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 账号的唯一标识符。
• 模拟账号管理员时，您还可以使用字符串 my_customer，它可用于表示您账号的 customerId。获取 customerId 值的另一种方法是使用获取用户操作。在该操作的 userKey 路径参数中，使用您的管理员电子邮件地址或管理员唯一用户 ID 值。

以下是可在请求中使用的所有载荷参数，仅供参考：

参数	是否必需	类型	说明
orgUnitPath	可选	字符串	仅列出在特定单位部门中创建的注册令牌。如果不指定此字段，系统会列出此客户的所有注册令牌。
pageSize	可选	int	页面中结果的数量上限。最大值和默认值均为 100。
pageToken	可选	字符串	pageToken 查询参数用于请求下一页查询结果。下一个请求的 pageToken 查询参数是上一个响应中的 nextPageToken。注意：所提供的包含 page_token 字段的请求与生成 page_token 的请求必须具有相同的 query 和 org_unit_path 字段值。
query	可选	字符串	用于过滤列出的令牌的搜索字符串。以下部分（过滤查询语言）介绍了 list page 查询语言的格式。

示例

请求示例

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

过滤查询语言

在 list 请求中使用“query”参数时，query 中的字词必须与以下参数之一匹配，系统才会将结果视为匹配。您可以指定要缩小返回的令牌，以匹配该字词的字段值。如果您未在 query 中指定任何运算符（字段），则搜索结果将包含找到的所有注册令牌。

例如，如果您的 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 请求，并包含按照“授权”部分获取的访问令牌。

注意：为了方便阅读，此代码示例使用回车断行。

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

• customerId 是客户的 Google 账号的唯一标识符。
• 模拟账号管理员时，您还可以使用字符串 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 请求，并包含按照“授权”部分获取的访问令牌。

注意：为了方便阅读，此代码示例使用回车断行。

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

• customerId 是客户的 Google 账号的唯一标识符。
• 模拟账号管理员时，您还可以使用字符串 my_customer，它可用于表示您账号的 customerId。获取 customerId 值的另一种方法是使用获取用户操作。在该操作的 userKey 路径参数中，使用您的管理员电子邮件地址或管理员唯一用户 ID 值。
• tokenPermanentId 是注册令牌的唯一标识符，可在“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 状态代码。