Method: users.settings.cse.keypairs.disable
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Desactiva un par de claves de encriptación del cliente. El usuario autenticado ya no puede usar el par de claves para desencriptar los textos de los mensajes de CSE entrantes ni firmar los correos electrónicos de CSE salientes.
Para recuperar el acceso, usa keypairs.enable para activar el par de claves.
Después de 30 días, puedes borrar de forma permanente el par de claves con el método keypairs.obliterate.
En el caso de los administradores que administran identidades y pares de claves para los usuarios de su organización, las solicitudes requieren autorización con una cuenta de servicio que tenga autoridad de delegación en todo el dominio para suplantar la identidad de los usuarios con el alcance https://www.googleapis.com/auth/gmail.settings.basic.
En el caso de los usuarios que administran sus propias identidades y pares de claves, las solicitudes requieren que la encriptación de claves de hardware esté activada y configurada.
Solicitud HTTP
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
| Parámetros |
userId |
string
La dirección de correo electrónico principal del solicitante. Para indicar el usuario autenticado, puedes usar el valor especial me.
|
keyPairId |
string
Es el identificador del par de claves que se desactivará.
|
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de CseKeyPair.
Alcances de autorización
Se necesita uno de los siguientes permisos de OAuth:
https://www.googleapis.com/auth/gmail.settings.basic
https://www.googleapis.com/auth/gmail.settings.sharing
Para obtener más información, consulta la Guía de autorización.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 2025-07-25 (UTC)"],[],[],null,["# Method: users.settings.cse.keypairs.disable\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\nTurns off a client-side encryption key pair. The authenticated user can no longer use the key pair to decrypt incoming CSE message texts or sign outgoing CSE mail.\n\nTo regain access, use the [keypairs.enable](/workspace/gmail/api/reference/rest/v1/users.settings.cse.keypairs/enable#caribou.api.proto.MailboxService.EnableCseKeyPair) to turn on the key pair.\n\nAfter 30 days, you can permanently delete the key pair by using the [keypairs.obliterate](/workspace/gmail/api/reference/rest/v1/users.settings.cse.keypairs/obliterate#caribou.api.proto.MailboxService.ObliterateCseKeyPair) method.\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}:disable`\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 turn off. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [CseKeyPair](/workspace/gmail/api/reference/rest/v1/users.settings.cse.keypairs#CseKeyPair).\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)."]]
