插件登录对接及配置说明

本文为您介绍如何进行自定义插件登录。

说明

独立部署版本支持插件登录,可自行完成对接。若需要紧急支持专家指导,请联系Quick BI运营负责人

应用场景

针对需要使用非标准化登录方式登录Quick BI的场景,Quick BI在登录层引入了插件化开发的理念,实现将身份验证、登出等流程对外开放,允许外部系统根据需求进行定制和扩展。

快速开始

1. 注册插件

按照图示方式在开放平台自定义插件页面上注册插件,插件类型选择登录管理,具体配置请参见自定义插件

image

2. 对接配置

2.1 开启插件登录

步骤一:使用登录认证超管账号进入超级管理员后台。

image

若账号无权限登录时,会出现以下界面,提示“无权限禁止访问”。请联系Quick BI运维人员添加权限。image.png

步骤二: 选择登录系统管理->登录全局开关,开启/关闭指定的三方登录方式,保存后立即生效image

2.2 插件登录对接配置

步骤一:打开登录认证配置页面

在运维中心->登录策略配置或开放平台->登录认证中打开。两个位置打开的配置效果是一样的,下面以在开放平台中打开对应页面为例,页面如下:

image

步骤二:添加登录策略

若您已配置过登录策略,则跳过步骤二。

每个登录策略都允许配置一套域名/IP拦截策略,用来指定访问指定域名或IPQuick BI支持的登录方式。

登录策略配置请参见自定义企业登录门户

步骤三:选中需要开启插件登录的策略,并点击编辑策略。

image

步骤四:在「编辑策略」页面,选择基础设置。

image

步骤五:配置插件三方登录

在您进行插件三方登录配置前,若您未开启Quick BI账号,建议开启,原因为:1)防止三方登录设置错误后,无法登录Quick BI;2)自定义账号配置成功且能正常登录后,可根据需要关闭Quick BI账号。

  • Quick BI账号配置页面如下(相关配置项请参见内置账号配置说明):

    image

  • 开启插件登录。

    image

  • 在弹出窗口填写插件的配置信息。

    image插件登录相关的配置项及说明如下:

    配置项

    是否必填

    说明

    参考值

    提供方

    登录插件信息

    下拉框选择用户已上传且激活的登录类型插件

    由租户侧自定义

    Session 失效时间(秒)

    指定失效时间,失效后,重新发起校验。

    86400

    由租户侧自定义

    Cookie 失效时间(秒)

    -1,表示随浏览器关闭失效;

    > 0,指定失效时间,失效后重新登录

    86400

    由租户侧自定义

步骤六: 保存并发布策略

保存发布后立即生效,请慎重操作。

推荐新建无痕模式窗口或者打开其他浏览器测试登录配置是否成功,以防退出登录后由于登录配置错误导致无法登录。

image

3. 登录验证

在您完成插件登录对接配置后,请访问Quick BI服务地址,并点击插件登录,进行登录验证。

image

说明

为了防止其他因素干扰,推荐新建无痕窗口用来测试登录。

需要注意的是所有的无痕窗口共用cookies,通过关闭窗口清空登录态时需要保证所有无痕窗口被关闭。