ipr.currentUser

Scope: ipr

Кто может вызывать: Любой авторизованный пользователь REST. Подробнее: Роли и права доступа

Возвращает контекст текущего пользователя: роль, флаги доступа и список методов модуля, доступных для вызова.

HTTP: GET

Побочные эффекты: none

Параметры метода

Параметр Тип Обяз. Описание
— — — Нет параметров

Возвращаемые данные

Поле Тип Описание
id int ID пользователя
login string Логин
name string Полное имя
role string admin | hr | manager | employee (см. Роли пользователя)
isAdmin bool role === 'admin'
isHr bool role === 'hr' или 'admin'
isManager bool role в ['manager', 'hr', 'admin']
scope string Всегда ipr
availableMethods string[] Полный список зарегистрированных методов ipr.* (по аннотациям @restMethod контроллеров)

Обработка ошибок

Справочник кодов: error-codes.md.

Код Описание
UNAUTHORIZED Пользователь не авторизован
INTERNAL_ERROR Внутренняя ошибка сервера

Пример запроса (GET)

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/ipr.currentUser.json"
          -H "Accept: application/json"

Пример ответа

{
          "result": {
            "result": {
              "id": 15,
              "login": "n.ivanova",
              "name": "Наталья Иванова",
              "role": "manager",
              "isAdmin": false,
              "isHr": false,
              "isManager": true,
              "scope": "ipr",
              "availableMethods": [
                "ipr.currentUser",
                "ipr.schema",
                "ipr.ipr.list",
                "ipr.ipr.get"
              ]
            },
            "total": null,
            "next": null,
            "error": null
          }
        }

См. также

Предыдущая
Обзор раздела
Следующая
ipr.schema