OAuth 首頁

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

歡迎使用 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 範例存放區查看這個進階範例。您可以複製、部署並執行範例。詳情請參閱「 README」檔案。其中包括可靠的登入應用程式，用於驗證使用者，並透過授權伺服器安全地進行通訊。

隱性

  • 「要求權杖：隱含授權類型」：示範如何使用隱含授權類型要求權杖。

資源擁有者密碼憑證

  • 導入密碼授權類型 - 導入授權類型，並特別說明您在 Apigee Edge 中實作這個授權類型時必須採取的步驟。

快速說明主題

以下主題可讓您快速瞭解常見的 OAuth 2.0 工作執行步驟：

政策與 API 參考資料

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

  • OAuthV2 政策：下列政策可讓您實作及自訂 Apigee Edge 上的四種 OAuth 2.0 授權類型：
    • OAuthV2 政策：Apigee Edge OAuth 2.0 實作的核心。可讓您在 Apigee Edge 上設定 OAuth 2.0「作業」，藉此產生存取權並更新權杖、發出授權碼並驗證權杖。本主題包含程式碼範例，有助於說明功能的運作方式。
    • GetOAuthV2Info 政策：取得權杖屬性，並在 API Proxy 中執行政策和程式碼時使用。當您需要根據存取權杖內的值設定動態、條件式行為時，這項政策類型就能派上用場。另請參閱「自訂存取權杖」。
    • SetOAuthV2Info 政策：更新存取權杖的設定檔。例如，如果要嵌入您商家專屬的標記，也請參閱自訂存取權杖。
  • OAuth 2.0 錯誤代碼
  • OAuth 2.0 API：Apigee 提供這些 API 可與 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。

GitHub 上的 OAuth 1.0a 範例

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

姓名 說明
OAuth10a-3uch 示範 OAuth 1.0a 三足式設定。