Method: users.watch

Observa as alterações 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 acessar apenas usuários deste domínio. Para retornar todos os usuários em um multidomínio, preencha o campo do cliente".
customer

string

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

enum (EventType)

Eventos a serem observados.
customFieldMask

string

Lista separada por vírgulas de nomes de esquemas. 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 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. Deve estar no formato "". A documentação completa está em https: //developers.google.com/admin-sdk/directory/v1/guides/search-users
showDeleted

string

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

enum (SortOrder)

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

enum (ViewType)

Define se a visualização pública do usuário será buscada somente pelo administrador ou em todo o domínio. Para mais informações, consulte Recuperar um usuário que 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 inscrição

Tipos enumerados
ADD Evento criado pelo usuário
DELETE Evento excluído pelo usuário
MAKE_ADMIN Evento de alteração de status do administrador de usuários
UNDELETE Evento de usuário cancelado
UPDATE Evento atualizado pelo usuário

OrderBy

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

Projeção

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

SortOrder

Tipos enumerados
ASCENDING Ordem crescente.
DESCENDING Ordem decrescente.

ViewType

Tipos enumerados
admin_view Os resultados incluem campos somente para administradores e domínios públicos.
domain_public Os resultados incluem apenas os campos do usuário visíveis publicamente para outros usuários no domínio.