OAuth 首頁

您正在查看 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info

歡迎使用 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 為 API 開發人員提供線上訓練課程，其中包括 API 安全性課程，其中包含 OAuth。
  • IETF 規格：
    • IETF 規格：Apigee 強烈建議您詳閱這項規格。其中包含基本概念的簡介和概略說明。
  • Apigee 電子書和影片：

實作授權類型流程

Apigee 提供各 OAuth 2.0 授權類型的實際範例，協助您開始使用。這些範例代表最佳做法，並示範如何在 Apigee Edge 上實作 OAuth 授權類型。

用戶端憑證

授權碼

  • 實作授權碼授權類型：介紹授權類型，並著重於您在 Apigee Edge 上實作此授權類型時，需要遵循的步驟。
  • 實作範例：請前往 GitHub 上的 api-samples 存放區查看這項進階範例。您可以複製範例、部署範例，然後執行範例。詳情請參閱 README 檔案。其中包含可驗證使用者身分的強大登入應用程式，可與授權伺服器安全地通訊。

隱性偏誤

資源擁有者密碼憑證

  • 實作密碼授權類型：介紹授權類型，並著重於您在 Apigee Edge 上實作此授權類型時必須遵循的步驟。

快速操作教學主題

這些主題可讓您快速瞭解處理常見 OAuth 2.0 工作時的背景資訊和簡潔步驟：

政策和 API 參考資料

這些主題會提供有關政策和 API 的詳細參考資訊，這些政策和 API 可直接在 Edge 上支援 OAuth 2.0。

  • OAuthV2 政策：這些政策可讓您在 Apigee Edge 上實作及自訂四種 OAuth 2.0 授權類型：
    • OAuthV2 政策：Apigee Edge OAuth 2.0 實作項目的核心。您可以在 Apigee Edge 上設定 OAuth 2.0「作業」，產生存取和更新權杖、發出授權碼，以及驗證權杖。本主題提供程式碼範例，說明運作方式。
    • GetOAuthV2Info 政策：取得權杖的屬性，並讓政策和在 API 代理程式中執行的程式碼可使用這些屬性。當您需要根據存取權杖中的值，設定動態條件行為時，這類政策類型就很實用。另請參閱「自訂存取權杖」一文。
    • SetOAuthV2Info 政策：更新存取權憑證的設定檔。舉例來說，您可能會想要嵌入商家專屬的標記。另請參閱「自訂存取權杖」一文。
  • OAuth 2.0 錯誤代碼
  • OAuth 2.0 API：Apigee 提供這些 API，可搭配 OAuth 2.0 端點使用。

OAuth 1.0a 架構

OAuth 1.0a 定義了標準通訊協定，讓應用程式使用者可授權應用程式代表他們使用 API，而無須在過程中向應用程式揭露密碼。

OAuth 1.0a 政策參考資料

OAuth V1 政策參考資料說明如何設定 OAuth v1.0a 政策。OAuthV1 政策類型負責根據 OAuth 1.0a 規格產生要求權杖、產生存取權杖，以及驗證存取權杖。

OAuth 1.0a API

Apigee 提供可搭配 OAuth 1.0a 端點使用的 API。

GitHub 上的 OAuth 1.0a 範例

這個 GitHub 上的 API 代理程式範例說明 OAuth 1.0a 三方設定。您可以下載並執行這個程式碼。

名稱 說明
oauth10a-3legged 示範 OAuth 1.0a 三方設定。