Перейти к содержанию

Интеграция с решением SSO OIDC Keycloak

Вы можете использовать технологию единого входа (Single Sign‑On, SSO) для аутентификации пользователей вашей компании на портале Вебмониторэкс, если ваша компания уже использует OIDC (OpenID Connect) SSO Keycloak.

В инструкциях по настройке и работе с SSO в связке с Вебмониторэкс в качестве поставщика сервиса (роль Service Provider, SP) выступает Вебмониторэкс (далее в документах — «поставщик сервиса»), в качестве поставщика идентификационных данных (роль Identity Provider, IdP) – Keycloak.

Подключение услуги SSO

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

Если эта услуга не активирована, блоки, относящиеся к SSO, не будут отображаться на вкладке Интеграции раздела Настройки на портале Вебмониторэкс.

После активации услуги:

  • вы сможете выполнить процедуру подключения SSO;

  • на вкладке Интеграции будут отображаться блоки для подключения SSO.

Процесс подключения SSO OIDC Keycloak

Настройки Keycloak

Проведите настройки Keycloak с помощью официальной документации:
1. Создайте Realm.
2. Создайте Client.
3. Настройте пользователей и роли (опционально).
Изучите документацию Keycloak по интеграции с OIDC.

Копирование и заполнение параметров

  1. Авторизуйтесь на портале Вебмониторэкс с использованием аккаунта администратора, перейдите в раздел Настройки → вкладка Интеграции.

  2. В разделе Аутентификация SSO нажмите на блок Keycloak OIDC SSO.

    Добавление интеграции OIDC

    Откроется форма создания интеграции Keycloak OIDC SSO.

  3. Скопируйте параметр Redirect uri из формы создания интеграции.

  4. Перейдите в Keycloak.

Чтобы не переключаться между приложениями при копировании параметров, можно открыть два окна рядом.

  1. Откройте раздел Clients, выберите клиента, на вкладке Settings вставьте параметр Redirect uri в поле Valid redirect URIs.
    Скопируйте Client ID и вставьте в поле Client id в форме создания интеграции в Вебмониторэкс.

    Valid redirect uris

    В Keycloak прокрутите вкладку Settings до секции Access settings и убедитесь, что включена опция Standart flow:

    Standart flow

  2. Скопируйте параметры Authorization endpoint, Token endpoint и Userinfo endpoint: это можно сделать в Keycloak в разделе Realm settings на вкладке Endpoints или по ссылке {keycloak_host}/realms/{realm_name}/.well-known/openid-configuration.

    Параметры OIDC

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

  3. В Keycloak перейдите в раздел Clients, выберите клиента, на вкладке Credentials скопируйте параметр Client Secret и вставьте в соответствующее поле в форме создания интеграции в Вебмониторэкс.

    Client Secret

  4. Заполните поле Scope – оно определяет, какие утверждения будут включены в токен. Например, openid, email, profile и т.д.

    • openid: обязательный scope для OIDC. Указывает, что вы используете протокол OpenID Connect.
    • email: запрашивает доступ к email пользователя. В токен будет включено поле email.
    • profile: запрашивает доступ к базовой информации о пользователе, такой как имя, фамилия, username и т.д.

    Форма интеграции Keycloak

  5. Нажмите кнопку Создать в форме создания интеграции в Вебмониторэкс.

Настройка SSO OIDC Keycloak завершена, и теперь можно приступить к настройке SSO‑аутентификации конкретных пользователей на стороне Вебмониторэкс.