统一用户管理规范协议文档.doc

项目名称：某某项目xxx信息中心xxxx公司版本信息：1.0.0时间：2010-7-15目 录1规范描述42参考文档43接口约定44统一用户管理接口规范54.1查询所有组织54.2查询根组织54.3查询指定组织下的下级组织64.4查询指定组织下的用户74.5查询指定组织下的下级组织和用户84.6查询用户94.7查询用户直接上级104.8查询用户直接下级用户114.9查询所有无上级组织的用户124.10查询可使用指定应用系统的用户134.11查询指定时间段内的变更集合134.12查询所有全局组154.13查询指定全局组下级组154.14查询指定全局组下的用户164.15查询指定全局组下级组和用户174.16查询指定全局组下用户184.17查询所有职务信息194.18查询指定职务信息205附录215.1xml数据规范215.1.1认证xml数据215.1.2组织xml数据215.1.3用户xml数据235.1.4全局组xml数据265.1.5全局组关联关系xml数据275.1.6职务xml数据285.2操作类型定义（actiontype）295.3状态类型定义（status）305.4组织类型定义（orgtype）305.5全局组关联关系定义（relate）305.6数据属性表315.6.1组织属性315.6.2用户属性325.6.3全局组属性335.6.4全局组关联属性335.6.5职务属性345.7各应用系统编码341 统一用户管理接口规范1.1 查询所有组织1. 接口定义接口名称查询所有组织getallorgs接口描述实现查询所有组织的树形结构接口协议soap主要使用者各应用系统2. 请求参数名称说明数据类型长度（字节）iasid应用系统编码，参见附录“各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19authenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string3. 应答消息名称说明数据类型长度（字节）iasid应用系统编码，参见附录“各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19orglist组织集合，xml表示，属性参见附录result0：认证通过1：失败2:包数据格式不正确int2errordescription对错误/异常的详细描述信息stringauthenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string1.2 查询根组织1. 接口定义接口名称查询根组织getrootorg接口描述实现查询查询根组织接口协议soap主要使用者各应用系统2. 请求参数名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19authenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string3. 应答消息名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19orglist组织result0：认证通过1：失败2:包数据格式不正确int2errordescription对错误/异常的详细描述信息stringauthenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string1.3 查询指定组织下的下级组织1. 接口定义接口名称查询指定组织下的下级组织getorgchild接口描述实现查询指定组织下的组织（树形结构）接口协议soap主要使用者各应用系统2. 请求参数名称说明数据类型长度（字节）iasid应用系统编码，参见附录“各应用系统编码”string3orgid指定组织编号string32timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19authenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string3. 应答消息名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19orglist组织集合，xml表示，组织属性参见附录result0：认证通过1：失败2:包数据格式不正确int2errordescription对错误/异常的详细描述信息stringauthenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string1.4 查询指定组织下的用户1. 接口定义接口名称查询指定组织下的用户getusersbyorgid接口描述实现查询指定组织下的用户接口协议soap主要使用者各应用系统2. 请求参数名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3orgid指定组织编号string32timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19authenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string3. 应答消息名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19user用户集合，xml表示，属性参见附录result0：认证通过1：失败2:包数据格式不正确int2errordescription对错误/异常的详细描述信息stringauthenticator认证码，用于鉴别发送者。取值= base64 (3des(sha1 (iasid+timestamp)+iasid+timestamp),3des采用iassecret加密string1.5 查询指定组织下的下级组织和用户1. 接口定义接口名称查询指定组织下的下级组织和用户getorgsandusersbyorgid接口描述实现查询指定组织下的下级组织和用户接口协议soap主要使用者各应用系统2. 请求参数名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3orgid指定组织编号string32timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19authenticator认证码，用于鉴别发送者。取值= base64 (3des(sha1 (iasid+timestamp)+iasid+timestamp),3des采用iassecret加密string3. 应答消息名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19userlist用户集合，xml表示，属性参见附录orglist组织集合，xml表示，属性参见附录result0：认证通过1：失败2:包数据格式不正确int2errordescription对错误/异常的详细描述信息stringauthenticator(3des(sha1 (iasid+ orgid+timestamp)+iasid+timestamp),3des采用iassecret加密string1.6 查询用户1. 接口定义接口名称查询指定用户属性信息getuserbyaccountname接口描述实现查询指定用户属性信息接口协议soap主要使用者各应用系统2. 请求参数名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3accountname用户帐号名string32timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19authenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string3. 应答消息名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19user用户集合，xml表示，属性参见附录result0：认证通过1：失败2:包数据格式不正确int2errordescription对错误/异常的详细描述信息stringauthenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string1.7 查询用户直接上级1. 接口定义接口名称查询指定用户直接上级信息getleaderbyaccountname接口描述实现查询指定用户直接上级集合接口协议soap主要使用者各应用系统2. 请求参数名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3accountname用户帐号名string32timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19authenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string3. 应答消息名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19user直接上级用户集合，xml表示，属性参见附录result0：认证通过1：失败2:包数据格式不正确int2errordescription对错误/异常的详细描述信息stringauthenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string1.8 查询用户直接下级用户1. 接口定义接口名称查询指定用户直接下级信息getchildbyaccountname接口描述实现查询指定用户直接下级集合接口协议soap主要使用者各应用系统2. 请求参数名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3accountname用户帐号名string20timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19authenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string3. 应答消息名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19userlist直接上级用户集合，xml表示，属性参见附录result0：认证通过1：失败2:包数据格式不正确int2errordescription对错误/异常的详细描述信息stringauthenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string1.9 查询所有无上级组织的用户1. 接口定义接口名称查询所有无上级组织的用户getusernoneroot接口描述实现查询所有无上级组织的用户接口协议soap主要使用者各应用系统2. 请求参数名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19authenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string3. 应答消息名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19userlist用户集合，xml表示，属性参见附录result0：认证通过1：失败2:包数据格式不正确int2errordescription对错误/异常的详细描述信息stringauthenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string1.10 查询可使用指定应用系统的用户1. 接口定义接口名称查询可使用指定应用系统的用户getusersbyiasid接口描述实现查询可使用指定应用系统的用户接口协议soap主要使用者各应用系统2. 请求参数名称说明数据类型长度（字节）iasid应用系统编码，参见附录“各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19authenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string3. 应答消息名称说明数据类型长度（字节）iasid应用系统编码，参见附录“各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19users用户集合，xml表示，属性参见附录result0：认证通过1：失败2:包数据格式不正确int2errordescription对错误/异常的详细描述信息stringauthenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string1.11 查询指定时间段内的变更集合1. 接口定义接口名称查询指定时间段内的变更集合getmodifyrecords接口描述实现查询指定时间段内的变更集合，时间段=30天接口协议soap主要使用者各应用系统2. 请求参数名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3starttime开始时间，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19endtime结束时间，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19logid日志id，每次取大于该值的记录longtimestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19authenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string3. 应答消息名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19modifyrecords变更集合记录result0：认证通过1：失败2:包数据格式不正确int2errordescription对错误/异常的详细描述信息stringauthenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)stringmodifyrecords变更集合记录定义如下：名称说明数据类型长度（字节）actiontype变更操作, 参见附录“操作类型定义”string2modifyrecords变更内容，包括organization、user、group对象。1.12 查询所有全局组1. 接口定义接口名称查询所有全局组getallgroups接口描述实现查询查询所有全局组接口协议soap主要使用者各应用系统2. 请求参数名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19authenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string3. 应答消息名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19grouplist全局组集合，xml表示，属性参见附录result0：认证通过1：失败2:包数据格式不正确int2errordescription对错误/异常的详细描述信息stringauthenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string1.13 查询指定全局组下级组1. 接口定义接口名称查询指定全局组信息getgroupchildbygroupid接口描述实现查询指定全局组信息接口协议soap主要使用者各应用系统2. 请求参数名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3groupid组idstring32timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19authenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string3. 应答消息名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19grouplist组集合result0：认证通过1：失败2:包数据格式不正确int2errordescription对错误/异常的详细描述信息stringauthenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string1.14 查询指定全局组下的用户1. 接口定义接口名称查询指定全局组信息getusersbygroupid接口描述实现查询指定全局组信息接口协议soap主要使用者各应用系统2. 请求参数名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3groupid组idstring32timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19authenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string3. 应答消息名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19userlist组用户集合result0：认证通过1：失败2:包数据格式不正确int4errordescription对错误/异常的详细描述信息stringauthenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string1.15 查询指定全局组下级组和用户1. 接口定义接口名称查询指定全局组信息getgroupsandusersbygroupid接口描述实现查询指定全局组信息接口协议soap主要使用者各应用系统2. 请求参数名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3groupid组idstring32timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19authenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string3. 应答消息名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19userlist组用户集合grouplist组集合result0：认证通过1：失败2:包数据格式不正确int2errordescription对错误/异常的详细描述信息stringauthenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string1.16 查询指定全局组下用户4. 接口定义接口名称查询指定全局组信息getgroupuserbygroupid接口描述实现查询指定全局组下用户接口协议soap主要使用者各应用系统5. 请求参数名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3groupid组名称string32timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19authenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string6. 应答消息名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19userlist组用户集合result0：认证通过1：失败2:包数据格式不正确int4errordescription对错误/异常的详细描述信息stringauthenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string1.17 查询所有职务信息1. 接口定义接口名称查询所有职务信息getallduty接口描述查询统一用户管理维护的所有职务信息接口协议soap主要使用者各应用系统2. 请求参数名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19authenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string3. 应答消息名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19dutylist职务集合，xml表示，属性参见附录result0：认证通过1：失败2:包数据格式不正确int2errordescription对错误/异常的详细描述信息stringauthenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string1.18 查询指定职务信息1. 接口定义接口名称查询指定职务信息getdutybyid接口描述查询指定职务信息接口协议soap主要使用者各应用系统2. 请求参数名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19dutyid职务idstring32authenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string3. 应答消息名称说明数据类型长度（字节）iasid应用系统编码，参见附录”各应用系统编码”string3timestamp当前时间戳，yyyy-mm-dd hh:mm:ss，其中hh取值为00-23,时区为东八区string19duty职务集合，xml表示，属性参见附录result0：认证通过1：失败2:包数据格式不正确int2errordescription对错误/异常的详细描述信息stringauthenticator认证码，用于鉴别发送者。取值= base64 (3des(iasid+timestamp)+iasid+timestamp)string2 附录2.1 xml数据规范xml中数据用格式表示，以保证对特殊字符的正确处理； 某节点值为空时(该节点允许为空时)，可不填该节点。2.1.1 认证xml数据返回节点xml实例描述认证0002010-07-19 15:25:000g2/ub6ifg7glseibjhjvhyr6uwghimxhpfvow8nt54odwd6dggsluka+wcg/nbjge5igqeg5o1g6oyaytwrriw=认证返回2.1.2 组织xml数据操作类型xml实例描述addaddorg123456789信息中心信息xxzx2org987654321202010-07-20 11:19:03user1234567892010-07-20 11:19:031.0新增组织deldelorg123456789删除组织modmodorg123456789信息中心信息xxzx2org987654321202010-07-20 11:19:03user1234567892010-07-20 11:19:031.0org123456789信息中心2信息