将安全性定义应用于 API 操作

您可以指定 API 操作是否继承在内含式 API 中创建的安全性定义。

关于此任务

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

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

可以选择继承所有安全性定义,也可以单独选择要继承的安全性定义。

有关在 API 中创建安全性定义的信息,请参阅创建安全性定义

过程

要使用 IBM® API Connect 指定 API 操作的安全性定义继承设置,请完成以下步骤:

  1. 在导航窗格中,单击 API UI 导航窗格中的“开发”图标 开发,然后选择 API 选项卡
  2. 要为现有 API 中的操作指定安全性定义继承设置,请单击要使用的 API 的标题。

    要在指定安全性定义继承设置之前创建新的 API 和 API 操作,请参阅创建 API 定义定义 REST API 的路径

  3. 单击路径,然后单击必需路径。
  4. 操作部分,单击所需操作以显示其详细信息。
  5. 指定将哪些安全性定义应用于您的操作。缺省情况下,为 API 配置的所有安全性定义都将应用于此操作。要选择将哪些 API 安全性定义应用于操作,请完成以下步骤:
    1. 选择覆盖 API 安全性定义
      这样会显示添加按钮。
    2. 单击添加,然后选择所需安全性定义。

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

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

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

    3. 如果所选安全性定义的类型为 OAuth2,那么选择必需的作用域;可供选择的作用域是在安全性定义中指定的作用域;有关更多信息,请参阅创建 OAuth 安全性定义
      注: 如果使用 DataPower® Gateway(与 V5 兼容),那么必须至少选择一个作用域,并且 API 请求中发送的作用域必须匹配一个选中的作用域,否则调用失败。

      如果使用 DataPower API Gateway,那么仅当未在与安全性定义相关联的本机 OAuth 提供者中启用令牌验证后进行高级作用域检查时,才需要选择任何作用域。如果已在本机 OAuth 提供者中设置了缺省作用域,并且 API 请求未包含任何作用域,那么将使用缺省作用域;有关更多信息,请参阅为本机 OAuth 提供者配置作用域

    注: 以下附加要求适用于将用于 OAuth 第三方提供者的安全性定义。如果选择 OAuth 安全性定义来保护使用者 API,那么还必须包含 API 密钥安全性定义,因为 X-IBM-Client-Idclient_id 必须包含在安全凭证中,以便能够实施正确的计划配置设置。
  6. 单击保存以保存更改。