定义基本认证安全方案

在线编辑

当需要调用 API 的应用程序通过用户注册表进行认证时，将使用基本认证安全方案。

准备工作

为了对 网关上实施的 API 操作进行身份验证，支持以下用户注册表类型：
  • 认证 URL
  • LDAP
不 支持以下用户注册表类型:
  • OpenID Connect (OIDC)
  • 本地用户注册表 (LUR)
  • 定制用户注册表

在 API 中创建基本认证安全性定义之前，用户注册表必须存在。 要创建用户注册表，可以使用 API Manager 或 Cloud Manager。 在 API Manager中创建注册表时，该注册表仅对提供者组织可见。 在 Cloud Manager中创建注册表时，可以使其对多个提供者组织可见。

要使用 API Manager创建用户注册表，请参阅 使用用户注册表。

关于本任务

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

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

使用基本认证时，需要 API 用户提供有效的用户名和密码才能访问所选操作。 在发送到需要基本认证的操作的请求中，应用程序开发者还必须提供 HTTP 授权头。

在使用认证 URL 时，在授权头中提供的用户凭证通过 URL 中指定的端点来验证。 如果用户已通过身份验证， IBM® API Connect 期望接收一个身份验证对象 URL ，并返回一个 HTTP200 OK响应状态码。 所有其他 HTTP 响应状态码都会导致认证失败并拒绝访问。

有关使用 LDAP 用户注册表进行身份验证的更多信息，请参阅 LDAP authentication。

有关使用身份验证 URL 的信息，请参阅身份验证 URL 用户注册表。

要使用基本认证安全方案，必须从 API 定义中的其他位置引用该方案。 如需了解更多信息，请参阅 《在 API 上强制执行安全要求》 和 《在操作上强制执行安全要求》。

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

过程

  1. 打开 API 以进行编辑，如 编辑 OpenAPI 2.0 API 定义中所述。
  2. 如果已定义一个或多个安全方案，请展开 安全方案。
  3. 要创建基本身份验证安全方案，请单击 “安全方案 ”旁边的添加 OpenAPI 2.0 API 添加图标 图标，然后在 “安全定义类型 ”中选择 “基本”。 要编辑现有基本认证安全方案，请单击导航窗格中的安全方案名称。
  4. 在 名称 字段中输入您选择的标识名称。
  5. 从 使用用户注册表进行认证 列表中选择用户注册表。
    列表中的用户注册表是已在沙箱目录中启用的用户注册表; 有关详细信息，请参阅 创建和配置目录。
  6. (可选) 提供安全方案的 描述 。 您可以使用 CommonMark 语法来呈现富文本。
  7. 如果要创建新的基本认证安全方案，请单击 创建。
    将显示安全方案详细信息以供进一步编辑。
  8. 完成后单击 保存 。

下一步

对 API 或操作应用该安全方案。 如需了解更多信息，请参阅 《在 API 上强制执行安全要求》 和 《在操作上强制执行安全要求》。

有关“ LDAP ”和“身份验证” URL 的更多信息，请参阅 LDAP authentication 以及 “身份验证” URL user registry。