Method: users.watch

Wartet auf Änderungen in der Nutzerliste.

HTTP-Anfrage

POST https://admin.googleapis.com/admin/directory/v1/users/watch

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
domain

string

Name der Domain. Füllen Sie dieses Feld aus, um nur Nutzer aus dieser Domain zu erhalten. Wenn Sie alle Nutzer in einer mehrdomänenfähigen Umgebung zurückgeben möchten, füllen Sie stattdessen das Kundenfeld aus."

customer

string

Die unveränderliche ID des Google Workspace-Kontos. Wenn Sie mehrere Domains haben, füllen Sie dieses Feld anstelle der Domain aus, um alle Nutzer für einen Kunden abzurufen.

event

enum (EventType)

Wichtige Ereignisse

customFieldMask

string

Durch Kommas getrennte Liste von Schemanamen. Alle Felder aus diesen Schemas werden abgerufen. Dieser sollte nur festgelegt werden, wenn „projection“ auf „custom“ gesetzt ist.

maxResults

integer

Maximale Anzahl der zurückzugebenden Ergebnisse.

orderBy

enum (OrderBy)

Spalte, die zum Sortieren der Ergebnisse verwendet werden soll

pageToken

string

Token, um die nächste Seite in der Liste anzugeben

projection

enum (Projection)

Welche Teilmenge von Feldern für diesen Nutzer abgerufen werden soll.

query

string

Abfragestring-Suche Muss das Format „“ haben. Die vollständige Dokumentation finden Sie unter https: //developers.google.com/workspace/admin/directory/v1/guides/search-users.

showDeleted

string

Wenn diese Option auf „true“ gesetzt ist, wird die Liste der gelöschten Nutzer abgerufen. (Standardeinstellung: false)

sortOrder

enum (SortOrder)

Ob die Ergebnisse in aufsteigender oder absteigender Reihenfolge zurückgegeben werden sollen.

viewType

enum (ViewType)

Gibt an, ob die öffentliche Ansicht des Nutzers nur für Administratoren oder domainweit abgerufen werden soll. Weitere Informationen finden Sie im Hilfeartikel Nutzer als Nichtadministrator abrufen.

Anfragetext

Der Anfragetext enthält eine Instanz von SubscriptionChannel.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von SubscriptionChannel.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.user.readonly
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

EventType

Typ des Aboereignisses

Enums
ADD Von Nutzern erstelltes Ereignis
DELETE Vom Nutzer gelöschtes Ereignis
MAKE_ADMIN Ereignis: Änderung des Admin-Status eines Nutzers
UNDELETE Ereignis: Nutzer wiederhergestellt
UPDATE Von Nutzern aktualisiertes Ereignis

OrderBy

Enums
EMAIL Primäre E-Mail-Adresse des Nutzers.
FAMILY_NAME Der Nachname des Nutzers.
GIVEN_NAME Der Vorname des Nutzers.

Projektion

Enums
BASIC Fügen Sie keine benutzerdefinierten Felder für den Nutzer hinzu.
CUSTOM Fügen Sie benutzerdefinierte Felder aus Schemas hinzu, die in „customFieldMask“ erwähnt werden.
FULL Fügen Sie alle mit diesem Nutzer verknüpften Felder hinzu.

SortOrder

Enums
ASCENDING Aufsteigende Reihenfolge.
DESCENDING Absteigende Reihenfolge.

ViewType

Enums
admin_view Die Ergebnisse enthalten sowohl Felder, die nur für Administratoren sichtbar sind, als auch Felder, die für alle Domainnutzer sichtbar sind.
domain_public Die Ergebnisse enthalten nur Felder für den Nutzer, die für andere Nutzer in der Domain öffentlich sichtbar sind.