Method: users.settings.cse.keypairs.disable
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
詳情請參閱授權指南。
除非另有註明，否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權，程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間：2024-09-05 (世界標準時間)。
[null,null,["上次更新時間：2024-09-05 (世界標準時間)。"],[[["Turns off a client-side encryption key pair, preventing the authenticated user from decrypting incoming or signing outgoing CSE messages."],["To regain access to the key pair, use the `keypairs.enable` method within 30 days, after which it can be permanently deleted with `keypairs.obliterate`."],["This action is performed through a POST request to the specified endpoint with `userId` and `keyPairId` as path parameters."],["Requires specific authorization scopes (`gmail.settings.basic` or `gmail.settings.sharing`) for the request to be processed."]]],["This API endpoint disables a client-side encryption key pair via a `POST` request to a specific URL including `userId` and `keyPairId` path parameters. The request body is empty. Upon success, the API returns a `CseKeyPair` instance. Disabling a key prevents decryption of incoming messages and signing of outgoing mail. The key can be re-enabled or permanently deleted after 30 days. Access requires specific OAuth scopes, either `gmail.settings.basic` or `gmail.settings.sharing`.\n"]]
