Method: users.get

Получает пользователя.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
userKey

string

Идентифицирует пользователя в запросе API. Значение может быть основным адресом электронной почты пользователя, псевдонимом адреса электронной почты или уникальным идентификатором пользователя.

Параметры запроса

Параметры
customFieldMask

string

Список имен схем, разделенных запятыми. Выбираются все поля из этих схем. Это должно быть установлено только в случае, если projection=custom .

projection

enum ( Projection )

Какое подмножество полей выбрать для этого пользователя.

viewType

enum ( ViewType )

Следует ли получить общедоступное представление пользователя только для администратора или для всего домена. Дополнительные сведения см. в разделе Получение пользователя без прав администратора .

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

В случае успеха тело ответа содержит экземпляр User .

Области авторизации

Требуется одна из следующих областей действия OAuth:

  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.user.readonly

Дополнительные сведения см. в руководстве по авторизации .

Проекция

перечисления
BASIC Не включайте никаких настраиваемых полей для пользователя.
CUSTOM Включите настраиваемые поля из схем, запрошенных в customFieldMask .
FULL Включить все поля, связанные с этим пользователем.

Тип просмотра

перечисления
admin_view Результаты включают как поля, доступные только администратору, так и общедоступные поля домена для пользователя.
domain_public Результаты включают только поля для пользователя, которые общедоступны для других пользователей в домене.