Monitorowanie zmian na liście użytkowników.
Żądanie HTTP
POST https://admin.googleapis.com/admin/directory/v1/users/watch
Adres URL używa składni transkodowania gRPC.
Parametry zapytania
Parametry | |
---|---|
domain |
Nazwa domeny. Aby dodać użytkowników tylko z tej domeny, wypełnij to pole. Aby zwrócić wszystkich użytkowników z wielu domen, wypełnij pole klienta. |
customer |
Stały identyfikator konta Google Workspace. Jeśli pobierasz dane wszystkich użytkowników klienta z wieloma domenami, wypełnij to pole zamiast domeny. |
event |
Wydarzenia, które warto obserwować. |
customFieldMask |
Lista nazw schematów oddzielonych przecinkami. Wszystkie pola z tych schematów są pobierane. Należy go ustawić tylko wtedy, gdy odwzorowanie=niestandardowe. |
maxResults |
Maksymalna liczba wyników do zwrócenia. |
orderBy |
Kolumna używana do sortowania wyników |
pageToken |
Token do określenia następnej strony na liście |
projection |
Podzbiór pól do pobrania dla tego użytkownika. |
query |
Wyszukiwanie ciągu zapytania. Dokument powinien mieć postać „ |
showDeleted |
Jeśli ma wartość Prawda, pobiera listę usuniętych kont użytkowników. (Domyślnie: Fałsz) |
sortOrder |
Określa, czy funkcja ma zwrócić wyniki w kolejności rosnącej czy malejącej. |
viewType |
Określa, czy chcesz pobierać publiczne dane użytkownika tylko dla administratora czy z całej domeny. Więcej informacji znajdziesz w artykule Pobieranie konta użytkownika bez uprawnień administratora. |
Treść żądania
Treść żądania zawiera wystąpienie elementu SubscriptionChannel
.
Treść odpowiedzi
W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu SubscriptionChannel
.
Zakresy autoryzacji
Wymaga jednego z tych zakresów 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
Więcej informacji znajdziesz w przewodniku po autoryzacji.
Typ zdarzenia
Typ zdarzenia Subskrypcja
Wartości w polu enum | |
---|---|
ADD |
Zdarzenie utworzone przez użytkownika |
DELETE |
Wydarzenie usunięte przez użytkownika |
MAKE_ADMIN |
Zdarzenie zmiany stanu administratora |
UNDELETE |
Wydarzenie przywrócone przez użytkownika |
UPDATE |
Zdarzenie zaktualizowane przez użytkownika |
Według
Wartości w polu enum | |
---|---|
EMAIL |
Główny adres e-mail użytkownika. |
FAMILY_NAME |
Nazwisko użytkownika. |
GIVEN_NAME |
Imię użytkownika. |
Odwzorowanie
Wartości w polu enum | |
---|---|
BASIC |
Nie dodawaj żadnych pól niestandardowych dla użytkownika. |
CUSTOM |
Uwzględnij pola niestandardowe ze schematów wspomnianych w polu customFieldMask. |
FULL |
Uwzględnij wszystkie pola powiązane z tym użytkownikiem. |
SortOrder
Wartości w polu enum | |
---|---|
ASCENDING |
Kolejność rosnąca. |
DESCENDING |
Malejąco. |
Typ widoku
Wartości w polu enum | |
---|---|
admin_view |
Wyniki obejmują pola przeznaczone tylko dla administratorów i publiczne. |
domain_public |
Wyniki obejmują tylko pola użytkownika, które są widoczne publicznie dla innych użytkowników domeny. |