Связаться с намиПодключиться

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

Статья создана
Обновлена 26 августа 2024 г.

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

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

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

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

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

  • Host

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

    api.tracker.yandex.net

  • Authorization

    OAuth-токен в формате OAuth <OAuth-токен>, например:

    OAuth 0c4181a7c2cf4521964a72ff********

  • X-Org-ID или X-Cloud-Org-ID

    Идентификатор организации. Узнать его можно на странице организаций Tracker.

    • Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок X-Org-ID.
    • Если к Tracker привязана только организация Yandex Cloud Organization, используется заголовок X-Cloud-Org-ID.
    • Если к Tracker одновременно привязаны организации Яндекс 360 для бизнеса и Yandex Cloud Organization, используется заголовок X-Org-ID и идентификатор организации Яндекс 360 для бизнеса.

Например, с помощью curl:

curl --request GET "api.tracker.yandex.net/v2/myself" \
     --header "Authorization: OAuth <OAuth-токен>" \
     --header "X-Cloud-Org-Id: <идентификатор_организации>"

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

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

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

   [
      {
      "self": "https://api.tracker.yandex.net/v2/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 Уникальный идентификатор учетной записи пользователя в Tracker. Число
login Логин пользователя. Строка
trackerUid Уникальный идентификатор аккаунта пользователя в Tracker. Число
passportUid Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. Число
cloudUid Уникальный идентификатор пользователя в Yandex Cloud Organization. Строка
firstName Имя пользователя. Строка
lastName Фамилия пользователя. Строка
display Отображаемое имя пользователя. Строка
email Электронная почта пользователя. Строка
external Служебный параметр. Логический
hasLicense Признак наличия у пользователя полного доступа к Tracker:
  • 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
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
Предыдущая
Редактировать локальное поле очереди
Следующая
Получить информацию о пользователях