Method: users.settings.cse.keypairs.obliterate
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Exclui um par de chaves de criptografia do lado do cliente de forma permanente e imediata. Só é possível excluir permanentemente pares de chaves que foram desativados por mais de 30 dias. Para desativar um par de chaves, use o método keypairs.disable.
O Gmail não pode restaurar ou descriptografar mensagens criptografadas por uma chave apagada. Os usuários autenticados e os administradores do Google Workspace perdem o acesso para ler as mensagens criptografadas.
Para administradores que gerenciam identidades e pares de chaves para usuários na organização, as solicitações exigem autorização com uma conta de serviço que tenha autoridade de delegação em todo o domínio para representar usuários com o escopo https://www.googleapis.com/auth/gmail.settings.basic.
Para usuários que gerenciam as próprias identidades e pares de chaves, as solicitações exigem a criptografia de chaves de hardware ativada e configurada.
Solicitação HTTP
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros |
userId |
string
O endereço de e-mail principal do solicitante. Para indicar o usuário autenticado, use o valor especial me.
|
keyPairId |
string
O identificador do par de chaves a ser destruído.
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta será um objeto JSON vazio.
Escopos de autorização
Requer um dos seguintes escopos do OAuth:
https://www.googleapis.com/auth/gmail.settings.basic
https://www.googleapis.com/auth/gmail.settings.sharing
Para mais informações, consulte o guia de autorização.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-25 UTC."],[],[],null,["# Method: users.settings.cse.keypairs.obliterate\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nDeletes 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 [keypairs.disable](/workspace/gmail/api/reference/rest/v1/users.settings.cse.keypairs/disable#caribou.api.proto.MailboxService.DisableCseKeyPair) method.\n\nGmail 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.\n\nFor administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope.\n\nFor users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.\n\n### HTTP request\n\n`POST https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------|\n| `userId` | `string` The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. |\n| `keyPairId` | `string` The identifier of the key pair to obliterate. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body is an empty JSON object.\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/gmail.settings.basic`\n- `\n https://www.googleapis.com/auth/gmail.settings.sharing`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
