REST Resource: users.settings.cse.keypairs

Ressource: CseKeyPair

Ein S/MIME-Schlüsselpaar für die clientseitige Verschlüsselung, das aus einem öffentlichen Schlüssel, seiner Zertifikatskette und Metadaten für den zugehörigen privaten Schlüssel besteht. Gmail verwendet das Schlüsselpaar für die folgenden Aufgaben:

  • Ausgehende clientseitig verschlüsselte Nachrichten signieren
  • Entwürfe von clientseitig verschlüsselten Nachrichten speichern und wieder öffnen
  • Gesendete Nachrichten speichern und wieder öffnen
  • Eingehende oder archivierte S/MIME-Nachrichten entschlüsseln

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 
{
  "keyPairId": string,
  "pkcs7": string,
  "pem": string,
  "subjectEmailAddresses": [
    string
  ],
  "enablementState": enum (EnablementState),
  "disableTime": string,
  "privateKeyMetadata": [
    {
      object (CsePrivateKeyMetadata)
    }
  ]
}
Felder
keyPairId

string

Nur Ausgabe. Die unveränderliche ID für das S/MIME-Schlüsselpaar der clientseitigen Verschlüsselung.
pkcs7

string

Nur Eingabe. Der öffentliche Schlüssel und seine Zertifikatskette. Die Kette muss im PKCS#7-Format vorliegen und PEM-Codierung und ASCII-Armierung verwenden.
pem

string

Nur Ausgabe. Der öffentliche Schlüssel und die zugehörige Zertifikatskette im PEM-Format.
subjectEmailAddresses[]

string

Nur Ausgabe. Die E-Mail-Adressenidentitäten, die im untergeordneten Zertifikat angegeben sind.
enablementState

enum (EnablementState)

Nur Ausgabe. Der aktuelle Status des Schlüsselpaars.
disableTime

string (Timestamp format)

Nur Ausgabe. Wenn ein Schlüsselpaar auf DISABLED festgelegt ist, ist das die Zeit, zu der sich der Status des Schlüsselpaars von ENABLED in DISABLED geändert hat. Dieses Feld ist nur vorhanden, wenn sich das Schlüsselpaar im Status DISABLED befindet.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

Metadaten für Instanzen des privaten Schlüssels dieses Schlüsselpaars.

EnablementState

Die Aufzählung für den aktuellen Status des Schlüsselpaars.

Enums
stateUnspecified Der aktuelle Status des Schlüsselpaars ist nicht festgelegt. Das Schlüsselpaar ist weder aktiviert noch deaktiviert.
enabled

Das Schlüsselpaar ist aktiviert. Alle E-Mails, die mit diesem Schlüsselpaar verschlüsselt werden, werden in Gmail entschlüsselt und ausgehende E-Mails werden mit dem privaten Schlüssel signiert.

Verwenden Sie die Methode keypairs.enable, um ein Schlüsselpaar zu aktivieren.
disabled

Das Schlüsselpaar ist deaktiviert. Authentifizierte Nutzer können keine E-Mails entschlüsseln und keine ausgehenden E-Mails signieren. Wenn ein Schlüsselpaar länger als 30 Tage deaktiviert ist, können Sie es endgültig löschen.

Verwenden Sie die Methode keypairs.disable, um ein Schlüsselpaar zu deaktivieren.

CsePrivateKeyMetadata

Metadaten für eine private Schlüsselinstanz.

JSON-Darstellung 
{
  "privateKeyMetadataId": string,

  // Union field metadata_variant can be only one of the following:
  "kaclsKeyMetadata": {
    object (KaclsKeyMetadata)
  },
  "hardwareKeyMetadata": {
    object (HardwareKeyMetadata)
  }
  // End of list of possible types for union field metadata_variant.
}
Felder
privateKeyMetadataId

string

Nur Ausgabe. Die unveränderliche ID für die Metadateninstanz des privaten Schlüssels.
Union-Feld metadata_variant. Union-Feld: Es muss genau einer der folgenden Metadatenvariantentypen vorhanden sein. Für metadata_variant ist nur einer der folgenden Werte zulässig:
kaclsKeyMetadata

object (KaclsKeyMetadata)

Metadaten für eine private Schlüsselinstanz, die von einem externen Dienst für die Zugriffssteuerungsliste für Schlüssel verwaltet wird.
hardwareKeyMetadata

object (HardwareKeyMetadata)

Metadaten für Hardwareschlüssel.

KaclsKeyMetadata

Metadaten für private Schlüssel, die von einem externen Dienst für die Zugriffssteuerungsliste für Schlüssel verwaltet werden. Weitere Informationen zum Verwalten des Schlüsselzugriffs finden Sie in der Google Workspace CSE API-Referenz.

JSON-Darstellung 
{
  "kaclsUri": string,
  "kaclsData": string
}
Felder
kaclsUri

string

Der URI des Schlüssel-ACL-Dienstes, der den privaten Schlüssel verwaltet.
kaclsData

string

Undurchsichtige Daten, die vom Dienst „Schlüssel-ACL“ generiert und verwendet werden. Maximale Größe: 8 KiB.

HardwareKeyMetadata

Metadaten für Hardwareschlüssel.

Wenn die Verschlüsselung mit Hardwareschlüsseln für die Google Workspace-Organisation eingerichtet ist, können Nutzer ihren privaten Schlüssel optional auf ihrer Smartcard speichern und damit E-Mails in Gmail signieren und entschlüsseln. Dazu müssen sie ihre Smartcard in ein Lesegerät einstecken, das an ihrem Windows-Gerät angeschlossen ist.

JSON-Darstellung 
{
  "description": string
}
Felder
description

string

Beschreibung des Hardwareschlüssels.

Methoden

create

 Erstellt und lädt eine clientseitige Verschlüsselung mit einer S/MIME-Zertifikatskette des öffentlichen Schlüssels und Metadaten des privaten Schlüssels für den authentifizierten Nutzer hoch.

disable

 Deaktiviert ein Schlüsselpaar für die clientseitige Verschlüsselung.

enable

 Aktiviert ein deaktiviertes Schlüsselpaar für die clientseitige Verschlüsselung.

get

 Ruft ein vorhandenes Schlüsselpaar für die clientseitige Verschlüsselung ab.

list

 Listet clientseitige Verschlüsselungsschlüsselpaare für einen authentifizierten Nutzer auf.

obliterate

 Löscht ein clientseitiges Verschlüsselungsschlüsselpaar endgültig und sofort.