Edge for Private Cloud версии 4.17.09
Портал Developer Services выступает в качестве клиента Apigee Edge. Это означает, что портал не функционирует как автономная система. Вместо этого большая часть информации, используемой порталом, фактически хранится на Edge. При необходимости портал отправляет запрос на получение информации от Edge или на отправку информации в Edge.
Портал всегда связан с одной организацией Edge. При настройке портала вы можете указать учетные данные для базовой аутентификации (имя пользователя и пароль) для аккаунта в организации, который портал использует для связи с Edge.
Если вы решите включить SAML для аутентификации Edge, вы можете настроить портал на использование аутентификации SAML при отправке запросов в Edge. При настройке портала для использования SAML автоматически создается новый аккаунт пользователя компьютера в организации Edge, который портал затем использует для отправки запросов в Edge. Подробнее об использовании SAML с автоматизированными задачами…
Для поддержки SAML на портале необходимо установить и настроить модуль системы единого входа Edge на узле сервера управления Edge. Общий процесс включения SAML для портала выглядит следующим образом:
- Настройте SAML в Edge, как описано в статье Установка и настройка SAML для Edge. Примечание. Чтобы установить портал, в Edge по-прежнему должна быть включена базовая аутентификация. Не отключайте базовую аутентификацию в Edge, пока не настроите использование SAML на портале.
- Установите портал и убедитесь, что он работает правильно. Подробнее о том, как установить портал Edge for Private Cloud Developer Services…
- Настройте SAML на портале.
- Теперь вы можете отключить базовую аутентификацию в Edge.
Создание пользователя компьютера для портала
Если SAML включен, Edge поддерживает автоматическое создание токенов OAuth2 с помощью пользователей-машин. Пользователь-машина может получать токены OAuth2 без указания кода доступа. Это означает, что вы можете полностью автоматизировать процесс получения и обновления токенов OAuth2.
В процессе настройки SAML для портала автоматически создается пользователь компьютера в организации, связанной с порталом. Затем портал использует этот аккаунт пользователя компьютера для подключения к Edge. Дополнительную информацию о пользователях-роботах можно найти в статье Использование SAML с автоматизированными задачами.
Об аутентификации для аккаунтов разработчиков портала
При настройке портала для использования SAML вы разрешаете порталу использовать SAML для аутентификации в Edge, чтобы портал мог отправлять запросы в Edge. Однако на портале также поддерживается тип пользователей, называемый разработчиками.
Разработчики – это сообщество пользователей, которые создают приложения с помощью ваших API. Разработчики приложений используют портал, чтобы узнавать о ваших API, регистрировать приложения, использующие ваши API, взаимодействовать с сообществом разработчиков и просматривать статистическую информацию об использовании их приложений на панели управления.
Когда разработчик входит на портал, именно портал отвечает за аутентификацию разработчика и за применение разрешений на основе ролей. Портал продолжает использовать базовую аутентификацию с разработчиками даже после того, как вы включите SAML между порталом и Edge. Подробнее о взаимодействии между порталом и Edge…
Также можно настроить портал для использования SAML для аутентификации разработчиков. Пример включения SAML с помощью сторонних модулей Drupal можно найти на странице https://community.apigee.com/articles/29201/sso-integration-via-saml-with-developer-portal.html.
Настройте SAML на портале для взаимодействия с Edge.
Чтобы настроить SAML для портала, необходимо создать файл конфигурации:
# IP address of Edge Management Server and apigee-sso node. IP1=22.222.22.222 # URL of Edge management API. MGMT_URL=http://$IP1:8080/v1 # Org associated with the portal. EDGE_ORG=myorg # Information about apigee-sso. # Externally accessible IP or DNS of apigee-sso. SSO_PUBLIC_URL_HOSTNAME=$IP1 SSO_PUBLIC_URL_PORT=9099 # Default is http. Set to https if you enabled TLS on apigee-sso. SSO_PUBLIC_URL_SCHEME=http # SSO admin credentials as set when you installed apigee-sso. SSO_ADMIN_NAME=ssoadmin SSO_ADMIN_SECRET=Secret123 # Default is "n" to disable SAML support. DEVPORTAL_SSO_ENABLED=y # The name of the OAuth client used to connect to apigee-sso. # The default client name is portalcli. PORTALCLI_SSO_CLIENT_NAME=portalcli # Oauth client password using uppercase, lowercase, number, and special chars. PORTALCLI_SSO_CLIENT_SECRET=Abcdefg@1 # Email address and user info for the machine user created in # the Edge org specified above by EDGE_ORG. # This account is used by the portal to make requests to Edge. # Add this email as an org admin before configuring the portal to use SAML. DEVPORTAL_ADMIN_EMAIL=DevPortal_SAML@google.com DEVPORTAL_ADMIN_FIRSTNAME=DevPortal DEVPORTAL_ADMIN_LASTNAME=SAMLAdmin DEVPORTAL_ADMIN_PWD=Abcdefg@1 # If set, the existing portal OAuth client is deleted and new one is created. # The default value is "n". # Set to "y" when you configure SAML and change the value of # any of the PORTALCLI_* properties. PORTALCLI_SSO_CLIENT_OVERWRITE=y
Чтобы включить поддержку SAML на портале:
- В пользовательском интерфейсе Edge добавьте пользователя компьютера, указанного в DEVPORTAL_ADMIN_EMAIL, в организацию, связанную с порталом, в качестве администратора организации.
Примечание. Пользователь компьютера ещё не существует, но будет создан автоматически на следующем шаге. - Чтобы настроить SAML на портале, выполните следующую команду:
> /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f samlConfigFile
где samlConfigFile – это файл конфигурации SAML. - Войдите на портал как администратор.
- В главном меню Drupal выберите Configuration (Конфигурация) > Dev Portal (Портал для разработчиков). Откроется экран конфигурации портала, включая настройки SAML:
Обратите внимание, что флажок This org is SAML-enabled (Для этой организации включен SAML) установлен, конечная точка для модуля Edge SSO заполнена, поля API key (Ключ API) и Consumer secret (Секретный ключ клиента) для клиента Oauth портала заполнены, а под кнопкой Test Connection (Проверить подключение) появилось сообщение Connection Successful (Подключение установлено).
- Чтобы повторно проверить подключение, нажмите кнопку Test Connection (Проверить подключение).
Чтобы изменить эти значения, обновите файл конфигурации и снова выполните команду.
Отключите SAML на портале
Если вы отключите SAML для обмена данными между порталом и Edge, портал больше не сможет отправлять запросы в Edge. Разработчики могут входить на портал, но не могут просматривать продукты и создавать приложения.
Внимание! Если вы отключите SAML, вам нужно будет заново настроить портал, чтобы использовать SAML или, если Edge по-прежнему поддерживает базовую аутентификацию, настроить портал для связи с Edge с помощью базовой аутентификации. Подробнее об использовании базовой аутентификации для обмена данными между порталом и Edge…
Чтобы отключить SAML на портале:
- Измените файл конфигурации, который вы использовали для настройки SAM, чтобы задать:
DEVPORTAL_SSO_ENABLED=n - Настройте портал:
> /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile