Method: users.settings.cse.keypairs.disable
Deaktiviert ein Schlüsselpaar für die clientseitige Verschlüsselung. Der authentifizierte Nutzer kann das Schlüsselpaar nicht mehr verwenden, um eingehende CSE-Nachrichtentexte zu entschlüsseln oder ausgehende CSE-E-Mails zu signieren.
Wenn Sie wieder Zugriff erhalten möchten, aktivieren Sie das Schlüsselpaar mit der keypairs.enable.
Nach 30 Tagen können Sie das Schlüsselpaar mit der Methode keypairs.obliterate endgültig löschen.
HTTP-Anfrage
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
| Parameter |
userId |
string
Die primäre E-Mail-Adresse des Antragstellers. Um den authentifizierten Nutzer anzugeben, können Sie den speziellen Wert me verwenden.
|
keyPairId |
string
Die Kennung des Schlüsselpaars, das deaktiviert werden soll.
|
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von CseKeyPair.
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://www.googleapis.com/auth/gmail.settings.basic
https://www.googleapis.com/auth/gmail.settings.sharing
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2024-09-05 (UTC).
[null,null,["Zuletzt aktualisiert: 2024-09-05 (UTC)."],[[["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"]]
