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

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

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

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

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

Войдите в Apiary в качестве администратора.
В меню слева выберите Админ > Пользователи > Список (List).
В правом верхнем углу страницы нажмите + Пользователь (+ User).
В окне Новый пользователь (New user) заполните обязательные поля: Login (Логин), Email (Электронная почта) и Password (Пароль).
Назначьте пользователю роль: Admin (Администратор), Editor (Редактор) или Readonly (Только для чтения).

Примечание: только администраторы могут назначать пользователям права администратора.
Заполните остальные поля по желанию и нажмите Сохранить (Create).

Новый пользователь появится в списке на странице Список пользователей (User list).

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

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

Подтверждение и редактирование пользователей

Все неподтвержденные пользователи появляются в списке со статусом Ожидание (Pending) на странице Список пользователей (User list).
Подтверждать пользователей могут только администраторы.

Чтобы подтвердить или отклонить выбранных пользователей:

В списке пользователей найдите пользователей со статусом Ожидание (Pending).
Для удобства включите сортировку по статусу, нажав на заголовок столбца Статус (Status).
Нажмите на значок статуса пользователя и выберите нужное значение: Подтверждён (Accepted) или Отклонён (Decline).
Если нужно изменить статус пользователя, нажмите на значок статуса и выберите Подтверждён (Accepted) или Заблокирован (Blocked).
Чтобы вернуть пользователю статус Ожидание (Pending), нажмите имя пользователя в списке и измените статус в открывшемся окне.

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

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

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

Пользователя-бота можно использовать для автоматизации работы с Apiary:

автоматизации поиска;
автоматизации просмотра сообщений;
автоматизации ответа на сообщения;
а также интеграции со сторонними приложениями.

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

Войдите в Apiary в качестве администратора.
В меню слева выберите Админ > Пользователи > Список (List).
В правом верхнем углу страницы нажмите + Пользователь (+ User).
В окне Новый пользователь (New user) в поле Тип (Type) выберите Бот (Bot).
Укажите имя пользователя-бота (Name) и дату блокировки (Lockout date).
Назначьте пользователю-боту роль. Рекомендуем выбрать роль Admin (Администратор), чтобы при работе с ботом вам был доступен весь его функционал, в том числе доступ ко всем проектам Apiary.

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

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

curl --silent --location '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) — может только просматривать проекты и иши.

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

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

В меню слева выберите Админ > Пользователи > Список (List).
Найдите нужного пользователя в списке и нажмите Проекты (Projects):
В открывшемся окне выберите нужные проекты, а затем подходящую роль пользователя. Нажмите Назначить (Assign):

Чтобы добавить пользователей в конкретный проект:

В меню слева выберите Проекты.
Найдите подходящий проект в списке и нажмите на значок любого пользователя в столбце Команда (Team):
В открывшемся окне нажмите на пустую строку и добавьте одного или несколько пользователей при помощи +:
Чтобы изменить роль или удалить пользователя из проекта, в этом же окне нажмите на роль пользователя и выберите нужный вариант: