用户注册表(例如,LDAP)针对 API Manager 提供用户认证。如果在“安全性定义”中指定用户注册表,那么还可以通过该用户注册表来保护 API。
关于此任务
要将 LDAP 用户注册表配置为 API Manager 中的资源,必须创建并填充 LDAP 目录以用于 API Connect 生态系统。
LDAP 注册表可用于对访问 API 的用户进行认证,或保护某目录以对 Developer Portal 用户进行认证。
需要以下某个角色才能配置 LDAP 用户注册表:
- 组织管理员
- 所有者
- 具有 Settings: Manage 许可权的定制角色
过程
请执行以下步骤以将新的 LDAP 用户注册表配置为资源。
- 在 API Manager 中,单击
资源。
- 单击创建以添加新的用户注册表。
- 选择“LDAP 用户注册表”作为用户注册表类型,并输入以下信息:
| 字段 |
描述 |
| 标题 |
输入要在屏幕上使用的描述性名称。 |
| 名称 |
在 CLI 命令中使用的名称。 |
| 摘要(可选) |
输入简短描述。 |
| 地址 |
输入 LDAP 服务器的 IP 地址或主机名。 |
| 端口 |
输入 API Connect 与 LDAP 注册表通信所使用的端口号。例如,389。 |
| 选择 TLS 客户机概要文件(可选) |
选择 LDAP 服务器所需的 TLS 客户机概要文件。必须使用 TLS 来配置 LDAP 服务器。 |
| 选择协议版本 |
选择要使用的 LDAP 协议的版本号。 |
注: 用户名是否区分大小写取决于支持注册表,不能由 API Connect 控制。
- 单击下一步,并输入认证信息(此信息因所选认证方法而异)。选项包括:
- 组成 DN - 如果可以通过用户名来组成用户 LDAP 专有名称 (DN),请选择此格式。下面是可通过用户名组成的 DN 格式的示例:uid=<username>,ou=People,dc=company,dc=com。如果不确定“组成 (DN)”是否为正确选项,请联系 LDAP 管理员。
- 组成 UPN - 如果 LDAP 目录支持与用户主体名称(例如 john@acme.com)进行绑定,请选择此格式。Microsoft Active Directory 是支持组成 UPN 认证的 LDAP 目录的示例。如果不确定 LDAP 目录是否支持与 UPN 绑定,请联系 LDAP 管理员。
- 搜索 DN - 如果不能通过用户名来组成用户 LDAP 专有名称,请选择此格式;例如,如果用户的基本 DN 不同。此格式可能需要管理员 DN 和密码才能搜索 LDAP 目录中的用户。如果 LDAP 目录允许匿名绑定,那么可省略管理员 DN 和密码。如果不确定 LDAP 目录是否允许匿名绑定,请联系 LDAP 管理员。如果正在创建要用于 Developer Portal 的 LDAP 注册表,那么必须使用搜索 DN。
对于所有认证方法:
如果您是创建 LDAP 注册表来认证 API 的用户,那么可以指定 LDAP 授权组以限制 API 访问。要能够调用受 LDAP 注册表保护的 API,用户必须使用其 LDAP 用户标识和密码成功认证,并且他们必须是指定授权组的成员。
授权组可以是“静态组”或“动态组”。静态组是指显式列出组的各个成员的组。动态组是根据组成员共享的一组属性来定义的组。
- 对于认证方法组成 DN,请输入以下信息:
| 字段 |
描述 |
| 前缀(可选) |
向 DN 添加可选前缀。 |
| 后缀(可选) |
向 DN 添加可选后缀。 |
| 使用认证方法:静态或动态 |
对于“静态组”,输入“组 DN”、“前缀”和“后缀”。对于“动态组”,输入组的过滤条件。 |
| 测试配置 |
测试 LDAP 用户注册表的配置。 |
- 对于认证方法组成 UPN,请输入以下信息:
| 字段 |
描述 |
| 后缀 |
输入用户主体名称的域部分。例如,@acme.com。 |
| 使用认证组:静态或动态 |
对于“静态组”,输入“组 DN”、“前缀”和“后缀”。对于“动态组”,输入组的过滤条件。 |
| 测试配置 |
测试 LDAP 用户注册表的配置。 |
- 对于认证方法搜索 DN,请输入以下信息:
| 字段 |
描述 |
| 绑定方法 |
匿名或认证。如果搜索注册表时不需要特定许可权,请选择“匿名绑定”;如果需要特定许可权,请选择“认证绑定” |
| 前缀(可选) |
向 DN 添加可选前缀。 |
| 后缀(可选) |
向 DN 添加可选后缀。 |
| 管理 DN |
输入有权在 LDAP 目录中执行搜索的用户的专有名称。 |
| 管理密码 |
输入管理 DN 的用户密码。 |
| 测试绑定和获取基本 DN |
对于“认证绑定”,在“管理 DN”和“密码”文本字段中输入用户的专有名称和密码。 |
| 基本 DN |
对于“认证绑定”,在“基本 DN”字段中输入基本 DN,或者单击“测试绑定和获取基本 DN”以使用检索到的基本 DN 来填充“基本 DN”字段。 |
| 使用认证组:静态或动态 |
对于“静态组”,输入“组 DN”、“前缀”和“后缀”。对于“动态组”,输入组的过滤条件。 |
| 测试配置 |
测试 LDAP 用户注册表的配置。请输入有效凭证以确保您可以访问 LDAP 数据库。 |
- 单击创建。
- 将用户注册表添加到沙箱目录。请参阅创建和配置目录。
结果
可以在 API 的“安全性定义”中使用该用户注册表进行基本认证。
有关更多信息,请参阅创建基本认证安全性定义。