Method: users.settings.cse.keypairs.list

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

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.

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. Sie können den speziellen Wert me verwenden, um den authentifizierten Nutzer anzugeben.

Abfrageparameter

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 keine Angabe erfolgt, wird standardmäßig eine Seitengröße von 20 Einträgen verwendet.

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 clientseitigen Verschlüsselungsschlüsselpaare.
nextPageToken

string

Paginierungstoken, das an einen nachfolgenden Aufruf von „keypairs.list“ übergeben wird, um die nächste Seite mit Schlüsselpaaren abzurufen. Wenn dieser Wert nicht zurückgegeben wird, gibt es 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.