Resource: CseIdentity
The 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.
For administrators managing identities and keypairs for users in their organization, requests require authorization with a service account
that has domain-wide delegation authority
to impersonate users with the https://www.googleapis.com/auth/gmail.settings.basic
scope.
For users managing their own identities and keypairs, requests require hardware key encryption turned on and configured.
| JSON representation |
|---|
{ "emailAddress" : string , // Union field |
emailAddress
string
The email address for the sending identity. The email address must be the primary email address of the authenticated user.
Union field key_pair_configuration
.
key_pair_configuration
can be only one of the following:
primaryKeyPairId
string
If a key pair is associated, the ID of the key pair, CseKeyPair
.
signAndEncryptKeyPairs
object (
SignAndEncryptKeyPairs
)
The configuration of a CSE identity that uses different key pairs for signing and encryption.
SignAndEncryptKeyPairs
The configuration of a CSE identity that uses different key pairs for signing and encryption.
| JSON representation |
|---|
{ "signingKeyPairId" : string , "encryptionKeyPairId" : string } |
| Fields | |
|---|---|
signingKeyPairId
|
The ID of the |
encryptionKeyPairId
|
The ID of the |
Methods |
|
|---|---|
|
Creates and configures a client-side encryption identity that's authorized to send mail from the user account. |
|
Deletes a client-side encryption identity. |
|
Retrieves a client-side encryption identity configuration. |
|
Lists the client-side encrypted identities for an authenticated user. |
|
Associates a different key pair with an existing client-side encryption identity. |
