Monitora 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 |
Nome do domínio. Preencha este campo para obter usuários apenas deste domínio. Para retornar todos os usuários em um campo de preenchimento de vários domínios." |
customer |
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 |
Eventos nos quais prestar atenção. |
customFieldMask |
Lista de nomes de esquema separada por vírgulas. Todos os campos desses esquemas são buscados. Isso só deve ser definido quando projection=custom. |
maxResults |
Número máximo de resultados a serem retornados. |
orderBy |
Coluna para usar na classificação dos resultados |
pageToken |
Token para especificar a próxima página na lista |
projection |
O subconjunto de campos a ser buscado para este usuário. |
query |
Pesquisa da string de consulta. Deve estar no formato " |
showDeleted |
Se definido como verdadeiro, recupera a lista de usuários excluídos. (Padrão: false) |
sortOrder |
Se os resultados serão retornados em ordem crescente ou decrescente. |
viewType |
Se deve buscar a visualização pública somente de administrador ou de todo o domínio do usuário. Para mais informações, consulte Recuperar um usuário como um 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 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 mais informações, consulte o Guia de autorização.
EventType
Tipo do evento de inscrição
Enums | |
---|---|
ADD |
Evento criado por usuário |
DELETE |
Evento excluído pelo usuário |
MAKE_ADMIN |
Evento de alteração de status de administrador de usuário |
UNDELETE |
Evento não excluído do usuário |
UPDATE |
Evento atualizado pelo usuário |
OrderBy
Enums | |
---|---|
EMAIL |
E-mail principal do usuário. |
FAMILY_NAME |
Sobrenome do usuário. |
GIVEN_NAME |
Nome do usuário. |
Projection
Enums | |
---|---|
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
Enums | |
---|---|
ASCENDING |
Ordem crescente. |
DESCENDING |
Ordem decrescente. |
Tipo de visualização
Enums | |
---|---|
admin_view |
Os resultados incluem campos apenas para o administrador e o domínio público. |
domain_public |
Os resultados incluem apenas campos do usuário visíveis publicamente para outros usuários no domínio. |