Добавление пользователей в систему

Добавление пользователей

Прежде чем приглашать пользователей в проект, их нужно сначала добавить в Apiary. Зарегистрированные пользователи могут сами добавлять в проекты новых пользователей. Однако новым пользователям требуется подтверждение от любого из администраторов, чтобы залогиниться в Apiary.

Примечание: только администраторы могут добавлять пользователей в Apiary.

Чтобы добавить пользователя:

Войдите в качестве администратора.
В меню слева выберите Администрирование > Пользователи.
В правом нижнем углу страница нажмите кнопку + Добавить пользователя.
В окне Создать пользователя заполните поля: Имя пользователя, Mail (Электронная почта) и Пароль.
Назначьте пользователю роль: Admin (Администратор), Editor (Редактор) или Readonly (Только для чтения).
> Примечание: только администраторы могут назначать пользователям права администратора.
Нажмите Сохранить.

Новый пользователь появится в списке пользователей на странице Пользователи.

⚠️ Примечания:

Пользователи LDAP автоматически появятся в списке пользователей после первого входа в Apiary.
Когда LDAP включен, создать новых локальных пользователей в Apiary не получится. Однако можно добавлять ботов-пользователей.

Все неподтвержденные пользователи появляются в списке на странице Пользователи.

Примечание: для подтверждения пользователя необходимо иметь права администратора.

Чтобы подтвердить или отклонить выбранных пользователей, нажмите Подтвердить все/Отклонить все. Также можно выполнить это действие для каждого по отдельности, нажав Подтвердить/Отклонить в строке таблицы выбранного пользователя.

Для редактирования пользователя нажмите на выбранного пользователя. В окне Пользователь вы можете также заблокировать или удалить пользователя.

Примечание: пользователей LDAP нельзя удалять, их можно только заблокировать. Однако при удалении пользователя с LDAP-сервера пользователь потеряет возможность логина.

Создание пользователя-бота

Пользователя-бота можно использовать для автоматизации работы с Apiary. Например, для автоматизации поиска, автоматизации просмотра сообщений, автоматизации ответа на сообщения или для интеграции со сторонними приложениями.

Чтобы добавить пользователя-бота на Apiary:

Войдите в качестве администратора.
В меню слева выберите Администрирование > Пользователи.
В правом верхнем углу страница нажмите кнопку + Пользователь.
В окне Новый пользователь нажмите кнопку Создать сервисный аккаунт.
Укажите логин пользователя-бота.
Назначьте пользователю-боту роль: Admin, Editor or Readonly.

Примечание: после назначения пользователю-боту роли ее нельзя будет изменить.
Нажмите Создать. Новый пользователь-бот появится в списке пользователей на странице Управление пользователями.
Скопируйте токен пользователя-бота для подключения бота к вашему приложению.

Вы можете проверить подключение пользователя-бота при помощи следующей команды:

curl --silent 'http://apiary-hostname/api/projects/' -H 'Authentication: <user_bot_token>'

Если все правильно, ответ сервера будет следующим:

[
  {
    "completionDate": "2023-03-23",
    "connectionName": null,
    "created": "2023-03-23T08:47:14.358843Z",
    "description": "",
    "groupID": "4cd961ee-50ed-4d95-9340-4d1ace7038e9",
    "hawserID": null,
    "id": "ad09eb54-31f0-44d4-b991-6bbd83bbf0f7",
    "lastIncomingPong": null,
    "lastOutgoingPing": null,
    "name": "project_name",
    "owner": {
      "firstName": null,
      "id": "e2305102-84df-45b7-a779-f028b69229fc",
      "isAdmin": true,
      "lastName": null,
      "passwordChangeRequired": false,
      "userEmail": "root@ro.ot",
      "userLogin": "root@ro.ot"
    },
    "permission": null,
    "projectType": "",
    "scope": "",
    "startDate": "2023-03-23",
    "updated": "2023-03-23T08:47:14.358863Z"
  }
]

Роли пользователей

В Apiary есть два типа ролей: Глобальные и Проектные.

Глобальные роли отвечают за доступ пользователей к Apiary:

Администратор (Administrator) — имеет полный доступ ко всему функционалу Apiary.
Редактор (Editor) — может создавать и редактировать собственные проекты. Также может редактировать назначенные проекты и иши, если в проекте у него роль Редактор. Глобальные настройки Apiary редактировать не может.
Только для чтения (Readonly) — не может создавать проекты и редактировать глобальные настройки Apiary. Может только редактировать назначенные проекты и иши, если в проекте у него роль Редактор.

Проектные роли отвечают за доступ к проектам и ишам в Apiary:

Владелец (Owner) — имеет полный доступ ко всему функционалу проекта.
Редактор (Edit) — может редактировать назначенные пользователю проекты и иши.
Только для чтения (Readonly) — может только просматривать проекты и иши.