REST Resource: users.settings.cse.identities
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Ressource: CseIdentity
Die Konfiguration der clientseitigen Verschlüsselung (Client-Side Encryption, CSE) für die E-Mail-Adresse eines authentifizierten Nutzers. In Gmail werden CSE-Konfigurationen verwendet, um Entwürfe clientseitig verschlüsselter E-Mails zu speichern und verschlüsselte E-Mails zu signieren und zu senden.
Für Administratoren, die Identitäten und Schlüsselpaare für Nutzer in ihrer Organisation verwalten, ist für Anfragen eine Autorisierung mit einem Dienstkonto erforderlich, das domainweite Bevollmächtigung zur Identitätsübernahme von Nutzern mit dem Umfang https://www.googleapis.com/auth/gmail.settings.basic hat.
Für Nutzer, die ihre eigenen Identitäten und Schlüsselpaare verwalten, muss die Hardwareschlüsselverschlüsselung aktiviert und konfiguriert sein.
| JSON-Darstellung |
{
"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.
} |
| Felder |
emailAddress |
string
Die E-Mail-Adresse der Absenderidentität. Die E-Mail-Adresse muss die primäre E-Mail-Adresse des authentifizierten Nutzers sein.
|
Union-Feld key_pair_configuration. Für key_pair_configuration ist nur einer der folgenden Werte zulässig: |
primaryKeyPairId |
string
Wenn ein Schlüsselpaar verknüpft ist, die ID des Schlüsselpaars, CseKeyPair.
|
signAndEncryptKeyPairs |
object (SignAndEncryptKeyPairs)
Die Konfiguration einer CSE-Identität, die verschiedene Schlüsselpaare für die Signatur und Verschlüsselung verwendet.
|
SignAndEncryptKeyPairs
Die Konfiguration einer CSE-Identität, die verschiedene Schlüsselpaare für die Signatur und Verschlüsselung verwendet.
| JSON-Darstellung |
{
"signingKeyPairId": string,
"encryptionKeyPairId": string
} |
| Felder |
signingKeyPairId |
string
Die ID der CseKeyPair, die ausgehende E-Mails signiert.
|
encryptionKeyPairId |
string
Die ID der CseKeyPair, die signierte ausgehende E-Mails verschlüsselt.
|
Methoden |
|
|
Erstellt und konfiguriert eine clientseitige Verschlüsselungsidentität, die zum Senden von E-Mails über das Nutzerkonto berechtigt ist. |
|
|
Löscht eine Identität für die clientseitige Verschlüsselung. |
|
|
Ruft eine Identitätskonfiguration für die clientseitige Verschlüsselung ab. |
|
|
Listet die clientseitig verschlüsselten Identitäten für einen authentifizierten Nutzer auf. |
|
|
Hiermit wird einer vorhandenen Identität für die clientseitige Verschlüsselung ein anderes Schlüsselpaar zugewiesen. |
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[null,null,["Zuletzt aktualisiert: 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. |"]]
