Method: users.watch

Observa mudanças na lista de usuários.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
domain

string

Nome do domínio. Preencha este campo para receber usuários somente deste domínio. Para retornar todos os usuários em um campo de preenchimento do cliente com vários domínios."
customer

string

ID imutável da conta do Google Workspace. No caso de vários domínios, para buscar todos os usuários de um cliente, preencha este campo em vez de "domain".
event

enum (EventType)

Eventos a serem observados.
customFieldMask

string

Lista de nomes de esquemas separados por vírgulas. Todos os campos desses esquemas são buscados. Ele só deve ser definido quando projection=custom.
maxResults

integer

Número máximo de resultados a serem retornados.
orderBy

enum (OrderBy)

Coluna a ser usada para classificar os resultados
pageToken

string

Token para especificar a próxima página da lista
projection

enum (Projection)

Qual subconjunto de campos buscar para esse usuário.
query

string

Pesquisa de string de consulta. Precisa estar no formato "". A documentação completa está em https: //developers.google.com/workspace/admin/directory/v1/guides/search-users
showDeleted

string

Se definido como "true", recupera a lista de usuários excluídos. (Padrão: false)
sortOrder

enum (SortOrder)

Se os resultados serão retornados em ordem crescente ou decrescente.
viewType

enum (ViewType)

Indica se a visualização pública do usuário é somente para administradores ou para todo o domínio. Para mais informações, consulte Recuperar um usuário como não administrador.

Corpo da solicitação

O corpo da solicitação contém uma instância de SubscriptionChannel.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de SubscriptionChannel.

Escopos de autorização

Requer um dos seguintes escopos do 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 mais informações, consulte o guia de autorização.

EventType

Tipo de evento de assinatura

Enums
ADD Evento criado pelo usuário
DELETE Evento de exclusão de usuário
MAKE_ADMIN Evento de mudança de status de administrador do usuário
UNDELETE Evento de restauração de exclusão do usuário
UPDATE Evento de atualização do usuário

OrderBy

Enums
EMAIL E-mail principal do usuário.
FAMILY_NAME Sobrenome do usuário.
GIVEN_NAME Nome do usuário.

Projeção

Enums
BASIC Não inclua campos personalizados para o usuário.
CUSTOM Incluir campos personalizados de esquemas mencionados em customFieldMask.
FULL Inclua todos os campos associados a esse usuário.

SortOrder

Enums
ASCENDING Ordem crescente.
DESCENDING Ordem decrescente.

ViewType

Enums
admin_view Os resultados incluem campos somente para administradores e públicos do domínio.
domain_public Os resultados incluem apenas os campos do usuário que são visíveis publicamente para outros usuários no domínio.