Настройка Keycloak

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

1. В Keycloak создать realm «DH».

Для этого необходимо после авторизации в Keycloak перейти в раздел Manage realms и нажать кнопку [Create realm].

img

В открывшемся окне указать значение «DH» в поле Realm name, оставить тумблер Enabled в положении «On» и нажать кнопку [Create].

2. После создания в разделе Manage realms выбрать реалм «DH», нажав ЛКМ на его наименование.

3. Открыть раздел Realm Settings и на вкладке General перевести переключать User-Managed Access в активное состояние.

img

4. Создать глобальные роли «dh-admin», «dh-user», которые впоследствии необходимо будет добавить созданным системным клиентам и пользователям. Наименования ролей являются фиксированными и не могут быть изменены при создании. Роль «dh-admin» необходима для работоспособности Системы.

Для этого нужно перейти в раздел Realm roles, в открывшемся разделе нажать кнопку [Create role].

img

В открывшейся форме заполнить поля и нажать кнопку [Save] для каждой роли

img

5. Скачать файлы настроек «dh-backend.json» и «dh-webclient.json», расположенные в папке с документацией.

6. Выбрать раздел Clients и импортировать клиентов «dh-backend» и «dh-webclient», нажав кнопку [Import client]. Импорт данных клиентов необходим для работоспособности Системы.

img

7. В открывшейся форме для каждого создаваемого клиента импортировать соответствующие ему настройки.

img

После импорта настроек:

Для клиента «dh-backend»:

  • На вкладке Service Accounts Roles добавить роль «dh-admin».

Для клиента «dh-webclient»:

  • На вкладке Roles добавить клиентские роли «dh-admin» и «dh-user». Добавление данных ролей для клиентов необходимо. Наличие роли «uma_protection» не влияет на работоспособность Системы.

  • На вкладке Authorization нажать кнопку [Import] и импортировать настройки из файла «dh-webclient-authz-config.json», который расположен в папке с документацией.

7. Создать пользователей «admin» и «user». Создание данных пользователей предназначено для удобства администрирования и не является обязательным.

Для этого необходимо перейти в раздел Users, в правом верхнем углу нажать кнопку [Add user].

img

Для каждого пользователя заполнить поля:

  • Указать логин в поле Username и электронный адрес в поле Email.
  • В поле Required user actions можно выбрать обязательное действие, которое данный пользователь будет совершать при первом входе в Систему.
  • Активация тумблера Email verified устанавливает признак подтвержденного электронного адреса для создаваемого пользователя. В таком случае Keycloak не будет отправлять данному пользователю письмо с подтверждением регистрации, если отправка настроена в Realm settings. Поле Email verified имеет приоритет над Required user actions.

Нажать кнопку [Create].

img

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

8. После создания открыть каждую карточку пользователя и на вкладке Credentials установить постоянный пароль, нажав кнопку [Set password].

В открывшемся окне указать пароль, деактивировать тумблер [Temporary] и нажать кнопку [Save].

img

9. На вкладке Role Mappings в карточках пользователей нажать кнопку [Assign Role] и выбрать значение «Realm roles», чтобы назначить пользователям роли.

Пользователи и их роли

Пользователь Роли
admin dh-admin
user dh-user, uma_authorization

Стандартные роли на вкладке Role Mappings изменять и удалять не требуется.