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

このページは Apigee と Apigee ハイブリッドに適用されます。

Apigee Edge のドキュメントを表示します。

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

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

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

OAuth 検証を API に追加するには:

Cloud コンソールの Apigee

  1. Google Cloud コンソールで、[プロキシ開発] > [API プロキシ] ページに移動します。

    [API プロキシ] に移動

  2. Google Cloud ペインのプロジェクト選択ツールから組織を選択します。組織名は Google Cloud プロジェクト名と同じです。
  3. [API プロキシ] ペインで [+ 作成] をクリックします。
  4. [Create a proxy] ペインで、[Proxy template] の [Reverse proxy (most common)] を選択します。
  5. プロキシを次のように構成します。
    名前 値
    Proxy Name helloworld_oauth2
    Base Path

    /hellooauth2

    [Project Base Path] は、API プロキシに対してリクエストを行うために使用される URL の一部です。
    Description hello world protected by OAuth v2.0
    Target (Existing API)

    https://mocktarget.apigee.net/ip

    API プロキシへのリクエストに応じて Apigee が呼び出すターゲット URL を定義します。このターゲットは、Hello, Guest! という簡単なレスポンスを返すだけです。
  6. [Next] をクリックします。
  7. Deploy（省略可）:
    • Deployment environments: 省略可。チェックボックスを使用して、プロキシをデプロイする環境を 1 つ以上選択します。この時点でプロキシをデプロイしない場合は、[Deployment environments] フィールドを空白のままにします。プロキシは、後でいつでもデプロイできます。
    • Service Account: 省略可。サービス アカウントをデプロイに関連付けることで、そのプロキシがサービス アカウントに設定されたロールと権限に基づいて Google Cloudサービスにアクセスできるようにします。
  8. [Create] をクリックします。
  9. helloworld_apikey プロキシの [Proxy summary] ペインで、[Develop] タブをクリックします。
  10. [Policies] メニューで、[ Add policy] をクリックします。
  11. [Create policy] ペインの [Security] で、[Verify API Key] を選択します。
  12. [Verify API Key] ペインで、[Name] セクションと [Display name] セクションの必須項目に次の値を使用して入力します。
    • Name: ポリシー名を入力します。例: VerifyAPIKey
    • Display name: UI で使用するポリシー名を入力します。例: Verify API Key
  13. [Create] をクリックします。
  14. をクリックして、別のポリシーを追加します。
  15. [Create policy] ペインの [Mediation] で、[Assign Message] を選択します。
  16. [Assign Message] ペインで、[Name] セクションと [Display name] セクションの必須項目に次の値を使用して入力します。
    • Name: ポリシー名を入力します。例: AssignMessage
    • Display name: UI で使用するポリシー名を入力します。例: Assign Message
  17. [Create] をクリックします。

  18. Assign Message ポリシーの内容を次のように更新します。

    
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="remove-header-authorization">
    <DisplayName>Remove Header Authorization</DisplayName>
    <Remove>
        <Headers>
            <Header name="Authorization"/>
        </Headers>
    </Remove>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>
  19. VerifyApiKey ポリシーと Remove Header Authorization ポリシーを追加します。
    1. [Proxy endpoints] メニューで、[Preflow] をクリックします。
    2. ビジュアル エディタの [Request] ペインで、 [Add policy step] をクリックします。
    3. [Add policy step pane] ペインで、[Verify API Key] を選択します。
    4. [Add] をクリックします。
    5. ビジュアル エディタの [Request] ペインで、 [Add policy step] をクリックします。
    6. [Add policy step] ペインで、[Remove Header Authorization] を選択します。
    7. [Add] をクリックします。
  20. [Save] をクリックします。

従来の UI

  1. Apigee UI にログインします。
  2. 左側のナビゲーション バーで [Develop] > [API Proxies] を選択します。
  3. [+ Proxy] をクリックします。
  4. [Create Proxy] ウィザードを使用して、リバース プロキシを作成します。シンプルな API プロキシの構築をご覧ください。
  5. ウィザードの [Common policies] ページで、[OAuth v2.0] の横にあるラジオボタンをオンにします。
新しく作成された 1 つの API プロキシで、1 つはアクセストークンを検証するため、もう 1 つは検証後にアクセス トークンを取り除くために使われます。

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