您目前查看的是 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 電子書和影片:
- OAuth the Big Picture:免費的 Apigee 電子書。
- OAuth the Big Picture (OAuth 大全),這是一場免費的 Apigee 網路直播。
導入授權類型流程
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 參考資料
這些主題提供政策和 API 的詳細參考資訊,直接支援 Edge 上的 OAuth 2.0。
-
OAuthV2 政策:這些政策可讓您在 Apigee Edge 上實作及自訂四種 OAuth 2.0 授權類型:
- OAuthV2 政策:Apigee Edge OAuth 2.0 實作的核心。您可以在 Apigee Edge 上設定 OAuth 2.0「作業」,產生存取和更新權杖、核發授權碼,以及驗證權杖。本主題提供程式碼範例,協助您瞭解運作方式。
- GetOAuthV2Info 政策:取得權杖的屬性,並提供給 API Proxy 中執行的政策和程式碼。如需根據存取權杖中的值設定動態條件式行為,這類政策就非常實用。另請參閱「自訂存取權杖」。
- SetOAuthV2Info policy - 更新存取權杖的設定檔。舉例來說,您可能想嵌入專屬商家的代碼。另請參閱「自訂存取權杖」。
- OAuth 2.0 錯誤代碼
- OAuth 2.0 API:Apigee 提供這些 API,用於處理 OAuth 2.0 端點。
OAuth 1.0a 架構
OAuth 1.0a 定義了標準通訊協定,可讓應用程式使用者授權應用程式代表他們使用 API,過程中不必向應用程式揭露密碼。
OAuth 1.0a 政策參考資料
OAuth 1.0a 已停止支援。詳情請參閱「已淘汰的功能」。OAuthV1 政策類型負責產生要求權杖、產生存取權杖,以及根據 OAuth 1.0a 規格驗證存取權杖。
OAuth 1.0a API
Apigee 提供 API,可處理 OAuth 1.0a 端點。
GitHub 上的 OAuth 1.0a 範例
GitHub 上的這個範例 API Proxy 說明 OAuth 1.0a 三向驗證設定。您可以下載並執行這段程式碼。
| 名稱 | 說明 |
|---|---|
| oauth10a-3legged | 示範 OAuth 1.0a 三向設定。 |