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. Remplissez ce champ pour n'obtenir que les utilisateurs de ce domaine. Pour renvoyer tous les utilisateurs d'un remplissage multidomaine, utilisez 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 champ ne doit être défini que lorsque projection=custom.
maxResults

integer

Nombre maximal de résultats à renvoyer.
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 à récupérer pour cet utilisateur.
query

string

Recherche par chaîne de requête. Contient une ou plusieurs clauses de recherche, chacune avec un champ, un opérateur et une valeur. Pour obtenir la documentation complète, consultez Rechercher des utilisateurs.
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)

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

enum (ViewType)

Indique s'il faut récupérer la vue publique de l'utilisateur réservée aux administrateurs ou celle à l'échelle 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.

Niveaux d'accès 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 d'événement d'abonnement

Enums
ADD Événement créé par l'utilisateur
DELETE Événement "Utilisateur supprimé"
MAKE_ADMIN Événement de modification de l'état d'administrateur d'un utilisateur
UNDELETE Événement "Utilisateur récupéré"
UPDATE Événement "Utilisateur mis à jour"

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 mentionnés dans customFieldMask.
FULL Incluez tous les champs associés à cet utilisateur.

SortOrder

Enums
ASCENDING Ordre croissant.
DESCENDING Ordre décroissant.

ViewType

Enums
admin_view Les résultats incluent à la fois les champs réservés aux administrateurs et ceux 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.