Method: users.settings.cse.keypairs.obliterate
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Удаляет пару ключей шифрования на стороне клиента навсегда и немедленно. Вы можете удалить навсегда только те пары ключей, которые были отключены более 30 дней. Чтобы отключить пару ключей, используйте метод keypairs.disable .
Gmail не может восстановить или расшифровать сообщения, которые были зашифрованы стертым ключом. Аутентифицированные пользователи и администраторы Google Workspace теряют доступ к чтению зашифрованных сообщений.
Для администраторов, управляющих удостоверениями и парами ключей для пользователей в своей организации, запросы требуют авторизации с помощью учетной записи службы , имеющей полномочия делегирования полномочий на уровне домена для выдачи себя за пользователей с областью действия https://www.googleapis.com/auth/gmail.settings.basic .
Для пользователей, управляющих своими собственными удостоверениями и парами ключей, запросы требуют включения и настройки аппаратного шифрования ключей .
HTTP-запрос
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate
URL-адрес использует синтаксис gRPC Transcoding .
Параметры пути
| Параметры |
|---|
userId | string Основной адрес электронной почты запрашивающего. Чтобы указать аутентифицированного пользователя, можно использовать специальное значение me . |
keyPairId | string Идентификатор пары ключей, которую необходимо удалить. |
Текст запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа представляет собой пустой объект JSON.
Области действия авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/gmail.settings.basic -
https://www.googleapis.com/auth/gmail.settings.sharing
Более подробную информацию см. в Руководстве по авторизации .
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[null,null,["Последнее обновление: 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)."]]
