Method: users.watch

Wykrywa 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 uzyskać dostęp tylko do użytkowników z tej domeny. Aby zwrócić wszystkich użytkowników w polu klienta obejmującym wiele domen”.
customer

string

Stały identyfikator konta Google Workspace. Jeśli masz wiele domen i chcesz pobrać wszystkich użytkowników klienta, wypełnij to pole zamiast domeny.
event

enum (EventType)

Zdarzenia, które warto obserwować
customFieldMask

string

Rozdzielona przecinkami lista nazw schematów. Wszystkie pola z tych schematów zostały pobrane. To ustawienie należy ustawić tylko wtedy, gdy projekcja=niestandardowy.
maxResults

integer

Maksymalna liczba wyników do zwrócenia.
orderBy

enum (OrderBy)

Kolumna 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. Powinien mieć format „”. Pełna dokumentacja jest dostępna na stronie https: //developers.google.com/admin-sdk/directory/v1/guides/search-users
showDeleted

string

Jeśli ma wartość Prawda, pobiera listę usuniętych użytkowników. (Domyślnie: false)
sortOrder

enum (SortOrder)

Określa, czy wyniki mają być zwracane w kolejności rosnącej czy malejącej.
viewType

enum (ViewType)

Określa, czy pobrać publiczny widok użytkownika dostępny tylko dla administratora czy w całej domenie. Więcej informacji znajdziesz w artykule Pobieranie konta użytkownika jako 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.

EventType

Typ zdarzenia subskrypcji

Wartości w polu enum
ADD Zdarzenie utworzone przez użytkownika
DELETE Wydarzenie usunięte przez użytkownika
MAKE_ADMIN Zdarzenie zmiany statusu administratora użytkowników
UNDELETE Cofnięcie usunięcia użytkownika
UPDATE Zdarzenie zaktualizowane przez użytkownika

OrderBy

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 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 W kolejności rosnącej.
DESCENDING Malejąco.

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 dotyczące użytkownika, które są widoczne publicznie dla innych użytkowników w domenie.