創建自定義認證
更新時間 2024-11-24 16:52:15
最近更新時間: 2024-11-24 16:52:15
分享文章
本章主要介紹創建自定義認證。
操作場景
自定義認證包含兩種認證:前端自定義認證和后端自定義認證。
- 前端自定義認證:如果您希望使用自己的認證系統,而不是APP認證/IAM認證對API的訪問進行認證鑒權時,您可以使用自定義認證,通過您自定義的函數進行認證鑒權。
- 后端自定義認證:當不同的后端服務使用不同的認證系統時,導致您需要為不同的認證系統定制化開發API,而APIG通過自定義認證功能,將多種認證系統集成,簡化API開發的復雜度。您只需要在APIG中創建自定義的函數認證,APIG通過此函數對接后端認證系統,獲取后端服務的訪問授權。
說明自定義認證依賴函數工作流服務。如果當前Region沒有上線函數工作流服務,則不支持使用自定義認證。
使用自定義認證調用API的流程如下圖所示:
圖 使用自定義認證調用API

前提條件
已在函數工作流服務中完成函數創建。
創建自定義認證
步驟 1 進入API網關控制臺頁面。
步驟 2 根據實際業務在左側導航欄上方選擇實例。
步驟 3 在左側導航欄選擇“API管理 > API策略”。
步驟 4 在“自定義認證”頁面,單擊“創建自定義認證”。
配置自定義認證參數。
表 自定義認證參數說明
| 信息項 | 描述 |
|---|---|
| 認證名稱 | 您自定義的認證名稱,用于區分不同的自定義認證。 |
| 類型 | 前端:對API的訪問進行認證鑒權。 后端:對后端服務的訪問授權。 |
| 函數地址 | 選擇在FunctionGraph中創建的函數。 |
| 版本或別名 | 選擇函數的版本或別名。 |
| 緩存時間(秒) | 設置認證結果緩存的時間。 值為0時代表不緩存,最大支持3600秒。 |
| 身份來源 | 設置用于認證的請求參數。 當“類型”為“前端”,且“緩存時間”不為0時,必須設置此參數。使用緩存時,此參數將作為搜索條件來查詢認證結果。 |
| 是否發送body | 指是否將API請求的body體內容傳遞給認證函數。body體內容傳給函數的方式,與header、query內容傳遞一致。 |
| 用戶數據 | 您自定義的請求參數,APIG調用函數時,與“身份來源”一同作為請求參數。 |
步驟 5 單擊“確定”,完成自定義認證的創建。