Получить информацию о пользователе

Запрос позволяет получить информацию об учетной записи пользователя организации.

GET

https://api.tracker.yandex.net/v3/users/<логин_или_id_пользователя>

Формат запроса

Перед выполнением запроса получите доступ к API.

Для получения информации о пользователе используйте HTTP-запрос с методом GET:

GET /v3/users/<логин_или_id_пользователя>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Заголовки

  • Host: адрес узла, предоставляющего API.

  • Authorization: токен для авторизации в одном из форматов:

    • OAuth <OAuth-токен> при авторизации по протоколу OAuth 2.0. Читать подробнее

    • Bearer <IAM-токен> при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Cloud Organization. Читать подробнее

  • X-Org-ID или X-Cloud-Org-ID: идентификатор организации.

    • Используйте заголовок X-Org-ID, если к Трекеру привязана организация Яндекс 360 для бизнеса.

    • Используйте заголовок X-Cloud-Org-ID, если к Трекеру привязана организация Yandex Cloud Organization.

    Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Ресурс
Параметр Описание Тип данных
<логин_или_id_пользователя> Уникальный идентификатор учетной записи или логин пользователя. Строка

Если логин пользователя состоит только из цифр, используйте такой формат запроса:

GET https://api.tracker.yandex.net/v3/users/login:12345

где 12345 — логин пользователя.

Формат ответа

В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.

Тело ответа содержит JSON-объект с параметрами пользователя.

{
    "self": "https://api.tracker.yandex.net/v3/users/12********",
    "uid": 12********,
    "login": "<логин_пользователя>",
    "trackerUid": 12********,
    "passportUid": 12********,
    "cloudUid": "bfbdrb1aa248********",
    "firstName": "<имя>",
    "lastName": "<фамилия>",
    "display": "<отображаемое_имя>",
    "email": "<электронная_почта>",
    "external": false,
    "hasLicense": true,
    "dismissed": false,
    "useNewFilters": true,
    "disableNotifications": false,
    "firstLoginDate": "2020-10-27T13:06:21.787+0000",
    "lastLoginDate": "2022-07-25T17:12:33.787+0000",
    "welcomeMailSent": true
}
Параметры ответа

С 1 октября 2023 года тип идентификатора пользователя по умолчанию изменился с passportUid на uid. Рекомендуем явно указывать тип идентификатора пользователя при интеграции.

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию об учетной записи пользователя. Строка
uid Уникальный идентификатор учетной записи пользователя в Трекере. Число
login Логин пользователя. Строка
trackerUid Уникальный идентификатор аккаунта пользователя в Трекере. Число
passportUid Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. Число
cloudUid Уникальный идентификатор пользователя в Yandex Cloud Organization. Строка
firstName Имя пользователя. Строка
lastName Фамилия пользователя. Строка
display Отображаемое имя пользователя. Строка
email Электронная почта пользователя. Строка
external Служебный параметр. Логический
hasLicense Признак наличия у пользователя полного доступа к Трекеру:
  • true — полный доступ;
  • false — только чтение.
 Логический
dismissed Статус пользователя в организации:
  • true — пользователь удален из организации;
  • false — действующий сотрудник организации.
 Логический
useNewFilters Служебный параметр. Логический
disableNotifications Признак принудительного отключения уведомлений для пользователя:
  • true — уведомления отключены;
  • false — уведомления включены.
 Логический
firstLoginDate Дата и время первой авторизации пользователя в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Строка
lastLoginDate Дата и время последней авторизации пользователя в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Строка
welcomeMailSent Способ добавления пользователя:
  • true — с помощью приглашения на почту;
  • false — другим способом.
.		 Логический
401
Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
Предыдущая
Получить информацию о пользователях
Следующая
Возможные коды ответа