Method: users.watch

Surveille les modifications apportées à la liste des utilisateurs.

Requête HTTP

POST https://admin.googleapis.com/admin/directory/v1/users/watch

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
domain

string

Nom du domaine. Complétez ce champ pour n'obtenir que des utilisateurs de ce domaine. Pour renvoyer tous les utilisateurs d'un domaine multidomaine, remplissez plutôt le champ "client"."

customer

string

ID immuable du compte Google Workspace. En cas de multidomaine, pour récupérer tous les utilisateurs d'un client, remplissez ce champ au lieu du domaine.

event

enum (EventType)

Événements à surveiller.

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. Ce paramètre ne doit être défini que lorsque projection=custom.

maxResults

integer

Nombre maximal de résultats sur une page.

orderBy

enum (OrderBy)

Colonne à utiliser pour trier les résultats

pageToken

string

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

projection

enum (Projection)

Sous-ensemble de champs à extraire pour cet utilisateur.

query

string

Recherche avec une chaîne de requête. Doit être au format "". La documentation complète est disponible à l'adresse https: //developers.google.com/workspace/admin/directory/v1/guides/search-users.

showDeleted

string

Si la valeur est définie sur "true", la liste des utilisateurs supprimés est récupérée. (valeur par défaut : "false")

sortOrder

enum (SortOrder)

Indique si les résultats doivent être renvoyés par ordre croissant ou décroissant.

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 contient une instance de SubscriptionChannel.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de SubscriptionChannel.

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.

EventType

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 Inclure les champs personnalisés des schémas mentionné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.
domain_public Les résultats n'incluent que les champs de l'utilisateur qui sont visibles publiquement par les autres utilisateurs du domaine.