对 API 实施安全需求

在线编辑

要对 API 实施安全性需求，请应用先前创建的安全方案，以指定 API 安全性配置的各个方面。

关于本任务

注: 此任务与配置 OpenAPI 2.0 API 定义相关。 有关如何配置 OpenAPI 3.0 API 定义的详细信息，请参阅 编辑 OpenAPI 3.0 API 定义。

您可以使用 API Designer UI 应用程序或使用基于浏览器的 API Manager UI 来完成此任务。

有关如何创建和配置安全方案定义的详细信息，请参阅 “定义安全方案 ”。

对 API 应用安全方案时，存在以下限制：
  • 您对一个 API 应用的 API 密钥安全方案不能超过两个。
  • 如果对客户机私钥应用 API 密钥安全方案，那么还必须对客户机标识应用 API 密钥安全方案。
  • 如果需要应用程序开发者提供客户机标识和客户机私钥，那么必须分别应用两个单独的 API 密钥安全方案。
  • 无论客户机标识是在请求头中发送，还是作为查询参数发送，您最多只能有一个客户机标识类型的 API 密钥方案。
  • 无论客户机私钥是在请求头中发送，还是作为查询参数发送，您最多只能有一个客户机私钥类型的 API 密钥方案。
  • 不能对一个 API 应用多个基本安全方案。 如果应用了基本安全方案，那么无法再应用 OAuth 安全方案。
  • 最多可对一个 API 应用一个 OAuth 安全方案。

安全需求指定一个或多个安全方案，要成功调用 API ，必须全部满足这些安全方案的条件。 您可以定义多个安全需求；在此情况下，如果应用程序满足您定义的任意安全需求，那么应用程序可以调用 API。

您随时可以通过点击“源代码”图标 OpenAPI 源图标，直接切换到底层的 OpenAPI YAML源代码。 要返回设计表单，请点击 “表单 ”图标 表单图标。

过程

  1. 打开 API 以进行编辑，如 编辑 OpenAPI 2.0 API 定义中所述。
  2. 展开 常规。
  3. 要为 API 创建新的安全需求，请完成以下步骤：
    1. 点击导航窗格中 “安全 ”旁边的“添加 OpenAPI 2.0 API 添加图标 ”图标。
    2. 选择要包含在此安全需求中的安全方案。 所列出的安全方案均为已定义的方案；请参阅“定义安全方案”。

      如果所选的安全方案类型为“ OAuth2 ”，请选择所需的范围；可供选择的范围即为安全方案中指定的范围；有关详细信息，请参阅 “定义 OAuth2 安全方案 ”。

      如果您将“ OAuth2 ”安全方案应用于由 强制执行的 API， DataPower® API Gateway并且在与该安全方案关联的原生 OAuth 提供程序中未启用 “令牌生成后的高级范围检查”功能 ，则只需选择任意范围即可。 如果在原生 OAuth 提供程序中已设置了默认范围，且API请求中未包含任何范围，则将使用该默认范围；有关详细信息，请参阅 《为原生 OAuth 提供程序配置范围 》。

      注意： 以下附加要求适用于将与 OAuth 第三方服务提供商配合使用的安全方案。 如果选择 OAuth 安全方案来保护使用者 API，那么还必须添加 API 密钥安全方案，因为 X-IBM-Client-Id 或 client_id 必须包含在安全凭证中，以便能够实施正确的计划配置设置。
    3. 点击 “创建”。 系统将显示安全方案选择；您可以在保存之前再次更改。
    4. 完成后单击 提交 。
  4. 要修改现有安全需求，请完成以下步骤：
    1. 在导航窗格中单击 安全性 。 这会列示所有先前定义的安全需求；系统将显示每个安全需求中包含的安全方案。
    2. 若要更改某项安全要求的安保方案，请点击该安全要求旁边的 安全需求编辑图标 编辑图标，然后根据需要修改安全要求选项。
    3. 完成后单击 提交 ，然后单击 保存。
    4. 要删除一项安全要求，请单击相应的删除图标 安全需求删除图标，单击 “删除 ”进行确认，然后单击 “保存 ”。
    5. 要禁用 API 的安全性，请清除 需要以下某个安全性需求 复选框，然后单击 保存。