REST Resource: users.settings.cse.identities
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recurso: CseIdentity
A configuração da criptografia do lado do cliente (CSE) para o endereço de e-mail de um usuário autenticado. O Gmail usa configurações de CSE para salvar rascunhos de mensagens de e-mail criptografadas do lado do cliente e para assinar e enviar mensagens de e-mail criptografadas.
Para administradores que gerenciam identidades e pares de chaves para usuários na organização, as solicitações exigem autorização com uma conta de serviço que tenha autoridade de delegação em todo o domínio para representar usuários com o escopo https://www.googleapis.com/auth/gmail.settings.basic
.
Para usuários que gerenciam as próprias identidades e pares de chaves, as solicitações exigem a criptografia de chaves de hardware ativada e configurada.
Representação 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
O endereço de e-mail da identidade do remetente. O endereço de e-mail precisa ser o principal do usuário autenticado.
|
Campo de união key_pair_configuration . key_pair_configuration pode ser apenas de um dos tipos a seguir:
|
primaryKeyPairId |
string
Se um par de chaves estiver associado, o ID do par de chaves, CseKeyPair .
|
signAndEncryptKeyPairs |
object (SignAndEncryptKeyPairs )
A configuração de uma identidade da CSE que usa pares de chaves diferentes para assinatura e criptografia.
|
SignAndEncryptKeyPairs
A configuração de uma identidade da CSE que usa pares de chaves diferentes para assinatura e criptografia.
Representação JSON |
{
"signingKeyPairId": string,
"encryptionKeyPairId": string
} |
Campos |
signingKeyPairId |
string
O ID do CseKeyPair que assina o e-mail de saída.
|
encryptionKeyPairId |
string
O ID do CseKeyPair que criptografa o e-mail de saída assinado.
|
Métodos |
|
Cria e configura uma identidade de criptografia do lado do cliente autorizada a enviar e-mails da conta do usuário. |
|
Exclui uma identidade de criptografia do lado do cliente. |
|
Recupera uma configuração de identidade de criptografia do lado do cliente. |
|
Lista as identidades criptografadas do lado do cliente de um usuário autenticado. |
|
Associa um par de chaves diferente a uma identidade de criptografia do lado do cliente. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 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. |"]]