Получить информацию о пользователях
Запрос позволяет получить информацию об учетных записях пользователей, которые зарегистрированы в организации. Результат запроса отображается постранично.
Ограничение
Данный запрос имеет ограничение в 10 000 пользователей. Для получения большего количества пользователей используйте метод с относительной пагинацией.
GET
https://api.tracker.yandex.net/v3/users?expand=groups
Формат запроса
Перед выполнением запроса получите доступ к API.
Для получения информации о пользователях организации используйте HTTP-запрос с методом GET:
GET /v3/users
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.
Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.
-
Параметры запроса
Дополнительные параметры
| Параметр | Описание | Тип данных |
|---|---|---|
| perPage | Количество элементов на странице. От 1 до 100 включительно. | Число |
| id | Идентификатор пользователя (uid), начиная с которого нужно искать. | Число |
| Фильтрация пользователей по электронной почте. Возвращает пользователя, чей email совпадает с указанным значением. | Строка | |
| group | Фильтрация пользователей по идентификатору группы. Возвращает пользователей, которые входят в указанную группу. | Число |
| expand | Дополнительная информация, которая будет включена в ответ:
|
Строка |
Примеры запросов:
Пример 1: Запросить информацию о пользователях, включая данные о группах, в которые они входят.
GET /v3/users?expand=groups Host: api.tracker.yandex.net Authorization: OAuth y0__xAbc****** X-Org-ID: 1234******
Пример 2: Найти пользователей по электронной почте.
GET /v3/users?email=username@example.com Host: api.tracker.yandex.net Authorization: OAuth y0__xAbc****** X-Cloud-Org-ID: ab1c******
Пример 3: Получить информацию о пользователях из определенной группы с информацией о группах.
GET /v3/users?group=5&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": "2019-08-22T14:56:57.981+0000",
"lastLoginDate": "2022-06-22T17:44:32.981+0000",
"welcomeMailSent": true
},
...
]
Параметры ответа
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса API, который содержит информацию об учетной записи пользователя. | Строка |
| uid | Уникальный идентификатор учетной записи пользователя в Трекере. | Число |
| login | Логин пользователя. | Строка |
| trackerUid | Уникальный идентификатор аккаунта пользователя в Трекере. | Число |
| passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число |
| cloudUid | Уникальный идентификатор пользователя в Yandex Cloud Organization. | Строка |
| firstName | Имя пользователя. | Строка |
| lastName | Фамилия пользователя. | Строка |
| display | Отображаемое имя пользователя. | Строка |
| Электронная почта пользователя. | Строка | |
| groups | Группы, в которые входит пользователь. Присутствует в ответе, если в запросе для параметра expand указано значение groups. |
Массив объектов |
| external | Служебный параметр. | Логический |
| hasLicense | Признак наличия у пользователя полного доступа к Трекеру:
|
Логический |
| dismissed | Статус пользователя в организации:
|
Логический |
| useNewFilters | Служебный параметр. | Логический |
| disableNotifications | Признак принудительного отключения уведомлений для пользователя:
|
Логический |
| firstLoginDate | Дата и время первой авторизации пользователя в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. |
Строка |
| lastLoginDate | Дата и время последней авторизации пользователя в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. |
Строка |
| welcomeMailSent | Способ добавления пользователя:
|
Логический |
Параметры объектов в массиве groups
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса API, который содержит информацию о группе. | Строка |
| id | Идентификатор группы. | Строка |
| display | Отображаемое имя группы. | Строка |
- 401
- Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.