Различия

Показаны различия между двумя версиями страницы.

--- product:api:integration_examples:blitz-idp [12.09.2024 06:47] – [Настройки в ADVANTA] ekaterina.menkhuzina
+++ product:api:integration_examples:blitz-idp [01.11.2025 09:14] (текущий) – ekaterina.menkhuzina
@@ Строка 1: / Строка 1: @@
 ====== Интеграция ADVANTA с Blitz Identity Provider ======
 Сервер аутентификации [[https://identityblitz.ru|Blitz Identity Provider]] - это российское ПО для управления входом пользователей в приложения, позволяющее оснастить веб-сайты и мобильные приложения компании функциями защиты учетных записей пользователей. Благодаря интеграции возможно осуществлять авторизацию в Систему ADVANTA через сервер аутентификации по протоколу OpenIdConnect.
 Подключение Системы ADVANTA к Blitz IDP выполняется по протоколу **OpenIdConnect** и состоит из двух этапов:
-  - Настройки на стороне [[https://identityblitz.ru|Blitz Identity Provider]].
   - Настройки на стороне Системы ADVANTA.
+  - Настройки на стороне [[https://identityblitz.ru|Blitz Identity Provider]].
 Для реализации интеграции у вас должен быть доступ по крайней мере к демо-версиям данных продуктов.
@@ Строка 28: / Строка 29: @@
 Blitz IDP зарегистрирован в Едином реестре российского ПО (№842) и сертифицирован ФСТЭК России (№4525 от 10.03.2022), что подтверждает соответствие требованиям информационной безопасности и допускает применение продукта в государственных информационных системах.
-===== Установка и настройка Blitz IDP =====
+===== Настройки интеграции на стороне ADVANTA =====
-==== Общая инструкция по установке ====
-Подробная информация об установке и настройке Blitz IDP в документации на сайте Blitz IDP на странице [[https://docs.identityblitz.ru/latest/admin-guide/install-ee.html|Общая инструкция по установке]].
-<callout type="primary" icon="true">В зависимости от используемой операционной системы есть своя специфика по установке необходимого окружения.</callout>
-Также можно посмотреть [[https://demo.identityblitz.com/list_ru/|демоверсию]] приложения.
-==== Настройки интеграции на стороне Blitz IDP ====
-Для настройки интеграции в консоли управления Blitz IDP перейдите в раздел "Приложения" и выполните действия:
-. Создайте новое приложение ADVANTA, задав его базовые настройки:
-  * идентификатор (''entityID'' или ''client_id''): ''<client_id>'';
-  * название: ''<name>'';
-  * домен.
-. Нажмите "Сохранить".
-. Далее нажмите кнопку "Параметры"  у предложения ADVANTA и отредактируйте параметры приложения:
-  * протоколы: выберите **OAuth 2.0** / **OpenIdConnect** и нажмите "Сконфигурировать";
-  * далее в параметрах укажите данные, как в конфигурационном файле ''client.config'': секрет (''client_secret''), префиксы ссылок возврата, допустимые разрешения: profile.
-. Нажмите "Сохранить".
-<callout type="info" icon="true">После прохождения всех шагов рекомендуем проверить корректность входа в ADVANTA.</callout>
-Более подробную информацию о настройках интеграции можно найти в документации на сайте Blitz IDP в разделе [[https://docs.identityblitz.ru/latest/integration-guide/index.html|Интеграция]].
-===== Настройки в ADVANTA =====
 [[product:settings:system:open_id|Настройка авторизации через Open ID Connect]] производится Администратором системы.
@@ Строка 76: / Строка 51: @@
 ^ Параметр ^ Описание ^
-|caption|Название провайдера авторизации на странице входа в систему|
+|caption|Обязательный параметр \\ Название провайдера авторизации для отображения кнопки с этим именем|
-|metadataURL|URL-адрес удаленного сервера с метаданными|
+|metadataURL|Обязательный параметр \\ URL-адрес удаленного сервера с метаданными|
-|authenticationType|Идентификатор провайдера авторизации|
+|authenticationType|Обязательный параметр \\ Идентификатор провайдера авторизации, под этим именем данный провайдер OpenIdConnect будет отображаться в профиле пользователя, а также использоваться в API методах. Можно использовать любой удобный|
-|clientId|Идентификатор клиента (приложения), выбирается согласно правилам именования сервисов для аутентификации в OpenIdConnect|
+|clientId|Обязательный параметр \\ Идентификатор клиента (приложения), выбирается согласно правилам именования сервисов для аутентификации в OpenIdConnect|
-|enabled|Включение/отключение провайдера, возможные значения: true и false|
+|enabled|Обязательный параметр \\ Включение/отключение провайдера, возможные значения: true и false|
-|scope|Запрашиваемые скоупы. Если параметр не задан, то используется только скоуп ''openid''|
+|scope|Указываются запрашиваемые скоупы. Если параметр не задан, то используется только скоуп ''openid'' \\ Может быть несколько|
-|clientSecret|Секрет приложения|
+|clientSecret|Обязательный параметр \\ Указывается секрет приложения|
-|responseType|Необязательный параметр. Тип ответа, по умолчанию ''id_token''. Возможные значения: ''code'',''code id_token'', ''code id_token token'', ''code token'', ''id_token'', ''id_token token'', ''token''|
+|responseType|Необязательный параметр. \\ Тип ответа, по умолчанию ''id_token''. Возможные значения: \\ ''code'', \\ ''code id_token'', \\ ''code id_token token'', \\ ''code token'', \\ ''id_token'', \\ ''id_token token'', \\ ''token''|
-|claimType|Тип утверждения, используемый для получения идентификатора пользователя на сервере авторизации|
+|claimType|Тип утверждения, используемый для получения идентификатора пользователя на сервере авторизации. Будет использоваться для связки пользователя системы с пользователем OpenIdConnect|
-|disableSignatureValidation|Необязательный параметр, отключает валидацию токена. Если параметр не задан, то значение false и валидация включена|
+|disableSignatureValidation|Необязательный параметр \\ Отключает валидацию токена. Если параметр не задан, то значение false и валидация включена|
-|jwks_uri|Стандарт под OpenIdConnect провайдера|
+|jwksFilePath|Опциональный параметр \\ Файл, который содержит ключи валидации в формате JSON. Формат аналогичен странице ''jwks_uri''. Если параметр не задан, то ключи берутся только с адреса ''jwks_uri'' \\ Можно использовать, если по какой-то причине провайдер OpenIdConnect не предоставляет ключи валидации \\ Пример использования:  ''jwksFilePath'' = ″C:\inetpub\wwwroot\a2key\jwksFile.txt″|
-|jwksFilePath|Опциональный параметр. Файл, который содержит ключи валидации в формате JSON. Формат аналогичен странице ''jwks_uri''. Если параметр не задан, то ключи берутся только с адреса ''jwks_uri''. Можно использовать, если по какой-то причине провайдер OpenIdConnect не предоставляет ключи валидации|
-<callout type="warning" icon="true">В конфигурационном файле ''client.config'' также необходимо добавить индикацию, что необходимо использовать интеграцию с **OpenIdConnect**. Для этого опционально в разделе ''<configSections>'' предусмотреть размещение секции ''"<section name="openIdConnect" type="Config.OpenIdConnectConfigurationSection, smcorelib"/>»''. При отсутствии данной секции, использование **OpenIdConnect** невозможно.</callout>
+<callout type="warning" icon="true">В ''client.config'' также необходимо добавить индикацию, что необходимо использовать интеграцию с **OpenIdConnect**. Для этого опционально в разделе ''<configSections>'' предусмотреть размещение секции '' ″<section name= ″openIdConnect″'' ''type=″Config.OpenIdConnectConfigurationSection,smcorelib″/>″''. При отсутствии данной секции, использование **OpenIdConnect** невозможно.</callout>
 Пример настройки конфигурационного файла системы ''client.config'' для авторизации через провайдера [[https://identityblitz.ru|Blitz IDP]]:
@@ Строка 117: / Строка 91: @@
 </openIdConnect>
-...
-<appSettings>
-  <add key="AllowedExternalApplicationClientIds" value="1;2"/>
-  ...
-</appSettings>
 ...
 </code>
@@ Строка 131: / Строка 98: @@
   * использовать метод API [[product:api:list:deletelinkuserwith_oid|DeleteLinksWithOpenIdConnect]]. Подробнее о методах API на странице [[product:api:list|Описание методов API]].
 </callout>
+===== Установка и настройка Blitz IDP =====
+==== Общая инструкция по установке ====
+Подробная информация об установке и настройке Blitz IDP в документации на сайте Blitz IDP на странице [[https://docs.identityblitz.ru/latest/admin-guide/install-ee.html|Общая инструкция по установке]].
+<callout type="primary" icon="true">В зависимости от используемой операционной системы есть своя специфика по установке необходимого окружения.</callout>
+Также можно посмотреть [[https://demo.identityblitz.com/list_ru/|демоверсию]] приложения.
+==== Настройки интеграции на стороне Blitz IDP ====
+Для настройки интеграции в консоли управления Blitz IDP перейдите в раздел "Приложения" и выполните действия:
+. Создайте новое приложение ADVANTA, задав его базовые настройки:
+  * идентификатор (''entityID'' или ''client_id''): ''<client_id>'';
+  * название: ''<name>'';
+  * домен.
+. Нажмите "Сохранить".
+. Далее нажмите кнопку "Параметры"  у приложения ADVANTA и отредактируйте параметры приложения:
+  * протоколы: выберите **OAuth 2.0** / **OpenIdConnect** и нажмите "Сконфигурировать";
+  * далее в параметрах укажите данные, как в конфигурационном файле ''client.config'': секрет (''client_secret''), префиксы ссылок возврата, допустимые разрешения: profile.
+. Нажмите "Сохранить".
+<callout type="info" icon="true">После прохождения всех шагов рекомендуем проверить корректность входа в ADVANTA.</callout>
+Более подробную информацию о настройках интеграции можно найти в документации на сайте Blitz IDP в разделе [[https://docs.identityblitz.ru/latest/integration-guide/index.html|Интеграция]].
 ===== Результат интеграции =====
 ==== Вход в систему ====
-После корректных настроек конфигурационного файла и перезапуска системы, пользователю будет доступен вход в систему через нового провайдера аутентификации.
+После корректных настроек конфигурационного файла и перезапуска системы, пользователю будет доступен вход в систему через новый провайдер аутентификации.
 Например, пользователь, нажимая на кнопку «Войти через SSO», перенаправляется на адрес провайдера авторизации Blitz IDP, указанный в настройках файла ''client.config''. После успешного прохождения авторизации у провайдера **OpenIdConnect**, запрос будет перенаправлен обратно в систему ADVANTA. Система ADVANTA производит идентификацию пользователя и, в случае успешной идентификации, авторизует пользователя в системе.
@@ Строка 142: / Строка 137: @@
 ==== Портлет в настройках пользователя ====
-После настройки интеграции с Blitz IDP в профиле пользователя также появится раздел для связывания учетной записи системы ADVANTA с учетной записью внешнего провайдера. Портлет находится в настройках пользователя, после портлета «Мои настройки».
+После настройки интеграции с Blitz IDP в профиле пользователя также появится [[product:auth:users:list_of_bindings#список_привязок_open_id_connect|раздел]] для связывания учетной записи системы ADVANTA с учетной записью внешнего провайдера. Портлет находится в настройках пользователя, после портлета «Мои настройки».
 В портлете указана информация: