外部 IDP のタスクを自動化する

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

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

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

IDP 対応の組織にマシンユーザーを作成するには、次の 2 つの方法があります。

• apigee-ssoadminapi.sh の使用
• Management API の使用

各方法については、以降のセクションで説明します。

外部 IDP が有効になっていない組織のマシンユーザーは作成できません。

apigee-ssoadminapi.sh を使用してマシンユーザーを作成する

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

マシンユーザーは、IDP ではなく Edge データストアに作成され、保存されます。したがって、Edge UI と Edge Management API を使用してマシンユーザーを管理する必要はありません。

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

apigee-ssoadminapi.sh を使用してマシンユーザーを作成するには:

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

     この例では、apigee-sso モジュールが --port のデフォルト値 9099 と --ssl のデフォルト値 http を使用するため、--port と --ssl の値を省略できます。インストールでこれらのデフォルトを使用しない場合は、必要に応じて指定します。

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

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

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

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 にログインします。
4. マシンユーザーのメールアドレスを組織に追加し、マシンユーザーに必要なロールを割り当てます。詳細については、グローバル ユーザーの追加をご覧ください。

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

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/org_name

   ここで、org_name はマシンユーザーを含む組織の名前です。

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'