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

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

GET

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

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

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

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

GET /v3/users/<логин_или_id_пользователя>&expand=<дополнительные_поля>
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: идентификатор организации.
- если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок X-Org-ID,
- если к Трекеру привязана организация Yandex Cloud Organization, используйте заголовок X-Cloud-Org-ID.
Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Ресурс

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

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

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

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

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

Дополнительные параметры

Параметр	Описание	Тип данных
expand	Дополнительная информация, которая будет включена в ответ: `groups` — группы, в которые входит пользователь	Строка

Пример: Запросить информацию о пользователе, включая данные о группах, в которые он входит.
GET /v3/users/username?expand=groups
Host: api.tracker.yandex.net
Authorization: OAuth y0__xAbc******
X-Org-ID: 1234******

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

Запрос выполнен успешно

Запрос выполнен с ошибкой

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

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

{
    "self": "https://api.tracker.yandex.net/v3/users/12********",
    "uid": 12********,
    "login": "username",
    "trackerUid": 12********,
    "passportUid": 12********,
    "cloudUid": "bfbdrb1aa248********",
    "firstName": "Имя",
    "lastName": "Фамилия",
    "display": "Имя Фамилия",
    "email": "mail@example.com",
    "groups": [
          {
              "self": "https://api.tracker.yandex.net/v3/groups/5",
              "id": "5",
              "display": "Developers"
          }
      ],
    "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	Электронная почта пользователя.	Строка
groups	Группы, в которые входит пользователь. Присутствует в ответе, если в запросе для параметра `expand` указано значение `groups`.	Массив объектов
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` — другим способом. .	Логический

Параметры объектов в массиве groups

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию о группе.	Строка
id	Идентификатор группы.	Строка
display	Отображаемое имя группы.	Строка

401: Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.

403: У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.

404: Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.

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

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

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