将安全性定义应用于 API

安全性定义包含通过将安全性定义应用于 API 来定义 API 中操作的访问控制需求而实施的安全性设置。

开始之前

在 API 中创建一个或多个安全性定义。有关更多信息，请参阅创建安全性定义。

关于此任务

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

在将安全性定义应用于 API 时，存在以下限制：
  • 不能将两个以上的 API 密钥安全性定义应用于一个 API。
  • 如果应用客户机密钥的 API 密钥安全性定义，那么还必须应用客户机标识的 API 密钥安全性定义。
  • 如果需要应用程序开发者同时提供客户机标识和客户机密钥，那么必须应用两套独立的 API 密钥安全性定义。
  • 不论客户机标识是在请求头中发送，还是作为查询操作发送，您最多只能具有一个客户机标识类型的 API 密钥定义。
  • 不论客户机密钥是在请求头中发送，还是作为查询操作发送，您最多只能具有一个客户机密钥类型的 API 密钥定义。
  • 不能将多个基本安全性定义应用于同一个 API。 如果应用了基本安全性定义，那么将无法再应用 OAuth 安全性定义。
  • 如果将多个 OAuth 安全性定义应用于同一个 API，这些定义必须全部采用相同的客户机类型设置（“公共”或“机密”）。
  • 如果将多个 OAuth 安全性定义应用于同一个 API，这些定义必须采用兼容的认证设置。 也就是说，对于使用某个认证属性的所有已应用 OAuth 安全方案，该认证属性的值都必须相同。
  • 如果将多个 OAuth 安全性定义应用于同一个 API，这些定义必须采用兼容的令牌刷新和撤销设置。 也就是说，对于使用某个令牌刷新属性或撤销属性的所有已应用 OAuth 安全方案，该属性的值都必须相同。

过程

要将安全性定义应用于 API，请完成以下步骤：

  1. 在导航窗格中，单击 API UI 导航窗格中的“开发”图标 开发。 这样会打开 API 和产品列示页面。
  2. 要将定义应用于现有 API，请单击想要处理的 API。

    要在应用定义之前新建 API，请参阅创建 API 定义。

  3. 浏览至安全性部分。
  4. 在安全性部分，单击添加并选择要应用的安全性定义。

    对 API 应用安全性定义时，用户界面会提供所有现有安全性定义的集合。您可从该集合中选择一个或多个定义，以指定希望此 API 满足的精确的定义组合。

    此外，还可指定多种定义组合。要指定第二种组合，请再次单击添加，此界面会提供第二个所有现有安全性定义的集合。选择要在第二种组合中包含的每个定义的复选框。您可添加其他集合并指定其他组合，直至为此 API 创建所有有效组合为止。

    如果 API 满足您已定义的任意组合，那么应用程序即可调用此 API。

    注： 以下附加要求适用于将用于 OAuth 第三方提供者的安全性定义。如果选择 OAuth 安全性定义来保护使用者 API，那么还必须包含 API 密钥安全性定义，因为 X-IBM-Client-Id 或 client_id 必须包含在安全凭证中，以便能够实施正确的计划配置设置。
    现在已将选定的定义应用于 API。
  5. 要除去安全性定义以使其不再应用于 API，请清除该安全性定义的选定。
  6. 单击保存以保存更改。
父主题： 配置 API 安全性
时间戳记图标 上次更新时间：2019-06-21