Method: users.watch

Sprawdza 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ć dane tylko o użytkownikach z tej domeny. Aby zamiast tego zwrócić wszystkich użytkowników w polu klienta wypełnianym z wielu domen”.
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 należy zwrócić uwagę
customFieldMask

string

Lista nazw schematów rozdzielona przecinkami. Pobierane są wszystkie pola z tych schematów. Wartość ta powinna być ustawiona 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)

Który podzbiór pól ma zostać pobrany dla tego użytkownika.
query

string

wyszukiwanie za pomocą ciągu zapytania; powinna mieć format „”. Pełną dokumentację znajdziesz na stronie https: //developers.google.com/workspace/admin/directory/v1/guides/search-users;
showDeleted

string

Jeśli ma wartość prawda, pobiera listę usuniętych użytkowników. (wartość domyślna to false)
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 należy pobrać widok użytkownika tylko dla administratora czy widok publiczny dla całej domeny. Więcej informacji znajdziesz w artykule Pobieranie użytkownika jako użytkownik 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 dotyczącym autoryzacji.

EventType

Typ zdarzenia subskrypcji

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 nieusunięcia użytkownika
UPDATE Zdarzenie aktualizacji 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 dotyczących użytkownika.
CUSTOM Uwzględnij pola niestandardowe ze schematów wymienionych w customFieldMask.
FULL Uwzględnij wszystkie pola powiązane z tym użytkownikiem.

SortOrder

Wartości w polu enum
ASCENDING rosnąco;
DESCENDING w kolejności malejącej.

ViewType

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