Method: users.list

Pobiera podzieloną na strony listę usuniętych użytkowników lub wszystkich użytkowników w domenie.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
customFieldMask

string

Rozdzielona przecinkami lista nazw schematów. Wszystkie pola z tych schematów zostały pobrane. Należy go ustawić tylko wtedy, gdy zasada projection=custom.
customer

string

Unikalny identyfikator konta Google Workspace klienta. Jeśli masz konto z wieloma domenami i chcesz pobrać wszystkie grupy klienta, użyj tego pola zamiast domain. Możesz też użyć aliasu my_customer do reprezentowania konta customerId na swoim koncie. Zwracana jest też wartość customerId jako część zasobu Users. Musisz podać parametr customer lub domain.
domain

string

Nazwa domeny. Użyj tego pola, aby uzyskać grupy tylko z jednej domeny. Aby zwrócić wszystkie domeny konta klienta, użyj parametru zapytania customer. Należy podać parametr customer lub domain.
event

enum (Event)

Zdarzenie dotyczące docelowej subskrypcji (jeśli jest subskrybowana)
maxResults

integer

Maksymalna liczba wyników do zwrócenia.
orderBy

enum (OrderBy)

Właściwość używana 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

Ciąg zapytania do przeszukiwania pól użytkownika. Więcej informacji o tworzeniu zapytań użytkowników znajdziesz w artykule Wyszukiwanie użytkowników.
showDeleted

string

Jeśli ma wartość true, 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 (bez uwzględniania wielkości liter).
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 musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "kind": string,
  "trigger_event": string,
  "etag": string,
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
Pola
kind

string

To jakieś zasoby.
trigger_event

string

Zdarzenie, które wywołało tę odpowiedź (używane tylko w przypadku odpowiedzi push)
etag

string

ETag zasobu.
users[]

object (User)

Lista obiektów użytkownika.
nextPageToken

string

Token używany do uzyskania dostępu do następnej strony tego wyniku.

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.

Zdarzenie

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 żądanych w polu 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ą zarówno pola dostępne tylko dla administratora, jak i pola publiczne w domenie użytkownika.
domain_public Wyniki obejmują tylko pola dotyczące użytkownika, które są widoczne publicznie dla innych użytkowników w domenie.