VK WorkSpace On-Premise logo
Помощь
Обновлена 16 ноября 2026 г. в 11:40

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

Возвращает информацию о конкретном пользователе.

GET /cwm/public/api/v1/users/{user}

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

user (обязательный)

Логин или идентификатор пользователя
ivan.ivanov
3fa85f64-5717-4562-b3fc-2c963f66afa6

providerId

Идентификатор провайдера аутентификации
?providerId=3fa85f64-5717-4562-b3fc-2c963f66afa6

Тело успешного ответа 200

{  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  "displayName": "string",  "username": "string",  "email": "string",  "providerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}

Описание возвращаемой модели пользователя

id

Идентификатор пользователя

displayName

Отображаемое имя пользователя

username

Логин пользователя

email

Почтовый адрес пользователя

providerId

Идентификатор провайдера аутентификации

Особенности для агентов

Если пользователь является ИИ-агентом, поля модели заполняются так:

  • username — внешний идентификатор агента;
  • displayName — название агента;
  • email — null;
  • providerId — идентификатор локального провайдера тенанта (тот же, что у локально созданных пользователей).

Ошибки


Технический писатель: Белова Ирина

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