更新 SAML 配置

版本 4.0.23.6（最新）

更新 SAML 配置。

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

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

您可以使用 enabled 字段为 Looker 启用或停用 SAML。

我们强烈建议先使用下面的 API 测试所有 SAML 设置更改，然后再进行全局设置。

请求

PATCH /saml_config
数据类型
说明
请求
HTTP 请求
body
HTTP 正文
展开 HTTPBody 定义...
body
SAML 配置
展开 SamlConfig 定义...
可以
对象
当前用户可以对此对象执行的操作
已启用
布尔值
为服务器启用/停用 Saml 身份验证
idp_cert [ID 证书]
字符串
身份提供商证书（由 IdP 提供）
idp_url
字符串
身份提供方网址（由 IdP 提供）
idp_issuer [ID 发放者]
字符串
身份提供商颁发者（由 IdP 提供）
idp_audience
字符串
身份提供方受众群体（在 IdP 配置中设置）。在 Looker 中是可选的。请仅在您希望 Looker 验证 IdP 返回的受众群体值时设置此字段。
allow_clock_drift
整数
验证断言的时间戳时允许的时钟偏移（以秒为单位）的计数。
user_attribute_map_email
字符串
用于指明电子邮件地址字段的用户记录属性的名称
user_attribute_map_first_name
字符串
用于表明名字的用户记录属性的名称
user_attribute_map_last_name
字符串
用于指明姓氏的用户记录属性的名称
new_user_migration_types
字符串
通过电子邮件地址将首次 SAML 登录合并到现有用户帐号。当用户首次通过 SAML 登录时，此选项会让用户通过测试提供给定类型凭据的凭据来查找该帐号，从而将其关联到现有帐号。否则，系统会为用户创建一个新的用户帐号。此列表（如果提供）必须是以英文逗号分隔的字符串列表，例如“email,ldap,google”
alternate_email_login_allowed
布尔值
允许通过“/login/email”为管理员和具有“login_special_email”权限的指定用户提供备用邮箱登录方式。在 LDAP 设置期间、 LDAP 配置问题之后或当您需要支持 LDAP 目录中的一些用户时，此选项都非常有用。启用 LDAP 后，系统会为常规用户停用 Looker 电子邮件地址/密码登录功能。
test_slug
字符串
运行 Slug，找出为了运行 Saml 配置测试而创建的配置
已修改
字符串
上次修改此配置的时间
修改时间
字符串
上次修改此配置的用户的用户 ID
default_new_user_roles
default_new_user_groups
default_new_user_role_ids
字符串 []
default_new_user_group_ids
字符串 []
set_roles_from_groups
布尔值
根据来自 Saml 的群组在 Looker 中设置用户角色
groups_attribute
字符串
用于指明群组的用户记录属性的名称。在“groups_finder_type”设置为“grouped_attribute_values”时使用
groups_with_role_ids
auth_required_role
布尔值
用户根本无法登录，除非在 Saml 中发现用户的角色设为 true
user_attributes
user_attributes_with_ids
groups_finder_type
字符串
策略的标识符，该 Looker 用于查找 SAML 响应中的群组。['grouped_attribute_values', 'individual_attributes'] 中的一个
groups_member_value [群组值]
字符串
用于指明成员资格的组属性的值。在“groups_finder_type”设置为“individual_attributes”时使用
绕过登录页面
布尔值
需要用户身份验证时绕过登录页面。请立即重定向至 IdP。
allow_normal_group_membership
布尔值
允许通过 SAML 身份验证的用户成为未反映的 Looker 群组的成员。如果设为“false”，登录的用户将从非反映群组中移除。
allow_roles_from_normal_groups
布尔值
通过 SAML 身份验证的用户会继承未反映的 Looker 群组的角色。
allow_direct_roles
布尔值
允许将角色直接分配给 SAML 身份验证用户。
网址
字符串
用于获取此商品的链接

响应

200：SAML 配置的新状态。

数据类型
说明
（对象）
可以
对象
当前用户可以对此对象执行的操作
已启用
布尔值
为服务器启用/停用 Saml 身份验证
idp_cert [ID 证书]
字符串
身份提供商证书（由 IdP 提供）
idp_url
字符串
身份提供方网址（由 IdP 提供）
idp_issuer [ID 发放者]
字符串
身份提供商颁发者（由 IdP 提供）
idp_audience
字符串
身份提供方受众群体（在 IdP 配置中设置）。在 Looker 中是可选的。请仅在您希望 Looker 验证 IdP 返回的受众群体值时设置此字段。
allow_clock_drift
整数
验证断言的时间戳时允许的时钟偏移（以秒为单位）的计数。
user_attribute_map_email
字符串
用于指明电子邮件地址字段的用户记录属性的名称
user_attribute_map_first_name
字符串
用于表明名字的用户记录属性的名称
user_attribute_map_last_name
字符串
用于指明姓氏的用户记录属性的名称
new_user_migration_types
字符串
通过电子邮件地址将首次 SAML 登录合并到现有用户帐号。当用户首次通过 SAML 登录时，此选项会让用户通过测试提供给定类型凭据的凭据来查找该帐号，从而将其关联到现有帐号。否则，系统会为用户创建一个新的用户帐号。此列表（如果提供）必须是以英文逗号分隔的字符串列表，例如“email,ldap,google”
alternate_email_login_allowed
布尔值
允许通过“/login/email”为管理员和具有“login_special_email”权限的指定用户提供备用邮箱登录方式。在 LDAP 设置期间、 LDAP 配置问题之后或当您需要支持 LDAP 目录中的一些用户时，此选项都非常有用。启用 LDAP 后，系统会为常规用户停用 Looker 电子邮件地址/密码登录功能。
test_slug
字符串
运行 Slug，找出为了运行 Saml 配置测试而创建的配置
已修改
字符串
上次修改此配置的时间
修改时间
字符串
上次修改此配置的用户的用户 ID
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
网址
字符串
用于获取此商品的链接
用户网址
字符串
用于获取具有此角色的用户列表的链接
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_group_ids
字符串 []
set_roles_from_groups
布尔值
根据来自 Saml 的群组在 Looker 中设置用户角色
groups_attribute
字符串
用于指明群组的用户记录属性的名称。在“groups_finder_type”设置为“grouped_attribute_values”时使用
展开 SamlGroupRead 定义...
id
字符串
唯一 ID
Looker_group_id
字符串
Looker 中群组的唯一 ID
Looker_group_name
字符串
Looker 中的群组名称
name
字符串
Saml 中的群组名称
角色
展开角色定义...
可以
对象
当前用户可以对此对象执行的操作
id
字符串
唯一 ID
name
字符串
角色名称
权限集
（只读）权限集
permission_set_id [权限集 ID]
字符串
（只写）权限集 ID
模型集
（只读）模型集
模型集 ID
字符串
（只写）模型集 ID
网址
字符串
用于获取此商品的链接
用户网址
字符串
用于获取具有此角色的用户列表的链接
网址
字符串
点击此链接可转到 SAML 配置
groups_with_role_ids
展开 SamlGroupWrite 定义...
id
字符串
唯一 ID
Looker_group_id
字符串
Looker 中群组的唯一 ID
Looker_group_name
字符串
Looker 中的群组名称
name
字符串
Saml 中的群组名称
角色 ID
字符串 []
网址
字符串
点击此链接可转到 SAML 配置
auth_required_role
布尔值
用户根本无法登录，除非在 Saml 中发现用户的角色设为 true
user_attributes
展开 SamlUserAttributeRead 定义...
name
字符串
Saml 中的用户属性名称
必填
布尔值
必须在 Saml 断言中成功登录才能成功
user_attributes
展开 UserAttribute 定义...
可以
对象
当前用户可以对此对象执行的操作
id
字符串
唯一 ID
name
字符串
用户属性的名称
标签
字符串
方便用户使用的用户属性标签
类型
字符串
用户属性类型（“字符串”“数字”“日期时间”“是”“邮政编码”）
default_value
字符串
未设置用户时的默认值
is_system
布尔值
属性是系统默认属性
是永久的
布尔值
该属性是永久性的，无法删除
值已隐藏
布尔值
如果为 true，用户将无法查看此属性的值
用户查看
布尔值
非管理员用户可以查看属性的值，并可以用它们进行过滤
__修改_用户
布尔值
用户可以自行更改此属性的值
隐藏_值_域_白名单
字符串
接收隐藏属性的目的地。一经设置便无法修改。
网址
字符串
点击此链接可转到 SAML 配置
user_attributes_with_ids
展开 SamlUserAttributeWrite 定义...
name
字符串
Saml 中的用户属性名称
必填
布尔值
必须在 Saml 断言中成功登录才能成功
user_attribute_ids
字符串 []
网址
字符串
点击此链接可转到 SAML 配置
groups_finder_type
字符串
策略的标识符，该 Looker 用于查找 SAML 响应中的群组。['grouped_attribute_values', 'individual_attributes'] 中的一个
groups_member_value [群组值]
字符串
用于指明成员资格的组属性的值。在“groups_finder_type”设置为“individual_attributes”时使用
绕过登录页面
布尔值
需要用户身份验证时绕过登录页面。请立即重定向至 IdP。
allow_normal_group_membership
布尔值
允许通过 SAML 身份验证的用户成为未反映的 Looker 群组的成员。如果设为“false”，登录的用户将从非反映群组中移除。
allow_roles_from_normal_groups
布尔值
通过 SAML 身份验证的用户会继承未反映的 Looker 群组的角色。
allow_direct_roles
布尔值
允许将角色直接分配给 SAML 身份验证用户。
网址
字符串
用于获取此商品的链接

400：错误请求

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

403：权限遭拒

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

404：未找到

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

422：验证错误

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