Method: users.list

Récupère une liste paginée d'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. Cette valeur ne doit être définie que lorsque 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 au lieu de domain. Vous pouvez également utiliser l'alias my_customer pour représenter le customerId de votre compte. customerId est également renvoyé dans la ressource Users (Utilisateurs). Vous devez fournir le paramètre customer ou domain.
domain

string

Nom du domaine. Utilisez ce champ pour obtenir des utilisateurs provenant 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 customer ou domain.
event

enum (Event)

Événement auquel l'abonnement est destiné (si 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 de la liste. Le jeton de page n'est valide que pendant trois jours.
projection

enum (Projection)

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

string

Chaîne de requête pour rechercher des champs utilisateur. Pour en savoir plus sur la création de requêtes utilisateur, consultez Rechercher des utilisateurs.
showDeleted

string

Si la valeur est true, la liste des utilisateurs supprimés est récupérée. (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)

Indique si la vue publique de l'utilisateur doit être récupérée pour les administrateurs uniquement ou pour l'ensemble du domaine. 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
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)

Liste d'objets utilisateur.
nextPageToken

string

Jeton utilisé pour accéder à la page suivante de ce résultat. Le jeton de page n'est valide que pendant trois jours.

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 d'autorisation.

Événement

Type de l'événement "Subscription" (Abonnement)

Enums
ADD Événement créé par l'utilisateur
DELETE Événement "Utilisateur supprimé"
MAKE_ADMIN Événement de modification de l'état de l'administrateur des utilisateurs
UNDELETE Événement de non-suppression d'un compte utilisateur
UPDATE Événement de mise à jour de 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 Incluez les champs personnalisés des schémas demandés dans customFieldMask.
FULL Incluez tous les champs associés à cet utilisateur.

SortOrder

Enums
ASCENDING par ordre croissant.
DESCENDING Ordre décroissant.

ViewType

Enums
admin_view Les résultats incluent à la fois les champs réservés aux administrateurs et les champs publics du domaine pour l'utilisateur.
domain_public Les résultats n'incluent que les champs de l'utilisateur qui sont visibles publiquement par les autres utilisateurs du domaine.