Czeka na zmiany 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. Wypełnij to pole, aby uzyskać dostęp tylko z tej domeny. Aby wyświetlić wszystkie konta użytkowników w wielu domenach, wypełnij pole klienta." |
customer |
Stały identyfikator konta Google Workspace. W przypadku wielu domen aby wypełnić wszystkie pola na koncie klienta, wypełnij to pole zamiast domeny. |
event |
Zdarzenia do obejrzenia. |
customFieldMask |
Rozdzielana przecinkami lista nazw schematów. Wszystkie pola z tych schematów są pobierane. Należy ją ustawić tylko wtedy, gdy projekcja=niestandardowa. |
maxResults |
Maksymalna liczba wyników do zwrócenia. |
orderBy |
Kolumna używana do sortowania wyników |
pageToken |
Token, który określa następną stronę na liście |
projection |
Podzbiór pól do pobrania dla tego użytkownika. |
query |
Ciąg zapytania. Zgłoszenie powinno mieć postać „ |
showDeleted |
Jeśli ma wartość Prawda, pobiera listę usuniętych użytkowników. (Domyślnie: fałsz) |
sortOrder |
Określa, czy wyniki mają być zwracane w kolejności rosnącej czy malejącej. |
viewType |
Określa, czy pobrać widok publiczny tylko dla administratora, czy tylko dla 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 następujących 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 artykule Omówienie OAuth 2.0.
Typ zdarzenia
Typ zdarzenia Subskrypcja
Wartości w polu enum | |
---|---|
ADD |
Zdarzenie utworzone przez użytkownika |
DELETE |
Zdarzenie usunięcia konta użytkownika |
MAKE_ADMIN |
Zdarzenie zmiany stanu administratora |
UNDELETE |
Wydarzenie usunięte przez użytkownika |
UPDATE |
Zdarzenie dotyczące aktualizacji użytkownika |
Sortuj według
Wartości w polu enum | |
---|---|
EMAIL |
Główny adres e-mail użytkownika. |
FAMILY_NAME |
Nazwisko użytkownika. |
GIVEN_NAME |
Imię i nazwisko użytkownika. |
Prognoza
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 |
Kolejność malejąco. |
Rodzaj widoku danych
Wartości w polu enum | |
---|---|
admin_view |
Wyniki obejmują zarówno pole przeznaczone tylko dla administratora, jak i pola publiczne. |
domain_public |
Wyniki obejmują tylko pola użytkownika, które są widoczne publicznie dla innych użytkowników domeny. |