Перейти к основному содержимому
Версия: Indeed Access Manager 9.7

Миграция настроек приложений Identity Provider

Начиная с версии Access Manager 9.7 настройки SAML- и OIDC-приложений Identity Provider задаются в Management Console, а не в конфигурационном файле am/idp/app-settings.json.

Чтобы перенести настройки приложений из конфигурационного файла в Management Console, используйте утилиту AM.Module.Settings.MigrationTool.exe. Утилита поддерживает конфигурационные файлы версий 8.2, 9.3 и 9.4.

Важно

Утилита не переносит следующие параметры:

  • Сертификат поставщика услуг (SP) — для SAML-приложений.
  • Разрешенные адреса отправки форм (CSP) — для всех приложений Identity Provider.

После миграции укажите эти параметры вручную на странице настроек каждого приложения в Management Console. Подробнее — в Параметры SAML-приложения и Параметры OIDC-приложения.

Системные требования​

Утилита запускается на хосте с ОС Windows, с которого есть сетевой доступ к Core Server. На этот хост нужно скопировать конфигурационный файл Identity Provider am/idp/app-settings.json.

На хосте должны быть установлены:

  • .NET Runtime (dotnet-runtime-8.0.22-win-x64.exe)
  • ASP.NET Core Runtime (aspnetcore-runtime-8.0.22-win-x64.exe)

Запуск утилиты​

  1. На хосте с ОС Windows откройте терминал и перейдите в папку с утилитой AM.Module.Settings.MigrationTool.exe.

  2. Запустите утилиту с командой migrate idp-settings:

    .\AM.Module.Settings.MigrationTool.exe migrate idp-settings -u <URL> -n <имя_пользователя> -m <способ_аутентификации> -f <путь_к_app-settings.json> [--force]

    В таблице приведены параметры, которые можно задать при выполнении команды.

    • -u <URL>
    Обязательный параметр.
    URL-адрес Core Server.
    Пример: https://<AM_CORE_URL>/am/core
    • -n <имя_пользователя>
    Обязательный параметр.
    Имя администратора Access Manager.
    Пример: admin@company.local
    • -m <способ_аутентификации>
    Обязательный параметр.
    Выберите способ аутентификации: WindowsPassword или Passcode.
    • -f <путь>
    Обязательный параметр.
    Путь к конфигурационному файлу app-settings.json на хосте, где запускается утилита.
    • --force
    Переносит настройки всех приложений без запроса подтверждения.
    Если параметр не указан, утилита запрашивает подтверждение для каждого приложения, настройки которого уже есть в Management Console.
    • --version
    Информация о версии утилиты.
    • -h
    • -?
    • --help
    Справка.

    Пример команды:

    .\AM.Module.Settings.MigrationTool.exe migrate idp-settings -u https://am.company.local/am/core -n admin@company.local -m WindowsPassword -f .\app-settings.json
  3. Введите пароль (параметр -m).

  4. Подтвердите или отклоните перезапись настроек для каждого приложения из конфигурационного файла, которое уже есть в Management Console. Приложения сопоставляются по Entity ID для SAML и по Client ID для OIDC.

    Примечание
    • Приложения из конфигурационного файла, которых нет в Management Console, утилита создает сама, подтверждение для них не запрашивается.

    • Приложения, которые есть в Management Console, но не описаны в конфигурационном файле, утилита не изменяет и не удаляет.

  5. Укажите для каждого перенесенного приложения параметры, которые утилита не переносит:

    1. На боковой панели Management Console откройте раздел Приложения.

    2. Выберите приложение и перейдите на вкладку IDP.

    3. Для SAML-приложения в поле Сертификат поставщика услуг (SP) укажите сертификат открытого ключа поставщика услуг (SP) в формате PEM.

    4. В поле Разрешенные адреса отправки форм (CSP) укажите адреса, на которые с этой страницы разрешено отправлять данные форм (директива CSP form-action). Например: https://app.example.com/saml/acs.

      До обновления эти адреса задавались в переменных CUSTOM_SP_* файла am/.env.

    Подробнее об остальных параметрах — в Параметры SAML-приложения и Параметры OIDC-приложения.

Проверка результата​

Перенесенные приложения отображаются в Management Console в разделе Приложения.

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