页面树结构

版本比较

标识

  • 该行被添加。
  • 该行被删除。
  • 格式已经改变。

...

1、统一登录平台需单点登录到Smartbi,未使用行业标准协议,但提供了自建协议接口:

1.1、必须提供至少一个接口RESTful API(RESTful API)

1.2、接口返回值是JSON格式字符串

2、建议统一登录平台跟Smartbi用户一致;可参考 用户同步 做用户同步

...

5、通过Smartbi前端注销则注销整个统一登录平台。

名词解释

统一登录平台:

...

统一登录平台是企业或组织用于集中管理用户身份认证与权限控制的系统,用户通过一次登录即可访问所有授权的内部或外部应用,无需重复输入账号密码

token:访问用户资源的令牌,一般有较短的有效期。

单点登录流程

单点登录使用限制及主要能力

1、只支持PC端及集成页面单点登录,不支持插件端(电子表格、分析报告)及移动端APP;移动端可通过集成页面实现单点登录。

...

1.3、当应用范围中未包含需要单点登录处理的页面时,可通过"自定义"添加,添加到"自定义"中的页面,未登录时,也会正常跳转到"统一登录平台"的登录页面。

        Image Modified

2、基于"统一登录平台"的单点登录接口配置文档,在Smartbi中依次配置单点登录接口信息。的单点登录接口配置文档,在Smartbi中依次配置单点登录接口信息。

依次配置 前置授权请求(可选)统一登录接口(必须)、独立获取用户信息接口(可选)、统一注销接口(可选),如有疑问,可参考后续"自建协议场景配置示例"。

...

2.4、可选择配置统一注销地址:当点击Smartbi注销按钮,需要同步注销统一登录平台时,可选择配置

Image Modified

2.5、产品提供了灵活的配置设置,可基于实际接口文档自由选择,如有疑问可参考后续实际配置示例章节

  • 随意增减参数个数
  • 自定义参数名称,基于接口实际参数名称填写
  • 选择入参设置方式:可设置到header,request(body)、cookie、session
    • 入参设置方式说明:
      • request/query:查询参数(Query Parameters)附加在URL的?后面,键值对形式,比如。
      • request/body:请求体参数(Body Parameters):在请求体中传递,常见于POST、PUT等方法,默认是JSON格式。
        • 默认会在请求头中添加:Content-Type:application/json
        • 如果需要键值对格式,需要主动增加请求头参数:Content-Type:application/x-www-form-urlencoded
        • 暂不支持XML格式。
      • request/header:请求头参数(Headers):在HTTP头部中传递,如Content-Type用于设置请求体参数格式。
      • cookie:Cookie参数:通过Cookie头传递,键值对拼接,如 。
      • session:session参数,通过session传递,键值对拼接。
  • 选择参数来源及参数值:
    • 可配置静态值、动态时间戳、或者是上个接口的返回值等可配置静态值、动态时间戳、或者是上个接口的返回值等
      • "上个接口返回"用来获取上一个接口的返回值,并传递到当前接口中,第一个接口获取token。
      • "Smartbi单点地址"用来获取单点登录Smartbi时使用的Smartbi连接地址,一般在前置请求需要回调url时使用。

...

  • 当Smartbi的用户未实时跟统一登录的用户同步时,会出现登录用户在Smartbi中不存在的情况。
  • 当遇到不存在的用户时,产品默认会提示:当前用户在Smartbi中不存在,请联系管理员添加。
  • 客户可选择自动创建用户,并分配到某个默认组,默认角色,以便用户登录后直接访问有权限的资源。
  • 当前只支持分配到固定的用户组或角色,不支持同步动态用户组。

Image Modified

4、可选择配置逃生通道:

  • 逃生通道允许用户绕开oauth2登录协议,直接使用Smartbi账号密码登录,主要是解决oauth2服务异常、Smartbi单点登录配置错误等导致无法正常登录Smartbi的异常情况。
  • 产品默认开启了逃生通道,用户可基于实际需求灵活配置。
  • 注意:在最后一步单点登录验证成功前,不要禁用逃生通道,否则将无法正常登录Smartbi继续调整配置。

Image Modified

5、可选接口入参特殊处理:

  • 当接口参数需要额外处理时使用,比如要特殊加密,或者在上一个接口的返回值+前缀后传给下一个接口等。
  • 该场景需要额外定制开发,基于实际业务场景,通过java扩展接口实现。
  • 产品提供了灵活的扩展接口,通过接口入参的高级配置实现。

Image Modified

6、可选择配置多系统登录Smartbi:

...

在统一登录平台中,用户点击BI平台菜单时,前端会携带该 session 跳转到BI平台的 web 端。跳转url格式是:http:{ip}:{port}/bi/index.html?token=sessionId}&tenantId=3849234893
BI平台获取到token后,可以携带这个 sessionId 来调用一体化平台的接口。当 sessionId 有效时,便可以正常获取用户的唯一标识和用户名称。

接口说明:

Image Modified

Smartbi单点登录配置信息:

Image Modified

场景2:金蝶云之家单点登录到Smartbi

适用类似场景:统一登录平台不携带token,需要先通过统一登录接口获取token,再基于token获取合法用户信息

...

场景3:需要使用重定向获取授权码,再基于授权码获取token,最后使用token获取用户信息。

原始需求描述

Image Modified

配置流程:

1、Smartbi单点登录配置:启用前置授权请求

...