修订历史记录目录1.目的 (5)2.SSO API接口 (6)2.1.组织管理........................................................................................错误!未定义书签。
2.1.1.组织增加修改....................................................................错误!未定义书签。
2.1.2.组织删除............................................................................错误!未定义书签。
2.1.3.根据组织编码获取组织详细信息....................................错误!未定义书签。
2.1.4.根据组织编码获取下级组织列表....................................错误!未定义书签。
2.2.用户管理 (6)2.2.1.用户增加修改 (6)2.2.2.用户删除............................................................................错误!未定义书签。
2.2.3.根据SSO用户登录名获取用户详细信息........................错误!未定义书签。
2.2.4.根据组织编码获取用户列表............................................错误!未定义书签。
2.2.5.根据映射系统用户名获取SSO的绑定用户....................错误!未定义书签。
2.2.6.根据SSO用户获取映射系统的用户................................错误!未定义书签。
2.2.7.获取用户角色....................................................................错误!未定义书签。
2.3.认证和单点登录标准接口(commnetAuth) (12)2.3.1.票据认证 (12)2.3.2.根据授权码获取令牌 (14)2.3.3.更新接入资源令牌 (15)2.3.4.根据代理令牌获取第三方接入资源票据 (17)2.3.5.根据访问令牌获取票据 (19)2.3.6.用户认证 (20)2.3.7.根据访问令牌获取用户详细信息 (22)2.3.8.获取用户角色....................................................................错误!未定义书签。
2.3.9.CA认证(待定) ..............................................................错误!未定义书签。
2.3.10.用户可访问系统列表 (42)2.3.11.统一登录入口 (37)2.3.12.统一登出 (38)2.3.13.修改密码 (40)2.3.14.修改个人信息 (40)2.4.认证和单点登录简化接口(easyAuth) (26)2.4.1.票据认证 (26)2.4.2.根据令牌获取第三方接入资源票据 (28)2.4.3.用户认证 (30)2.4.4.根据令牌获取用户详细信息 (32)2.4.5.获取用户角色 (34)3.接入资源接口规范 (44)3.1.组织接口........................................................................................错误!未定义书签。
3.1.1.组织增加修改....................................................................错误!未定义书签。
3.1.2.组织删除............................................................................错误!未定义书签。
3.2.用户接口 (44)3.2.1.用户增加修改 (44)3.2.2.用户删除 (48)3.2.3.用户角色同步....................................................................错误!未定义书签。
3.3.角色接口........................................................................................错误!未定义书签。
3.3.1.角色增加修改....................................................................错误!未定义书签。
3.3.2.角色删除............................................................................错误!未定义书签。
3.4.职务接口........................................................................................错误!未定义书签。
3.4.1.职务增加修改....................................................................错误!未定义书签。
3.4.2.职务删除............................................................................错误!未定义书签。
4.接入资源认证 (50)4.1.1.统一验证方式 (50)4.1.2.http附加参数 (51)1.目的本规范详细定义了SSO对外提供接口规范和调用方法。
约定⏹方法名区分大小写,参数名均是小写。
⏹SSO系统同时支持两种数据格式xml和json。
接入资源只要实现一种格式即可⏹WebService接口返回值(还有args参数)json或者xml格式传输:1.XML返回格式如下:对象格式:<?xml version=“1.0” encoding=“UTF-8”?><SSO><loginname>zhangs</loginname><username>张三</username></SSO>列表格式:<?xml version=“1.0” encoding=“UTF-8”?><SSO><total>2</total><user loginname=“zhangs” username=“张三”></user><user loginname=“lisi” username=“李四”></user></SSO>2.JSON返回格式如下:对象格式{“loginname”:”zhangs” }列表格式{“total”:2,”user”:[{“loginname”:”zhangs”,”username”:”张三”},{“loginname”:”lisi”,”username”:”李四” }]}⏹接口类型:本文档支持webservice、http、js三种接口类型。
一个接口可能同时支持一种或者多种类型。
⏹注:接入资源的接口方式为http方式时,需要设置编码方式。
HTTP contentType 设置成text/xml 如:response.setContentType(“text/xml;charset=utf-8”);⏹如果采用http方式,请增加参数method,值为方法名字。
⏹后缀域名相同的组织所拥有的用户名必须唯一。
⏹用户只能在后缀域名相同的组织之间进行调换。
⏹组织以orgcoding为唯一主键。
⏹认证参数:servicecode 与 servicepwd 由SSO管理员在SSO注册接入资源之后,提供给接入资源。
2.SSO API接口2.1.用户管理2.1.1.用户增加修改2.1.1.1.接口说明该接口是实现接入资源用户信息到SSO同步的接口规范。
由SSO提供接口,接入资源(webservice客户端)调用SSO(webservice服务端)接口主动将用户信息推给SSO。
2.1.1.2.接口类型webservice/http2.1.1.3.接口方法synchronizeUser2.1.1.4.输入参数Webservice 参数列表:2.1.1.5.返回参数2.1.2.根据SSO用户id获取用户详细信息2.1.2.1.接口说明该接口是实现接入资源到SSO获取用户相关详细信息。
只能获取接入资源中的用户信息。
2.1.2.2.接口类型webservice/http2.1.2.3.接口方法getUserInfoById2.1.2.4.输入参数Webservice 参数列表:2.1.2.5.返回参数2.2.认证和单点登录标准接口(commnetAuth)2.3认证和单点登录标准接口的调用地址。
其中未对功能指定地址的默认使用以下地址Webservice地址:http://[ip]:[port]/[sso4]/service/SsoAuthService?wsdlhttp地址:http://[ip]:[port]/[sso4]/servlet/ssoauth2.2.1.票据认证2.2.1.1.接口说明该接口是实现接入资源验证临时票据的有效性。
如果有效,将返回绑定该票据的用户信息2.2.1.2.接口类型webservice/http2.2.1.3.接口方法ticketValidation2.2.1.4.输入参数Webservice 参数列表:2.2.1.5.返回参数2.2.2.根据授权码获取令牌2.2.2.1.接口说明该接口是实现接入资源使用授权码获取接入资源令牌、刷新令牌、代理令牌等票据信息。
代理令牌必须接入拥有代理权才返回2.2.2.2.接口类型webservice/http2.2.2.3.接口方法getToken2.2.2.4.输入参数Webservice 参数列表:2.2.2.5.返回参数2.2.3.更新接入资源令牌2.2.3.1.接口说明该接口是实现接入资源使用刷新令牌,更新将要过期的接入资源令牌,获取最新的接入资源令牌。