Method: users.watch

Observa si hay cambios en la lista de usuarios.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
domain

string

Es el nombre del dominio. Completa este campo para obtener usuarios de este dominio únicamente. Para que se muestren todos los usuarios en un campo de cliente con relleno de varios dominios.

customer

string

Es el ID inmutable de la cuenta de Google Workspace. En el caso de los dominios múltiples, para recuperar todos los usuarios de un cliente, complete este campo en lugar del dominio.

event

enum (EventType)

Eventos para tener en cuenta.

customFieldMask

string

Lista de nombres de esquema separados por comas. Se recuperan todos los campos de estos esquemas. Solo se debe establecer cuando proyección=custom.

maxResults

integer

Cantidad máxima de resultados que se mostrarán

orderBy

enum (OrderBy)

Columna para ordenar los resultados

pageToken

string

Token para especificar la página siguiente en la lista

projection

enum (Projection)

El subconjunto de campos que se debe recuperar para este usuario.

query

string

Búsqueda de cadenas de consulta. Debe tener el formato "". La documentación completa se encuentra en https: //developers.google.com/admin-sdk/directory/v1/guides/search-users

showDeleted

string

Si se configura como verdadera, recupera la lista de usuarios borrados. (Valor predeterminado: false)

sortOrder

enum (SortOrder)

Indica si se deben mostrar los resultados en orden ascendente o descendente.

viewType

enum (ViewType)

Indica si se debe recuperar la vista pública del usuario solo de administrador o de todo el dominio. Para obtener más información, consulta Cómo recuperar un usuario como no administrador.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene una instancia de SubscriptionChannel.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de SubscriptionChannel.

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

Para obtener más información, consulta la guía de autorización.

EventType

Tipo de evento de suscripción

Enumeradores
ADD Evento creado por el usuario
DELETE Evento borrado por el usuario
MAKE_ADMIN Evento de cambio de estado del administrador del usuario
UNDELETE Evento no borrado del usuario
UPDATE Evento actualizado del usuario

OrderBy

Enumeradores
EMAIL Es el correo electrónico principal del usuario.
FAMILY_NAME Apellido del usuario
GIVEN_NAME Es el nombre del usuario.

Proyección

Enumeradores
BASIC No incluyas ningún campo personalizado para el usuario.
CUSTOM Incluye campos personalizados de los esquemas mencionados en customFieldMask.
FULL Incluye todos los campos asociados con este usuario.

SortOrder

Enumeradores
ASCENDING Orden ascendente.
DESCENDING Orden descendente.

ViewType

Enumeradores
admin_view Los resultados incluyen los campos solo para administrador y para el dominio público.
domain_public Los resultados solo incluyen campos para el usuario que son visibles públicamente para otros usuarios del dominio.