Method: users.watch

Monitora 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 apenas deste domínio. Para retornar todos os usuários em um preenchimento de vários domínios, use o campo "Cliente"."
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írgula. Todos os campos desses esquemas são buscados. Isso 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 na lista.
projection

enum (Projection)

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

string

Pesquisa de string de consulta. Contém uma ou mais cláusulas de pesquisa, cada uma com um campo, um operador e um valor. Para ver a documentação completa, acesse Pesquisar usuários.
showDeleted

string

Se definido como verdadeiro, 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)

Se é para buscar a visualização pública do usuário somente para administradores ou em 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 do evento de assinatura.

Tipos enumerados
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 cancelamento de exclusão de usuário
UPDATE Evento de atualização do usuário

OrderBy

Tipos enumerados
EMAIL E-mail principal do usuário.
FAMILY_NAME O sobrenome do usuário.
GIVEN_NAME O nome do usuário.

Projeção

Tipos enumerados
BASIC Não inclua campos personalizados para o usuário.
CUSTOM Inclui campos personalizados dos esquemas mencionados em customFieldMask.
FULL Inclua todos os campos associados a esse usuário.

SortOrder

Tipos enumerados
ASCENDING Ordem crescente.
DESCENDING Ordem decrescente.

ViewType

Tipos enumerados
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 estão visíveis publicamente para outros usuários no domínio.