创建单点登录嵌入网址

版本 4.0.23.4

创建单点登录嵌入网址

创建单点登录嵌入网址并使用嵌入密钥对该网址进行加密。然后,此签名网址可用于在 PBL Web 应用中实例化 Looker 嵌入会话。请勿对此网址进行任何修改 - 任何更改都可能会使签名无效,并导致该网址无法加载 Looker 嵌入会话。

已签名的 SSO 嵌入网址只能使用 1 次。在用于从 Looker 服务器请求页面后,该网址将失效。日后使用同一网址的请求将会失败。这是为了防止“重放攻击”。

target_url 属性必须是 Looker 界面网页的完整网址(架构、主机名、路径和查询参数)。如需加载 ID 为 56 且过滤条件为 Date=1 years 的信息中心,Looker 网址应类似于 https:/myname.looker.com/dashboards/56?Date=1%20years。 获取此 target_url 的最佳方法是在网络浏览器中导航到所需的 Looker 页面,复制浏览器地址栏中显示的网址,然后将其粘贴到此 API 请求中带引号的字符串值 target_url 属性。

嵌入用户的权限由嵌入用户所属的群组(group_ids 属性)以及分配给嵌入用户的模型和权限列表定义。您必须至少提供 group_ids 属性或同时提供模型和权限属性的值。 这些属性可以累加使用;嵌入的用户可以是特定群组的成员,并且可以获得模型和权限。

嵌入用户的访问权限是由 group_ids、模型和权限属性授予的权限的并集。

此函数并不严格要求在创建 SSO 嵌入网址时存在所有 group_id、用户属性名称或模型名称。未知的 group_id、用户属性名称或模型名称会传递到输出网址。如需诊断单点登录嵌入网址的潜在问题,您可以将签名网址复制到 <your looker instance>/admin/embed 中的“嵌入 URI 验证工具”文本框。

secret_id 参数是可选参数。如果指定,则其值必须是 Looker 实例中定义的活跃 Secret 的 ID。如果未指定,网址将使用 Looker 实例中定义的最新活跃 Secret 进行签名。

安全性说明

按照与访问令牌或密码凭据相同的方式保护此签名网址,不要将其写入磁盘,不要将其传递给第三方,而只通过安全的 HTTPS 加密传输进行传递。

请求

POST /embed/sso_url
数据类型
说明
请求
HTTP 请求
body
HTTP 正文
展开 HTTPBody 定义...
body
SSO 参数
展开 EmbedSsoParams 定义...
target_url
字符串
要在嵌入上下文中显示的 Looker 界面页面的完整网址。例如,如需显示 ID 为 34 的信息中心,`target_url` 会类似于:https://mycompany.looker.com:9999/dashboards/34。`target_uri` 必须包含协议 (HTTPS)、域名和网址路径。如果必须从浏览器客户端访问 Looker 服务器,则必须添加端口。如果 Looker 实例位于负载均衡器或其他代理后面,则“target_uri”必须是访问 Looker 实例所需的公开域名和端口,而不是 Looker 实例的实际内部网络计算机名称。
会话时长
整数
单点登录会话启动后,单点登录嵌入会话的秒数。默认为 300 秒。接受的会话时长上限为 2592000 秒(30 天)。
force_logout_login
布尔值
如果为 true,嵌入会话将完全清除所有剩余的 Looker 登录状态(例如在浏览器 Cookie 中),然后再使用指定的嵌入用户信息创建新的登录状态。默认值为 true。
external_user_id
字符串
来自外部系统的值,用于唯一标识嵌入用户。Looker 嵌入用户的 user_id 可能会随每次嵌入会话而发生变化,因此 external_user_id 提供了一种方式来跨多个嵌入式会话分配已知稳定的用户标识符。
first_name(名字)
字符串
嵌入用户的名字。如果未指定,则默认为“嵌入”
last_name(姓氏)
字符串
嵌入用户的姓氏。如果未指定,则默认为“用户”
user_timezone
字符串
如果在 Looker 管理员设置中启用了“特定于用户的时区”设置,则为嵌入用户会话设置用户时区。值“null”将强制嵌入用户使用 Looker 应用默认时区。如果用户专用时区设置处于停用状态,您必须在请求中省略此属性。时区值会根据 IANA 时区标准进行验证,您可以在 Looker 常规设置管理页面的“应用时区”下拉列表中查看。
权限
字符串 []
模型
字符串 []
组 ID
字符串 []
external_group_id [外部群组 ID]
字符串
用于标识嵌入专有组的唯一值。多个使用相同 `external_group_id` 值的嵌入用户将能够彼此共享 Looker 内容。普通 Looker 用户将无法访问与该 `external_group_id` 关联的内容和嵌入用户,也不会嵌入未与此 `external_group_id` 关联的嵌入用户。
user_attributes
对象
一个名称-值对的字典,用于将 Looker 用户属性名称与值相关联。
Secret_ID
字符串
用于对此 SSO 网址签名的嵌入密钥的 ID。如果指定,则该值必须是 Looker 实例中定义的有效(有效)Secret 的 ID。如果未指定,网址将使用 Looker 实例中定义的最新活跃嵌入密钥进行签名。

响应

200:已签名的单点登录网址

数据类型
说明
(对象)
网址
字符串
嵌入网址。对此字符串所做的任何修改都会导致网址无法使用。

400:错误请求

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

404:未找到

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

409:资源已存在

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

422:验证错误

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

429:请求数过多

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