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
要关闭的密钥对的标识符。
|
响应正文
如果成功，则响应正文包含一个 CseKeyPair 实例。
授权范围
需要以下 OAuth 范围之一：
https://www.googleapis.com/auth/gmail.settings.basic
https://www.googleapis.com/auth/gmail.settings.sharing
有关详情，请参阅授权指南。
如未另行说明，那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可，并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情，请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC)：2024-09-05。
[null,null,["最后更新时间 (UTC)：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"]]
