Method: users.watch

Śledzi 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

string

Nazwa domeny. Wypełnij to pole, aby pobierać użytkowników tylko z tej domeny. Aby zwrócić wszystkich użytkowników w wielu domenach, zamiast tego wypełnij pole klienta”.
customer

string

Niezmienny identyfikator konta Google Workspace. W przypadku wielu domen, aby pobrać wszystkich użytkowników klienta, wypełnij to pole zamiast pola domeny.
event

enum (EventType)

Zdarzenia, na które warto zwrócić uwagę.
customFieldMask

string

Lista nazw schematów rozdzielona przecinkami. Pobierane są wszystkie pola z tych schematów. Należy go ustawić tylko wtedy, gdy projection=custom.
maxResults

integer

Maksymalna liczba wyników do zwrócenia.
orderBy

enum (OrderBy)

Kolumna używana do sortowania wyników.
pageToken

string

Token określający następną stronę na liście.
projection

enum (Projection)

Podzbiór pól do pobrania dla tego użytkownika.
query

string

Wyszukiwanie ciągu zapytania. Zawiera co najmniej 1 klauzulę wyszukiwania, z której każda ma pole, operator i wartość. Pełną dokumentację znajdziesz w artykule Wyszukiwanie użytkowników.
showDeleted

string

Jeśli ma wartość „prawda”, pobiera listę usuniętych użytkowników. (Domyślnie: fałsz)
sortOrder

enum (SortOrder)

Określa, czy wyniki mają zostać zwrócone w kolejności rosnącej czy malejącej.
viewType

enum (ViewType)

Określa, czy pobrać widok publiczny użytkownika dostępny tylko dla administratora czy dla całej domeny. Więcej informacji znajdziesz w artykule Pobieranie informacji o użytkowniku jako osoba niebędąca administratorem.

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.

EventType

Typ zdarzenia związanego z subskrypcją

Wartości w polu enum
ADD Zdarzenie utworzone przez użytkownika
DELETE Zdarzenie usunięcia użytkownika
MAKE_ADMIN Zdarzenie zmiany stanu administratora użytkownika
UNDELETE Zdarzenie cofnięcia usunięcia użytkownika
UPDATE Zdarzenie zaktualizowania użytkownika

OrderBy

Wartości w polu enum
EMAIL Podstawowy adres e-mail użytkownika.
FAMILY_NAME Nazwisko użytkownika.
GIVEN_NAME Imię użytkownika.

Odwzorowanie

Wartości w polu enum
BASIC Nie uwzględniaj żadnych pól niestandardowych użytkownika.
CUSTOM Uwzględnia pola niestandardowe ze schematów wymienionych w parametrze customFieldMask.
FULL Uwzględnij wszystkie pola powiązane z tym użytkownikiem.

SortOrder

Wartości w polu enum
ASCENDING w kolejności rosnącej,
DESCENDING w kolejności malejącej,

ViewType

Wartości w polu enum
admin_view Wyniki obejmują pola dostępne tylko dla administratora i pola publiczne w domenie.
domain_public Wyniki zawierają tylko pola użytkownika, które są publicznie widoczne dla innych użytkowników w domenie.