Yandex Cloud
Поиск
Связаться с намиПопробовать бесплатно
  • Истории успеха
  • Документация
  • Блог
  • Все сервисы
  • Статус работы сервисов
  • Marketplace
    • Популярные
    • Инфраструктура и сеть
    • Платформа данных
    • Искусственный интеллект
    • Безопасность
    • Инструменты DevOps
    • Бессерверные вычисления
    • Управление ресурсами
  • Все решения
    • По отраслям
    • По типу задач
    • Экономика платформы
    • Безопасность
    • Техническая поддержка
    • Каталог партнёров
    • Обучение и сертификация
    • Облако для стартапов
    • Облако для крупного бизнеса
    • Центр технологий для общества
    • Облако для интеграторов
    • Поддержка IT-бизнеса
    • Облако для фрилансеров
    • Обучение и сертификация
    • Блог
    • Документация
    • Контент-программа
    • Мероприятия и вебинары
    • Контакты, чаты и сообщества
    • Идеи
    • Калькулятор цен
    • Тарифы
    • Акции и free tier
  • Истории успеха
  • Документация
  • Блог
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Проект Яндекса
© 2026 ООО «Яндекс.Облако»
Yandex Identity Hub
  • Управление доступом
  • Правила тарификации
  • Справочник Terraform
    • Аутентификация
      • Overview
        • Overview
          • Overview
          • Get
          • List
          • Create
          • Update
          • Delete
          • SetOwnPassword
          • SetOthersPassword
          • Suspend
          • Reactivate
          • GeneratePassword
          • GetSelfPasswordMetadata
          • ConvertToExternal
          • SetPasswordHash
          • ResolveExternalIds
  • Аудитные логи Audit Trails
  • История изменений
  • История изменений Yandex Identity Hub Sync Agent
  • Обучающие курсы

В этой статье:

  • gRPC request
  • GetUserRequest
  • User
  1. Справочник API
  2. gRPC (англ.)
  3. Identity Provider API
  4. User
  5. Get

Identity Provider API, gRPC: UserService.Get

Статья создана
Yandex Cloud
Обновлена 24 февраля 2026 г.
  • gRPC request
  • GetUserRequest
  • User

Returns the specified user.

To get the list of available users, make a List request.

gRPC requestgRPC request

rpc Get (GetUserRequest) returns (User)

GetUserRequestGetUserRequest

{
  "user_id": "string"
}

Request to get a user by ID.

Field

Description

user_id

string

Required field. ID of the user to return.

The maximum string length in characters is 50.

UserUser

{
  "id": "string",
  "userpool_id": "string",
  "status": "Status",
  "username": "string",
  "full_name": "string",
  "given_name": "string",
  "family_name": "string",
  "email": "string",
  "phone_number": "string",
  "created_at": "google.protobuf.Timestamp",
  "updated_at": "google.protobuf.Timestamp",
  "external_id": "string",
  "company_name": "string",
  "department": "string",
  "job_title": "string",
  "employee_id": "string"
}

A user in the Identity Provider system.

Users are created within a userpool and can authenticate to access cloud resources.
Each user has a unique identifier, credentials, and profile information.

Field

Description

id

string

Unique identifier of the user.
This ID is generated automatically when the user is created.

userpool_id

string

ID of the userpool this user belongs to.
To get the userpool ID, make a UserpoolService.List request.

status

enum Status

Current status of the user.
Determines whether the user can authenticate and access the system.

  • CREATING: The user is in the process of being created.
  • ACTIVE: The user is active and can authenticate.
    Active users have full access to the system according to their permissions.
  • SUSPENDED: The user is suspended and cannot authenticate.
    Suspended users retain their data but cannot access the system.
  • DELETING: The user is in the process of being deleted.
    This is a transitional state before the user is completely removed from the system.

username

string

Username used for authentication.
Usually in the format of an email address.

full_name

string

User's full name (display name).
This is typically shown in the UI and used for identification purposes.

given_name

string

User's first name.
Part of the user's profile information.

family_name

string

User's last name.
Part of the user's profile information.

email

string

User's email address.

phone_number

string

User's phone number.

created_at

google.protobuf.Timestamp

Timestamp when the user was created.

updated_at

google.protobuf.Timestamp

Timestamp when the user was last updated.

external_id

string

External identifier for federation with external identity systems.
This ID can be used to link this user with an account in an external system.

company_name

string

User's company name.

department

string

User's department.

job_title

string

User's job title.

employee_id

string

User's employee ID

Была ли статья полезна?

Предыдущая
Overview
Следующая
List
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Проект Яндекса
© 2026 ООО «Яндекс.Облако»