Method: domains.users.list

Répertorie les utilisateurs qui ont accès à un domaine.

Requête HTTP

GET https://gmailpostmastertools.googleapis.com/v2beta/{parent=domains/*}/users

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de la ressource parent pour laquelle vous souhaitez répertorier les utilisateurs. Format: domains/{domain}

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Taille de la page demandée. Le serveur peut renvoyer moins d'utilisateurs que demandé. Si aucune valeur n'est spécifiée, la valeur par défaut de ce champ est 10. La valeur maximale de ce champ est 200.
pageToken

string

Facultatif. La valeur nextPageToken affichée par une requête "List" antérieure, le cas échéant.

Corps de la requête

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

Corps de la réponse

Message de réponse pour users.list.

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

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

object (User)

Les utilisateurs qui ont accès au domaine.
nextPageToken

string

Jeton permettant de récupérer la page suivante des résultats ou non renseigné si la liste ne contient plus de résultats.

Niveaux d'accès des autorisations

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

  • https://www.googleapis.com/auth/postmaster
  • https://www.googleapis.com/auth/postmaster.user

Pour en savoir plus, consultez le guide sur l'autorisation.