Method: users.settings.cse.keypairs.list

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

Administratoren, die Identitäten und Schlüsselpaare für Nutzer in ihrer Organisation verwalten, müssen Anfragen mit einem Dienstkonto autorisieren, das domainweite Delegierungsberechtigungen hat, um Nutzer mit dem Bereich https://www.googleapis.com/auth/gmail.settings.basic zu imitieren.

Für Nutzer, die ihre eigenen Identitäten und Schlüsselpaare verwalten, muss die Hardware-Schlüsselverschlüsselung aktiviert und konfiguriert sein.

HTTP-Anfrage

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
userId

string

Die primäre E-Mail-Adresse des Antragstellers. Um den authentifizierten Nutzer anzugeben, können Sie den speziellen Wert me verwenden.

Suchparameter

Parameter
pageToken

string

Paginierungstoken, das angibt, welche Seite mit Schlüsselpaaren zurückgegeben werden soll. Wenn das Token nicht angegeben wird, gibt die API die erste Ergebnisseite zurück.

pageSize

integer

Die Anzahl der zurückzugebenden Schlüsselpaare. Wenn nichts angegeben ist, wird die Seitengröße standardmäßig auf 20 Einträge festgelegt.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

JSON-Darstellung
{
  "cseKeyPairs": [
    {
      object (CseKeyPair)
    }
  ],
  "nextPageToken": string
}
Felder
cseKeyPairs[]

object (CseKeyPair)

Eine Seite der Liste der für den Nutzer installierten Schlüsselpaare für die clientseitige Verschlüsselung.

nextPageToken

string

Paginierungstoken, das an einen nachfolgenden keypairs.list-Aufruf übergeben werden soll, um die nächste Seite mit Schlüsselpaaren abzurufen. Wenn dieser Wert nicht zurückgegeben wird, sind keine weiteren Seiten vorhanden.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/gmail.settings.basic
  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.settings.sharing

Weitere Informationen finden Sie unter OAuth 2.0 Overview.