测试 LDAP 身份验证

版本 4.0.23.6（最新）

测试 LDAP 配置的连接身份验证设置。

此操作会测试是否可以建立连接，并根据给定的连接和身份验证信息，让 Looker 使用的“服务器”帐号对 LDAP 服务器进行身份验证。

必须提供 connection_host、connection_port 和 auth_username。connection_tls 和 auth_password 是可选的。

示例：

{
  "connection_host": "ldap.example.com",
  "connection_port": "636",
  "connection_tls": true,
  "auth_username": "cn=looker,dc=example,dc=com",
  "auth_password": "secret"
}

Looker 绝不会返回 auth_password。如果此请求中省去了 auth_password 字段，则系统将使用活动配置中的 auth_password 值（如果存在）。

系统不会修改有效的 LDAP 设置。

请求

PUT /ldap_config/test_auth
数据类型
说明
请求
HTTP 请求
body
HTTP 正文
展开 HTTPBody 定义...
body
LDAP 配置
展开 LDAPConfig 定义...
可以
对象
当前用户可以对此对象执行的操作
alternate_email_login_allowed
布尔值
允许通过“/login/email”为管理员和具有“login_special_email”权限的指定用户提供备用邮箱登录方式。在 LDAP 设置期间、 LDAP 配置问题之后或当您需要支持 LDAP 目录中的一些用户时，此选项都非常有用。启用 LDAP 后，系统会为常规用户停用 Looker 电子邮件地址/密码登录功能。
身份验证密码
字符串
（只写）用于访问 LDAP 服务器的 LDAP 帐号的密码
auth_required_role
布尔值
除非在 LDAP 中发现某个用户的角色设为 true，否则该用户将永远无法登录
身份验证用户名
字符串
用于访问 LDAP 服务器的 LDAP 帐号的区分名称
connection_host（连接主机）
字符串
LDAP 服务器主机名
连接端口
字符串
LDAP 主机端口
connection_tls
布尔值
使用传输层安全协议
connection_tls_no_verify
布尔值
使用 TLS 时不验证对等设备
default_new_user_group_ids
字符串 []
default_new_user_groups
default_new_user_role_ids
字符串 []
default_new_user_roles
已启用
布尔值
为服务器启用/停用 LDAP 身份验证
force_no_page
布尔值
请勿尝试进行 LDAP 搜索结果分页 (RFC 2696)，即使 LDAP 服务器声明支持此类设置也不例外。
群组基准
字符串
在 LDAP 搜索中查找群组的基本 dn
groups_finder_type
字符串
用于了解 Looker 如何在 LDAP 服务器中搜索群组的策略的标识符
groups_member_attribute
字符串
表示群组成员的 LDAP 群组属性。最常见的“会员”
groups_objectclasses
字符串
执行群组搜索时，可选的群组受支持的 LDAP 对象类（以英文逗号分隔）列表
groups_user_attribute
字符串
表示群组内用户的 LDAP 群组属性。最常用于“dn”
groups_with_role_ids
has_auth_password
布尔值
（只读）是否已为用于访问 LDAP 服务器的 LDAP 帐号设置密码
merge_new_users_by_email
布尔值
通过电子邮件地址将初始 LDAP 登录名与现有用户帐号合并。当用户首次通过 LDAP 登录时，此选项会通过查找匹配电子邮件地址的帐号，将其关联到现有帐号。否则，系统会为用户创建一个新的用户帐号。
已修改
字符串
上次修改此配置的时间
修改时间
字符串
上次修改此配置的用户的用户 ID
set_roles_from_groups
布尔值
根据 LDAP 中的群组，在 Looker 中设置用户角色
test_ldap_password
字符串
（只写）测试 LDAP 用户密码。仅适用于 LDAP 测试。
test_ldap_user
字符串
（只写）测试 LDAP 用户登录 ID。仅适用于 LDAP 测试。
user_attribute_map_email
字符串
用于指明电子邮件地址字段的用户记录属性的名称
user_attribute_map_first_name
字符串
用于表明名字的用户记录属性的名称
user_attribute_map_last_name
字符串
用于指明姓氏的用户记录属性的名称
user_attribute_map_ldap_id
字符串
用于指示唯一记录 ID 的用户记录属性的名称
user_attributes
user_attributes_with_ids
user_bind_base_dn
字符串
将 LDAP 节点用作用户搜索的基础的区分名称
user_custom_filter
字符串
（可选）自定义 RFC-2254 过滤器子句，用于在登录期间查找用户。通过“and”与其他生成的过滤器子句结合使用。
user_id_attribute_name
字符串
用于匹配用户登录 ID 的用户记录属性的名称（以英文逗号分隔列表）
user_objectclass
字符串
（可选）用于在登录 ID 中查找用户的用户记录对象类的名称
allow_normal_group_membership
布尔值
允许通过 LDAP 身份验证的用户成为未反映的 Looker 群组的成员。如果设为“false”，登录的用户将从非反映群组中移除。
allow_roles_from_normal_groups
布尔值
通过 LDAP 身份验证的用户可以继承未反映的 Looker 群组的角色。
allow_direct_roles
布尔值
允许将角色直接分配给 LDAP 身份验证的用户。
网址
字符串
用于获取此商品的链接

响应

200：结果信息。

数据类型
说明
（对象）
明细
字符串
错误案例的其他详情
展开 LDAPConfigTestIssue 定义...
严重程度
字符串
问题的严重性。错误或警告
消息
字符串
问题描述消息
消息
字符串
关于结果的人工可读测试
状态
字符串
测试状态代码：始终为“success”或“error”
trace
字符串
更详细的身份验证测试期间增量结果跟踪记录
位用户
来自 LDAP 服务器的用户身份验证测试详情
展开 LDAPUser 定义...
all_emails
字符串 []
attributes
对象
用户字典（名称/值）字典
电子邮件
字符串
主电子邮件地址
first_name（名字）
字符串
名字
组
字符串 []
last_name（姓氏）
字符串
姓氏
LDAP 目录
字符串
用于用户记录的 LDAP 可识别名称
LDAP ID
字符串
用户 LDAP 的唯一 ID
角色
字符串 []
网址
字符串
指向 LDAP 配置的链接
网址
字符串
指向 LDAP 配置的链接

400：错误请求

数据类型
说明
（对象）
消息
字符串
错误详情
文档网址
字符串
文档链接

403：权限遭拒

数据类型
说明
（对象）
消息
字符串
错误详情
文档网址
字符串
文档链接

404：未找到

数据类型
说明
（对象）
消息
字符串
错误详情
文档网址
字符串
文档链接

422：验证错误

数据类型
说明
（对象）
消息
字符串
错误详情
展开 ValidationErrorDetail 定义...
字段
字符串
出错的字段
代码
字符串
错误代码
消息
字符串
错误信息消息
文档网址
字符串
文档链接
文档网址
字符串
文档链接