Получить информацию о пользователях
Запрос позволяет получить информацию об учетных записях пользователей, которые зарегистрированы в организации. Результат запроса отображается постранично.
Формат запроса
Перед выполнением запроса получите доступ к API.
Для получения информации о пользователях организации используйте HTTP-запрос с методом GET
:
GET /v2/users
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID: <идентификатор организации>
Заголовки
-
Host
Адрес узла, предоставляющего API:
https://api.tracker.yandex.net
-
Authorization
OAuth-токен в формате
OAuth <значение токена>
, например:OAuth 0c4181a7c2cf4521964a72ff57a34a07
-
X-Org-ID
Идентификатор организации.
Формат ответа
Запрос выполнен успешно
Запрос выполнен с ошибкой
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK
.
Тело ответа содержит JSON-массив с параметрами пользователей.
[
{
"self": "https://api.tracker.yandex.net/v2/users/1234567890",
"uid": 1234567890,
"login": "<user_login>",
"trackerUid": 1234567890,
"passportUid": 1234567890,
"firstName": "<Имя>",
"lastName": "<Фамилия>",
"display": "<Имя Фамилия>",
"email": "<login@yandex.ru>",
"external": false,
"hasLicense": true,
"dismissed": false,
"useNewFilters": true,
"disableNotifications": false,
"firstLoginDate": "2019-08-22T14:56:57.981+0000",
"lastLoginDate": "2022-06-22T17:44:32.981+0000",
"welcomeMailSent": true
},
...
]
Параметры ответа
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию об учетной записи пользователя. | Строка |
uid | Уникальный идентификатор учетной записи пользователя. | Число |
login | Логин пользователя. | Строка |
trackerUid | Уникальный идентификатор аккаунта пользователя в Tracker. | Число |
passportUid | Уникальный идентификатор аккаунта пользователя на Яндексе. | Число |
firstName | Имя пользователя. | Строка |
lastName | Фамилия пользователя. | Строка |
display | Отображаемое имя пользователя. | Строка |
Электронная почта пользователя. | Строка | |
external | Служебный параметр. | Логический |
hasLicense | Признак наличия у пользователя полного доступа к Tracker:
|
Логический |
dismissed | Статус пользователя в организации:
|
Логический |
useNewFilters | Служебный параметр. | Логический |
disableNotifications | Признак принудительного отключения уведомлений для пользователя:
|
Логический |
firstLoginDate | Дата и время первой авторизации пользователя в формате YYYY-MM-DDThh:mm:ss.sss±hhmm . |
Строка |
lastLoginDate | Дата и время последней авторизации пользователя в формате YYYY-MM-DDThh:mm:ss.sss±hhmm . |
Строка |
welcomeMailSent | Способ добавления пользователя:
|
Логический |
- 401
- Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.