資源:CseKeyPair
用戶端加密 S/MIME 金鑰組,其中包含一組公開金鑰、其憑證鏈結,以及配對私密金鑰的中繼資料。Gmail 會使用這組金鑰組完成以下工作:
- 簽署用戶端加密郵件。
- 儲存並重新開啟用戶端加密郵件的草稿。
- 儲存並重新開啟已傳送的郵件。
- 將收到或封存的 S/MIME 郵件解密。
JSON 表示法 |
---|
{ "keyPairId": string, "pkcs7": string, "pem": string, "subjectEmailAddresses": [ string ], "enablementState": enum ( |
欄位 | |
---|---|
keyPairId |
僅供輸出。用戶端加密 S/MIME 金鑰組的不變 ID。 |
pkcs7 |
僅限輸入。公開金鑰及其憑證鏈結。鏈結必須採用 PKCS#7 格式,並使用 PEM 編碼和 ASCII 保護程式。 |
pem |
僅供輸出。公開金鑰及其憑證鏈結,採 PEM 格式。 |
subjectEmailAddresses[] |
僅供輸出。分葉憑證中指定的電子郵件地址身分。 |
enablementState |
僅供輸出。金鑰組的目前狀態。 |
disableTime |
僅供輸出。如果金鑰組設為 RFC3339 世界標準時間「Zulu」的時間戳記格式,解析度為奈秒,且最多 9 個小數位數。範例: |
privateKeyMetadata[] |
這組金鑰組私密金鑰的執行個體中繼資料。 |
EnablementState
金鑰組目前狀態列舉。
列舉 | |
---|---|
stateUnspecified |
未設定金鑰組的目前狀態。這個金鑰組未開啟或關閉。 |
enabled |
金鑰組已開啟。針對這組金鑰組加密的電子郵件,Gmail 都會將郵件解密,並使用私密金鑰簽署任何外寄郵件。 如要啟用金鑰組,請使用 |
disabled |
金鑰組已關閉。通過驗證的使用者無法解密電子郵件,也無法簽署外寄郵件。如果金鑰組關閉超過 30 天,你可以永久刪除該金鑰組。 如要關閉金鑰組,請使用 |
CsePrivateKeyMetadata
私密金鑰執行個體的中繼資料。
JSON 表示法 |
---|
{ "privateKeyMetadataId": string, // Union field |
欄位 | |
---|---|
privateKeyMetadataId |
僅供輸出。私密金鑰中繼資料執行個體的不變 ID。 |
聯集欄位 metadata_variant 。聯集欄位:至少必須包含下列其中一個中繼資料變體類型。metadata_variant 只能是下列其中一項: |
|
kaclsKeyMetadata |
由外部金鑰存取控制清單服務代管的私密金鑰執行個體中繼資料。 |
hardwareKeyMetadata |
硬體金鑰的中繼資料。 |
KaclsKeyMetadata
由外部金鑰存取控制清單服務管理的私密金鑰中繼資料。如要進一步瞭解如何管理金鑰存取權,請參閱「Google Workspace CSE API 參考資料」。
JSON 表示法 |
---|
{ "kaclsUri": string, "kaclsData": string } |
欄位 | |
---|---|
kaclsUri |
管理私密金鑰的金鑰存取控制清單服務 URI。 |
kaclsData |
金鑰存取控制清單服務產生及使用的不透明資料。大小上限:8 KiB。 |
HardwareKeyMetadata
硬體金鑰的中繼資料。
JSON 表示法 |
---|
{ "description": string } |
欄位 | |
---|---|
description |
硬體金鑰的說明。 |
方法 |
|
---|---|
|
為已驗證使用者建立並上傳用戶端加密 S/MIME 公開金鑰憑證鏈結,以及私密金鑰中繼資料。 |
|
關閉用戶端加密金鑰組合。 |
|
開啟已停用的用戶端加密金鑰組合。 |
|
擷取現有的用戶端加密金鑰組合。 |
|
列出已驗證使用者的用戶端加密金鑰組合。 |
|
會立即永久刪除用戶端加密金鑰組合。 |