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

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

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

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

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

  1. Apigee Edge のアカウントにログインします。
  2. [APIs] > [API Proxies] を選択します。
  3. [+ API Proxy] をクリックします。
  4. ウィザードを使用して Reverse プロキシを作成します。このダイアログの情報については、シンプルな API プロキシのビルド方法をご覧ください。
  5. ウィザードの [Security] セクションで、[OAuth v2.0] の横にあるラジオボタンを選択します。

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

[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

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