设计 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 由具有 write:pets 范围的 petstore_auth 保护。
  3. 选择一个资源,然后选择要应用于该资源所有操作的安全方案。
    或者,您可以选择一个操作来定义其特定的安全性。
    在此示例中,使用 petstore_auth 保护“按标签查找宠物”方法。

本页面有帮助吗?

如果您发现此页面或其内容有任何问题 – 打字错误、遗漏步骤或技术错误 – 请告诉我们!