gmail.users.settings.cse.keypairs.obliterate
Permanently deletes a client-side encryption key pair that has been disabled for over 30 days, revoking access to messages encrypted with that key.
Instructions
Deletes a client-side encryption key pair permanently and immediately. You can only permanently delete key pairs that have been turned off for more than 30 days. To turn off a key pair, use the DisableCseKeyPair method. Gmail can't restore or decrypt any messages that were encrypted by an obliterated key. Authenticated users and Google Workspace administrators lose access to reading the encrypted messages. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/ [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON ObliterateCseKeyPairRequest object; pass it via params or whole via body_file Siblings over the same resource: create, disable, enable, get, list.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe. | |
| params | No | Parameter map merged into the request; typed parameters win. | |
| userId | Yes | [URL path segment] The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. | me |
| dry_run | No | Return the request that would be sent, without sending it. | |
| body_file | No | Read the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON ObliterateCseKeyPairRequest object. | |
| keyPairId | Yes | [URL path segment] The identifier of the key pair to obliterate. | |
| request_body | No | Request body of type ObliterateCseKeyPairRequest: pass it via `params` (merged into the built body) or whole via `body_file`. |