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,

  "kaclsKeyMetadata": {
    object (KaclsKeyMetadata)
  },
  "hardwareKeyMetadata": {
    object (HardwareKeyMetadata)
  }
}
欄位
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

 永久且立即刪除用戶端加密金鑰組。