REST Resource: users.settings.cse.identities
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Zasób: CseIdentity
Konfiguracja szyfrowania po stronie klienta (CSE) dla adresu e-mail uwierzytelnionego użytkownika. Gmail używa konfiguracji szyfrowania po stronie klienta do zapisywania wersji roboczych e-maili zaszyfrowanych po stronie klienta oraz do podpisywania i wysyłania zaszyfrowanych e-maili.
W przypadku administratorów zarządzających tożsamościami i parami kluczy użytkowników w organizacji prośby wymagają autoryzacji konta usługi, które ma uprawnienia do delegowania uprawnień w całej domenie, aby podszywać się pod użytkowników w zakresie https://www.googleapis.com/auth/gmail.settings.basic.
W przypadku użytkowników zarządzających własnymi tożsamościami i parami kluczy żądania wymagają włączenia i skonfigurowania szyfrowania za pomocą klucza sprzętowego.
| Zapis 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.
} |
| Pola |
emailAddress |
string
Adres e-mail tożsamości nadawcy. Adres e-mail musi być głównym adresem e-mail uwierzytelnionego użytkownika.
|
Pole unii key_pair_configuration. key_pair_configuration może być tylko jednym z tych elementów:
|
primaryKeyPairId |
string
Jeśli jest powiązana para kluczy, identyfikator tej pary, CseKeyPair.
|
signAndEncryptKeyPairs |
object (SignAndEncryptKeyPairs)
Konfiguracja tożsamości szyfrowania po stronie klienta, która używa różnych par kluczy do podpisywania i szyfrowania.
|
SignAndEncryptKeyPairs
Konfiguracja tożsamości szyfrowania po stronie klienta, która używa różnych par kluczy do podpisywania i szyfrowania.
| Zapis JSON |
{
"signingKeyPairId": string,
"encryptionKeyPairId": string
} |
| Pola |
signingKeyPairId |
string
Identyfikator CseKeyPair, który podpisuje wychodzące e-maile.
|
encryptionKeyPairId |
string
Identyfikator CseKeyPair, który szyfruje podpisane wychodzące wiadomości e-mail.
|
Metody |
|
|
Tworzy i konfiguruje tożsamość szyfrowania po stronie klienta, która ma uprawnienia do wysyłania poczty z konta użytkownika. |
|
|
Usuwa tożsamość szyfrowania po stronie klienta. |
|
|
Pobiera konfigurację tożsamości szyfrowania po stronie klienta. |
|
|
Wyświetla listę tożsamości zaszyfrowanych po stronie klienta dla uwierzytelnionego użytkownika. |
|
|
Powiązanie innego klucza pary z istniejącą tożsamością szyfrowania po stronie klienta. |
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[null,null,["Ostatnia aktualizacja: 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. |"]]
