Method: users.watch

Detecta 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 mostrar todos los usuarios en un campo de cliente de varios dominios, completa el campo "customer".
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 a 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)

Es la 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án 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/workspace/admin/directory/v1/guides/search-users
showDeleted

string

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

enum (SortOrder)

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 Subscription

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 actualización del usuario

OrderBy

Enumeraciones
EMAIL Es el correo electrónico principal del usuario.
FAMILY_NAME Es el apellido del usuario.
GIVEN_NAME Es el nombre del usuario.

Proyección

Enumeraciones
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

Enumeraciones
ASCENDING Orden ascendente.
DESCENDING Orden descendente.

ViewType

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