REST Resource: users.settings.cse.identities
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Ressource: CseIdentity
Configuration du chiffrement côté client (CSE) pour l'adresse e-mail d'un utilisateur authentifié. Gmail utilise les configurations CSE pour enregistrer des brouillons de messages e-mail chiffrés côté client, et pour signer et envoyer des messages e-mail chiffrés.
Pour les administrateurs qui gèrent les identités et les paires de clés des utilisateurs de leur organisation, les demandes nécessitent une autorisation avec un compte de service disposant d'une autorité de délégation au niveau du domaine pour usurper l'identité des utilisateurs avec le champ d'application https://www.googleapis.com/auth/gmail.settings.basic.
Pour les utilisateurs qui gèrent leurs propres identités et paires de clés, les demandes nécessitent que le chiffrement par clé matérielle soit activé et configuré.
| Représentation 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.
} |
| Champs |
emailAddress |
string
Adresse e-mail de l'identité d'envoi. L'adresse e-mail doit être l'adresse e-mail principale de l'utilisateur authentifié.
|
Champ d'union key_pair_configuration. key_pair_configuration ne peut être qu'un des éléments suivants :
|
primaryKeyPairId |
string
Si une paire de clés est associée, l'ID de la paire de clés, CseKeyPair.
|
signAndEncryptKeyPairs |
object (SignAndEncryptKeyPairs)
Configuration d'une identité CSE qui utilise différentes paires de clés pour la signature et le chiffrement.
|
SignAndEncryptKeyPairs
Configuration d'une identité CSE qui utilise différentes paires de clés pour la signature et le chiffrement.
| Représentation JSON |
{
"signingKeyPairId": string,
"encryptionKeyPairId": string
} |
| Champs |
signingKeyPairId |
string
ID de l'CseKeyPair qui signe le courrier sortant.
|
encryptionKeyPairId |
string
ID de l'CseKeyPair qui chiffre le courrier sortant signé.
|
Méthodes |
|
|
Crée et configure une identité de chiffrement côté client autorisée à envoyer des e-mails à partir du compte utilisateur. |
|
|
Supprime une identité de chiffrement côté client. |
|
|
Récupère une configuration d'identité de chiffrement côté client. |
|
|
Répertorie les identités chiffrées côté client d'un utilisateur authentifié. |
|
|
Associe une autre paire de clés à une identité de chiffrement côté client existante. |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 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. |"]]
