Method: users.settings.cse.keypairs.list

列出已通过身份验证的用户的客户端加密功能密钥对。

对于管理组织中用户身份和密钥对的管理员，请求需要使用具有全网域授权的服务账号进行授权，才能模拟具有 https://www.googleapis.com/auth/gmail.settings.basic 范围的用户。

对于管理自己的身份和密钥对的用户，请求需要开启并配置硬件密钥加密。

HTTP 请求

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs

网址采用 gRPC 转码语法。

路径参数

参数
userId

string

请求者的主电子邮件地址。如需指明已通过身份验证的用户，您可以使用特殊值 me。

查询参数

参数
pageToken

string

分页令牌，用于指明要返回的键值对页面。如果未提供令牌，则 API 将返回第一页的结果。
pageSize

integer

要返回的键对数量。如果未提供，则每页数据大小将默认为 20 条条目。

请求正文

请求正文必须为空。

响应正文

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "cseKeyPairs": [
    {
      object (CseKeyPair)
    }
  ],
  "nextPageToken": string
}
字段
cseKeyPairs[]

object (CseKeyPair)

为用户安装的 CSE 密钥对列表的其中一页。
nextPageToken

string

要传递给后续 keypairs.list 调用以检索下一页密钥对的分页令牌。如果未返回此值，则表示没有其他页面。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/gmail.settings.basic
  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.settings.sharing

如需了解详情，请参阅授权指南。