Управление учётными записями пользователей с помощью Keycloak

Данная инструкция описывает настройку учётных записей для пользователей продуктов 2ГИС, в которых не поддерживается регистрация через API. Вы узнаете:

• как создать учётную запись,
• как установить пароль для неё,
• как редактировать данные пользователя,
• как удалить учётную запись.

Все примеры приведены для продуктов 2ГИС On-Premise (в частности, 2ГИС On-Premise Pro).

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

Разделение пользователей по продуктам обеспечивает realm — конфигурация безопасности, которая содержит совокупность всех данных, необходимых для аутентификации (пользователи, пароли). Каждый realm изолирован от других: содержащиеся в них пользователи не пересекаются.

Realm уже создан заранее, поэтому в рамках инструкции его создание не описывается.

Начало работы

Перед началом работы убедитесь, что сервис аутентификации установлен и корректно работает. После этого:

1. Перейдите по ссылке вида https://keycloak.example.com (вы получили ее в результате установки сервиса).

2. Нажмите Administration Console.

   

3. Введите логин и пароль администратора.

4. Нажмите Sign In.

   

Регистрация пользователя

Для регистрации пользователя:

1. Создайте учетную запись.
2. Задайте для неё пароль.

Создание учетной записи

1. Выберите realm on-premise.

   

2. Перейдите в меню Users.

3. Нажмите Add user.

   

4. Заполните форму:

   

   • Username: системное имя пользователя. Обязательное поле.
   • Email: email пользователя. Поле не отмечено как обязательное, но для корректной работы Keycloak оно должно быть заполнено.
   • Email verified: включите эту опцию, чтобы на указанный email не приходило письмо после каждого входа пользователя в систему.
   • First Name: имя пользователя.
   • Last Name: фамилия пользователя.

5. Завершите создание учётной записи пользователя, нажав Create.

Установка пароля

Сразу после того, как учётная запись создана, вы будете перенаправлены в её карточку. Чтобы установить пароль:

1. Перейдите на вкладку Credentials.

   

2. Нажмите Set password.

3. Заполните форму:

   

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

4. Нажмите Save. После этого появится диалоговое окно:

   

5. Завершите установку пароля, нажав Save password.

Изменение данных пользователя

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

1. Выберите realm on-premise.

2. Перейдите в меню Users.

3. Выберите учётную запись из списка.

   

Изменение основных данных (вкладка Details)

1. Введите новые значения там, где это необходимо. Неизменяемые поля окрашены серым.

   • Email: email пользователя.
   • Email verified: признак верифицированного email.
   • First Name: имя пользователя.
   • Last Name: фамилия пользователя.

2. Нажмите Save.

Изменение пароля (вкладка Credentials)

1. Нажмите Reset password.

2. Заполните форму:

   

   • Password: введите новый пароль.
   • New password confirmation: подтвердите новый пароль.
   • Temporary: включите эту опцию, если вам нужен временный пароль.

3. Нажмите Save. После этого появится диалоговое окно:

   

4. Подтвердите изменение пароля, нажав Reset password.

Сброс пароля (вкладка Credentials)

1. Нажмите значок .

2. Нажмите Delete.

   

3. Подтвердите сброс пароля, нажав Delete в открывшемся диалоговом окне.

   

Удаление учётной записи пользователя

1. Выберите realm on-premise.

2. Перейдите в меню Users.

3. Чтобы удалить одну учетную запись:

   1. Нажмите значок в строке пользователя.
   2. Нажмите Delete.

4. Чтобы удалить несколько учётных записей:

   1. Отметьте чекбоксы в нужных строках списка.
   2. Нажмите Delete user.

5. После этого в обоих случаях появится диалоговое окно:

   

6. Подтвердите удаление, нажав Delete.