Method: users.settings.cse.keypairs.list

Répertorie les paires de clés de chiffrement côté client pour un utilisateur authentifié.

Pour les administrateurs qui gèrent les identités et les paires de clés des utilisateurs de leur organisation, les demandes nécessitent une autorisation avec un compte de service disposant d'une autorité de délégation au niveau du domaine pour usurper l'identité des utilisateurs avec le champ d'application https://www.googleapis.com/auth/gmail.settings.basic.

Pour les utilisateurs qui gèrent leurs propres identités et paires de clés, les demandes nécessitent que le chiffrement par clé matérielle soit activé et configuré.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
userId

string

Adresse e-mail principale de la personne à l'origine de la demande. Pour indiquer l'utilisateur authentifié, vous pouvez utiliser la valeur spéciale me.

Paramètres de requête

Paramètres
pageToken

string

Jeton de pagination indiquant la page de paires de clés à renvoyer. Si le jeton n'est pas fourni, l'API renvoie la première page de résultats.
pageSize

integer

Nombre de paires de clés à renvoyer. Si aucune valeur n'est fournie, la taille de page est définie par défaut sur 20 entrées.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données présentant la structure suivante :

Représentation JSON 
{
  "cseKeyPairs": [
    {
      object (CseKeyPair)
    }
  ],
  "nextPageToken": string
}
Champs
cseKeyPairs[]

object (CseKeyPair)

Une page de la liste des paires de clés CSE installées pour l'utilisateur.
nextPageToken

string

Jeton de pagination à transmettre à un appel keypairs.list ultérieur afin de récupérer la page suivante de paires de clés. Si cette valeur n'est pas renvoyée, il ne reste plus aucune page.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • 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

Pour en savoir plus, consultez le guide d'autorisation.