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

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

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

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

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

1. Войдите в качестве администратора;
2. В меню слева выберите Администрирование > Пользователи;

3. В правом верхнем углу страница нажмите на кнопку + Пользователь;

   

4. В окне Новый пользователь заполните поля: Имя, Фамилия, Логин, Эл. почта, Пароль и Подтвердите пароль;

   

5. Назначьте пользователю роль: Администратор, Редактор или Только чтение;

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

   

6. Нажмите Сохранить. Новый пользователь появится в списке пользователей на странице Управление пользователями.

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

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

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

Чтобы подтвердить или отклонить выбранных пользователей, нажмите Одобрить/Отклонить или Одобрить всех/Отклонить всех, чтобы подтвердить всех неподтвержденных пользователей в списке.

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

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

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

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

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

1. Войдите в качестве администратора;
2. В меню слева выберите Администрирование > Пользователи;
3. В правом верхнем углу страница нажмите на кнопку + Пользователь;

4. В окне Новый пользователь нажмите кнопку Создать сервисный аккаунт;

   

5. Укажите логин бот-пользователя;

6. Назначьте бот-пользователю роль: Admin, Editor or Readonly;

   Примечание: после назначения бот-пользователю роли, ее нельзя будет изменить.

   

7. Нажмите Создать. Новый бот-пользователь появится в списке пользователей на странице Управление пользователями;

8. Скопируйте токен бот-пользователя, для подключения бота к вашему приложению;

   

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

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) - может создавать и редактировать собственные проекты; может редактировать назначенные пользователю проекты и иши, если назначена роль Editor в проекте; не может редактировать глобальные настройки Apiary;
• Только чтение (readonly) - не может создавать проекты и редактировать глобальные настройки Apiary; может редактировать назначенные пользователю проекты и иши, если назначена роль Editor в проекте.

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

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