外部系统自主调用SSO模式登录七巧应用平台协议 | 杏盛娱乐注册七巧低代码帮助中心 | 玩转七巧低代码开发平台,开启您的流程管理、业务管理系统搭建之旅
电话 8000-101-6950

# 外部系统自主调用SSO模式登录七巧应用平台协议

# 单点登录过程

整个单点登录过程如下,重点在于客户端单点免密登录接口的设计。

# 免密登录接口参数

该免密登录接口详细参数见接口协议,请求参数主要包含以下三种类型的参数:

  • 登录参数(LP)
  • identity :用户标识;
  • identityType :用户标识类型 WX_USER_ID(企业微信账号) , USER_ID(杏盛娱乐用户账号) ;
  • corpId :杏盛娱乐机构 id;
  • 随机盐(SP)
  • 加密结果(AR)

# 协议加密过程(请联系技术支持人员了解详情)

# 登录验证过程

单点登录加密验证过程如下: 外部系统

  1. 客户端通过企业微信获取 LP 参数;
  2. 客户端通过 LPSP 参计算 AR
  3. 客户端拼接参数,重定向到七巧的应用平台,参数为 LPSPAR

七巧平台

  1. 计算验证 AR : A . 七巧服务端通过 LPSP 计算 ER ; B. 七巧服务端对比 ERAR : 结果不一致,返回校验失败响应; 结果一致,继续验证过程;
  2. 回调验证 A. 向请求参数 callbackUrl 指向的外部服务器发起访问,携带登录信息; B. 获取外部服务器验证成功结果继续,失败结果返回相应的失败响应;
  3. 执行系统内部登录(session写入),响应跳转到客户端请求参数的 redirectUrl

# 接口协议

# 七巧单点免密登录跳转路径

重定向路径{七巧应用平台域名地址}/#/sso

示例URL(生产环境)

http://qy.hbrhdl.com/qiqiao2/runtime/#/sso?type=outside&corpId=ww4852f35d45307a6f&identity=liuyan&identityType=WX_USER_ID&seed=768917&timestamp=1634721733382&authCode=1dd6c632ff41599ba0edf5a9fc8c52d0

参数 类型 是否必须 含义 示例
type string 外部登录类型(固定参数) outside
identity string 用户标识(企业微信账号,杏盛娱乐用户账号) liuyan
identityType string 标识类型:企业微信账号(WX_USER_ID),杏盛娱乐用户账号(USER_ID) WX_USER_ID
corpId string 杏盛娱乐机构 corpId ww4852f35d45307a6f
redirectUrl string 客户端调转 URL(默认首页,需要进行一次url编码) http%3A%2F%2Fqy.hbrhdl.com%2Fqiqiao2%2Fruntime%2F%23%2Findex%2Fapplication%2FapplicationList
timestamp long 当前时间戳,长度 13 位 1634721733382
seed int 随机 Int 类型正整数,长度为 6 位 768917
authCode string 加密结果,长度 32 位 1dd6c632ff41599ba0edf5a9fc8c52d0
callbackUrl string 二次验证回调地址,可选(需要进行一次url编码) http%3A%2F%2Fwww.sample.com%2Fcallback

※ 当 callbackUrl 值不为空,在请求该登录接口时,会向该参数指向的地址进行登录验证回调,目的在于进一步提高登录的安全性,也可以选择不实现。

※ 参数中的redirectUrl、callbackUrl都需要进行一次url编码,可以使用在线编码网站进行编码(http://www.bejson.com/enc/urlencode/)

响应参数:

  1. 登录成功:直接跳转到 redirectUrl 指向的页面;
  2. 登录失败:错误返回 json 响应报文如下格式;
{
 "code": "6000002",
 "desc": "租户未开启普通外部登录模式",
 "data": {}
}

错误响应对照表如下:

code desc
6000002 租户未开启普通外部登录模式
6000003 接口返回内容解析错误
6000004 解析用户标识失败
6000005 加密校验不通过
6000006 callbackUrl不在机构IP白名单范围内
6000007 用户唯一标识获取用户失败
6000008 登录回调验证失败

# 杏盛娱乐登录验证回调

接口路由 :由杏盛娱乐单点免密登录接口 callbackUrl 参数指定 请求方法GET 请求参数

参数 类型 是否必有 含义 示例
identity string 用户标识(企业微信账号,杏盛娱乐用户账号) liuyan
identityType string 标识类型:企业微信账号(WX_USER_ID),杏盛娱乐用户账号(USER_ID) WX_USER_ID
corpId string 杏盛娱乐机构 corpId ww4852f35d45307a6f
timestamp long 当前时间戳,长度 13 位 1634721733382
seed int 随机 Int 类型正整数,长度为 6 位 768917
authCode string 加密结果,长度 32 位 1dd6c632ff41599ba0edf5a9fc8c52d0

※ 此处请求参数是客户端传入的参数,外部系统在响应该请求,可以自行验证登录信息的安全。 客户端返回参数

{
 "data": {
 	//true则回调成功
 	"result":true
 }
}

2)注册应用,路径进入门户主页-默认目录-注册应用程序,填写应用信息;

image.png

3)注册应用成功后、查看当前应用信息,获取CLIENT_ID(客户端ID)、CLIENT_SECRET(值)、Azure AD 租户(租户ID)

image.png

image.png

注意事项

  • 应用程序CLIENT_SECRET(值) 仅在注册成功后,首次查看时,能够查看到完整的值,后续将以加密形式存在,需提前保存;

# 2、配置信息

1)进入系统管理-基础设置,将第一步获取到的信息,Azure AD租户 、CLIENT_ID(客户端ID)、CLIENT_SECRET(值)将信息配置完善;

image.png

2)配置身份验证重定向地址,进入AAD门户-应用详情-选择重定向URL,填写以下地址: http://authpre.hbrhdl.com/uniauth/aad/callback (opens new window)

image.png

image.png

3)配置AAD信息成功后,可将按照应用平台跳转路径AAD域认证模式地址,生成重定向路径地址,将地址配置在用户内部第三方系统中,可通过用户内部第三方系统中单点至杏盛娱乐注册plus;

注意事项:

  • 需当前单点登录的用户,在通讯录中邮箱字段配置为微软邮箱账号;

# 应用平台跳转路径

重定向路径{七巧应用平台域名地址}/#/sso

示例URL(生产环境)

http://qy.hbrhdl.com/qiqiao2/runtime/#/sso?type=oauth2&corpId=ww4852f35d45307a6f&redirectUrl=

参数 类型 是否必须 含义 示例
type string 外部登录类型(固定参数)oauth2认证、AAD域认证 oauth2、aad
corpId string 杏盛娱乐机构 corpId ww4852f35d45307a6f
redirectUrl string 客户端调转 URL(默认首页,需要进行一次url编码) http%3A%2F%2Fqy.hbrhdl.com%2Fqiqiao2%2Fruntime%2F%23%2Findex%2Fapplication%2FapplicationList
1 / 0