Method: users.get

Pobiera dane użytkownika.

Żądanie HTTP

GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
userKey

string

Identyfikuje użytkownika w żądaniu interfejsu API. Wartością może być podstawowy adres e-mail użytkownika, alias adresu e-mail lub unikalny identyfikator użytkownika.

Parametry zapytania

Parametry
customFieldMask

string

Lista nazw schematów rozdzielona przecinkami. Pobierane są wszystkie pola z tych schematów. Ta opcja powinna być ustawiona tylko wtedy, gdy projection=custom.

projection

enum (Projection)

Który podzbiór pól ma zostać pobrany dla tego użytkownika.

viewType

enum (ViewType)

Określa, czy należy pobrać widok użytkownika tylko dla administratora czy widok publiczny dla całej domeny. Więcej informacji znajdziesz w artykule Pobieranie użytkownika jako użytkownik bez uprawnień administratora.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu User.

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.

Odwzorowanie

Wartości w polu enum
BASIC Nie uwzględniaj żadnych pól niestandardowych dotyczących użytkownika.
CUSTOM Uwzględnij pola niestandardowe ze schematów podanych w pliku customFieldMask.
FULL Uwzględnij wszystkie pola powiązane z tym użytkownikiem.

ViewType

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