Method: users.watch

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Observa 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

Nombre del dominio. Completa este campo para obtener usuarios de este dominio únicamente. Si, en cambio, desea mostrar todos los usuarios en un campo de cliente con propósito de varios dominios,

customer

string

Es el ID inmutable de la cuenta de Google Workspace. En el caso de dominios múltiples, a fin de 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 esquemas separados por comas. Se recuperan todos los campos de estos esquemas. Solo se debe configurar cuando se usa 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)

El subconjunto de campos que se 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 establece como verdadera, recupera la lista de usuarios borrados. (Predeterminado: falso)

sortOrder

enum (SortOrder)

Indica si se muestran resultados en orden ascendente o descendente.

viewType

enum (ViewType)

Indica si se debe recuperar la vista pública del usuario exclusiva para el administrador 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 incluye 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 la 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 Descripción general de OAuth 2.0.

EventType

Tipo de evento de suscripción

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

OrderBy

Enumeradores
EMAIL Correo electrónico principal del usuario.
FAMILY_NAME Apellido del usuario.
GIVEN_NAME Nombre del usuario.

Proyección

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

SortOrder

Enumeradores
ASCENDING Orden ascendente
DESCENDING Orden descendente.

Tipo de vista

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