Method: users.list

Ruft eine paginierte Liste mit gelöschten Nutzern oder allen Nutzern in einer Domain ab.

HTTP-Anfrage

GET https://admin.googleapis.com/admin/directory/v1/users

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
customFieldMask

string

Eine durch Kommas getrennte Liste von Schemanamen. Alle Felder aus diesen Schemas werden abgerufen. Sollte nur festgelegt werden, wenn projection=custom.
customer

string

Die eindeutige ID für das Google Workspace-Konto des Kunden. Verwenden Sie bei einem Konto mit mehreren Domains dieses Feld anstelle von domain, um alle Nutzer eines Kunden abzurufen. Sie können auch den Alias my_customer verwenden, um die customerId Ihres Kontos darzustellen. customerId wird auch als Teil der Ressource Users zurückgegeben. Sie müssen den Parameter customer oder domain angeben.
domain

string

Der Domainname. Verwenden Sie dieses Feld, um Nutzer aus nur einer Domain abzurufen. Wenn alle Domains für ein Kundenkonto zurückgegeben werden sollen, verwenden Sie stattdessen den Suchparameter customer. Es muss entweder der Parameter customer oder der Parameter domain angegeben werden.
event

enum (Event)

Ereignis, für das ein Abo vorgesehen ist (bei Abonnieren)
maxResults

integer

Maximale Anzahl der zurückzugebenden Ergebnisse.
orderBy

enum (OrderBy)

Eigenschaft zum Sortieren von Ergebnissen.
pageToken

string

Token zur Angabe der nächsten Seite in der Liste
projection

enum (Projection)

Die Teilmenge der Felder, die für diesen Nutzer abgerufen werden sollen.
query

string

Abfragestring zum Suchen von Nutzerfeldern. Weitere Informationen zum Erstellen von Nutzerabfragen finden Sie unter Nach Nutzern suchen.
showDeleted

string

Wenn dieser Wert auf true gesetzt ist, wird die Liste der gelöschten Nutzer abgerufen. (Standardeinstellung: false)
sortOrder

enum (SortOrder)

Gibt an, ob Ergebnisse in aufsteigender oder absteigender Reihenfolge zurückgegeben werden. Groß- und Kleinschreibung wird ignoriert.
viewType

enum (ViewType)

Gibt an, ob die nur für Administratoren zugängliche oder die domainweite öffentliche Ansicht des Nutzers abgerufen werden soll. Weitere Informationen finden Sie unter Nutzer als Nicht-Administrator abrufen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

JSON-Darstellung 
{
  "kind": string,
  "trigger_event": string,
  "etag": string,
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
Felder
kind

string

Der Ressourcentyp.
trigger_event

string

Ereignis, das diese Antwort ausgelöst hat (wird nur im Fall einer Push-Antwort verwendet)
etag

string

Das ETag der Ressource.
users[]

object (User)

Eine Liste von Nutzerobjekten.
nextPageToken

string

Token für den Zugriff auf die nächste Seite dieses Ergebnisses.

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.

Ereignis

Typ des Aboereignisses

Enums
ADD Vom Nutzer erstelltes Ereignis
DELETE Ereignis vom Nutzer gelöscht
MAKE_ADMIN Ereignis zur Statusänderung des Nutzeradministrators
UNDELETE Ereignis wiederhergestellt
UPDATE Ereignis vom Nutzer aktualisiert

OrderBy

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

Projektion

Enums
BASIC Schließen Sie keine benutzerdefinierten Felder für den Nutzer ein.
CUSTOM Benutzerdefinierte Felder aus Schemas einschließen, die in customFieldMask angefordert werden.
FULL Alle mit diesem Nutzer verknüpften Felder einschließen.

SortOrder

Enums
ASCENDING Aufsteigende Reihenfolge.
DESCENDING Absteigende Reihenfolge.

ViewType

Enums
admin_view Die Ergebnisse enthalten Felder, die nur für Administratoren zugänglich sind, und Felder, die für die Domain öffentlich zugänglich sind.
domain_public Die Ergebnisse enthalten nur Felder für den Nutzer, die für andere Nutzer in der Domain öffentlich sichtbar sind.