获取 LDAP 配置

版本 4.0.23.2

获取 LDAP 配置。

您可以选择性地将 Looker 配置为针对 Active Directory 或其他 LDAP 目录服务器验证用户身份。 LDAP 设置需要与该目录服务器的管理员进行协作。

只有 Looker 管理员可以读取和更新 LDAP 配置。

配置 LDAP 会影响所有用户的身份验证。您应谨慎配置。

Looker 会维护一个 LDAP 配置。可以读取和更新。仅当新状态有效（因为所有必填字段已填充）时，更新才会成功；您需要确保配置得当且正确。

您可以使用已启用字段为 Looker 启用或停用 LDAP。

Looker 绝不会返回 auth_password 字段。该值可以设置，但绝不能检索。

如需了解详情，请参阅 Looker LDAP 文档。

请求

获取 /ldap_config
数据类型
说明
请求
HTTP 请求

响应

200： LDAP 配置。

数据类型
说明
（对象）
可以
对象
当前用户可以对此对象执行的操作
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
展开群组定义...
可以
对象
当前用户可以对此对象执行的操作
can_add_to_content_metadata
布尔值
群组可用于内容访问权限控制
包含当前用户
布尔值
当前登录的用户是群组成员
external_group_id [外部群组 ID]
字符串
外部 ID 组（如果嵌入组）
由外部管理
布尔值
群组成员资格由 Looker 外部控制
id
字符串
唯一 ID
include_by_default
布尔值
默认情况下，新用户会添加到此群组
name
字符串
群组名称
用户计数
整数
此群组中包含的用户数量
default_new_user_role_ids
字符串 []
default_new_user_roles
展开角色定义...
可以
对象
当前用户可以对此对象执行的操作
id
字符串
唯一 ID
name
字符串
角色名称
权限集
（只读）权限集
展开 PermissionSet 定义...
可以
对象
当前用户可以对此对象执行的操作
all_access
布尔值
内置
布尔值
id
字符串
唯一 ID
name
字符串
PermissionSet 的名称
权限
字符串 []
网址
字符串
用于获取此商品的链接
permission_set_id [权限集 ID]
字符串
（只写）权限集 ID
模型集
（只读）模型集
展开 ModelSet 定义...
可以
对象
当前用户可以对此对象执行的操作
all_access
布尔值
内置
布尔值
id
字符串
唯一 ID
模型
字符串 []
name
字符串
ModelSet 的名称
网址
字符串
用于获取此商品的链接
模型集 ID
字符串
（只写）模型集 ID
网址
字符串
用于获取此商品的链接
用户网址
字符串
用于获取具有此角色的用户列表的链接
已启用
布尔值
为服务器启用/停用 LDAP 身份验证
force_no_page
布尔值
请勿尝试进行 LDAP 搜索结果分页 (RFC 2696)，即使 LDAP 服务器声明支持此类设置也不例外。
展开 LDAPGroupRead 定义...
id
字符串
唯一 ID
Looker_group_id
字符串
Looker 中群组的唯一 ID
Looker_group_name
字符串
Looker 中的群组名称
name
字符串
LDAP 中的群组名称
角色
展开角色定义...
可以
对象
当前用户可以对此对象执行的操作
id
字符串
唯一 ID
name
字符串
角色名称
权限集
（只读）权限集
permission_set_id [权限集 ID]
字符串
（只写）权限集 ID
模型集
（只读）模型集
模型集 ID
字符串
（只写）模型集 ID
网址
字符串
用于获取此商品的链接
用户网址
字符串
用于获取具有此角色的用户列表的链接
网址
字符串
指向 LDAP 配置的链接
群组基准
字符串
在 LDAP 搜索中查找群组的基本 dn
groups_finder_type
字符串
用于了解 Looker 如何在 LDAP 服务器中搜索群组的策略的标识符
groups_member_attribute
字符串
表示群组成员的 LDAP 群组属性。最常见的“会员”
groups_objectclasses
字符串
执行群组搜索时，可选的群组受支持的 LDAP 对象类（以英文逗号分隔）列表
groups_user_attribute
字符串
表示群组内用户的 LDAP 群组属性。最常用于“dn”
groups_with_role_ids
展开 LDAPGroupWrite 定义...
id
字符串
唯一 ID
Looker_group_id
字符串
Looker 中群组的唯一 ID
Looker_group_name
字符串
Looker 中的群组名称
name
字符串
LDAP 中的群组名称
角色 ID
字符串 []
网址
字符串
指向 LDAP 配置的链接
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
展开 LDAPUserAttributeRead 定义...
name
字符串
LDAP 中用户属性的名称
必填
布尔值
必须在 LDAP 断言中，才能成功登录
user_attributes
展开 UserAttribute 定义...
可以
对象
当前用户可以对此对象执行的操作
id
字符串
唯一 ID
name
字符串
用户属性的名称
标签
字符串
方便用户使用的用户属性标签
类型
字符串
用户属性类型（“字符串”“数字”“日期时间”“是”“邮政编码”）
default_value
字符串
未设置用户时的默认值
is_system
布尔值
属性是系统默认属性
是永久的
布尔值
该属性是永久性的，无法删除
值已隐藏
布尔值
如果为 true，用户将无法查看此属性的值
用户查看
布尔值
非管理员用户可以查看属性的值，并可以用它们进行过滤
__修改_用户
布尔值
用户可以自行更改此属性的值
隐藏_值_域_白名单
字符串
接收隐藏属性的目的地。一经设置便无法修改。
网址
字符串
指向 LDAP 配置的链接
user_attributes_with_ids
展开 LDAPUserAttributeWrite 定义...
name
字符串
LDAP 中用户属性的名称
必填
布尔值
必须在 LDAP 断言中，才能成功登录
user_attribute_ids
字符串 []
网址
字符串
指向 LDAP 配置的链接
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 身份验证的用户。
网址
字符串
用于获取此商品的链接

403：权限遭拒

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

404：未找到

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