Method: users.get

Pobiera 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 do interfejsu API. Może to być podstawowy adres e-mail użytkownika, alias adresu e-mail lub unikalny identyfikator użytkownika.

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.
projection

enum (Projection)

Podzbiór pól do pobrania dla tego użytkownika.
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ść 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 po autoryzacji.

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.

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.