Method: users.list

Ruft eine paginierte Liste entweder gelöschter Nutzer oder aller Nutzer 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 des Google Workspace-Kontos des Kunden. Wenn Sie ein Konto mit mehreren Domains haben, verwenden Sie zum Abrufen aller Gruppen für einen Kunden dieses Feld anstelle von domain. Sie können den Alias my_customer auch für die customerId Ihres Kontos verwenden. Das customerId wird auch als Teil der Ressource Users zurückgegeben. Sie müssen entweder den Parameter customer oder den Parameter domain angeben.

domain

string

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

event

enum (Event)

Ereignis, für das das Abo vorgesehen ist (falls ein Abo abgeschlossen wird)

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)

Teilmenge von Feldern, die für diesen Nutzer abgerufen werden sollen.

query

string

Abfragestring für die Suche in 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, wobei die Groß- und Kleinschreibung ignoriert wird.

viewType

enum (ViewType)

Gibt an, ob die nur für Administratoren 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 bei einer Push-Antwort verwendet)

etag

string

Das ETag der Ressource.

users[]

object (User)

Eine Liste mit 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.

Veranstaltung

Typ des Aboereignisses

Enums
ADD Vom Nutzer erstelltes Ereignis
DELETE Vom Nutzer gelöschter Termin
MAKE_ADMIN Nutzeradministrator-Statusänderungsereignis
UNDELETE Nutzerereignis wiederhergestellt
UPDATE Durch Nutzer aktualisiertes Ereignis

OrderBy

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

Projektion

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

SortOrder

Enums
ASCENDING Aufsteigende Reihenfolge.
DESCENDING Absteigende Reihenfolge.

ViewType

Enums
admin_view Die Ergebnisse umfassen sowohl nur für den Administrator zugängliche Felder als auch für die Domain öffentlich zugängliche Felder für den Nutzer.
domain_public Die Ergebnisse enthalten nur Felder für den Nutzer, die für andere Nutzer in der Domain öffentlich sichtbar sind.