Method: users.settings.cse.keypairs.obliterate
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
natychmiast usuwa parę kluczy szyfrowania po stronie klienta. Możesz trwale usunąć tylko pary kluczy, które są wyłączone od ponad 30 dni. Aby wyłączyć parę kluczy, użyj metody keypairs.disable.
Gmail nie może przywrócić ani odszyfrować żadnych wiadomości zaszyfrowanych za pomocą wymazywanych kluczy. Uwierzytelnieni użytkownicy i administratorzy Google Workspace tracą dostęp do odczytu zaszyfrowanych wiadomości.
W przypadku administratorów zarządzających tożsamościami i parami kluczy użytkowników w organizacji prośby wymagają autoryzacji konta usługi, które ma uprawnienia do delegowania uprawnień w całej domenie, aby podszywać się pod użytkowników w zakresie https://www.googleapis.com/auth/gmail.settings.basic.
W przypadku użytkowników zarządzających własnymi tożsamościami i parami kluczy żądania wymagają włączenia i skonfigurowania szyfrowania za pomocą klucza sprzętowego.
Żądanie HTTP
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
| Parametry |
userId |
string
Podstawowy adres e-mail osoby, która wysłała prośbę. Aby wskazać uwierzytelnionego użytkownika, możesz użyć wartości specjalnej me.
|
keyPairId |
string
Identyfikator pary kluczy, którą chcesz wymazać.
|
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
W przypadku powodzenia treść odpowiedzi to pusty obiekt JSON.
Zakresy autoryzacji
Wymaga jednego z tych zakresów OAuth:
https://www.googleapis.com/auth/gmail.settings.basic
https://www.googleapis.com/auth/gmail.settings.sharing
Więcej informacji znajdziesz w przewodniku po autoryzacji.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[null,null,["Ostatnia aktualizacja: 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)."]]
