您正在查看 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 電子書和影片:
- OAuth the Big Picture - 免費的 Apigee 電子書。
- OAuth the Big Picture 是免費的 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 參考資料
這些主題針對直接支援 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 提供的 API 可用來處理 OAuth 1.0a 端點。
GitHub 上的 OAuth 1.0a 範例
這個 GitHub 上的 API Proxy 範例說明 OAuth 1.0a 三足式設定。您可以下載並執行這組程式碼。
名稱 | 說明 |
---|---|
oauth10a-3three | 示範 OAuth 1.0a 三足式設定。 |