Method: users.settings.cse.keypairs.list

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

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.

Abfrageparameter

Parameter
pageToken

string

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

pageSize

integer

Die Anzahl der zurückzugebenden Schlüsselpaare. Wenn nicht angegeben, 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 mit der Liste der für den Nutzer installierten CSE-Schlüsselpaare.

nextPageToken

string

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

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 im Leitfaden zur Autorisierung.