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

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