From: 刘洪青 <hongqing.liu@supwisdom.com>
Date: Thu, 25 Nov 2021 02:05:24 +0000 (+0800)
Subject: docs: 完善文档
X-Git-Url: https://source.supwisdom.com/gerrit/gitweb?a=commitdiff_plain;h=f14a19f079258c880eb35457df312caf974dd002;p=institute%2Fdeploy-authx-service.git

docs: 完善文档
---

diff --git "a/docs/\345\237\272\344\272\216RabbitMQ\347\232\204\346\225\260\346\215\256\346\216\250\351\200\201\351\230\237\345\210\227\344\275\277\347\224\250\350\257\264\346\230\216.md" "b/docs/\345\237\272\344\272\216RabbitMQ\347\232\204\346\225\260\346\215\256\346\216\250\351\200\201\351\230\237\345\210\227\344\275\277\347\224\250\350\257\264\346\230\216.md"
index 211c8a3..2309115 100644
--- "a/docs/\345\237\272\344\272\216RabbitMQ\347\232\204\346\225\260\346\215\256\346\216\250\351\200\201\351\230\237\345\210\227\344\275\277\347\224\250\350\257\264\346\230\216.md"
+++ "b/docs/\345\237\272\344\272\216RabbitMQ\347\232\204\346\225\260\346\215\256\346\216\250\351\200\201\351\230\237\345\210\227\344\275\277\347\224\250\350\257\264\346\230\216.md"
@@ -7,9 +7,9 @@
 
 本文档相关对接，须：
 
-* 依赖 用户服务 user-data-service，1.1.5-RELEASE 及以上版本
+* 依赖 用户服务 user-data-service，1.2.7-RELEASE 及以上版本
 
-* 依赖 同步服务 jobs-server 下的 rabbitmq-server
+* 依赖 authx-service 下的 rabbitmq-server
 
 * user-data-service-goa，须开启「推送数据到 jobs-server」
 
@@ -20,6 +20,7 @@
 
 内容为 json 格式，可以转换为 json 对象进行使用
 
+
 ### 数据模型
 
 * 字典类型 DictionaryType
@@ -134,11 +135,37 @@
 }
 ```
 
+* 用户组 Group
+
+```
+{
+  "id": String,                               // ID
+  "code": String,                             // 用户组代码
+  "name": String,                             // 用户组名称
+  "description": String,                      // 用户组描述
+  "type": String,                             // 类型，1 普通用户组，2 岗位用户组
+  "category": <ref Dictionary>,               // 类别，字典
+  "state": Integer,                           // 状态，1:启用，0:禁用
+  "sort": Integer,                            // 排序
+  "common": Boolean,                          // 是否公共
+  "applicationId": String                     // 所属应用
+}
+```
+
+* 账号用户组 AccountGroup
+
+```
+{
+  "account": <ref Account>,   // 帐号
+  "group": <ref Group>,   // 用户组
+}
+```
+
 
 ## RabbitMQ 服务地址
 
 ```
-host: rabbitmq-server.jobs-server.svc.cluster.local
+host: rabbitmq-server.authx-service.svc.cluster.local
 port: 5672
 username: guest
 password: guest
@@ -164,6 +191,22 @@ password: guest
 
 ### 交换机清单
 
+* 身份类型保存
+
+交换机名称，`jobs.fanout.exchange.identityType-userSvc-2-jobs-save`
+
+数据，身份类型 IdentityType
+
+**可依据 code 身份类型代码，作为唯一标识，用于判定数据是否在目标应用存在**
+
+
+* 身份类型删除
+
+交换机名称，`jobs.fanout.exchange.identityType-userSvc-2-jobs-delete`
+
+数据，身份类型 IdentityType
+
+
 * 组织机构保存
 
 交换机名称，`jobs.fanout.exchange.organization-userSvc-2-jobs-save`
@@ -213,3 +256,33 @@ password: guest
 
 **可将明文密码同步到第三方应用**
 
+
+* 用户组保存
+
+交换机名称，`jobs.fanout.exchange.group-userSvc-2-jobs-save`
+
+数据，用户组 Group
+
+**可依据 code 用户组代码，作为唯一标识，用于判定数据是否在目标应用存在**
+
+
+* 用户组删除
+
+交换机名称，`jobs.fanout.exchange.group-userSvc-2-jobs-delete`
+
+数据，用户组 Group
+
+
+* 帐号用户组添加
+
+交换机名称，`jobs.fanout.exchange.account-group-userSvc-2-jobs-add`
+
+数据，帐号用户组关系 AccountGroup
+
+
+* 帐号用户组移除
+
+交换机名称，`jobs.fanout.exchange.account-group-userSvc-2-jobs-del`
+
+数据，帐号用户组关系 AccountGroup
+