自動タスクでの SAML の使用

Edge for Private Cloud v4.18.01

Edge API で SAML を使用する場合、SAML アサーションから OAuth2 アクセス トークンと更新トークンを取得するプロセスをパスコード フローと呼びます。パスコード フローでは、ブラウザを使用してワンタイム パスコードを取得し、それを使用して OAuth2 トークンを取得します。

ただし、開発環境では、テストの自動化や継続的インテグレーション/継続的デプロイ（CI/CD）など、一般的な開発タスクの自動化がサポートされている場合があります。SAML が有効になっているときにこれらのタスクを自動化するには、ブラウザからパスコードをコピーして貼り付けることなく、OAuth2 トークンを取得して更新する方法が必要です。

Edge は、マシンユーザーを使用してトークンの自動生成をサポートしています。マシンユーザーは、パスコードを指定せずに OAuth2 トークンを取得できます。つまり、Edge Management API を使用して、OAuth2 トークンの取得と更新のプロセスを完全に自動化できます。

マシンユーザーを作成する

apigee-ssoadminapi.sh ユーティリティを使用して、SAML 組織のマシンユーザーを作成します。詳細については、apigee-ssoadminapi.sh の使用をご覧ください。すべての組織で使用される単一のマシンユーザーを作成することも、組織ごとに個別のマシンユーザーを作成することもできます。

マシンユーザーは、SAML ID プロバイダではなく、Edge データストアに作成されて保存されます。したがって、Edge UI と Edge Management API を使用してマシンユーザーをメンテナンスする必要はありません。

マシンユーザーを作成するときは、メールアドレスとパスワードを指定する必要があります。マシンユーザーを作成したら、1 つ以上の組織に割り当てます。

マシンユーザーを作成するには:

  1. 次の apigee-ssoadminapi.sh コマンドを使用して、マシンユーザーを作成します。
    > apigee-ssoadminapi.sh saml machineuser add --admin SSO_ADMIN_NAME --secret SSO_ADMIN_SECRET --host edge_sso_IP_or_DNS -u machine_user_email -p machine_user_password

    ここで、
    • SSO_ADMIN_NAME は、Edge SSO モジュールの構成に使用される構成ファイルの SSO_ADMIN_NAME プロパティで定義された管理者のユーザー名です。デフォルトは ssoadmin です。
    • SSO_ADMIN_SECRET は、構成ファイルの SSO_ADMIN_SECRET プロパティで指定された管理者パスワードです。

      この例では、--port と --ssl の値を省略できます。apigee-sso モジュールは、--port にデフォルト値の 9099 を使用し、--ssl に http を使用するためです。インストールでこれらのデフォルトを使用しない場合は、必要に応じて指定します。
  2. Edge UI にログインして、マシンユーザーのメールアドレスを組織に追加し、マシンユーザーに必要なロールを割り当てます。詳細については、グローバル ユーザーの追加をご覧ください。

マシンユーザー トークンを取得して更新する

Edge API を使用して、パスコードの代わりにマシンユーザーの認証情報を渡すことで、OAuth2 トークンを取得して更新します。

マシンユーザーの OAuth2 トークンを取得するには:

  1. 次の API 呼び出しを使用して、初期アクセス トークンと更新トークンを生成します。
    > curl -H "Content-Type: application/x-www-form-urlencoded;charset=utf-8" /
    -H "accept: application/json;charset=utf-8" /
    -H "Authorization: Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0" -X POST /
    http://edge_sso_IP_DNS:9099/oauth/token -s /
    -d 'grant_type=password&username=m_user_email&password=m_user_password     '
    この呼び出しにより、アクセス トークンと更新トークンが画面に出力されます。後で使用するためにトークンを保存します。
  2. アクセス トークンを Bearer ヘッダーとして Edge Management API 呼び出しに渡します。
    > curl -H "Authorization: Bearer access_token" http://ms_IP_DNS:8080/v1/organizations/orgName

    ここで、orgName は、マシンユーザーを含む組織の名前です。
  3. 後でアクセス トークンを更新するには、更新トークンを含む次の呼び出しを使用します。
    > curl -H "Content-Type:application/x-www-form-urlencoded;charset=utf-8" /
    -H "Accept: application/json;charset=utf-8" /
    -H "Authorization: Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0" -X POST /
    http://edge_sso_IP_DNS:9099/oauth/token /
    -d 'grant_type=refresh_token&refresh_token=refreshToken'

Edge Management API を使用してマシンユーザーを作成する

apigee-ssoadminapi.sh ユーティリティを使用する代わりに、Edge Management API を使用してマシンユーザーを作成できます。マシンユーザーを作成するには:

  1. 次の cURL コマンドを使用して、ssoadmin ユーザー（apigee-sso の管理者アカウントのユーザー名）のトークンを取得します。
    > curl "http://edge_sso_IP_DNS:9099/oauth/token" -i -X POST /
    -H 'Accept: application/json' / -H 'Content-Type: application/x-www-form-urlencoded' /
    -d "response_type=token" -d "grant_type=client_credentials" /
    --data-urlencode "client_secret=SSO_ADMIN_SECRET" /
    --data-urlencode "client_id=ssoadmin"

    ここで、SSO_ADMIN_SECRET は、構成ファイルの SSO_ADMIN_SECRET プロパティで指定されている、apigee-sso のインストール時に設定した管理者パスワードです。

    このコマンドを実行すると、次の呼び出しを行うために必要なトークンが表示されます。
  2. 次の cURL コマンドを使用してマシンユーザーを作成し、前の手順で受け取ったトークンを渡します。
    > curl "http://edge_sso_IP_DNS:9099/Users" -i -X POST /
    -H "Accept: application/json" -H "Content-Type: application/json" /
    -d '{"userName" : "machine_user_email", "name" : {"formatted":"DevOps", "familyName" : "last_name", "givenName" : "first_name"}, "emails" : [ {"value" : "machine_user_email", "primary" : true } ], "active" : true, "verified" : true, "password" : "machine_user_password" }' /
    -H "Authorization: Bearer token"

    後の手順でマシンユーザーのパスワードが必要になります。
  3. Edge UI にログインして、マシンユーザーのメールアドレスを組織に追加し、マシンユーザーに必要なロールを割り当てます。詳細については、グローバル ユーザーの追加をご覧ください。