Method: users.settings.cse.keypairs.list

列出经过身份验证的用户的客户端加密密钥对。

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

有关详情,请参阅授权指南