REST Resource: users.settings.cse.keypairs

Ressource: CseKeyPair

Ein S/MIME-Schlüsselpaar mit clientseitiger 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, um die folgenden Aufgaben auszuführen:

  • Signieren Sie ausgehende clientseitig verschlüsselte Nachrichten.
  • Speichern Sie Entwürfe clientseitig verschlüsselter Nachrichten und öffnen Sie sie wieder.
  • Speichern Sie gesendete Nachrichten und öffnen Sie sie wieder.
  • Entschlüsseln Sie eingehende oder archivierte S/MIME-Nachrichten.
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-Armor verwenden.
pem

string

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

string

Nur Ausgabe. Die Identitäten der E-Mail-Adressen, die auf dem 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 gesetzt ist, wurde der Status des Schlüsselpaars von ENABLED zu DISABLED geändert. Dieses Feld ist nur vorhanden, wenn sich das Schlüsselpaar im Status DISABLED befindet.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
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 eingeschaltet. Alle E-Mails, die durch dieses Schlüsselpaar verschlüsselt werden, werden von Gmail entschlüsselt und alle ausgehenden E-Mails 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 E-Mails nicht 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 zum Deaktivieren eines Schlüsselpaars die Methode keypairs.disable.

CsePrivateKeyMetadata

Metadaten für eine Instanz mit privatem Schlüssel.

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 Variantentypen für Metadaten vorhanden sein. Für metadata_variant ist nur einer der folgenden Werte zulässig:
kaclsKeyMetadata

object (KaclsKeyMetadata)

Metadaten für eine Instanz mit einem privaten Schlüssel, die von einem externen Schlüssel für die Zugriffssteuerungsliste verwaltet wird.
hardwareKeyMetadata

object (HardwareKeyMetadata)

Metadaten für Hardwareschlüssel.

KaclsKeyMetadata

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

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

string

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

string

Intransparente Daten, die vom Key Access Control List-Dienst generiert und verwendet werden. Maximale Größe: 8 KiB.

HardwareKeyMetadata

Metadaten für Hardwareschlüssel.

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

string

Beschreibung des Hardwareschlüssels.

Methoden

create

 Erstellt eine clientseitige Verschlüsselung mit S/MIME-Zertifikatskette und Metadaten privater Schlüssel für den authentifizierten Nutzer und lädt sie hoch.

disable

 Deaktiviert ein clientseitiges Verschlüsselungsschlüsselpaar.

enable

 Aktiviert ein deaktiviertes clientseitiges Verschlüsselungsschlüsselpaar.

get

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

list

 Listet die Schlüsselpaare der clientseitigen Verschlüsselung für einen authentifizierten Nutzer auf.

obliterate

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