Расширенные возможности администрирования пользователей

Получение списка пользователей системы и их ролей

В некоторых случаях, например, для интеграции со сторонними системами, требуется получить список пользователей. В этом параграфе показан пример получения списка пользователей. Чтобы выполнить этот http-запрос, нужно предварительно получить значение куки FSESSIONID. Это можно сделать, посмотрев Инструменты разработчика (по кнопке F12 или Исследовать) либо выполнив http-запрос аутентификации.

Пример запроса:

curl 'http://apiary.host.address/api/users/' \
    -H 'Content-Type: application/json' \
    -H 'Cookie: FSESSIONID=<session_id>'

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

[
  {
    "mfaConfirmed": false,
    "userGroups": [],
    "id": "4f5fcf42-8b79-48f5-b15e-31e1478b671a",
    "role": "READONLY",
    "permissions": [],
    "passwordChangeRequired": false,
    "lastName": "Third",
    "isAdmin": false,
    "userType": "LOCAL",
    "registered": "2025-04-18",
    "state": "ACTIVE",
    "firstName": "User3",
    "userEmail": "user3@example.com",
    "userLogin": "user3"
  },
  {
    "mfaConfirmed": false,
    "userGroups": [],
    "id": "8bdb052c-692a-4f48-9080-3b272a81edd8",
    "role": "EDITOR",
    "permissions": [
      "PROJECT_CREATE"
    ],
    "passwordChangeRequired": false,
    "lastName": "Second",
    "isAdmin": false,
    "userType": "LOCAL",
    "registered": "2025-04-18",
    "state": "ACTIVE",
    "firstName": "User2",
    "userEmail": "user2@example.com",
    "userLogin": "user2"
  },
  {
    "mfaConfirmed": false,
    "userGroups": [
      {
        "description": "test group1 ",
        "id": "fe47ed25-2a11-49fb-91a6-d3d25009a8c5",
        "updated": "2025-04-17T14:06:04.208500Z",
        "created": "2025-04-17T14:05:44.250589Z",
        "name": "group1"
      }
    ],
    "id": "058b2608-b5b1-4af5-92e7-3cc572ab8246",
    "role": "ADMIN",
    "permissions": [
      "ALL"
    ],
    "passwordChangeRequired": false,
    "lastName": "First",
    "isAdmin": true,
    "userType": "LOCAL",
    "registered": "2025-04-17",
    "state": "ACTIVE",
    "firstName": "User1",
    "userEmail": "user1@example.com",
    "userLogin": "user1"
  }
]

В данном примере:

isAdmin — пользователь является администратором;
state — состояние пользователя:
ACTIVE — пользователь имеет доступ к Apiary;
PENDING — создан, но ещё не подтверждён;
BLOCKED — заблокирован.

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

В Apiary продолжительность пользовательской сессии по умолчанию — 360 минут (6 часов). То есть, через 6 часов бездействия сессия пользователя будет прервана, и ему придётся логиниться заново. Но вы можете изменить время жизни пользовательской сессии.

Чтобы изменить продолжительность пользовательской сессии в Apiary, измените конфигурацию.

Добавьте опцию f.engine.session.lifetime.minutes и установите числовое значение в минутах.

Пример:

f.engine.session.lifetime.minutes = 1

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