SAML 有効化後の Edge 管理ユーティリティと API の使用

このセクションでは、SAML を有効にした後で Edge システム管理ツールと Edge システム管理コマンドを実行する方法について説明します。次に示すような Edge の多くのタスクでは、システム管理の認証情報が必要になります。

  • 組織と環境の作成
  • Edge コンポーネントの追加と削除
  • apngee-adminapi.sh コマンドの実行

ただし、Edge で SAML を有効にすると、通常は Basic 認証が無効になるため、唯一の認証方法は SAML IDP となります。したがって、SAML IDP にシステム管理者アカウントを必ず追加しておく必要があります。

システム管理者として Edge Management API を呼び出す

多くの Edge API 呼び出しでは、システム管理者の認証情報を渡す必要があります。Edge Management API での SAML の使用では、Edge Management API 呼び出しを行う際のトークン取得方法とトークン更新方法が説明されています。

SAML 認証で apigee-adminapi.sh ユーティリティを使用する

Edge Management API を呼び出して実施する場合と同じ Edge 構成タスクを、apigee-adminapi.sh ユーティリティを使用して実施します。apigee-adminapi.sh ユーティリティには次のような利点があります。

  • シンプルなコマンドライン インターフェースを使用できる。
  • タブベースのコマンド補完が実装される。
  • ヘルプと使用方法の情報が提供される。
  • API を試したい場合、対応する API 呼び出しを表示できる。

詳細については、apigee-ssoadminapi.sh の使用をご覧ください。

SAML 認証を有効にすると、複数の方法でシステム管理者の認証情報を apigee-adminapi.sh ユーティリティに渡すことができます。

コマンドに「-h」オプションを使用すると、SAML 認証情報を指定するオプションを含む、apigee-adminapi.sh コマンドのすべてのオプションを表示できます。例:

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 オプションは、Apigee SSO モジュールの URL を指定します。ポートまたはプロトコルを 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 のいずれかを指定します。この例では、最初に get_token を使用してトークンを取得したので、passcode を指定します。詳細については、Edge Management API での SAML の使用をご覧ください。
  • oauh_token には、トークンを指定します。

SAML 認証で Edge ユーティリティを使用する

次に示すような多くの 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 では、Apigee SSO モジュールの URL を指定します。ポートまたはプロトコルを 9099 および HTTP から変更している場合は、ポートまたはプロトコルを変更します。
  • 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 のいずれかを指定します。この例では、最初に get_token を使用してトークンを取得したので、passcode を指定します。詳細については、Edge Management API での SAML の使用をご覧ください。
  • OAUTH_BEARER_TOKEN には、トークンを指定します。