REST Resource: users.settings.cse.identities
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Recurso: CseIdentity
La configuración de la encriptación del cliente (CSE) para la dirección de correo electrónico de un usuario autenticado Gmail usa configuraciones de CSE para guardar borradores de mensajes de correo electrónico encriptados del cliente y para firmar y enviar mensajes de correo electrónico encriptados.
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.
| Representación JSON |
{
"emailAddress": string,
// Union field key_pair_configuration can be only one of the following:
"primaryKeyPairId": string,
"signAndEncryptKeyPairs": {
object (SignAndEncryptKeyPairs)
}
// End of list of possible types for union field key_pair_configuration.
} |
| Campos |
emailAddress |
string
Es la dirección de correo electrónico de la identidad de envío. La dirección de correo electrónico debe ser la dirección de correo electrónico principal del usuario autenticado.
|
Campo de unión key_pair_configuration. key_pair_configuration puede ser una de las siguientes opciones:
|
primaryKeyPairId |
string
Si se asocia un par de claves, el ID del par de claves, CseKeyPair.
|
signAndEncryptKeyPairs |
object (SignAndEncryptKeyPairs)
La configuración de una identidad de CSE que usa diferentes pares de claves para la firma y la encriptación.
|
SignAndEncryptKeyPairs
La configuración de una identidad de CSE que usa diferentes pares de claves para la firma y la encriptación
| Representación JSON |
{
"signingKeyPairId": string,
"encryptionKeyPairId": string
} |
| Campos |
signingKeyPairId |
string
El ID del CseKeyPair que firma el correo saliente.
|
encryptionKeyPairId |
string
Es el ID del CseKeyPair que encripta el correo saliente firmado.
|
Métodos |
|
|
Crea y configura una identidad de encriptación del cliente que esté autorizada para enviar correo electrónico desde la cuenta de usuario. |
|
|
Borra una identidad de encriptación del cliente. |
|
|
Recupera una configuración de identidad de encriptación del cliente. |
|
|
Muestra una lista de las identidades encriptadas del cliente para un usuario autenticado. |
|
|
Asocia un par de claves diferente con una identidad de encriptación del cliente existente. |
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,["# REST Resource: users.settings.cse.identities\n\n- [Resource: CseIdentity](#CseIdentity)\n - [JSON representation](#CseIdentity.SCHEMA_REPRESENTATION)\n- [SignAndEncryptKeyPairs](#SignAndEncryptKeyPairs)\n - [JSON representation](#SignAndEncryptKeyPairs.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: CseIdentity\n---------------------\n\nThe client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email 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| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"emailAddress\": string, // Union field `key_pair_configuration` can be only one of the following: \"primaryKeyPairId\": string, \"signAndEncryptKeyPairs\": { object (/workspace/gmail/api/reference/rest/v1/users.settings.cse.identities#SignAndEncryptKeyPairs) } // End of list of possible types for union field `key_pair_configuration`. } ``` |\n\n| Fields ||\n|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `emailAddress` | `string` The email address for the sending identity. The email address must be the primary email address of the authenticated user. |\n| Union field `key_pair_configuration`. `key_pair_configuration` can be only one of the following: ||\n| `primaryKeyPairId` | `string` If a key pair is associated, the ID of the key pair, [CseKeyPair](/workspace/gmail/api/reference/rest/v1/users.settings.cse.keypairs#CseKeyPair). |\n| `signAndEncryptKeyPairs` | `object (`[SignAndEncryptKeyPairs](/workspace/gmail/api/reference/rest/v1/users.settings.cse.identities#SignAndEncryptKeyPairs)`)` The configuration of a CSE identity that uses different key pairs for signing and encryption. |\n\nSignAndEncryptKeyPairs\n----------------------\n\nThe configuration of a CSE identity that uses different key pairs for signing and encryption.\n\n| JSON representation |\n|-----------------------------------------------------------------------|\n| ``` { \"signingKeyPairId\": string, \"encryptionKeyPairId\": string } ``` |\n\n| Fields ||\n|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `signingKeyPairId` | `string` The ID of the [CseKeyPair](/workspace/gmail/api/reference/rest/v1/users.settings.cse.keypairs#CseKeyPair) that signs outgoing mail. |\n| `encryptionKeyPairId` | `string` The ID of the [CseKeyPair](/workspace/gmail/api/reference/rest/v1/users.settings.cse.keypairs#CseKeyPair) that encrypts signed outgoing mail. |\n\n| Methods ------- ||\n|-------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|\n| ### [create](/workspace/gmail/api/reference/rest/v1/users.settings.cse.identities/create) | Creates and configures a client-side encryption identity that's authorized to send mail from the user account. |\n| ### [delete](/workspace/gmail/api/reference/rest/v1/users.settings.cse.identities/delete) | Deletes a client-side encryption identity. |\n| ### [get](/workspace/gmail/api/reference/rest/v1/users.settings.cse.identities/get) | Retrieves a client-side encryption identity configuration. |\n| ### [list](/workspace/gmail/api/reference/rest/v1/users.settings.cse.identities/list) | Lists the client-side encrypted identities for an authenticated user. |\n| ### [patch](/workspace/gmail/api/reference/rest/v1/users.settings.cse.identities/patch) | Associates a different key pair with an existing client-side encryption identity. |"]]
