Администрирование

Учетная запись администратора

Для первичного входа в ЛК под учетной записью администратора, необходимо пройти саморегистрацию (см. раздел «Самостоятельная регистрация в личном кабинете»).

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

php artisan tandem:create-admin <email>

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

Роли и разрешения

Перечень ролей находится в меню Администрирование | Права доступа | Роли.

На странице отображены все доступные роли, для них можно настроить разрешения и удалить.

Для добавления новой роли необходимо нажать [+ Добавить роль] заполнить необходимые поля и нажать [Создать]. При создании роли необходимо указать её название, системный код (любой уникальный набор символов) и описание.

Настройка разрешений для роли

Для настройки разрешений для ролей необходимо нажать на кнопку с карандашом в столбце Действия и в открывшемся списке прав отметить нужные (разрешения, для удобства, сгруппированы по модулям ЛК). Все назначенные для роли разрешения будут применяться к пользователям с данной ролью.

Перечень разрешений доступен в меню Администрирование | Права доступа | Разрешения.

Назначение ролей для конкретных пользователей осуществляется в Администрирование | Пользователи.

Настройка привязки ролей

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

В случае, если пользователь является обучающимся или работником и имеет учетную карточку (запись персоны) в системе ТАНДЕМ.Университет, ему необходимо выполнить действия по привязке своего личного кабинета к данным ТАНДЕМ.Университет.

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

Для осуществления настройки необходимо войти в систему под учетной записью администратора, перейти в раздел Администрирование | Модули | Главный модуль | Получение ролей.

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

На вкладке Настройка параметров с помощью чекбоксов необходимо выбрать данные, которые ЛК будет запрашивать у пользователя в виджете привязки ролей. Выбор необходимо осуществлять с учетом данных, которые хранятся в системе и их полноты. Сделанная настройка должна обеспечивать возможность однозначной идентификации пользователя.

Необязательные для выбора параметры, по которым будет производиться подтверждение получения роли:

• Фамилия;
• Имя;
• Отчество.

Требуется выбрать хотя бы один параметр, по которому будет производиться подтверждение получения роли:

• Дата рождения;
• Последние 4 цифры паспорта;
• СНИЛС;
• ИНН;
• Номер зачетной книжки (для обучающихся);
• Табельный номер (для сотрудников);
• Email.

Дополнительные настройки:

• Описание

С помощью поля Описание в блоке Дополнительные настройки можно задать текст, который будет отображаться у пользователя в виджете привязки роли.

На вкладке Порядок параметров можно установить порядок вывода параметров.

Управление пользователями

Для работы с разделом управления пользователями платформы личных кабинетов необходимо авторизоваться под учетной записью с правами администратора. Для перехода в раздел с перечнем пользователей необходимо выбрать раздел Администрирование | Пользователи.

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

• Фамилия;
• Имя;
• Отчество;
• Роль;
• Разрешения (выданные пользователю);
• Подразделение (для поиска сотрудников);
• Администратор;
• E-mail не подтвержден;
• Пользователи онлайн.

Все пользователи системы отображаются в таблице с выводом аватара, фамилии, имени, отчества, email, списком привязанных ролей, данных о наличии прав администратора, даты последней авторизации в ЛК и даты создания учетной записи.

Состояние подтверждения почты

В списке пользователей ЛК реализовано отображение состояния подтверждения электронной почты. Зеленый значок напротив почты пользователя в списке означает, что email подтвержден. Если значка нет — пользователь не подтвердил email.

Статус пользователя

Также в разделе можно узнать статус пользователя — онлайн/оффлайн. Статус выводится рядом с аватаркой пользователя в списке и в карточке пользователя. Если индикатор зеленый — пользователь онлайн, красный — оффлайн.

Для перехода в карточку пользователя необходимо нажать на его ФИО.

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

• Пользователь — на карточке пользователя отображаются данные о его электронной почте, телефоне и дате регистрации в ЛК. Доступна функциональность, позволяющая осуществить вход в систему от имени пользователя (кнопка [Вход под пользователем].
  На карточке доступна функция назначения прав администратора пользователю.
• Роли и разрешения — на вкладках с помощью кнопок [Добавить] можно назначить роли для пользователя и выдать разрешения.
• Безопасность — реализована возможность смены пароля пользователя.
•  

Общие настройки

Для настройки платформы личных кабинетов необходимо авторизоваться под учетной записью с правами администратора. Для перехода в раздел общих настроек приложения необходимо выбрать «Администрирование | Модули | Главный модуль | Настройка| Общие».

• Название приложения — название, отображаемое на вкладке браузера.
• URL — доменное имя приложения.
• Описание приложения (<meta name=»description»/>)
• Пользовательские скрипты. Возможность подключения пользовательских скриптов. (Код необходимо вставлять в теге <script></script>, возможно добавление нескольких блоков).

Внешний вид приложения

• Логотип — выбор картинки, которая отображается на форме авторизации и в верхнем меню приложения. При выборе картинки доступно кадрирование изображения. Изображение до 500Кб.
• Иконка — изображение отображаемое на вкладке браузера (favicon)
• Высота логотипа на странице авторизации (в пикселях)
• Тема страницы входа (цвет фона на странице авторизации)
• Логотип для «шапки» приложения (отображается в верхнем левом углу каждой страницы)

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

Форма обращения в техническую поддержку

Опция отправки обращений на странице авторизации.

• E-mail поддержки*.
• Название ссылки (по умолчанию «Поддержка»)*.
• Текст подсказки (по умолчанию «Обязательно укажите ФИО, группу, e-mail и текст обращения»).
• Включить форму технической поддержки (кнопка включения опции).

Если функция включена, на странице авторизации под кнопкой «Войти» отображается кнопка «'Название ссылки'» с помощью которой открывается форма отправки письма на указанный в настройках e-mail.

Пользователю необходимо заполнить:

• Тему обращения.
• E-mail.
• Текст обращения (выводится текст указанной в настройках подсказки), текст обращения не должен превышать 2048 символов.

Кнопкой «отправить» пользователь направляет обращение на указанный в настройках e-mail.

Инструкция пользователя

На странице авторизации отображает ссылку на указанный ресурс.

• Название ссылки (по умолчанию «Инструкция»)*.
• Ссылка на инструкцию*.
• Отображать ссылку на инструкцию (кнопка включения отображения инструкции).

«*» — обязательные поля.

Настройки интерфейса

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

Восстановление пароля на странице авторизации

Для отображения функции восстановления пароля на странице авторизации необходимо в терминале выполнить следующую команду:

php artisan tandem:publish --views

Управление пользователями

• Разрешить самостоятельное удаление.
  При включенной опции пользователи смогут удалять свои учетные записи, без возможности восстановления.
• Включить двухфакторную аутентификацию.
  Пользователю в разделе личных данных будет доступен виджет включения двухфакторной аутентификации для совей учетной записи.
• Разрешить изменять ФИО.
  У пользователей будет возможность изменять свое ФИО.
• Разрешить вход без регистрации.
  Включенная настройка позволяет осуществлять вход в ЛК без регистрации для доступа к спискам поступающих, конкурсным спискам и поиску абитуриентов. На форме авторизации будет доступна кнопка «Войти без регистрации».

Внешние ресурсы

В системе можно размещать ссылки на различные материалы или ресурсы с помощью механизма «Внешние ресурсы». Для просмотра внешних ресурсов пользователем необходимо нажать на пункт «Внешние ресурсы» в навигационной панели.

Администрирование внешних ресурсов

Для добавления внешнего ресурса необходимо добавить категории внешних ресурсов. Создание категории происходит в на странице Управление — Внешние ресурсы — Категории, путем нажатия на кнопку «Новая категория» расположенную в правом верхнем углу экрана. При создании категории откроется диалоговое окно в котором необходимо заполнить:

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

Для удаления категории её необходимо перевести в архив соответствующей кнопкой напротив категории. Так же возможно изменить порядок следования категорий, и соответственно порядок их отображения у пользователя.

Для добавления внешнего ресурса необходимо перейти на страницу Управление — Внешние ресурсы — Ресурсы. На данной странице отображается список созданных внешних ресурсов с возможностью их редактирования, архивирования и удаления. Для создания ресурса необходимо нажать на кнопку «Новый ресурс» расположенную в правом верхнем углу экрана. При создании необходимо указать следующую информацию:

• Название
• Описание (краткое, отображается под названием)
• Ссылка на ресурс / материал (URL формата https://example.ru)
• Категория

Разрешения для администрирования

Для администрирования доступны следующие разрешения:

• Просмотр категорий ресурсов
• Создание категорий ресурсов
• Обновление категорий ресурсов
• Отправка категорий ресурсов в архив
• Восстановление категорий ресурсов их архива
• Удаление категорий ресурсов
• Просмотр элементов ресурсов (для управления)
• Создание элементов ресурсов
• Обновление элементов ресурсов
• Отправка элементов ресурсов в архив
• Восстановление элементов ресурсов их архива
• Удаление элементов ресурсов
• Изменение позиций элементов ресурсов

Просмотр внешних ресурсов

Просмотр внешних ресурсов доступен всем обучающимся и сотрудникам

Для просмотра списка внешних ресурсов необходимо в навигационной панели выбрать пункт «Внешние ресурсы». На странице отобразится список категорий с закрепленными к ним внешними ресурсами.

Нажатие на название внешнего ресурса открывает его в новой вкладке браузера.

Авторизация OAuth2

Подключение клиента

Для настройки авторизации OAuth2 необходимо:

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

composer install

2. Прописать команду команду для установки Laravel/passport:

php artisan passport:install

3. Прописать команду:

php artisan tandem:publish

4. Почистить кеш:

php artisan route:clear

5. Далее требуется создать клиента в меню «Администрирование | Настройки | OAuth2 | Клиенты» (/admin/oauth2/clients/create).
   Название – любое произвольное название, Url переадресации – https:://{ДОМЕН} /admin/oauth2callback.php.
6. После создания в окне редактирования клиента есть поля ID клиента и секретный ключ. Эти поля будут использоваться для интеграции с moodle.

Для работы moodle с проектом требуется наличие SSL сертификата

Настройка moodle

1. Войти под учетной записью администратора.
2. Перейти по адресу /admin/search.php?query=oauth2 и на странице с поиском нажать на значок глаз для активации OAuth2 плагина.
3. Перейти по адресу /admin/tool/oauth2/issuers.php и выбрать создание новой персонализированной службы.
4. В форме создания службы указать id пользователя и пароль пользователя, которые были получены при создании клиента OAuth2 в ЛК. В области видимости ввести user, для базовой url-адрес службы и url-адрес логотипа ввести ссылки на ЛК. В первом случае домашняя страница и во втором ссылка на логотип (не обязательно).
5. После создания потребуется настроить конечные точки. Для этого в списке служб требуется нажать на кнопку со списком и создать 3 точки. Конечные точки которые необходимо создать:НазваниеURLauthorization_endpointhttps://{адрес личного кабинета}/oauth/authorizetoken_endpointhttps://{адрес личного кабинета}/oauth/tokenuserinfo_endpointhttps://{адрес личного кабинета}/api/user
6. Необходимо настроить поля пользователя, по которым данные пользователя ЛК будут перенесены пользователю moodle. Для настроек полей необходимо нажать на иконку человека.Данные пользователя:Имя внешнего ключа, Имя внутреннего ключа, first_name, firstname, last_name, lastname, email, emailid, id, number
7. После этого можно проверить работоспособность нажав на кнопку вход.

Настройка авторизации через сторонние провайдеры (работа в режиме клиента)

Работа в режиме клиента дает возможность подключать сторонние OAuth2 провайдеры и осуществлять авторизацию через подключенные провайдеры. Например, можно подключить OAuth2 провайдер «ВКонтакте» и осуществлять вход в личный кабинет через авторизацию «ВКонтакте», данные о пользователе будут перенесены.

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

Подключение

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

composer install

2. Прописать команду для установки Laravel/passport:

В случае если пакет не был установлен ранее и не созданы ключи.

php artisan passport:install

3. Прописать команду для публикации файлов:

php artisan tandem:publish --views

4. Почистить кеш роутов:

php artisan route:clear

Добавление провайдера

В качестве примера добавления провайдера будет использован провайдер «ВКонтакте».

Для добавления провайдера необходимо авторизоваться под учетной записью администратора и перейти в раздел меню «Администрирование | Настройки | OAuth2 | Провайдеры» и нажать кнопку «+ Провайдер» или перейти по адресу /admin/oauth2/providers/create. При добавлении провайдера откройте раздел добавления клиента на стороне провайдера и начните добавлять клиента. Когда потребуется callback адрес — укажите его из формы добавления провайдера, который автоматически генерируется при вводе текста.

Форма добавления провайдера состоит из трех обязательных форм:

1. Основные параметры
2. Конечные точки
3. Поля пользователя

Вкладка «Основные параметры»

Описание полей формы:

Владка «Конечные точки»

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

1. authorization_endpoint – url адрес получения разрешения на авторизацию.
2. token_endpoint – url адрес получения токена для авторизации.
3. userinfo_endpoint – url адрес получения информации по токену авторизации.

Обратите внимание, что в форме разрешено вводить несколько userinfo_endpoint. Некоторые сервисы выдают информацию не полностью и разбивают ее на разные конечные точки. Например, email адрес можно получить только по адресу /oauth2/user2/email, а ФИО и прочие поля можно получить по адресу /oauth2/user/2 .

Также настройка конечных точек userinfo_endpoint наделена возможностью указывать параметры. Некоторым сервисам, например, «ВКонтакте», необходимо указывать версию и токен авторизации через GET параметры, а не через заголовок. Если в значении параметра необходимо передать токен авторизации, то требуется вписать в поле значения метку “{token}”, и при выполнении запросов эта метка будет заменена на значение токена.

Большинство провайдеров используют авторизацию через передачу токена в заголовке — “Authorization” Bearer token. Как и в случае с параметром для указания Bearer токена необходимо в значение записать текст с меткой токена “Bearer {token}”. Если запросы получения информации о пользователе требуют других заголовков, то их также можно добавить и задать значения. Все настройки заголовков автоматически применяются ко всем userinfo_endpoint.

Владка «Поля пользователя»

Поля пользователя — это данные, которые будут синхронизированы с аккаунтом в личном кабинете при создании нового пользователя. При авторизации без создания учетной записи поля не будут изменять данные пользователя. Поле provider_user_id будет указываться только в случае, если пользователь еще не выполнял авторизацию через конкретный провайдер.

Для добавления провайдера необходимо указать минимум три поля:

1. provider_user_id — id пользователя на стороне клиента;
2. first_name — Имя;
3. last_name — Фамилия.

Остальные поля опциональны и их значения можно не указывать. Для добавления полей необходимо нажать на кнопку «Добавить».В добавленной строке, в выпадающем списке «Локальное значение» указать требуемое поле и значение, которое будет получено.

Заполнение поля «Внешнее значение (провайдер)»:

Некоторые сервисы, например, «ВКонтакте», отправляют информацию о пользователе объектом. «Вконтакте» возвращет в ответ объект response, внутри которого элементы и по индексу 0 можно получить данные пользователя.

Поэтому, для получения значения в поле Имя необходимо использовать следующее значение: response.0.first_name. И для других полей по такому же принципу: response.0.{название поля}.

Если провайдер отправляет значения пользователя прямо в запросе, то можно сразу писать first_name и т.д.

После добавления провайдера («Основные параметры» включен парамер «Действует») на формах входа и регистрации будут отображаться альтернативные способы входа.

Дополнительная информация об OAuth2:

• Введение в OAuth2
• OAuth 2.0

Модули

Настройки главного модуля

Службы

ЛКА – Личный кабинет абитуриента
ВИ – Вступительные испытания/Вступительное испытание
ДДС – Дисциплины для сдачи
ПК – Приемная кампания
ОЗ – Онлайн-заявление