Использование утилит и API администратора Edge после включения SAML

Edge for Private Cloud v4.18.05

В этом разделе описывается, как запускать инструменты и команды системного администратора Edge после включения SAML. Для выполнения многих задач в Edge требуются учетные данные системного администратора, например:

  • Создание организаций и сред
  • Добавление и удаление компонентов Edge
  • Выполнение команд apigee-adminapi.sh

Однако после включения SAML в Edge вы обычно отключаете базовую аутентификацию, чтобы единственным способом аутентификации был поставщик идентификационной информации SAML. Поэтому убедитесь, что вы добавили аккаунт системного администратора к поставщику идентификационной информации SAML.

Вызов API управления Edge в качестве системного администратора.

Для многих вызовов Edge API требуется передавать учетные данные системного администратора. В статье Использование SAML с Edge Management API рассказывается, как получать и обновлять токены при вызове Edge Management API.

Как использовать утилиту apigee-adminapi.sh с аутентификацией SAML

Утилита apigee-adminapi.sh позволяет выполнять те же задачи по настройке Edge, что и вызовы Edge Management API. Преимущество утилиты apigee-adminapi.sh заключается в следующем:

  • Используйте простой интерфейс командной строки.
  • Реализует автозавершение команд с помощью клавиши Tab.
  • Предоставляет справочную информацию и сведения об использовании.
  • Показывает соответствующий вызов API, если вы решите попробовать API.

Подробнее об использовании apigee-ssoadminapi.sh…

После включения аутентификации SAML у вас есть несколько способов передать учетные данные системного администратора утилите apigee-adminapi.sh.

Чтобы посмотреть все параметры для любой команды apigee-adminapi.sh, в том числе параметры для указания учетных данных SAML, используйте параметр -h. Пример:

apigee-adminapi.sh orgs list -h

Например, вы можете передать учетные данные системного администратора:

apigee-adminapi.sh orgs list --sso-url http://edge_sso_IP_DNS:9099 --oauth-flow password_grant \
  --admin adminEmail --oauth-password adminPword

Где:

  • Параметр sso-url указывает URL модуля SSO Edge. Если вы изменили порт или протокол, укажите их вместо 9099 и HTTP.
  • oauth-flow указывает на passcode или password_grant. В этом примере вы указываете password_grant.
  • adminEmail – адрес электронной почты системного администратора.
  • oauth-password – пароль системного администратора.

Вы также можете использовать код доступа при вызове команды:

apigee-adminapi.sh orgs list --sso-url http://edge_sso_IP_DNS:9099 --oauth-flow passcode \
  --admin adminEmail --oauth-passcode passcode

Где:

  • oauth-flow указывает passcode.
  • oauth-passcode – код доступа, полученный от http://edge_sso_IP_DNS:9099/passcode..

Наконец, вы можете использовать токен при вызове команды:

apigee-adminapi.sh orgs list --sso-url http://edge_sso_IP_DNS:9099 --oauth-flow passcode \
  --admin adminEmail --oauth-token token

Где:

  • oauth-flow указывает на passcode или password_grant в зависимости от того, как вы получили токен. В этом примере вы указываете passcode, потому что изначально получили токен с помощью get_token. Подробнее об использовании SAML с Edge Management API…
  • oauh_token содержит токен.

Как использовать утилиты Edge с аутентификацией SAML

Для работы многих утилит Edge требуются учетные данные системного администратора, например:

  • apigee-provision, используемый для создания организаций, сред и виртуальных хостов.
  • setup.sh используется для добавления узлов в существующую систему
  • Любые другие утилиты, в которых необходимо указать учетные данные системного администратора в файле конфигурации.

Эти утилиты принимают в качестве входных данных файл конфигурации, в котором указаны учетные данные системного администратора. Для этого используются следующие свойства:

ADMIN_EMAIL="adminEmail"
APIGEE_ADMINPW=adminPWord

Если вы не укажете пароль, вам будет предложено ввести его.

После включения SAML вы используете разные свойства, чтобы указать учетные данные системного администратора. Например, вы можете передать учетные данные системного администратора:

ADMIN_EMAIL="adminEmail"
SSO_LOGIN_URL=http://edge_sso_IP_DNS:9099
OAUTH_FLOW=password_grant
OAUTH_ADMIN_PASSWORD=adminPWord

Где:

  • SSO_LOGIN_URL указывает URL модуля SSO Edge. Если вы изменили порт или протокол, укажите новые значения.
  • OAUTH_FLOW указывает на passcode или password_grant. В этом примере вы указываете password_grant, потому что передаете пароль системного администратора.
  • OAUTH_ADMIN_PASSWORD – пароль системного администратора.

Вы также можете использовать следующие свойства, чтобы указать учетные данные в рамках процесса ввода кода доступа:

ADMIN_EMAIL="adminEmail"
SSO_LOGIN_URL=http://edge_sso_IP_DNS:9099
OAUTH_FLOW=passcode
OAUTH_ADMIN_PASSCODE=passcode

Где:

  • OAUTH_FLOW указывает passcode.
  • OAUTH_ADMIN_PASSCODE – код доступа, полученный от http://edge_sso_IP_DNS:9099/passcode..

Наконец, вы можете использовать токен

ADMIN_EMAIL="adminEmail"
SSO_LOGIN_URL=http://edge_sso_IP_DNS:9099
OAUTH_FLOW=passcode
OAUTH_BEARER_TOKEN=token

Где:

  • OAUTH_FLOW указывает на passcode или password_grant в зависимости от того, как вы получили токен. В этом примере вы указываете passcode, потому что изначально получили токен с помощью get_token. Подробнее об использовании SAML с Edge Management API…
  • OAUTH_BEARER_TOKEN содержит токен.