Korzystanie z narzędzi administracyjnych Edge i interfejsów API po włączeniu SAML

Edge dla chmury prywatnej w wersji 4.18.05

W tej sekcji opisano, jak uruchamiać narzędzia i polecenia administratora systemu Edge po włączeniu SAML. Wiele zadań w Edge wymaga danych logowania administratora systemu, takich jak:

  • Tworzenie organizacji i środowisk
  • Dodawanie i usuwanie komponentów Edge
  • Uruchamianie poleceń apigee-adminapi.sh

Jednak po włączeniu SAML w Edge zwykle wyłącza się uwierzytelnianie podstawowe, aby jedynym sposobem uwierzytelniania był dostawca tożsamości SAML. Dlatego musisz upewnić się, że konto administratora systemu zostało dodane do dostawcy tożsamości SAML.

Wywoływanie interfejsów API zarządzania Edge jako administrator systemu

Wiele wywołań interfejsu API Edge wymaga przekazania danych logowania administratora systemu. Artykuł Używanie SAML z interfejsem Edge Management API zawiera instrukcje uzyskiwania i odświeżania tokenów podczas wywoływania interfejsu Edge Management API.

Używanie narzędzia apigee-adminapi.sh z uwierzytelnianiem SAML

Użyj narzędzia apigee-adminapi.sh, aby wykonać te same zadania konfiguracji Edge, które wykonujesz, wywołując interfejs API zarządzania Edge. Zalety narzędzia apigee-adminapi.sh:

  • używać prostego interfejsu wiersza poleceń,
  • implementuje uzupełnianie poleceń za pomocą tabulatora;
  • Zawiera informacje o pomocy i użytkowaniu.
  • Może wyświetlać odpowiednie wywołanie interfejsu API, jeśli zdecydujesz się go wypróbować.

Więcej informacji znajdziesz w artykule Korzystanie z apigee-ssoadminapi.sh.

Po włączeniu uwierzytelniania SAML możesz przekazać dane logowania administratora systemu do narzędzia apigee-adminapi.sh na kilka sposobów.

Wszystkie opcje dowolnego polecenia apigee-adminapi.sh, w tym opcje określania danych logowania SAML, możesz wyświetlić, używając opcji „-h” w poleceniu. Obejmuje to na przykład:

apigee-adminapi.sh orgs list -h

Możesz na przykład przekazać dane logowania administratora systemu:

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

Gdzie:

  • Opcja sso-url określa adres URL modułu logowania jednokrotnego Edge. Jeśli port i protokół zostały zmienione z 9099 i HTTP, zmodyfikuj je.
  • oauth-flow określa passcode lub password_grant. W tym przykładzie podajesz password_grant.
  • adminEmail to adres e-mail administratora systemu.
  • oauth-password określa hasło administratora systemu.

Możesz też użyć hasła podczas wywoływania polecenia:

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

Gdzie:

  • oauth-flow określa passcode.
  • oauth-passcode określa kod dostępu uzyskany z http://edge_sso_IP_DNS:9099/passcode.

Możesz też użyć tokena podczas wywoływania polecenia:

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

Gdzie:

Korzystanie z narzędzi Edge z uwierzytelnianiem SAML

Wiele narzędzi Edge wymaga danych logowania administratora systemu, takich jak:

  • apigee-provision używane do tworzenia organizacji, środowisk i hostów wirtualnych
  • setup.sh używane do dodawania węzłów do istniejącego systemu
  • każdego innego narzędzia, w którym musisz podać dane logowania administratora systemu w pliku konfiguracji.

Te narzędzia przyjmują jako dane wejściowe plik konfiguracji, który określa dane logowania administratora systemu za pomocą właściwości:

ADMIN_EMAIL="adminEmail"
APIGEE_ADMINPW=adminPWord

Jeśli pominiesz hasło, pojawi się prośba o jego podanie.

Po włączeniu SAML używasz różnych właściwości, aby określić dane logowania administratora systemu. Możesz na przykład przekazać dane logowania administratora systemu:

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

Gdzie:

  • SSO_LOGIN_URL określa adres URL modułu logowania jednokrotnego Edge. Jeśli port lub protokół zostały zmienione z 9099 i HTTP, zmodyfikuj je.
  • OAUTH_FLOW określa passcode lub password_grant. W tym przykładzie podajesz password_grant, ponieważ przekazujesz hasło administratora systemu.
  • OAUTH_ADMIN_PASSWORD określa hasło administratora systemu.

Możesz też użyć tych właściwości, aby określić dane logowania w ramach procesu podawania hasła:

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

Gdzie:

  • OAUTH_FLOW określa passcode.
  • OAUTH_ADMIN_PASSCODE określa kod dostępu uzyskany z http://edge_sso_IP_DNS:9099/passcode.

Możesz też użyć tokena,

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

Gdzie: