REST Resource: users.settings.cse.keypairs

资源：CseKeyPair

客户端加密 S/MIME 密钥对，由公钥、其证书链以及其配对私钥的元数据组成。Gmail 使用密钥对完成以下任务：

  • 对发出的客户端加密邮件进行签名。
  • 保存和重新打开客户端加密邮件的草稿。
  • 保存和重新打开已发送的消息。
  • 解密传入或归档的 S/MIME 邮件。

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

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

JSON 表示法 
{
  "keyPairId": string,
  "pkcs7": string,
  "pem": string,
  "subjectEmailAddresses": [
    string
  ],
  "enablementState": enum (EnablementState),
  "disableTime": string,
  "privateKeyMetadata": [
    {
      object (CsePrivateKeyMetadata)
    }
  ]
}
字段
keyPairId

string

仅限输出。客户端加密 S/MIME 密钥对的不可变 ID。
pkcs7

string

仅限输入。公钥及其证书链。该链必须采用 PKCS#7 格式，并使用 PEM 编码和 ASCII 铠装。
pem

string

仅限输出。公钥及其证书链，采用 PEM 格式。
subjectEmailAddresses[]

string

仅限输出。叶证书上指定的电子邮件地址身份。
enablementState

enum (EnablementState)

仅限输出。密钥对的当前状态。
disableTime

string (Timestamp format)

仅限输出。如果密钥对设置为 DISABLED，则表示密钥对的状态从 ENABLED 更改为 DISABLED 的时间。只有当密钥对处于状态 DISABLED 时，此字段才会显示。

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

此密钥对私钥实例的元数据。

EnablementState

密钥对的当前状态的枚举。

枚举
stateUnspecified 未设置密钥对的当前状态。密钥对处于未启用和未停用状态。
enabled

密钥对已开启。对于此密钥对加密的任何电子邮件，Gmail 都会对其进行解密，并使用私钥对所有外发邮件进行签名。

如需开启密钥对，请使用 keypairs.enable 方法。
disabled

密钥对已停用。经过身份验证的用户无法解密电子邮件，也无法为出站邮件签名。如果密钥对已停用超过 30 天，您可以将其永久删除。

如需关闭密钥对，请使用 keypairs.disable 方法。

CsePrivateKeyMetadata

私钥实例的元数据。

JSON 表示法 
{
  "privateKeyMetadataId": string,

  // Union field metadata_variant can be only one of the following:
  "kaclsKeyMetadata": {
    object (KaclsKeyMetadata)
  },
  "hardwareKeyMetadata": {
    object (HardwareKeyMetadata)
  }
  // End of list of possible types for union field metadata_variant.
}
字段
privateKeyMetadataId

string

仅限输出。私钥元数据实例的不可变 ID。
联合字段 metadata_variant。联合字段：必须包含以下元数据变体类型之一。metadata_variant 只能是下列其中一项：
kaclsKeyMetadata

object (KaclsKeyMetadata)

由外部密钥访问控制列表服务管理的私钥实例的元数据。
hardwareKeyMetadata

object (HardwareKeyMetadata)

实体按键的元数据。

KaclsKeyMetadata

由外部密钥访问控制列表服务管理的私钥的元数据。如需详细了解如何管理密钥访问权限，请参阅 Google Workspace CSE API 参考文档。

JSON 表示法 
{
  "kaclsUri": string,
  "kaclsData": string
}
字段
kaclsUri

string

用于管理私钥的密钥访问控制列表服务的 URI。
kaclsData

string

密钥访问控制列表服务生成和使用的不透明数据。大小上限：8 KiB。

HardwareKeyMetadata

实体按键的元数据。

如果为 Google Workspace 组织设置了硬件密钥加密，用户可以选择将其私钥存储在智能卡上，并将智能卡插入连接到 Windows 设备的读卡器，以便使用该私钥在 Gmail 中对电子邮件进行签名和解密。

JSON 表示法 
{
  "description": string
}
字段
description

string

硬件密钥的说明。

方法

create

 为已验证身份的用户创建并上传客户端加密 S/MIME 公钥证书链和私钥元数据。

disable

 停用客户端加密功能密钥对。

enable

 启用已停用的客户端加密密钥对。

get

 检索现有的客户端加密密钥对。

list

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

obliterate

 立即永久删除客户端加密密钥对。