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 folgende Aufgaben:

  • Ausgehende clientseitig verschlüsselte Nachrichten signieren
  • Entwürfe clientseitig verschlüsselter 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, erfordern Anfragen eine Autorisierung mit einem Dienstkonto, das die domänenweite Delegierungsberechtigung hat, Nutzer mit dem https://www.googleapis.com/auth/gmail.settings.basic Bereich zu vertreten.

Für Nutzer, die ihre eigenen Identitäten und Schlüsselpaare verwalten, muss die Verschlüsselung mit Hardwareschlüsseln 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 für die clientseitige Verschlüsselung.
pkcs7

string

Nur Eingabe. Der öffentliche Schlüssel und seine Zertifikatskette. Die Kette muss das PKCS#7-Format haben und die PEM-Codierung und ASCII-Armor verwenden.
pem

string

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

string

Nur Ausgabe. Die E‑Mail-Adressidentitäten, die im Blattzertifikat angegeben sind.
enablementState

enum (EnablementState)

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

string (Timestamp format)

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

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. 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üsselpaares.

EnablementState

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

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

Das Schlüsselpaar ist aktiviert. Für alle E‑Mails, die mit diesem Schlüsselpaar verschlüsselt werden, entschlüsselt Gmail die Nachrichten und signiert alle ausgehenden Nachrichten mit dem privaten Schlüssel.

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 Nachrichten 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 Instanz eines privaten Schlüssels.

JSON-Darstellung 
{
  "privateKeyMetadataId": string,

  "kaclsKeyMetadata": {
    object (KaclsKeyMetadata)
  },
  "hardwareKeyMetadata": {
    object (HardwareKeyMetadata)
  }
}
Felder
privateKeyMetadataId

string

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

object (KaclsKeyMetadata)

Metadaten für eine Instanz eines privaten Schlüssels, 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

Die URI des Dienstes für die Zugriffssteuerungsliste für Schlüssel, der den privaten Schlüssel verwaltet.
kaclsData

string

Opake Daten, die vom Dienst für die Zugriffssteuerungsliste für Schlüssel 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 S/MIME-Zertifikatskette für den öffentlichen Schlüssel und Metadaten für den privaten Schlüssel für die clientseitige Verschlüsselung 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 Schlüsselpaare für die clientseitige Verschlüsselung für einen authentifizierten Nutzer auf.

obliterate

 Löscht ein Schlüsselpaar für die clientseitige Verschlüsselung endgültig und sofort.