Q GDW 11417-2019 统一权限平台接口规范.pdf

1、ICS 2 9 . 2 4 0 Q /G DW国 家 电 网 有 限 公 司 企 业 标 准Q /G D W 1 1 4 1 7 2 0 1 9 替 Q/GDW 11417 2015统 一 权限 平 台接口 规 范 I n te r f a c e s p e c if ic a tio n f o r id e n tity s e c u r ity c o n tr o l p la tf o r m 2 0 2 0 - 0 9 - 2 8 发 布 2 0 2 0 - 0 9 - 2 8 实 施国 家 电 网 有 限 公 司 发 布 天喜 2020-10-10 国网江苏省电力有限公司 设

2、备管理部 谢天喜 2020-10-10 国网江苏省电力有限公司 设备管理部 谢天喜 2020-10-10 国网江苏省电力有限公司 设备管理部 谢天喜 2020-10-10 江苏省电力有限公司 设备管理部 谢天喜 2020-10-10 国网江苏省电力有限公司 设备管理部 谢天喜 2020-10-10 国网江苏省电力有限公司 设备管理部 谢天喜 2020-10-10 国网江苏省电力有限公司 设备管理部 谢天喜 2020-10-10 -10 国网江苏省电力有限公司 设备管理部 谢天喜 2020-10-10 国网江苏省电力有限公司 设备管理部 谢天喜 2020-10-10 国网江苏省电力有限公司 设备

3、管理部 谢天喜 2020-10-10 国网江苏省电力有限公司 设备管理部 谢天喜 2020-10-10 有限公司 设备管理部 谢天喜 2020-10-10 国网江苏省电力有限公司 设备管理部 谢天喜 2020-10-10 国网江苏省电力有限公司 设备管理部 谢天喜 2020-10-10 国网江苏省电力有限公司 设备管理部 谢天喜 2020-10-10 设备管理部 谢天喜 2020-10-10 国网江苏省电力有限公司 设备管理部 谢天喜 2020-10-10 国网江苏省电力有限公司 设备管理部 谢天喜 2020-10-10 国网江苏省电力有限公司 设备管理部 谢天喜 2020-10-10 Q /

4、 G D W 1 1 4 1 7 2 0 1 9 I 目 次 .11 .22 .23 .24 缩 .45 .46 一 .47 一 . 6 8 一 .16 A（ ） 一 .20 B（ ） 一 .26 C（ ） 一 .45 .46 Q / G D W 1 1 4 1 7 2 0 1 9 II 前 言 （ ） 一 ， 寿 帐 ， 、 、 一 ， 。 替 Q/GDW 11417 2015 一 ， Q/GDW 11417 2015 , ： SDK ； 微 ； 微 鉴 ； ； ； ； ； 一 。 释 。 归 。 ： 徽 、 、 、 ： 畅 、 、 、 圆 、 蔡 梦 臣、 旭 、 卓 、 斌 、 萍 、

5、、曹弯 弯 、 秋 、 跃 、 、 宫 帅 、 梅 、 郭 、 郭 骏 、 姚 振 、 靖 、 秦 娟 、 、 熊 盼 旗 ，薛 轩 、 锋 、 琰 。 2015 ， 2019 11 一 。 馈 。 Q / G D W 1 1 4 1 7 2 0 1 9 1 统 一 权 限 平 台 接 口 规 范1 范围 一 一 、 一 一 。 一 、 微 微 。2 规 范 性 引 用 文 件 。凡 ， 。凡 ， （ ） 。 GB/T 29798 Web IT Q/GDW 1594 Q/GDW 1597 3 术 语 和 定 义 。3 . 1 统 一 权 限 平 台 i d e n t i t y s e c

6、u r i t y c o n t r o l p l a t f o r m （ I S C - P l a t f o r m ） 一 ， 、 、 、 一 。 3 . 2 代表 性 状 态 传 输 r e p r e s e n t a t i o n a l s t a t e t r a n s f e r （ R E S T ）一 ， 描 迁 一 操 。3 . 3 浏 览 器 / 服 务 器 架 构 b r o w s e r / s e r v e r a r c h i t e c t u r e ( B / S 架构 )一 架 ， 逻 辑 端 ， 浏 览 。3 . 4 客 户

7、端 / 服 务 器 架 构 c l i e n t / s e r v e r a r c h i t e c t u r e （ C / S 架构 ）一 架 ， 逻 辑 端 ， 端 。 3 . 5 Q / G D W 1 1 4 1 7 2 0 1 9 2 单点 登 录 s i n g l e s i g n o n ( S S O ） 一 。3 . 6 统一 认证 服务 u n i f i e d a u t h e n t i c a t i o n s e r v i c e （U A S ） 一 ， ， 一 。 一 一 。3 . 7 服 务 票 据 s e r v i c e t i

8、 c k e t ( S T ) 。 ， 允 ， 禁 。 3 . 8 认 证 凭 证 缓 存 t i c k e t - g r a n t i n g c o o k i e ( T G C ) 浏 览 （ HTTPS） 缓 凭 ， 凭 。3 . 9 登 录 票 据 t i c k e t g r a n t i n g t i c k e t （ T G T ） 一 一 。 ， 。3 . 1 0 基 于 角 色 访 问 控 制 r o l e - b a s e d a c c e s s c o n t r o l （ R B A C ） “ ” 概 ， “ - - ” 射 ， 灵 。

9、， ， ， 逻 辑 。3 . 1 1 业 务 应 用 b u s i n e s s a p p l i c a t i o n ， 涵 盖 、 、 、 、 、 ， 、 微 。3 . 1 2 单 体 应 用 m o n o l i t h i c a p p l i c a t i o n一 归 档 （ jar、 war、 ear 归 档 ） 含 。 3 . 1 3 微应 用 m i c r o a p p l i c a t i o n 一 微 ， 一 耦 一 逻辑 ， 端 ， 。 Q / G D W 1 1 4 1 7 2 0 1 9 3 3 . 1 4 微 服 务 m i c r o s

10、 e r v i c e ， 署 、 ， 撑 一 逻 辑 ， 跨 逻 辑 。4 缩略 语 缩 。CSV： 符 隔 (Comma-Separated Values)HTTPS： （ Hyper Text Transfer Protocol over Secure Socket Layer）JDBC： Java (Java Data Base Connectivity)JSON： （ JavaScript Object Notation） SDK： （ Software Development Kit）SFTP： （ Secure File Transfer Protocol）SOAP： （ Si

11、mple Object Access Protocol）WSDL： Web 描 Web Service Description Language）5 总 则5 . 1 总 体 内 容 一 （ 、微 ） 一 、 一 一 ， 鉴 、 、 ， 撑 一 。5 . 2 统 一 认 证 接 口 一 一 ， Filter（ 滤 ） 、REST SDK 。 B/S架 Filter（ 滤 ） ， C/S架 REST ， SDK 脸 、 纹 。5 . 3 统 一 身 份 权 限 接 口 一 、 鉴 ， 、 、微 微 鉴 。 一 ； ；微 微 ；微 鉴 微 微 鉴 。5 . 4 统 一 审 计 接 口 一 一 操

12、， Syslog 、SFTP ， 。6 统 一 认 证 接 口6 . 1 F i l t e r 认 证 接 口 Q / G D W 1 1 4 1 7 2 0 1 9 4 6 . 1 . 1 接口 描述Filter B/S架 一 。6 . 1 . 2 应用 场景 图 1 F i l t e r 认 证 接 口 应 用 场 景Filter 1， ：a) 浏 览 （ Service URL） ；b) （ 一 拦 截 、 跳 ） 浏 览 ，若 含 ST， 跳 骤 e), 一 ， 凭 ；c) 凭 ， 一 ；d) 一 凭 ， 若 ， 一 ST， 一 TGC 浏 览 ， ， 跳 骤 c)；e) ST ，

13、 ST 一 ；f) 一 ST ， 若 ， 含 ST JSON 返 ， 跳 骤 c)； 6 . 1 . 3 应 用 要 求6 . 1 . 3 . 1 一 册 。6 . 1 . 3 . 2 web 滤 ， 一 ， 拦截 ， 端 ， 逻 辑 A.1。6 . 1 . 3 . 3 浏 览 Cookie 。6 . 2 R E S T 认 证 接 口 Q / G D W 1 1 4 1 7 2 0 1 9 5 6 . 2 . 1 接口 描述REST C/S架 一 ， HTTPS REST ， Q/GDW 1594， REST 1。表 1 R E S T 认证 接口 清单 1 getTicket 帐 ， 返

14、。2 getServerTicket TGT (ST)， C/S 3 tgtValidate ID 4 getTgtByUserId ， ID 5 Logout 6 . 2 . 2 应 用 场 景 C/S架 REST 凭 一 ， 一 凭 ， 返 ， 2。 图 2 R E S T 认 证 接 口 应用 场 景6 . 2 . 3 应 用 要 求6 . 2 . 3 . 1 一 册 。6 . 2 . 3 . 2 端 post , 逻 辑 A.2。6 . 2 . 3 . 3 端 。6 . 3 S D K 认 证 接 口6 . 3 . 1 接 口 描述 Q / G D W 1 1 4 1 7 2 0 1

15、9 6 SDK （ 脸 、 纹 ） ， 一 ， HTTPS REST ， Q/GDW 1594。 SDK 2。表 2 S D K 认证 认证 接口 清 单 1 authUser ， 。2 logout ， 。6 . 3 . 2 应用 场 景 SDK ， 一 纹 、 脸 ， 返 ， 3。 图 3 S D K 认 证 应 用 场 景6 . 3 . 3 应用 要 求6 . 3 . 3 . 1 一 册 。6 . 3 . 3 . 2 端 一 ISC_SSO_SDK， 一 端 （ 脸 、 纹 ） ， 逻 辑 A.3。7 统 一 身 份 权 限 接 口7 . 1 单 体 应用 数 据 同 步 接 口7 .

16、1 . 1 接 口 描述 ， 储 ， 一 ， 。 遵 SOAP ， GB/T 29798。 一 。 3。 Q / G D W 1 1 4 1 7 2 0 1 9 7 表 3 单体 应 用 数 据 同 步 接口 清单 1 syncUser 2 syncBizOrganization 3 syncBizRoleGroup 4 syncBizRole 5 syncBizOrgRole 6 syncResource 7 syncFunction 8 syncBizRoleOfUser 9 syncBizOrgRoleOfUser 10 syncFunctionOfBizRole 11 syncResO

17、fBizRole 12 syncFunctionOfOrgRole 13 syncResOfOrgRole 7 . 1 . 2 应 用 场 景 一 。 一 端 署 ， 返 。 4。 图 4 单 体 应用 数 据 同 步 接 口 应用 场 景7 . 1 . 3 应用 要 求7 . 1 . 3 . 1 符 RBAC 。7 . 1 . 3 . 2 一 册 。7 . 1 . 3 . 3 一 。7 . 1 . 3 . 4 一 WSDL ， B.1。 Q / G D W 1 1 4 1 7 2 0 1 9 8 7 . 1 . 3 . 5 宜 操 ， ， 。7 . 1 . 3 . 6 100ms/ ， 20

18、0ms/ 。7 . 2 单体 应 用 数据 服 务 接口7 . 2 . 1 接口 描述 ， 储 ， 一 。 REST ， 4。 表 4 单 体 应用 数 据 服务 接 口 清 单 描 1 getSubDepartment ID、 一 （ / / ）2 getDepartmentById ID （ ）3 getRelationDepartmentByOrgId ID （ ）4 getQuoteDepartmentByOrgId ID （ 一 ） 5 getQuoteDepartmentsByConditionAndOrderBy 6 getUserByIds ID 7 getUsersByNam

19、e ( 糊 匹 )8 getUsersByLoginCode （ 唯 一 ）9 getUsersByOrg ID 滤 10 getUsersByOrgRole 滤 11 getUserOrgPathByUserId ID 径12 getUsers ID 滤 Q / G D W 1 1 4 1 7 2 0 1 9 9 表 4 （续 ） 描 13 userLoginAuth 14 userLoginAuth ID 15 getUsersByOrg ID 滤 16 getUsersByConditionAndOrderBy 17 getUsersByOrg ID 18 getRoleGroupByR

20、ole ID 19 getRoleGroup ID 20 getRoleByRoleId ID 。21 getRolesByRoleName 22 getRolesByRoleGroupID ID 。23 getOrgRolesByIds ID 。24 getOrgRolesByName 。25 getOrgRolesByUserId ID ， 一 。 26 getOrgRolesByBusiOrgId ID 。27 getOrgRolesByRoleId ID 。28 getOrgRolePathByOrgRoleId ID 径 。29 getOrgRoles ID 30 getOrgRol

21、esByOrgId （ ） 。31 getOrgRolesByResIdAndUserId ID 。 32 hasFuncNodePerm ID， ID ， 返 true ， 返 false 33 getPermissionObjectsByfuncId ID 含 34 hasPermitUserFuncId 鉴 35 hasPermitUserFuncCode ID、 鉴 Q / G D W 1 1 4 1 7 2 0 1 9 10 表 4 （ 续 ） 描 36 getFuncTree 递归 37 getFuncTreeByFuncId 递归 38 getFuncsByFuncCode 39

22、 getFuncsByOrgRoleId 40 getFuncsByRoleId 41 getFuncsByFuncName 匹 42 getFuncs ID 43 getSubFuncsByFuncId 44 getFuncsBySystemIDAndURL 链 45 hasPermitURLObj 46 getFuncsByIds 47 getUserPermitFuncs 48 getFuncsByParentId 49 getDeployUrlByFuncId ID 署 址 (URL)50 getFirstLayerFuncs 一 51 getSubFuncs 一 52 hasUrlB

23、yBusiId URL 册 53 getFuncsByParentId 54 getFuncsPath 径55 getFuncTreeByRoleId ID 56 addFunc 册 57 addFuncs 册 58 delFuncByFuncId ID 删 59 delFuncByFuncCode 删 60 getPermObjectsByPerCodes 61 getFuncsObjByOrgRoleId 62 getUserPermitionFuncs ID、 ID、 63 getFuncContextByParentId ID ID 一 一 Q / G D W 1 1 4 1 7 2

24、0 1 9 11 表 4 （ 续 ） 描 64 getPermissionObjectsByPerObjId ID 65 getPermissionObjectsByPerObjName 66 getPermissionObjects 67 hasPermitUserPerObject 鉴 68 getPermissionsBySysIdAndRoleIdAndFuncId ID、 ID ID 69 getBusiOrgsByIds 70 getBusiOrgsByOrgName 71 getSuperCorrespondOrg ID 72 getChildOrgsBySystemId 一 7

25、3 getMatchedOrgsByOrgName ( 匹 ) 匹 （ 500 ） 74 getChildBusiOrgsById 一 75 getAllBusiOrgsById 递 归 （ 500 ）76 getOrgPathByOrgId 返 径 77 getBussOrgs ID 78 getSubBussOrgs 79 getOrgsPathByOrgName 径 80 getUpperOrgBySystemIdAndUserId ID 81 getOrgByUnifiedCode “ 一 ” 82 getDimensionality ID 83 getOrgProperty ID Q

26、 / G D W 1 1 4 1 7 2 0 1 9 12 表 4 （ 续 ） 描 84 getOrgProperty ID 85 getOrgExtenProperty ID 86 getOrgExtenProperty ID 87 getBusinessApplication 88 getBusinessApplication 89 getBusiAppByUserId ID 90 getBusiAppByUserIdAndRoleCode 、 ID 91 callService 92 getPermissionInfoByUserId ID 93 getUsersByRoleGroupI

27、d ID ID 94 getUsersByRoleGroupId ID ID 95 getUsersByOrgId ID ID 96 getDefUsersByorgId ID 97 getObjectsByUserId ID 98 getBusiOrgsByUserId ID， 99 getOrgRolesByResIdAndUserId ID ID, 7 . 2 . 2 应用 场 景 一 。 ， （ B.2） ， 返 逻 辑 ， 5。 Q / G D W 1 1 4 1 7 2 0 1 9 13 图 5 单 体 应 用 数 据 服务 接 口 应 用 场 景7 . 2 . 3 应 用 要 求

28、7 . 2 . 3 . 1 符 RBAC 。7 . 2 . 3 . 2 一 册 。7 . 2 . 3 . 3 一 端 。7 . 3 微 应 用 数 据 服 务 接 口7 . 3 . 1 接 口 描述微 ， 储 ， 微 一 。微 REST 微 ， 5。 表 5 微应 用 数 据 服 务 接 口 清 单 描 1 /domain/auth 秘 钥 app_token， 微 header 添 appId app_token2 /domainOrg/list/app_id/count/cursor 微 ID 。3 /domainOrg/id ID 。 4 /userDomainOrg/user_id/count/cursor 5 /domainOrg/users/id/count/cursor