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. Zostaną pobrane wszystkie pola z tych schematów. Tę wartość należy ustawić tylko wtedy, gdy projection=custom.
customer

string

Unikalny identyfikator konta Google Workspace klienta. W przypadku konta z wieloma domenami, aby pobrać wszystkich użytkowników za klienta, użyj tego pola zamiast pola domain. Możesz też używać aliasu my_customer do reprezentowania domeny customerId Twojego konta. Element customerId jest też zwracany jako część zasobu Users. Musisz podać parametr customer lub domain.
domain

string

Nazwa domeny. Użyj tego pola, aby pobrać użytkowników tylko z jednej domeny. Aby zwracać wszystkie domeny z konta klienta, użyj parametru zapytania customer. Musisz podać parametr customer lub domain.
event

enum (Event)

Zdarzenie, którego dotyczy subskrypcja (w przypadku subskrypcji)
maxResults

integer

Maksymalna liczba wyników do zwrócenia.
orderBy

enum (OrderBy)

Właściwość używana do sortowania wyników.
pageToken

string

Token do określenia następnej strony na liście
projection

enum (Projection)

Podzbiór pól do pobrania w przypadku 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 kont 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 rozróżniania wielkości liter.
viewType

enum (ViewType)

Określa, czy pobrać widok publiczny użytkownika dostępny tylko dla administratora czy na poziomie całej domeny. Więcej informacji znajdziesz w artykule Pobieranie konta 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 jest rodzaj tego zasobu.
trigger_event

string

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

string

Tag ETag zasobu.
users[]

object (User)

Lista obiektów użytkownika.
nextPageToken

string

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

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu 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 na temat autoryzacji.

Zdarzenie

Typ zdarzenia „Subskrypcja”

Wartości w polu enum
ADD Zdarzenie utworzone przez użytkownika
DELETE Zdarzenie usunięte przez użytkownika
MAKE_ADMIN Zdarzenie zmiany stanu administratora użytkowników
UNDELETE Zdarzenie dotyczące przywrócenia 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 customFieldMask.
FULL Uwzględnij wszystkie pola powiązane z tym użytkownikiem.

SortOrder

Wartości w polu enum
ASCENDING Porządek rosnący.
DESCENDING Porządek malejący.

ViewType

Wartości w polu enum
admin_view Wyniki obejmują pola tylko administratora i domeny publiczne.
domain_public Wyniki obejmują tylko te pola dotyczące użytkownika, które są publicznie widoczne dla innych użytkowników w domenie.