Method: users.list

Récupère une liste paginée des utilisateurs supprimés ou de tous les utilisateurs d'un domaine.

Requête HTTP

GET https://admin.googleapis.com/admin/directory/v1/users

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
customFieldMask

string

Liste de noms de schémas séparés par une virgule. Tous les champs de ces schémas sont récupérés. Il ne doit être défini que si projection=custom.
customer

string

Identifiant unique du compte Google Workspace du client. Dans le cas d'un compte multidomaine, pour récupérer tous les utilisateurs d'un client, utilisez ce champ à la place de domain. Vous pouvez également utiliser l'alias my_customer pour représenter le customerId de votre compte. Le customerId est également renvoyé dans le cadre de la ressource Users. Vous devez fournir le paramètre customer ou domain.
domain

string

Nom de domaine. Utilisez ce champ pour récupérer les utilisateurs d'un seul domaine. Pour renvoyer tous les domaines d'un compte client, utilisez plutôt le paramètre de requête customer. Vous devez indiquer soit le paramètre customer, soit le paramètre domain.
event

enum (Event)

Événement pour lequel l'abonnement est prévu (en cas d'abonnement)
maxResults

integer

Nombre maximal de résultats sur une page.
orderBy

enum (OrderBy)

Propriété à utiliser pour trier les résultats.
pageToken

string

Jeton permettant de spécifier la page suivante dans la liste
projection

enum (Projection)

Sous-ensemble de champs à extraire pour cet utilisateur.
query

string

Chaîne de requête pour la recherche de champs utilisateur. Pour plus d'informations sur la création de requêtes utilisateur, consultez la page Rechercher des utilisateurs.
showDeleted

string

Si la valeur est true, récupère la liste des comptes utilisateur supprimés. (Par défaut: false)
sortOrder

enum (SortOrder)

Indique si les résultats doivent être renvoyés par ordre croissant ou décroissant, en ignorant la casse.
viewType

enum (ViewType)

Permet d'extraire la vue publique réservée à l'administrateur ou au niveau du domaine pour l'utilisateur. Pour en savoir plus, consultez Récupérer un utilisateur en tant que non-administrateur.

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 
{
  "kind": string,
  "trigger_event": string,
  "etag": string,
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
Champs
kind

string

Type de ressource dont il s'agit.
trigger_event

string

Événement ayant déclenché cette réponse (utilisé uniquement en cas de réponse push)
etag

string

ETag de la ressource.
users[]

object (User)

Une liste d'objets utilisateur.
nextPageToken

string

Jeton utilisé pour accéder à la page suivante de ce résultat.

Champs d'application des autorisations

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

  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.user.readonly
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez le Guide relatif aux autorisations.

Événement

Type d'événement d'abonnement

Enums
ADD Événement créé par l'utilisateur
DELETE Événement supprimé par un utilisateur
MAKE_ADMIN Événement de modification du statut de l'administrateur des utilisateurs
UNDELETE Événement d'utilisateur non supprimé
UPDATE Événement mis à jour par l'utilisateur

OrderBy

Enums
EMAIL Adresse e-mail principale de l'utilisateur.
FAMILY_NAME Nom de famille de l'utilisateur.
GIVEN_NAME Prénom de l'utilisateur.

Projection

Enums
BASIC N'incluez aucun champ personnalisé pour l'utilisateur.
CUSTOM Inclure les champs personnalisés des schémas demandés dans customFieldMask.
FULL Inclure tous les champs associés à cet utilisateur.

SortOrder

Enums
ASCENDING Ordre croissant.
DESCENDING Ordre décroissant.

ViewType

Enums
admin_view Les résultats comprennent à la fois des champs réservés à l'administrateur et des champs publics du domaine pour l'utilisateur.
domain_public Les résultats comprennent uniquement des champs de l'utilisateur visibles publiquement par les autres utilisateurs du domaine.