Method: users.settings.cse.identities.list

Liste les identités chiffrées 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 requêtes nécessitent une autorisation avec un compte de service disposant d'une autorité de délégation à l'échelle du domaine pour emprunter 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/identities

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
userId

string

Adresse e-mail principale du demandeur. 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 d'identités à renvoyer. Si le jeton n'est pas fourni, l'API renvoie la première page de résultats.
pageSize

integer

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

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 
{
  "cseIdentities": [
    {
      object (CseIdentity)
    }
  ],
  "nextPageToken": string
}
Champs
cseIdentities[]

object (CseIdentity)

Page de la liste des identités CSE configurées pour l'utilisateur.
nextPageToken

string

Jeton de pagination à transmettre à un appel identities.list ultérieur afin de récupérer la page suivante d'identités. Si cette valeur n'est pas renvoyée ou est une chaîne vide, cela signifie qu'il n'y a plus de pages.

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 plus d'informations, consultez la OAuth 2.0 Overview.