Method: users.settings.cse.keypairs.disable

關閉用戶端加密金鑰組。已驗證的使用者無法再使用金鑰組來解密傳入的 CSE 訊息文字,或簽署傳出的 CSE 郵件。

如要重新取得存取權,請使用 keypairs.enable 開啟金鑰組。

30 天後,您可以使用 keypairs.obliterate 方法永久刪除金鑰組。

管理員負責管理機構內使用者的身分和金鑰組,因此要求必須透過服務帳戶授權,該帳戶具備全網域委派權限,可模擬具有 https://www.googleapis.com/auth/gmail.settings.basic 範圍的使用者。

如果使用者自行管理身分和金鑰組,則要求必須開啟並設定硬體金鑰加密功能

HTTP 要求

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
userId

string

要求者的電子郵件地址。如要指出已驗證的使用者,您可以使用特殊值 me

keyPairId

string

要關閉的金鑰組 ID。

要求主體

要求主體必須為空白。

回應主體

如果成功,回應主體會包含 CseKeyPair 的執行例項。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/gmail.settings.basic
  • https://www.googleapis.com/auth/gmail.settings.sharing

詳情請參閱授權指南