Method: users.watch

Observa los 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 solo de este dominio. Para devolver todos los usuarios en un relleno de varios dominios, completa el campo del cliente".
customer

string

Es el ID inmutable de la cuenta de Google Workspace. En el caso de varios dominios, para recuperar todos los usuarios de un cliente, completa este campo en lugar del dominio.
event

enum (EventType)

Eventos que debes tener en cuenta
customFieldMask

string

Lista de nombres de esquemas separados por comas. Se recuperan todos los campos de estos esquemas. Solo se debe establecer cuando projection=custom.
maxResults

integer

Cantidad máxima de resultados que se mostrarán.
orderBy

enum (OrderBy)

Columna que se usará para ordenar los resultados
pageToken

string

Token para especificar la página siguiente en la lista
projection

enum (Projection)

Es el subconjunto de campos que se recuperará para este usuario.
query

string

Búsqueda de cadenas de consulta. Contiene una o más cláusulas de búsqueda, cada una con un campo, un operador y un valor. Para obtener la documentación completa, consulta Cómo buscar usuarios.
showDeleted

string

Si se establece como verdadero, recupera la lista de usuarios borrados. (Valor predeterminado: false)
sortOrder

enum (SortOrder)

Indica si se devuelven resultados en orden ascendente o descendente.
viewType

enum (ViewType)

Indica si se debe recuperar la vista pública del usuario solo para administradores o para 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 permisos 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

Enumeraciones
ADD Evento creado por el usuario
DELETE Evento de eliminación de usuario
MAKE_ADMIN Evento de cambio de estado de administrador de usuarios
UNDELETE Evento de recuperación de usuario
UPDATE Evento de usuario actualizado

OrderBy

Enumeraciones
EMAIL Es el correo electrónico principal del usuario.
FAMILY_NAME Apellido del usuario.
GIVEN_NAME Nombre del usuario.

Proyección

Enumeraciones
BASIC No se incluyen campos personalizados para el usuario.
CUSTOM Incluye los campos personalizados de los esquemas mencionados en customFieldMask.
FULL Incluye todos los campos asociados con este usuario.

SortOrder

Enumeraciones
ASCENDING Orden ascendente.
DESCENDING Orden descendente

ViewType

Enumeraciones
admin_view Los resultados incluyen campos solo para administradores y campos públicos del dominio.
domain_public Los resultados solo incluyen los campos del usuario que son visibles públicamente para otros usuarios del dominio.