浙江政务服务网SSO接口规范.doc

1、项目编号: usp4.12卷 号 usp4.12卷内编号密 级SSO 接口规范本文档使用部门：主管领导 项目组 客户（市场） 维护人员 用户修订历史记录日期 版本 AMD 修订内容简述 修订人 备注2012-3-17 4.2 A 周旭光注：A-添加，M-修改，D-删除目录1. 目的 .52. SSO API 接口 .62.1. 组织管理 .62.1.1. 组织增加修改 .62.1.2. 组织删除 .92.1.3. 根据组织编码获取组织详细信息 .112.1.4. 根据组织编码获取下级组织列表 .132.2. 用户管理 .152.2.1. 用户增加修改 .162.2.2. 用户删除 .192.2

2、.3. 根据 SSO 用户登录名获取用户详细信息 .212.2.4. 根据组织编码获取用户列表 .242.2.5. 根据映射系统用户名获取 SSO 的绑定用户 .272.2.6. 根据 SSO 用户获取映射系统的用户 .282.2.7. 获取用户角色 .302.3. 认证和单点登录标准接口(commnetAuth) .322.3.1. 票据认证 .322.3.2. 根据授权码获取令牌 .342.3.3. 更新接入资源令牌 .352.3.4. 根据代理令牌获取第三方接入资源票据 .372.3.5. 根据访问令牌获取票据 .392.3.6. 用户认证 .402.3.7. 根据访问令牌获取用户详细信

3、息 .422.3.8. 获取用户角色 .442.3.9. CA 认证（待定） .462.3.10. 用户可访问系统列表 .462.3.11. 统一登录入口 .472.3.12. 统一登出 .472.3.13. 修改密码 .482.3.14. 修改个人信息 .492.4. 认证和单点登录简化接口(easyAuth) .502.4.1. 票据认证 .502.4.2. 根据令牌获取第三方接入资源票据 .522.4.3. 用户认证 .532.4.4. 根据令牌获取用户详细信息 .552.4.5. 获取用户角色 .583. 接入资源接口规范 .593.1. 组织接口 .593.1.1. 组织增加修改 .

4、593.1.2. 组织删除 .623.2. 用户接口 .643.2.1. 用户增加修改 .643.2.2. 用户删除 .673.2.3. 用户角色同步 .693.3. 角色接口 .713.3.1. 角色增加修改 .713.3.2. 角色删除 .723.4. 职务接口 .743.4.1. 职务增加修改 .743.4.2. 职务删除 .754. 接入资源认证 .774.1.1. 统一验证方式 .774.1.2. http 附加参数 .781. 目的本规范详细定义了 SSO 对外提供接口规范和调用方法。约定 方法名区分大小写，参数名均是小写。 SSO 系统同时支持两种数据格式 xml 和 json。

5、接入资源只要实现一种格式即可 WebService 接口返回值（还有 args 参数）json 或者 xml 格式传输：1. XML 返回格式如下：对象格式：zhangs张三列表格式：22. JSON 返回格式如下：对象格式“loginname”:”zhangs” 列表格式“total”:2,”user”:“loginname”:”zhangs”,”username”:”张三”,“loginname”:”lisi”,” username”:”李四” 接口类型： 本文档支持 webservice、http、js 三种接口类型。一个接口可能同时支持一种或者多种类型。 注：接入资源的接口方式为 ht

6、tp 方式时，需要设置编码方式。 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.

7、1.1. 接口说明该接口是实现接入资源用户信息到 SSO 同步的接口规范。 由 SSO 提供接口，接入资源(webservice 客户端)调用 SSO（webservice 服务端）接口主动将用户信息推给SSO。2.1.1.2. 接口类型webservice/http2.1.1.3. 接口方法synchronizeUser2.1.1.4. 输入参数Webservice 参数列表:Args 参数由如下：名称 说明 是否必填 数据类型 长度username 用户的真实姓名(新增时，不能为空) 否 String 255loginname 登录名 是 String 255encryptiontype密

8、码加密类型 值为：1. 表示明文2. 表示 Base64(UTF-8 字符集操作)3 .MD5 （标准 32 位小写）否 String 1名称 说明 是否必填 数据类型 长度（字节）servicecode 接入资源在 SSO 注册成功后的业务代码，由【SSO 管理员】提供。 是 String 无限制time 时间戳，当前时间年月日时分秒例：2009 年 10 月 10 日 12 时 12 分 12 秒格式为 20091010121212是 String 14sign MD5(servicecode+servicepwd+time)，将业务代码、业务密钥、发送时间按顺序连接并进行 md5 加密。

9、注：1、参数servicepwd 由 【SSO 管理员】提供；2、MD5 算法是标准算法，可使用 java 内部实现；3、MD5 后的值为 32 位并且小写。是 String 32args参数集合。 由 json 或者 xml 格式组成。 该参数是动态参数，每次传递的将是必填参数和修改的参数。 如修改了组织名， 则只传递组织名和必填参数。（对象格式）是 String 无限制datatype 数据格式 0 xml 1 json 是 String 10describe 修改说明 否 String 2554 .AES （sun 自带库加密，密钥【servicepwd 】为 SSO 提供）5. 3DE

10、S （sun 自带库加密，密钥【servicepwd 】为 SSO 提供）loginpwd 密码（编辑统一用户时为空默认为原密码） 否 String 255email 邮件 否 String 255mobile 手机号码（常用手机） 否 String 11mobile2 手机号码 2（备用手机） 否 String 11telephone 座机号码（常用电话） 否 String 11telephone2 座机号码 2（备用电话） 否 String 11virtualnum 虚拟网号 否 String 11postcode 邮编 否 String 255cakey CA 证书 KEY 否 Stri

11、ng 255sex性别 1 男 2 女默认为 1 否String 1birthday 生日 否 String 255country 国籍 否 String 255province 省籍 否 String 255city 城市 否 String 255officeaddress 办公地址 否 String 255officenum 办公室号 否 String 11officephone 办公电话 否 String 255officefax 办公传真 否 String 255homephone 家庭电话 否 String 255homeaddress 家庭地址 否 String 255idtype

12、证件类型证件类型1 身份证 2.护照 3.军官证 4.士兵证 5.户口簿 默认为 1.身份证否 String 1idnum 证件号码 否 String 18useable用户激活状态 1 激活，2 未激活默认为：1 激活 否String 1orderby 排序 否 String 无符号 Integer 整型headpicture头像地址：http:/sso4/ headpicture 注意：该地址为外网能访问的地址否 String 2552.1.1.5. 返回参数名称 说明 数据类型 长度（字节）result结果：0： 同步成功（等待管理员审核） （针对接入系统设置审核）2001：接入资源未被

13、允许同步2002：接入资源不是统一用户体系2003：接入资源无权操作该用户2004：登录名非法(正则表达是配置 )2005：用户所在组织(部门)不存在2006：排序号为非数字2007: loginpwd 参数不能为空2008: orgcoding 不规范2009：用户被锁定，信息不能修改。2010：已经存在相同登录名2011：用户调动组织，用户不存在。2012： args 参数非法2013：用户类型错误2014：不支持的密码加密类型2015：密码解密出错2016：用户调整组织发生错误2017： username 参数不能为空String2018：常用电话已经存在2019：常用电话不能为空209

14、9：其他错误errmsg 错误说明 String2.1.2. 根据 SSO 用户 id 获取用户详细信息2.1.2.1. 接口说明该接口是实现接入资源到 SSO 获取用户相关详细信息。只能获取接入资源中的用户信息。2.1.2.2. 接口类型webservice/http2.1.2.3. 接口方法getUserInfoById2.1.2.4. 输入参数Webservice 参数列表:名称 说明 是否必填 数据类型 长度（字节）servicecode 接入资源在 SSO 注册成功后的业务代码，由【SSO 管理员】提供。 是 String 无限制time 时间戳，当前时间年月日时分秒例：2009 年 10 月 10 日 12 时 12 分 12 秒格式为 20091010121212是 String 14