REST Resource: users.settings.cse.identities
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Ресурс: CseIdentity
Конфигурация шифрования на стороне клиента (CSE) для адреса электронной почты аутентифицированного пользователя. Gmail использует конфигурации CSE для сохранения черновиков зашифрованных на стороне клиента сообщений электронной почты, а также для подписи и отправки зашифрованных сообщений электронной почты.
Для администраторов, управляющих удостоверениями и парами ключей для пользователей в своей организации, запросы требуют авторизации с помощью учетной записи службы , имеющей полномочия делегирования полномочий на уровне домена для выдачи себя за пользователей с областью действия https://www.googleapis.com/auth/gmail.settings.basic .
Для пользователей, управляющих своими собственными удостоверениями и парами ключей, запросы требуют включения и настройки аппаратного шифрования ключей .
| 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.
} |
| Поля |
|---|
emailAddress | string Адрес электронной почты для отправляющей личности. Адрес электронной почты должен быть основным адресом электронной почты аутентифицированного пользователя. |
Объединение полей key_pair_configuration . key_pair_configuration может быть только одним из следующих: |
primaryKeyPairId | string Если пара ключей связана, идентификатор пары ключей CseKeyPair . |
signAndEncryptKeyPairs | object ( SignAndEncryptKeyPairs ) Конфигурация удостоверения CSE, использующая разные пары ключей для подписи и шифрования. |
Подписать и зашифровать пары ключей
Конфигурация удостоверения CSE, использующая разные пары ключей для подписи и шифрования.
| JSON-представление |
|---|
{
"signingKeyPairId": string,
"encryptionKeyPairId": string
} |
| Поля |
|---|
signingKeyPairId | string Идентификатор CseKeyPair , который подписывает исходящую почту. |
encryptionKeyPairId | string Идентификатор CseKeyPair , который шифрует подписанную исходящую почту. |
Методы |
|---|
| Создает и настраивает клиентский идентификатор шифрования, который авторизован для отправки почты из учетной записи пользователя. |
| Удаляет идентификатор шифрования на стороне клиента. |
| Извлекает конфигурацию идентификатора шифрования на стороне клиента. |
| Перечисляет зашифрованные на стороне клиента идентификаторы для аутентифицированного пользователя. |
| Связывает другую пару ключей с существующим идентификатором шифрования на стороне клиента. |
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[null,null,["Последнее обновление: 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. |"]]
