設計 API 安全性 | Qlik Cloud 說明
跳到主要內容 跳至補充內容

設計 API 安全性

作為 API 設計程序的一部分,您需要指定哪些取用者可以存取您的 API (驗證),以及允許他們執行哪些操作 (授權)。

您可能只想為整個 API 定義一個通用的安全性,或者為關鍵資源選擇具有特定安全性的更精細原則。

您可能還想指定某些操作可以自由存取而無需驗證。

API Designer 可以使用主要安全性類型處理所有這些情況:
  • 基本驗證
  • Bearer 驗證
  • 摘要驗證
  • OAuth 1.0
  • OAuth 2.0
  • OpenID Connect
  • 自訂 / API 金鑰
  • 傳遞

不支援 Cookie 驗證。

建立安全性配置

建立要在您的 API 版本或個別元素中全域使用的安全性配置。

  1. 前往 API 的一般資訊頁面。
  2. 向下捲動至 安全性配置 區段,然後按一下 新增 以建立新配置。
  3. 輸入 名稱,並在下拉式清單中選取 類型
  4. 選用:輸入 描述
  5. 輸入所選類型特定的其他參數。
    安全性配置定義範例。
您的安全性配置現已建立,您可以在 API 的全域設定或特定資源和操作中使用它。

定義您的 API 安全性

為您的 API、資源和操作定義安全性配置。
  1. 前往 API 的一般資訊頁面。
  2. 全域安全性區段中,新增您的安全性配置,並選取您想要全域套用至 API 版本的配置。
    在此範例中,Petstore API 由 petstore_auth 保護,範圍為 write:pets。
  3. 選取資源,並選擇您想要套用至所有資源操作的安全性配置。
    或者,您可以選取操作以定義其特定安全性。
    在此範例中,Find Pets by tags 方法使用 petstore_auth 進行保護。

此頁面是否對您有幫助?

若您發現此頁面或其內容有任何問題——錯字、遺漏步驟或技術錯誤——請告知我們!