REST Resource: users.settings.cse.identities

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

create

Erstellt und konfiguriert eine clientseitige Verschlüsselungsidentität, die zum Senden von E-Mails über das Nutzerkonto berechtigt ist.

delete

Löscht eine Identität für die clientseitige Verschlüsselung.

get

Ruft eine Identitätskonfiguration für die clientseitige Verschlüsselung ab.

list

Listet die clientseitig verschlüsselten Identitäten für einen authentifizierten Nutzer auf.

patch

Hiermit wird einer vorhandenen Identität für die clientseitige Verschlüsselung ein anderes Schlüsselpaar zugewiesen.