OAuth 2.0: 新しい API プロキシの構成

Apigee Cloud バージョンの Edge を使用している場合は、oauth というプロキシがデフォルトで組織に含まれています。このプロキシは、アクセス トークンとリフレッシュ トークンを生成するための 2 つのサンプル エンドポイントを提供します。OAuth トークンのエンドポイントの詳細については、OAuth エンドポイントについてをご覧ください。

クライアント認証情報権限付与タイプは、アプリの認証情報と引き換えにアクセス トークンを発行する手順を定義します。このアプリの認証情報は、組織に登録されている各アプリに対して Apigee Edge が発行するコンシューマ キーとシークレットのペアです。詳細については、認可コード権限付与タイプを実装するをご覧ください。

新しい API プロキシへの OAuth 2.0 の追加

新しい API プロキシを作成する際、API に OAuth 認証を簡単に追加できます。

Edge

Edge UI を使用して API に OAuth 検証を追加するには:

  1. apigee.com/edge にログインします。
  2. 左側のナビゲーション バーで [Develop] > [API Proxies] を選択します。
  3. [+Proxy] をクリックします。
  4. [Create Proxy] ウィザードを使用して、リバース プロキシを作成します。シンプルな API プロキシの構築をご覧ください。
  5. ウィザードの [Common policies] ページで、[OAuth v2.0] の横にあるラジオボタンをオンにします。

Classic Edge(Private Cloud)

Classic Edge UI を使用して API に OAuth 検証を追加するには:

  1. http://ms-ip:9000 にログインします。ここで、ms-ip は、Management Server ノードの IP アドレスまたは DNS 名です。
  2. 上部のナビゲーション バーで [APIs] > [API Proxies] を選択します。
  3. [+ API Proxy] をクリックします。
  4. [Create Proxy] ウィザードを使用して、リバース プロキシを作成します。シンプルな API プロキシの構築をご覧ください。
  5. ウィザードの [Security] ページで、[OAuth v2.0] の横にあるラジオボタンをオンにします。

このオプションを選択すると、新しく作成された API プロキシにポリシーが 2 つ接続されます。1 つはアクセス トークンを検証するポリシー、もう 1 つは検証後のアクセス トークンを削除するポリシーです。

また、[Publish API Product] チェックボックスが選択可能になり、自動的に選択されます。新しい API プロキシを作成するときにプロダクトを自動的に生成する場合は、このチェックボックスをオンにします。自動生成されるプロダクトは、新しい API プロキシに関連付けられた状態で作成されます。この新しい API を関連付ける既存のプロダクトがある場合は、不要なプロダクトが作成されないよう、このチェックボックスを必ずオフにしてください。プロダクトについて詳しくは、API プロダクトとはをご覧ください。

デフォルトの OAuth プロキシの使用

OAuth プロキシは、次のエンドポイント URI を公開します。

/oauth/client_credential/accesstoken

この URI は、アクセス トークンを取得する必要のあるデベロッパーに公開します。アプリ デベロッパーは、アプリを構成する際、アプリがこのエンドポイントを呼び出し、コンシューマ キーとシークレットのペアを提示して、アクセス トークンを取得するようにします。

デフォルトのクライアント認証情報トークン エンドポイントは、次の URL でネットワーク上に公開されます。

https://{org_name}-{env_name}.apigee.net/oauth/client_credential/accesstoken

たとえば組織名が「apimakers」の場合、URL は次のようになります。

https://apimakers-test.apigee.net/oauth/client_credential/accesstoken

これは、アクセス トークンを取得するためにデベロッパーが呼び出す URL です。

API の呼び出し

アクセス トークンを取得すると、Authorization ヘッダーと Bearer トークンを使用して次のように API を呼び出すことができます。

curl -H "Authorization: Bearer <your access token>" http://myorg-myenv.apigee.net/myapi

アクセス トークンの検証もご覧ください。