OAuth ホーム

Apigee Edge の OAuth ホームページへようこそ。このランディング ページには、Apigee Edge で OAuth を使用する方法に関するドキュメント、サンプル、その他のリソースへのリンクがあります。

OAuth 2.0 フレームワーク

OAuth 2.0 で API を保護します。このセクションでは、Apigee Edge で OAuth 2.0 を使用する際に役立つリソース、サンプルコード、動画、その他のトピックを掲載しています。

OAuth 2.0 の詳細

以下のリソースのコレクションは、OAuth 2.0 の知識をすばやく習得するのに役立ちます。

• Apigee のドキュメント:
  • OAuth 2.0 の概要 - OAuth 2.0 のコンセプトと用語について説明します。Apigee Edge での OAuth の使用方法に焦点を絞って説明しています。
• Apigee のトレーニングと証明書:
  • Apigee では、OAuth を含む API セキュリティ に関するコースなど、API デベロッパー向けのオンライン トレーニングを実施しています。
• IETF 仕様:
  • IETF 仕様 - Apigee では、この仕様を確認することを強くおすすめしています。基本的な内容がよくまとめられており、概念の概要を理解できます。
• Apigee の電子書籍と動画:
  • 無料の Apigee 電子書籍、OAuth the Big Pic。
  • 無料の Apigee ウェブキャスト、OAuth the Big Pic。

---

権限付与タイプのフローを実装する

Apigee は、初心者向けに OAuth 2.0 の権限付与タイプごとの実用サンプルを提供しています。それらのサンプルは、Apigee Edge に OAuth の権限付与タイプを実装するためのおすすめの方法を示しています。

クライアント認証情報

• クライアント認証情報権限付与タイプを実装する - この権限付与タイプを Apigee Edge に実装するために必要な手順を中心に紹介します。
• サンプル実装 - このサンプルは、GitHub の api-samples リポジトリでご確認ください。
• API セキュリティ（OAuth を含む）

認可コード

• クライアント認可コード権限付与タイプを実装する - Apigee Edge に実装するために必要な手順を中心にこの権限付与タイプを紹介します。
• サンプル実装 - この詳細なサンプルは、GitHub の api-samples リポジトリでご確認ください。このサンプルのクローンを作成し、デプロイして実行できます。詳細については、README ファイルをご覧ください。このサンプルには、ユーザーを認証して認可サーバーと安全に通信するための堅牢なログインアプリが含まれています。

暗黙

• トークンのリクエスト: 暗黙的な付与タイプ - 暗黙的な付与タイプでトークンをリクエストする方法を示します。

リソース オーナー パスワード認証情報

• パスワード権限付与タイプを実装する - Apigee Edge に実装するために必要な手順を中心にこの権限付与タイプを紹介します。

---

クイック入門トピック

以下のトピックでは、一般的な OAuth 2.0 タスクを処理するための簡単なコンテキストと手順を示しています。

• 新しい API プロキシの構成
• クライアント アプリの登録
• クライアント認証情報の取得
• OAuth エンドポイントとポリシーの構成
• トークンと認証コードのリクエスト
• アクセス トークンのカスタマイズ
• アクセス トークンの承認と取り消し
• アクセス トークンの送信
• アクセス トークンの検証
• スコープの操作
• 高度なトピック

ポリシーと API リファレンス

以下のトピックでは、Edge で OAuth 2.0 を直接サポートするポリシーと API に関する詳細なリファレンス情報を提供します。

• OAuthV2 ポリシー - これらのポリシーを使用すると、Apigee Edge に 4 つの OAuth 2.0 権限付与タイプを実装してカスタマイズできます。
  • OAuthV2 ポリシー - Apigee Edge OAuth 2.0 実装の中心。Apigee Edge での OAuth 2.0 の「オペレーション」（アクセス権の生成、トークンの更新、認可コードの発行、トークンの検証）を構成できます。このトピックには、ポリシーが機能する仕組みの理解に役立つコードサンプルが含まれています。
  • GetOAuthV2Info ポリシー - トークンの属性を取得し、API プロキシで実行されるポリシーとコードで使用できるようにします。このポリシータイプは、アクセス トークンの値に基づいて動的な条件付き動作を構成する必要がある場合に役立ちます。アクセス トークンのカスタマイズもご覧ください。
  • SetOAuthV2Info ポリシー - アクセス トークンのプロファイルを更新します。たとえば、ビジネス固有のタグを埋め込むことができます。アクセス トークンのカスタマイズもご覧ください。
• OAuth 2.0 のエラーコード
  • OAuth HTTP エラー レスポンス リファレンス
• OAuth 2.0 API - Apigee は、OAuth 2.0 エンドポイントを利用するためにこの API を提供しています。
  • OAuth 2.0 アクセス トークン
  • OAuth 2.0 リクエスト トークン
  • OAuth 2.0 更新トークン

---

OAuth 1.0a フレームワーク

OAuth 1.0a では、アプリのユーザーがプロセスでアプリにパスワードを公開しなくても、アプリがユーザーの代わりに API を使用することを許可する標準的なプロトコルを定義しています。

OAuth 1.0a ポリシー リファレンス

OAuthV1 ポリシー リファレンスでは、OAuth v1.0a ポリシーの構成方法を説明しています。OAuthV1 ポリシータイプは、OAuth 1.0a 仕様に基づいて、リクエスト トークンの生成、アクセス トークンの生成、アクセス トークンの検証を行います。

OAuth 1.0a API

Apigee は、OAuth 1.0a エンドポイントを操作するための API を提供しています。

• OAuth 1.0a アクセス トークン
• OAuth 1.0a リクエスト トークン
• OAuth 1.0a 検証ツール

GitHub の OAuth 1.0a サンプル

この GitHub のサンプル API プロキシは、OAuth 1.0a の three-legged 構成を示しています。このコードをダウンロードして実行できます。

名前	説明
oauth10a-3legged	OAuth 1.0a の three-legged 構成を説明しています。