Gitiles
Code Review Sign In
source.supwisdom.com / institute / deploy-authx-service / 1a366ec19323d80289b9a5025cfee1e3bb7cbcfe / . / poa-api-docs / api-docs / user-data-service-poa.v1.yaml
blob: 46ac7460eb7869ed6a99d289bf4fed8669ef5625 [file] [log] [blame]
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]1# user-data-service-poa.v1.yaml
2#
3# 1. 创建服务
刘洪青61e63732020-10-19 20:00:04 +0800[diff] [blame]4# curl -i -s -X POST 'https://poa-sa.supwisdom.com/v1/services' -H 'Content-Type: application/json' -d '{"id": "user", "origin": "https://user-api.supwisdom.com", "name": "用户服务", "description": "用户服务"}'
5# http://user-data-service-poa-svc.user-data-service.svc.cluster.local:8080
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]6#
7# 2. 创建版本
刘洪青61e63732020-10-19 20:00:04 +0800[diff] [blame]8# curl -i -s -X POST 'https://poa-sa.supwisdom.com/v1/services/user/apiVersions/v1'
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]9#
10# 3. 上传OAS Yaml
刘洪青61e63732020-10-19 20:00:04 +0800[diff] [blame]11# curl -i -s -X POST 'https://poa-sa.supwisdom.com/v1/services/user/apiVersions/v1/apiSpecs' -H 'Content-Type: application/yaml' -d 'yaml content'
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]12#
13# 4. 发布版本
刘洪青61e63732020-10-19 20:00:04 +0800[diff] [blame]14# curl -i -s -X POST 'https://poa-sa.supwisdom.com/v1/services/user/apiVersions/v1/publish'
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]15#
16openapi: 3.0.2
17info:
18 title: User Data Service Platform Open APIs
19 version: v1
20 description: '用户服务 - 平台开放接口'
21servers:
22 - url: '${POA_SERVER_URL}/apis/user/v1'
刘洪青6b495a42020-11-16 16:28:40 +0800[diff] [blame]23 description: '生产环境'
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]24tags:
25 - name: User
26 description: '用户'
27 - name: UserBatchQuery
28 description: '用户批量查询'
29 - name: Organization
30 description: '组织机构'
31 - name: Group
32 description: '用户组'
33 - name: Label
34 description: '用户标签'
35 - name: PostAdmin
36 description: '用户组（岗位）管理'
37
38paths:
39
40 '/users':
41 get:
42 summary: 获取用户列表
43 operationId: pageUsers
44 tags:
45 - User
46 security:
47 - oauth2:
48 - "user:v1:readUser"
49 parameters:
50 - name: pageIndex
51 in: query
52 required: true
53 description: 分页-页码
54 schema:
55 type: integer
56 format: int32
57 default: 0
58 - name: pageSize
59 in: query
60 required: true
61 description: 分页-每页记录数
62 schema:
63 type: integer
64 format: int32
65 default: 20
66 - name: mapBean
67 in: query
68 required: false
69 description: 查询条件
70 style: deepObject
71 explode: true
72 schema:
73 type: object
74 properties:
75 keyword:
76 title: 查询条件 - 关键字(模糊，帐号、姓名等)
77 type: string
78 accountName:
79 title: 查询条件 - 账户名(模糊)
80 type: string
81 name:
82 title: 查询条件 - 姓名(模糊)
83 type: string
84 ids:
85 title: 查询条件 - ids（精确匹配，多个用逗号隔开）
86 type: string
87 accountNames:
88 title: 查询条件 - 账户名s（精确匹配，多个用逗号隔开）
89 type: string
90 responses:
91 '200':
92 description: 用户分页列表
93 content:
94 application/json:
95 schema:
96 $ref: '#/components/schemas/UserInfoPageResponse'
97 default:
98 $ref: '#/components/responses/DefaultErrorResponse'
99
刘洪青61e63732020-10-19 20:00:04 +0800[diff] [blame]100 '/users/newPage':
101 get:
102 summary: 获取用户列表(不计算totalCount)
103 operationId: pageUsersNew
104 tags:
105 - User
106 security:
107 - oauth2:
108 - "user:v1:readUser"
109 parameters:
110 - name: pageIndex
111 in: query
112 required: true
113 description: 分页-页码
114 schema:
115 type: integer
116 format: int32
117 default: 0
118 - name: pageSize
119 in: query
120 required: true
121 description: 分页-每页记录数
122 schema:
123 type: integer
124 format: int32
125 default: 20
126 - name: mapBean
127 in: query
128 required: false
129 description: 查询条件
130 style: deepObject
131 explode: true
132 schema:
133 type: object
134 properties:
135 keyword:
136 title: 查询条件 - 关键字(模糊，帐号、姓名等)
137 type: string
138 accountName:
139 title: 查询条件 - 账户名(模糊)
140 type: string
141 name:
142 title: 查询条件 - 姓名(模糊)
143 type: string
144 ids:
145 title: 查询条件 - ids（精确匹配，多个用逗号隔开）
146 type: string
147 accountNames:
148 title: 查询条件 - 账户名s（精确匹配，多个用逗号隔开）
149 type: string
150 responses:
151 '200':
152 description: 用户分页列表
153 content:
154 application/json:
155 schema:
156 $ref: '#/components/schemas/UserInfoPageResponse'
157 default:
158 $ref: '#/components/responses/DefaultErrorResponse'
159
160 '/users/totalCount':
161 get:
162 summary: 根据查询条件得到用户数量
163 operationId: totalCount
164 tags:
165 - User
166 security:
167 - oauth2:
168 - "user:v1:readUser"
169 parameters:
170 - name: mapBean
171 in: query
172 required: false
173 description: 查询条件
174 style: deepObject
175 explode: true
176 schema:
177 type: object
178 properties:
179 keyword:
180 title: 查询条件 - 关键字(模糊，帐号、姓名等)
181 type: string
182 accountName:
183 title: 查询条件 - 账户名(模糊)
184 type: string
185 name:
186 title: 查询条件 - 姓名(模糊)
187 type: string
188 ids:
189 title: 查询条件 - ids（精确匹配，多个用逗号隔开）
190 type: string
191 accountNames:
192 title: 查询条件 - 账户名s（精确匹配，多个用逗号隔开）
193 type: string
194 responses:
195 '200':
196 description: 用户数量
197 content:
198 application/json:
199 schema:
200 $ref: '#/components/schemas/UserTotalCountResponse'
201 default:
202 $ref: '#/components/responses/DefaultErrorResponse'
203
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]204 '/users/{accountId}':
205 get:
206 summary: 根据帐号ID获取用户信息
207 operationId: loadUserInfoByAccountId
208 tags:
209 - User
210 security:
211 - oauth2:
212 - "user:v1:readUser"
213 parameters:
214 - name: accountId
215 in: path
216 required: true
217 description: 帐号ID
218 schema:
219 type: string
220 responses:
221 '200':
222 description: 用户信息
223 content:
224 application/json:
225 schema:
226 $ref: '#/components/schemas/UserInfoLoadResponse'
227 default:
228 $ref: '#/components/responses/DefaultErrorResponse'
229
230 '/users/accountName/{accountName}':
231 get:
232 summary: 根据帐号获取用户信息
233 operationId: loadUserInfoByAccountName
234 tags:
235 - User
236 security:
237 - oauth2:
238 - "user:v1:readUser"
239 parameters:
240 - name: accountName
241 in: path
242 required: true
243 description: 用户名
244 schema:
245 type: string
246 responses:
247 '200':
248 description: 用户信息
249 content:
250 application/json:
251 schema:
252 $ref: '#/components/schemas/UserInfoLoadResponse'
253 default:
254 $ref: '#/components/responses/DefaultErrorResponse'
255
256
257 '/users/phoneNumber/{phoneNumber}':
258 get:
259 summary: 根据手机号（安全手机）获取用户列表
260 operationId: listUsersByPhoneNumber
261 tags:
262 - User
263 security:
264 - oauth2:
265 - "user:v1:readUser"
266 parameters:
267 - name: phoneNumber
268 in: path
269 required: true
270 description: 手机号（安全手机）
271 schema:
272 type: string
273 responses:
274 '200':
275 description: 用户列表
276 content:
277 application/json:
278 schema:
279 $ref: '#/components/schemas/UserInfoListResponse'
280 default:
281 $ref: '#/components/responses/DefaultErrorResponse'
282
283 '/users/email/{email}':
284 get:
285 summary: 根据邮件地址（安全邮箱）获取用户列表
286 operationId: listUsersByEmail
287 tags:
288 - User
289 security:
290 - oauth2:
291 - "user:v1:readUser"
292 parameters:
293 - name: email
294 in: path
295 required: true
296 description: 邮件地址（安全邮箱）
297 schema:
298 type: string
299 responses:
300 '200':
301 description: 用户列表
302 content:
303 application/json:
304 schema:
305 $ref: '#/components/schemas/UserInfoListResponse'
306 default:
307 $ref: '#/components/responses/DefaultErrorResponse'
308
309 '/users/{accountId}/portrait':
310 get:
311 summary: 根据帐号ID获取用户头像
312 operationId: loadUserPortraitByAccountId
313 tags:
314 - User
315 security:
316 - oauth2:
317 - "user:v1:readUser"
318 parameters:
319 - name: accountId
320 in: path
321 required: true
322 description: 帐号ID
323 schema:
324 type: string
325 responses:
326 '200':
327 description: 用户头像
328 content:
329 application/json:
330 schema:
331 $ref: '#/components/schemas/UserPortraitLoadResponse'
332 default:
333 $ref: '#/components/responses/DefaultErrorResponse'
334
335 '/users/accountName/{accountName}/portrait':
336 get:
337 summary: 根据帐号获取用户头像
338 operationId: loadUserPortraitByAccountName
339 tags:
340 - User
341 security:
342 - oauth2:
343 - "user:v1:readUser"
344 parameters:
345 - name: accountName
346 in: path
347 required: true
348 description: 帐号
349 schema:
350 type: string
351 responses:
352 '200':
353 description: 用户头像
354 content:
355 application/json:
356 schema:
357 $ref: '#/components/schemas/UserPortraitLoadResponse'
358 default:
359 $ref: '#/components/responses/DefaultErrorResponse'
360
361 '/users/{accountId}/safety':
362 get:
363 summary: 根据帐号ID获取用户的安全信息
364 operationId: loadUserSafetyByAccountId
365 tags:
366 - User
367 security:
368 - oauth2:
369 - "user:v1:readUserSecret"
370 parameters:
371 - name: accountId
372 in: path
373 required: true
374 description: 帐号ID
375 schema:
376 type: string
377 responses:
378 '200':
379 description: 安全信息
380 content:
381 application/json:
382 schema:
383 $ref: '#/components/schemas/UserSafetyLoadResponse'
384 default:
385 $ref: '#/components/responses/DefaultErrorResponse'
386
387 '/users/accountName/{accountName}/safety':
388 get:
389 summary: 根据帐号获取用户的安全信息
390 operationId: loadUserSafetyByAccountName
391 tags:
392 - User
393 security:
394 - oauth2:
395 - "user:v1:readUserSecret"
396 parameters:
397 - name: accountName
398 in: path
399 required: true
400 description: 帐号
401 schema:
402 type: string
403 responses:
404 '200':
405 description: 安全信息
406 content:
407 application/json:
408 schema:
409 $ref: '#/components/schemas/UserSafetyLoadResponse'
410 default:
411 $ref: '#/components/responses/DefaultErrorResponse'
412
413 '/users/{accountId}/federation/{federatedType}':
414 get:
415 summary: 根据帐号ID获取用户的联合登录信息
416 operationId: loadUserFederationByAccountId
417 tags:
418 - User
419 security:
420 - oauth2:
421 - "user:v1:readUserSecret"
422 parameters:
423 - name: accountId
424 in: path
425 required: true
426 description: 帐号ID
427 schema:
428 type: string
429 - name: federatedType
430 in: path
431 required: true
432 description: 联合登录类型（qq, openweixin, workweixin, alipay, dingtalk）
433 schema:
434 type: string
435 responses:
436 '200':
437 description: 联合登录信息
438 content:
439 application/json:
440 schema:
441 $ref: '#/components/schemas/UserFederationLoadResponse'
442 default:
443 $ref: '#/components/responses/DefaultErrorResponse'
444
445 '/users/accountName/{accountName}/federation/{federatedType}':
446 get:
447 summary: 根据帐号获取用户的联合登录信息
448 operationId: loadUserFederationByAccountName
449 tags:
450 - User
451 security:
452 - oauth2:
453 - "user:v1:readUserSecret"
454 parameters:
455 - name: accountName
456 in: path
457 required: true
458 description: 帐号
459 schema:
460 type: string
461 - name: federatedType
462 in: path
463 required: true
464 description: 联合登录类型（qq, openweixin, workweixin, alipay, dingtalk）
465 schema:
466 type: string
467 responses:
468 '200':
469 description: 联合登录信息
470 content:
471 application/json:
472 schema:
473 $ref: '#/components/schemas/UserFederationLoadResponse'
474 default:
475 $ref: '#/components/responses/DefaultErrorResponse'
476
477
478 '/users/batchQuery':
479 post:
480 summary: 批量获取用户列表
481 operationId: batchQueryUsers
482 description: |-
483 查询条件accountIds, accountNames, phoneNumbers, emails之间的是或关系。
484 如果你同时制定了accountIds和phoneNumbers，那么会分别按照这两个查询条件
485 查询出用户列表，然后合并返回给你。
486 同时，这些查询条件的数组长度最多1000个
487 tags:
488 - UserBatchQuery
489 security:
490 - oauth2:
491 - "user:v1:readUser"
492 requestBody:
493 description: 查询条件
494 required: true
495 content:
496 'application/json':
497 schema:
498 type: object
499 properties:
500 accountIds:
501 title: 账号Id（复数）
502 type: array
503 items:
504 title: 账号Id
505 type: string
506 maxItems: 1000
507 accountNames:
508 title: 账户名（复数）
509 type: array
510 items:
511 title: 账户名
512 type: string
513 maxItems: 1000
514 securePhoneNumbers:
515 title: 安全手机（复数）
516 type: array
517 items:
518 title: 安全手机
519 type: string
520 maxItems: 1000
521 secureEmails:
522 title: 安全邮箱（复数）
523 type: array
524 items:
525 title: 安全邮箱
526 type: string
527 maxItems: 1000
528 responses:
529 '200':
530 description: 用户列表
531 content:
532 application/json:
533 schema:
534 $ref: '#/components/schemas/UserInfoListResponse'
535 default:
536 $ref: '#/components/responses/DefaultErrorResponse'
537
538 '/users/safety/phoneNumber/batchQuery':
539 post:
540 summary: 批量查询用户的安全手机
541 operationId: batchQueryUserSafetyPhoneNumber
542 description: |-
543 查询条件accountIds, accountNames之间的是或关系。
544 如果你同时制定了accountIds和accountNames，那么会分别按照这两个查询条件
545 查询出用户列表，然后合并返回给你。
546 同时，这些查询条件的数组长度最多1000个
547 tags:
548 - UserBatchQuery
549 security:
550 - oauth2:
551 - "user:v1:readUserSecret"
552 requestBody:
553 description: 查询条件
554 required: true
555 content:
556 'application/json':
557 schema:
558 type: object
559 properties:
560 accountIds:
561 title: 账号Id（复数）
562 type: array
563 items:
564 title: 账号Id
565 type: string
566 maxItems: 1000
567 accountNames:
568 title: 账户名（复数）
569 type: array
570 items:
571 title: 账户名
572 type: string
573 maxItems: 1000
574 responses:
575 '200':
576 description: 用户安全信息列表
577 content:
578 application/json:
579 schema:
580 $ref: '#/components/schemas/UserSafetyPhoneNumberList'
581 default:
582 $ref: '#/components/responses/DefaultErrorResponse'
583
584 '/users/safety/email/batchQuery':
585 post:
586 summary: 批量查询用户的安全邮箱
587 operationId: batchQueryUserSafetyEmail
588 description: |-
589 查询条件accountIds, accountNames之间的是或关系。
590 如果你同时制定了accountIds和accountNames，那么会分别按照这两个查询条件
591 查询出用户列表，然后合并返回给你。
592 同时，这些查询条件的数组长度最多1000个
593 tags:
594 - UserBatchQuery
595 security:
596 - oauth2:
597 - "user:v1:readUserSecret"
598 requestBody:
599 description: 查询条件
600 required: true
601 content:
602 'application/json':
603 schema:
604 type: object
605 properties:
606 accountIds:
607 title: 账号Id（复数）
608 type: array
609 items:
610 title: 账号Id
611 type: string
612 maxItems: 1000
613 accountNames:
614 title: 账户名（复数）
615 type: array
616 items:
617 title: 账户名
618 type: string
619 maxItems: 1000
620 responses:
621 '200':
622 description: 用户安全信息列表
623 content:
624 application/json:
625 schema:
626 $ref: '#/components/schemas/UserSafetyEmailList'
627 default:
628 $ref: '#/components/responses/DefaultErrorResponse'
629
630 '/users/federation/{federatedType}/batchQuery':
631 post:
632 summary: 批量查询用户的联合登录信息
633 operationId: batchQueryUserFederation
634 description: |-
635 查询条件accountIds, accountNames之间的是或关系。
636 如果你同时制定了accountIds和accountNames，那么会分别按照这两个查询条件
637 查询出用户列表，然后合并返回给你。
638 同时，这些查询条件的数组长度最多1000个
639 tags:
640 - UserBatchQuery
641 security:
642 - oauth2:
643 - "user:v1:readUserSecret"
644 parameters:
645 - name: federatedType
646 description: 联合登录类型
647 in: path
648 required: true
649 schema:
650 type: string
651 enum:
652 - qq
653 - openweixin
654 - workweixin
655 - alipay
656 - dingtalk
657 requestBody:
658 description: 查询条件
659 required: true
660 content:
661 'application/json':
662 schema:
663 type: object
664 properties:
665 accountIds:
666 title: 账号Id（复数）
667 type: array
668 items:
669 title: 账号Id
670 type: string
671 maxItems: 1000
672 accountNames:
673 title: 账户名（复数）
674 type: array
675 items:
676 title: 账户名
677 type: string
678 maxItems: 1000
679 responses:
680 '200':
681 description: 用户联合登录信息列表
682 content:
683 application/json:
684 schema:
685 $ref: '#/components/schemas/UserFederationList'
686 default:
687 $ref: '#/components/responses/DefaultErrorResponse'
688
689
690 '/organizations/organizationTree':
691 get:
692 summary: 获取组织机构树
693 operationId: treeOrganization
694 tags:
695 - Organization
696 security:
697 - oauth2:
698 - "user:v1:readOrganization"
699 responses:
700 '200':
701 description: 组织机构列表
702 content:
703 application/json:
704 schema:
705 $ref: '#/components/schemas/OrganizationListResponse'
706 default:
707 $ref: '#/components/responses/DefaultErrorResponse'
708
709 '/organizations/rootOrganization':
710 get:
711 summary: 获取根组织机构列表
712 operationId: listRootOrganization
713 tags:
714 - Organization
715 security:
716 - oauth2:
717 - "user:v1:readOrganization"
718 responses:
719 '200':
720 description: 根组织机构列表
721 content:
722 application/json:
723 schema:
724 $ref: '#/components/schemas/RootOrganizationListResponse'
725 default:
726 $ref: '#/components/responses/DefaultErrorResponse'
727
728 '/organizations/rootOrganization/{rootOrganizationId}/organizations':
729 get:
730 summary: 获取根组织机构下的组织机构列表
731 operationId: pageOrganizationsOfRoot
732 tags:
733 - Organization
734 security:
735 - oauth2:
736 - "user:v1:readOrganization"
737 parameters:
738 - name: rootOrganizationId
739 in: path
740 required: true
741 description: 根组织机构ID
742 schema:
743 type: string
744 - name: pageIndex
745 in: query
746 required: true
747 description: 分页-页码
748 schema:
749 type: integer
750 format: int32
751 default: 0
752 - name: pageSize
753 in: query
754 required: true
755 description: 分页-每页记录数
756 schema:
757 type: integer
758 format: int32
759 default: 20
760 - name: mapBean
761 in: query
762 required: false
763 description: 查询条件
764 style: deepObject
765 explode: true
766 schema:
767 type: object
768 properties:
769 ids:
770 title: 查询条件 - IDs(多个用逗号隔开)
771 type: string
772 keyword:
773 title: 查询条件 - 关键字(模糊，代码、名称、描述等)
774 type: string
775 code:
776 title: 查询条件 - 代码(模糊)
777 type: string
778 name:
779 title: 查询条件 - 名称(模糊)
780 type: string
781 description:
782 title: 查询条件 - 描述(模糊)
783 type: string
784 responses:
785 '200':
786 description: 组织机构列表
787 content:
788 application/json:
789 schema:
790 $ref: '#/components/schemas/OrganizationListResponse'
791 default:
792 $ref: '#/components/responses/DefaultErrorResponse'
793
794 '/organizations/rootOrganization/{rootOrganizationId}/organizationTree':
795 get:
796 summary: 获取根组织机构下的组织机构树
797 operationId: treeOrganizationsOfRoot
798 tags:
799 - Organization
800 security:
801 - oauth2:
802 - "user:v1:readOrganization"
803 parameters:
804 - name: rootOrganizationId
805 in: path
806 required: true
807 description: 根组织机构ID
808 schema:
809 type: string
810 responses:
811 '200':
812 description: 组织机构列表
813 content:
814 application/json:
815 schema:
816 $ref: '#/components/schemas/OrganizationListResponse'
817 default:
818 $ref: '#/components/responses/DefaultErrorResponse'
819
820
821 '/organizations/{organizationId}':
822 get:
823 summary: 根据组织机构ID获取组织机构
824 operationId: getOrganization
825 tags:
826 - Organization
827 security:
828 - oauth2:
829 - "user:v1:readOrganization"
830 parameters:
831 - name: organizationId
832 in: path
833 required: true
834 description: 组织机构ID
835 schema:
836 type: string
837 responses:
838 '200':
839 description: 组织机构信息
840 content:
841 application/json:
842 schema:
843 $ref: '#/components/schemas/OrganizationLoadResponse'
844 default:
845 $ref: '#/components/responses/DefaultErrorResponse'
846
847 '/organizations/organizationCode/{organizationCode}':
848 get:
849 summary: 根据组织机构代码获取组织机构
850 operationId: getOrganizationByCode
851 tags:
852 - Organization
853 security:
854 - oauth2:
855 - "user:v1:readOrganization"
856 parameters:
857 - name: organizationCode
858 in: path
859 required: true
860 description: 组织机构代码
861 schema:
862 type: string
863 responses:
864 '200':
865 description: 组织机构信息
866 content:
867 application/json:
868 schema:
869 $ref: '#/components/schemas/OrganizationLoadResponse'
870 default:
871 $ref: '#/components/responses/DefaultErrorResponse'
872
873
874 '/organizations/{organizationId}/users':
875 get:
876 summary: 获取组织机构下的用户列表（弃用）
877 description: 弃用，应该使用 /organizations/users
878 operationId: listUsersByOrganization
879 tags:
880 - Organization
881 security:
882 - oauth2:
883 - "user:v1:readOrganization"
884 parameters:
885 - name: organizationId
886 in: path
887 required: true
888 description: 组织机构ID
889 schema:
890 type: string
891 - name: pageIndex
892 in: query
893 required: true
894 description: 分页-页码
895 schema:
896 type: integer
897 format: int32
898 default: 0
899 - name: pageSize
900 in: query
901 required: true
902 description: 分页-每页记录数
903 schema:
904 type: integer
905 format: int32
906 default: 20
907 - name: mapBean
908 in: query
909 required: false
910 description: 查询条件
911 style: deepObject
912 explode: true
913 schema:
914 type: object
915 properties:
916 keyword:
917 title: 查询条件 - 关键字(模糊，帐号、姓名等)
918 type: string
919 accountName:
920 title: 查询条件 - 账户名(模糊)
921 type: string
922 name:
923 title: 查询条件 - 姓名(模糊)
924 type: string
925 responses:
926 '200':
927 description: 用户分页列表
928 content:
929 application/json:
930 schema:
931 $ref: '#/components/schemas/UserInfoPageResponse'
932 default:
933 $ref: '#/components/responses/DefaultErrorResponse'
934
935 '/organizations/{organizationId}/allSub/users':
936 get:
937 summary: 获取组织机构(及其子集)下的用户列表（弃用）
938 description: 弃用，应该使用 /organizations/users
939 operationId: listUsersByOrganizationAllSub
940 tags:
941 - Organization
942 security:
943 - oauth2:
944 - "user:v1:readOrganization"
945 parameters:
946 - name: organizationId
947 in: path
948 required: true
949 description: 组织机构ID
950 schema:
951 type: string
952 - name: pageIndex
953 in: query
954 required: true
955 description: 分页-页码
956 schema:
957 type: integer
958 format: int32
959 default: 0
960 - name: pageSize
961 in: query
962 required: true
963 description: 分页-每页记录数
964 schema:
965 type: integer
966 format: int32
967 default: 20
968 - name: mapBean
969 in: query
970 required: false
971 description: 查询条件
972 style: deepObject
973 explode: true
974 schema:
975 type: object
976 properties:
977 keyword:
978 title: 查询条件 - 关键字(模糊，帐号、姓名等)
979 type: string
980 accountName:
981 title: 查询条件 - 账户名(模糊)
982 type: string
983 name:
984 title: 查询条件 - 姓名(模糊)
985 type: string
986 responses:
987 '200':
988 description: 用户分页列表
989 content:
990 application/json:
991 schema:
992 $ref: '#/components/schemas/UserInfoPageResponse'
993 default:
994 $ref: '#/components/responses/DefaultErrorResponse'
995
996 '/organizations/users':
997 get:
998 summary: 获取组织机构下的用户列表
999 description: organizationId和organizationCode二选一
1000 operationId: listOrganizationUsers
1001 tags:
1002 - Organization
1003 security:
1004 - oauth2:
1005 - "user:v1:readOrganization"
1006 parameters:
1007 - name: organizationId
1008 in: query
1009 description: 组织机构Id
1010 schema:
1011 type: string
1012 - name: organizationCode
1013 in: query
1014 description: 组织机构Code
1015 schema:
1016 type: string
1017 - name: fetchSub
1018 in: query
1019 description: 是否包含子组织机构的用户
1020 schema:
1021 type: boolean
1022 default: false
1023 - name: pageIndex
1024 in: query
1025 required: true
1026 description: 分页-页码
1027 schema:
1028 type: integer
1029 format: int32
1030 default: 0
1031 - name: pageSize
1032 in: query
1033 required: true
1034 description: 分页-每页记录数
1035 schema:
1036 type: integer
1037 format: int32
1038 default: 20
1039 - name: mapBean
1040 in: query
1041 required: false
1042 description: 查询条件
1043 style: deepObject
1044 explode: true
1045 schema:
1046 type: object
1047 properties:
1048 keyword:
1049 title: 查询条件 - 关键字(模糊，帐号、姓名等)
1050 type: string
1051 accountName:
1052 title: 查询条件 - 账户名(模糊)
1053 type: string
1054 name:
1055 title: 查询条件 - 姓名(模糊)
1056 type: string
1057 responses:
1058 '200':
1059 description: 用户分页列表
1060 content:
1061 application/json:
1062 schema:
1063 $ref: '#/components/schemas/UserInfoPageResponse'
1064 default:
1065 $ref: '#/components/responses/DefaultErrorResponse'
1066
1067 '/organizations/accountId/{accountId}/rootOrganization/{rootOrganizationId}/organizationChain':
1068 get:
1069 summary: 获取帐号在根组织机构下的所属组织机构
1070 operationId: getAccountOrganizationsOfRoot
1071 tags:
1072 - Organization
1073 security:
1074 - oauth2:
1075 - "user:v1:readOrganization"
1076 parameters:
1077 - name: rootOrganizationId
1078 in: path
1079 required: true
1080 description: 根组织机构ID
1081 schema:
1082 type: string
1083 - name: accountId
1084 in: path
1085 required: true
1086 description: 帐号
1087 schema:
1088 type: string
1089 responses:
1090 '200':
1091 description: 组织机构列表
1092 content:
1093 application/json:
1094 schema:
1095 $ref: '#/components/schemas/OrganizationListResponse'
1096 default:
1097 $ref: '#/components/responses/DefaultErrorResponse'
1098
1099
1100 '/groups':
1101 get:
1102 summary: 获取用户组（所有）的列表
1103 operationId: pageGroups
1104 tags:
1105 - Group
1106 security:
1107 - oauth2:
1108 - "user:v1:readGroup"
1109 parameters:
1110 - name: pageIndex
1111 in: query
1112 required: true
1113 description: 分页-页码
1114 schema:
1115 type: integer
1116 format: int32
1117 default: 0
1118 - name: pageSize
1119 in: query
1120 required: true
1121 description: 分页-每页记录数
1122 schema:
1123 type: integer
1124 format: int32
1125 default: 20
1126 - name: mapBean
1127 in: query
1128 required: false
1129 description: 查询条件
1130 style: deepObject
1131 explode: true
1132 schema:
1133 type: object
1134 properties:
1135 ids:
1136 title: 查询条件 - IDs(多个用逗号隔开)
1137 type: string
1138 keyword:
1139 title: 查询条件 - 关键字(模糊，名称、描述等)
1140 type: string
1141 name:
1142 title: 查询条件 - 名称(模糊)
1143 type: string
1144 description:
1145 title: 查询条件 - 描述(模糊)
1146 type: string
1147 type:
1148 title: 查询条件 - 类型(精确，1 普通用户组，2 岗位用户组)
1149 type: string
1150 responses:
1151 '200':
1152 description: 用户组分页列表
1153 content:
1154 application/json:
1155 schema:
1156 $ref: '#/components/schemas/GroupPageResponse'
1157 default:
1158 $ref: '#/components/responses/DefaultErrorResponse'
1159
1160 '/groups/{groupId}':
1161 get:
1162 summary: 根据用户组ID获取用户组（所有）的基本信息
1163 operationId: getGroup
1164 tags:
1165 - Group
1166 security:
1167 - oauth2:
1168 - "user:v1:readGroup"
1169 parameters:
1170 - name: groupId
1171 in: path
1172 required: true
1173 description: 用户组ID
1174 schema:
1175 type: string
1176 responses:
1177 '200':
1178 description: 用户组信息
1179 content:
1180 application/json:
1181 schema:
1182 $ref: '#/components/schemas/GroupLoadResponse'
1183 default:
1184 $ref: '#/components/responses/DefaultErrorResponse'
1185
1186 '/groups/groupCode/{groupCode}':
1187 get:
1188 summary: 根据用户组代码获取用户组（所有）的基本信息
1189 operationId: getGroupByCode
1190 tags:
1191 - Group
1192 security:
1193 - oauth2:
1194 - "user:v1:readGroup"
1195 parameters:
1196 - name: groupCode
1197 in: path
1198 required: true
1199 description: 用户组代码
1200 schema:
1201 type: string
1202 responses:
1203 '200':
1204 description: 用户组信息
1205 content:
1206 application/json:
1207 schema:
1208 $ref: '#/components/schemas/GroupLoadResponse'
1209 default:
1210 $ref: '#/components/responses/DefaultErrorResponse'
1211
1212
1213 '/groups/{groupId}/users':
1214 get:
1215 summary: 获取用户组（所有）下的用户列表（弃用）
1216 description: 弃用，应该使用 /groups/users
1217 operationId: listUsersByGroup
1218 tags:
1219 - Group
1220 security:
1221 - oauth2:
1222 - "user:v1:readGroup"
1223 parameters:
1224 - name: groupId
1225 in: path
1226 required: true
1227 description: 用户组ID
1228 schema:
1229 type: string
1230 - name: pageIndex
1231 in: query
1232 required: true
1233 description: 分页-页码
1234 schema:
1235 type: integer
1236 format: int32
1237 default: 0
1238 - name: pageSize
1239 in: query
1240 required: true
1241 description: 分页-每页记录数
1242 schema:
1243 type: integer
1244 format: int32
1245 default: 20
1246 - name: mapBean
1247 in: query
1248 required: false
1249 description: 查询条件
1250 style: deepObject
1251 explode: true
1252 schema:
1253 type: object
1254 properties:
1255 keyword:
1256 title: 查询条件 - 关键字(模糊，帐号、姓名等)
1257 type: string
1258 accountName:
1259 title: 查询条件 - 账户名(模糊)
1260 type: string
1261 name:
1262 title: 查询条件 - 姓名(模糊)
1263 type: string
1264 responses:
1265 '200':
1266 description: 用户分页列表
1267 content:
1268 application/json:
1269 schema:
1270 $ref: '#/components/schemas/UserInfoPageResponse'
1271 default:
1272 $ref: '#/components/responses/DefaultErrorResponse'
1273
1274 '/groups/users':
1275 get:
1276 summary: 获取用户组（所有）下的用户列表
1277 description: groupId和groupCode二选一
1278 operationId: listGroupUsers
1279 tags:
1280 - Group
1281 security:
1282 - oauth2:
1283 - "user:v1:readGroup"
1284 parameters:
1285 - name: groupId
1286 in: query
1287 description: 用户组ID
1288 schema:
1289 type: string
1290 - name: groupCode
1291 in: query
1292 description: 用户组Code
1293 schema:
1294 type: string
1295 - name: pageIndex
1296 in: query
1297 required: true
1298 description: 分页-页码
1299 schema:
1300 type: integer
1301 format: int32
1302 default: 0
1303 - name: pageSize
1304 in: query
1305 required: true
1306 description: 分页-每页记录数
1307 schema:
1308 type: integer
1309 format: int32
1310 default: 20
1311 - name: mapBean
1312 in: query
1313 required: false
1314 description: 查询条件
1315 style: deepObject
1316 explode: true
1317 schema:
1318 type: object
1319 properties:
1320 keyword:
1321 title: 查询条件 - 关键字(模糊，帐号、姓名等)
1322 type: string
1323 accountName:
1324 title: 查询条件 - 账户名(模糊)
1325 type: string
1326 name:
1327 title: 查询条件 - 姓名(模糊)
1328 type: string
1329 responses:
1330 '200':
1331 description: 用户分页列表
1332 content:
1333 application/json:
1334 schema:
1335 $ref: '#/components/schemas/UserInfoPageResponse'
1336 default:
1337 $ref: '#/components/responses/DefaultErrorResponse'
1338
1339 '/groups/{groupId}/organizationId/{organizationId}/users':
1340 get:
1341 summary: 获取用户组（所有）、部门下的用户列表
1342 operationId: listUsersByGroupOrganization
1343 tags:
1344 - Group
1345 security:
1346 - oauth2:
1347 - "user:v1:readGroup"
1348 parameters:
1349 - name: groupId
1350 in: path
1351 required: true
1352 description: 用户组ID
1353 schema:
1354 type: string
1355 - name: organizationId
1356 in: path
1357 required: true
1358 description: 组织机构ID
1359 schema:
1360 type: string
1361 - name: pageIndex
1362 in: query
1363 required: true
1364 description: 分页-页码
1365 schema:
1366 type: integer
1367 format: int32
1368 default: 0
1369 - name: pageSize
1370 in: query
1371 required: true
1372 description: 分页-每页记录数
1373 schema:
1374 type: integer
1375 format: int32
1376 default: 20
1377 - name: mapBean
1378 in: query
1379 required: false
1380 description: 查询条件
1381 style: deepObject
1382 explode: true
1383 schema:
1384 type: object
1385 properties:
1386 keyword:
1387 title: 查询条件 - 关键字(模糊，帐号、姓名等)
1388 type: string
1389 accountName:
1390 title: 查询条件 - 账户名(模糊)
1391 type: string
1392 name:
1393 title: 查询条件 - 姓名(模糊)
1394 type: string
1395 responses:
1396 '200':
1397 description: 用户分页列表
1398 content:
1399 application/json:
1400 schema:
1401 $ref: '#/components/schemas/UserInfoPageResponse'
1402 default:
1403 $ref: '#/components/responses/DefaultErrorResponse'
1404
1405 '/groups/{groupId}/accountId/{accountId}':
1406 get:
1407 summary: 获取用户组（普通）下指定帐号的关系
1408 operationId: loadAccountGroup
1409 tags:
1410 - Group
1411 security:
1412 - oauth2:
1413 - "user:v1:readGroup"
1414 parameters:
1415 - name: groupId
1416 in: path
1417 required: true
1418 description: 用户组ID
1419 schema:
1420 type: string
1421 - name: accountId
1422 in: path
1423 required: true
1424 description: 帐号
1425 schema:
1426 type: string
1427 responses:
1428 '200':
1429 description: 帐号-用户组
1430 content:
1431 application/json:
1432 schema:
1433 $ref: '#/components/schemas/AccountGroupResponse'
1434 default:
1435 $ref: '#/components/responses/DefaultErrorResponse'
1436
1437 '/groups/accountId/{accountId}/groups':
1438 get:
1439 summary: 获取帐号的用户组（普通）
1440 operationId: listAccountGroups
1441 tags:
1442 - Group
1443 security:
1444 - oauth2:
1445 - "user:v1:readGroup"
1446 parameters:
1447 - name: accountId
1448 in: path
1449 required: true
1450 description: 帐号
1451 schema:
1452 type: string
1453 responses:
1454 '200':
1455 description: 用户组
1456 content:
1457 application/json:
1458 schema:
1459 $ref: '#/components/schemas/GroupListResponse'
1460 default:
1461 $ref: '#/components/responses/DefaultErrorResponse'
1462
1463
刘洪青b7e29702020-11-05 19:07:13 +0800[diff] [blame]1464 '/groups/groupOrganizationSettings':
1465 get:
1466 summary: 获取所有的用户组（岗位）下设置的组织机构
1467 operationId: listGroupOrganizationSettings
1468 tags:
1469 - Group
1470 security:
1471 - oauth2:
1472 - "user:v1:readGroup"
1473 responses:
1474 '200':
1475 description: 岗位-组织机构设置的列表
1476 content:
1477 application/json:
1478 schema:
1479 $ref: '#/components/schemas/GroupOrganizationListResponse'
1480 default:
1481 $ref: '#/components/responses/DefaultErrorResponse'
1482
1483
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]1484 '/groups/{groupId}/accountOrganizations':
1485 get:
1486 summary: 获取用户组（岗位）下的帐号 - 组织机构列表
1487 operationId: listAccountOrganizationsByGroup
1488 tags:
1489 - Group
1490 security:
1491 - oauth2:
1492 - "user:v1:readGroup"
1493 parameters:
1494 - name: groupId
1495 in: path
1496 required: true
1497 description: 用户组ID
1498 schema:
1499 type: string
1500 responses:
1501 '200':
1502 description: 岗位-组织机构-帐号关系的列表
1503 content:
1504 application/json:
1505 schema:
1506 $ref: '#/components/schemas/GroupOrganizationAccountListResponse'
1507 default:
1508 $ref: '#/components/responses/DefaultErrorResponse'
1509
1510 '/groups/accountId/{accountId}/groupOrganizations':
1511 get:
1512 summary: 获取帐号的用户组（岗位） - 组织机构列表
1513 operationId: listGroupOrganizationsByAccount
1514 tags:
1515 - Group
1516 security:
1517 - oauth2:
1518 - "user:v1:readGroup"
1519 parameters:
1520 - name: accountId
1521 in: path
1522 required: true
1523 description: 帐号ID
1524 schema:
1525 type: string
1526 responses:
1527 '200':
1528 description: 岗位-组织机构-帐号关系的列表
1529 content:
1530 application/json:
1531 schema:
1532 $ref: '#/components/schemas/GroupOrganizationAccountListResponse'
1533 default:
1534 $ref: '#/components/responses/DefaultErrorResponse'
1535
1536 '/groups/organizationId/{organizationId}/accountGroups':
1537 get:
1538 summary: 获取组织机构下的帐号 - 用户组（岗位）列表
1539 operationId: listAccountGroupsByOrganization
1540 tags:
1541 - Group
1542 security:
1543 - oauth2:
1544 - "user:v1:readGroup"
1545 parameters:
1546 - name: organizationId
1547 in: path
1548 required: true
1549 description: 组织机构ID
1550 schema:
1551 type: string
1552 responses:
1553 '200':
1554 description: 岗位-组织机构-帐号关系的列表
1555 content:
1556 application/json:
1557 schema:
1558 $ref: '#/components/schemas/GroupOrganizationAccountListResponse'
1559 default:
1560 $ref: '#/components/responses/DefaultErrorResponse'
1561
1562 '/groups/{groupId}/accountId/{accountId}/organizations':
1563 get:
1564 summary: 获取用户组（岗位）下指定帐号 的 组织机构
1565 operationId: listOrganizationsByAccountGroup
1566 tags:
1567 - Group
1568 security:
1569 - oauth2:
1570 - "user:v1:readGroup"
1571 parameters:
1572 - name: groupId
1573 in: path
1574 required: true
1575 description: 用户组ID
1576 schema:
1577 type: string
1578 - name: accountId
1579 in: path
1580 required: true
1581 description: 帐号ID
1582 schema:
1583 type: string
1584 responses:
1585 '200':
1586 description: 岗位-组织机构-帐号关系的列表
1587 content:
1588 application/json:
1589 schema:
1590 $ref: '#/components/schemas/GroupOrganizationAccountListResponse'
1591 default:
1592 $ref: '#/components/responses/DefaultErrorResponse'
1593
1594 '/groups/{groupId}/organizationId/{organizationId}/accounts':
1595 get:
1596 summary: 获取用户组（岗位）下指定组织机构 的 帐号
1597 operationId: listAccountsByGroupOrganization
1598 tags:
1599 - Group
1600 security:
1601 - oauth2:
1602 - "user:v1:readGroup"
1603 parameters:
1604 - name: groupId
1605 in: path
1606 required: true
1607 description: 用户组ID
1608 schema:
1609 type: string
1610 - name: organizationId
1611 in: path
1612 required: true
1613 description: 组织机构ID
1614 schema:
1615 type: string
1616 responses:
1617 '200':
1618 description: 岗位-组织机构-帐号关系的列表
1619 content:
1620 application/json:
1621 schema:
1622 $ref: '#/components/schemas/GroupOrganizationAccountListResponse'
1623 default:
1624 $ref: '#/components/responses/DefaultErrorResponse'
1625
1626 '/groups/{groupId}/accountId/{accountId}/organizationId/{organizationId}':
1627 get:
1628 summary: 获取用户组（岗位）下指定帐号、组织机构的关系
1629 operationId: loadAccountGroupOrganization
1630 tags:
1631 - Group
1632 security:
1633 - oauth2:
1634 - "user:v1:readGroup"
1635 parameters:
1636 - name: groupId
1637 in: path
1638 required: true
1639 description: 用户组ID
1640 schema:
1641 type: string
1642 - name: accountId
1643 in: path
1644 required: true
1645 description: 帐号ID
1646 schema:
1647 type: string
1648 - name: organizationId
1649 in: path
1650 required: true
1651 description: 组织机构ID
1652 schema:
1653 type: string
1654 responses:
1655 '200':
1656 description: 岗位-组织机构-帐号关系
1657 content:
1658 application/json:
1659 schema:
1660 $ref: '#/components/schemas/GroupOrganizationAccountResponse'
1661 default:
1662 $ref: '#/components/responses/DefaultErrorResponse'
1663
1664
1665 '/labels':
1666 get:
1667 summary: 获取用户标签列表
1668 operationId: pageLabels
1669 tags:
1670 - Label
1671 security:
1672 - oauth2:
1673 - "user:v1:readLabel"
1674 parameters:
1675 - name: pageIndex
1676 in: query
1677 required: true
1678 description: 分页-页码
1679 schema:
1680 type: integer
1681 format: int32
1682 default: 0
1683 - name: pageSize
1684 in: query
1685 required: true
1686 description: 分页-每页记录数
1687 schema:
1688 type: integer
1689 format: int32
1690 default: 20
1691 - name: mapBean
1692 in: query
1693 required: false
1694 description: 查询条件
1695 style: deepObject
1696 explode: true
1697 schema:
1698 type: object
1699 properties:
1700 keyword:
1701 title: 查询条件 - 关键字(模糊，名称、描述等)
1702 type: string
1703 name:
1704 title: 查询条件 - 名称(模糊)
1705 type: string
1706 description:
1707 title: 查询条件 - 描述(模糊)
1708 type: string
1709 responses:
1710 '200':
1711 description: 用户标签分页列表
1712 content:
1713 application/json:
1714 schema:
1715 $ref: '#/components/schemas/LabelPageResponse'
1716 default:
1717 $ref: '#/components/responses/DefaultErrorResponse'
1718
1719 '/labels/{labelId}':
1720 get:
1721 summary: 获取用户标签
1722 operationId: getLabel
1723 tags:
1724 - Label
1725 security:
1726 - oauth2:
1727 - "user:v1:readLabel"
1728 parameters:
1729 - name: labelId
1730 in: path
1731 required: true
1732 description: 用户标签ID
1733 schema:
1734 type: string
1735 responses:
1736 '200':
1737 description: 用户标签信息
1738 content:
1739 application/json:
1740 schema:
1741 $ref: '#/components/schemas/LabelLoadResponse'
1742 default:
1743 $ref: '#/components/responses/DefaultErrorResponse'
1744
1745 '/labels/{labelId}/accountId/{accountId}':
1746 get:
1747 summary: 获取用户标签下指定帐号的关系
1748 operationId: loadAccountLabel
1749 tags:
1750 - Label
1751 security:
1752 - oauth2:
1753 - "user:v1:readLabel"
1754 parameters:
1755 - name: accountId
1756 in: path
1757 required: true
1758 description: 帐号
1759 schema:
1760 type: string
1761 - name: labelId
1762 in: path
1763 required: true
1764 description: 用户标签ID
1765 schema:
1766 type: string
1767 responses:
1768 '200':
1769 description: 用户标签
1770 content:
1771 application/json:
1772 schema:
1773 $ref: '#/components/schemas/AccountLabelResponse'
1774 default:
1775 $ref: '#/components/responses/DefaultErrorResponse'
1776
1777 '/labels/{labelId}/users':
1778 get:
1779 summary: 获取用户标签下的用户列表
1780 operationId: listUsersByLabel
1781 tags:
1782 - Label
1783 security:
1784 - oauth2:
1785 - "user:v1:readLabel"
1786 parameters:
1787 - name: labelId
1788 in: path
1789 required: true
1790 description: 用户标签ID
1791 schema:
1792 type: string
1793 - name: pageIndex
1794 in: query
1795 required: true
1796 description: 分页-页码
1797 schema:
1798 type: integer
1799 format: int32
1800 default: 0
1801 - name: pageSize
1802 in: query
1803 required: true
1804 description: 分页-每页记录数
1805 schema:
1806 type: integer
1807 format: int32
1808 default: 20
1809 - name: mapBean
1810 in: query
1811 required: false
1812 description: 查询条件
1813 style: deepObject
1814 explode: true
1815 schema:
1816 type: object
1817 properties:
1818 keyword:
1819 title: 查询条件 - 关键字(模糊，帐号、姓名等)
1820 type: string
1821 accountName:
1822 title: 查询条件 - 账户名(模糊)
1823 type: string
1824 name:
1825 title: 查询条件 - 姓名(模糊)
1826 type: string
1827 responses:
1828 '200':
1829 description: 用户分页列表
1830 content:
1831 application/json:
1832 schema:
1833 $ref: '#/components/schemas/UserInfoPageResponse'
1834 default:
1835 $ref: '#/components/responses/DefaultErrorResponse'
1836
1837 '/labels/accountId/{accountId}/labels':
1838 get:
1839 summary: 获取帐号的用户标签
1840 operationId: listAccountLabels
1841 tags:
1842 - Label
1843 security:
1844 - oauth2:
1845 - "user:v1:readLabel"
1846 parameters:
1847 - name: accountId
1848 in: path
1849 required: true
1850 description: 帐号
1851 schema:
1852 type: string
1853 responses:
1854 '200':
1855 description: 用户标签
1856 content:
1857 application/json:
1858 schema:
1859 $ref: '#/components/schemas/LabelListResponse'
1860 default:
1861 $ref: '#/components/responses/DefaultErrorResponse'
1862
1863
1864
1865
1866 '/admin/posts/accountName/{accountName}/manOrganizations':
1867 get:
1868 summary: 根据帐号获取可管理的组织机构列表
1869 operationId: loadManOrganizationsByAccount
1870 tags:
1871 - PostAdmin
1872 security:
1873 - oauth2:
1874 - "user:v1:readPost"
1875 parameters:
1876 - name: accountName
1877 in: path
1878 required: true
1879 description: 帐号
1880 schema:
1881 type: string
1882 responses:
1883 '200':
1884 description: 岗位-组织机构-帐号关系的列表
1885 content:
1886 application/json:
1887 schema:
1888 $ref: '#/components/schemas/GroupOrganizationAccountListResponse'
1889 default:
1890 $ref: '#/components/responses/DefaultErrorResponse'
1891
1892 '/admin/posts/organizationId/{organizationId}/accountName/{accountName}/manPosts':
1893 get:
1894 summary: 根据组织机构Id、帐号获取该帐号在组织机构下的可管理岗位
1895 operationId: loadManPostsByOrganizationOfAccount
1896 tags:
1897 - PostAdmin
1898 security:
1899 - oauth2:
1900 - "user:v1:readPost"
1901 parameters:
1902 - name: organizationId
1903 in: path
1904 required: true
1905 description: 组织机构ID
1906 schema:
1907 type: string
1908 - name: accountName
1909 in: path
1910 required: true
1911 description: 帐号
1912 schema:
1913 type: string
1914 responses:
1915 '200':
1916 description: 岗位-组织机构设置的列表
1917 content:
1918 application/json:
1919 schema:
1920 $ref: '#/components/schemas/GroupOrganizationListResponse'
1921 default:
1922 $ref: '#/components/responses/DefaultErrorResponse'
1923
1924 '/admin/posts/organizationId/{organizationId}/posts':
1925 get:
1926 summary: 根据组织机构Id获取组织机构下的所有岗位
1927 operationId: loadPostsByOrganization
1928 tags:
1929 - PostAdmin
1930 security:
1931 - oauth2:
1932 - "user:v1:readPost"
1933 parameters:
1934 - name: organizationId
1935 in: path
1936 required: true
1937 description: 组织机构ID
1938 schema:
1939 type: string
1940 responses:
1941 '200':
1942 description: 岗位-组织机构设置的列表
1943 content:
1944 application/json:
1945 schema:
1946 $ref: '#/components/schemas/GroupOrganizationListResponse'
1947 default:
1948 $ref: '#/components/responses/DefaultErrorResponse'
1949
1950
1951 '/admin/posts/organizationId/{organizationId}/postAccounts':
1952 get:
1953 summary: 根据组织机构Id获取组织机构下的岗位人员
1954 operationId: listPostAccountsByOrganization
1955 tags:
1956 - PostAdmin
1957 security:
1958 - oauth2:
1959 - "user:v1:readPost"
1960 parameters:
1961 - name: organizationId
1962 in: path
1963 required: true
1964 description: 组织机构ID
1965 schema:
1966 type: string
1967 responses:
1968 '200':
1969 description: 岗位-组织机构-帐号关系的列表
1970 content:
1971 application/json:
1972 schema:
1973 $ref: '#/components/schemas/GroupOrganizationAccountListResponse'
1974 default:
1975 $ref: '#/components/responses/DefaultErrorResponse'
1976
1977 post:
1978 summary: 根据组织机构Id保存组织机构下的岗位人员
1979 operationId: savePostAccountsByOrganization
1980 tags:
1981 - PostAdmin
1982 security:
1983 - oauth2:
1984 - "user:v1:writePost"
1985 parameters:
1986 - name: organizationId
1987 in: path
1988 required: true
1989 description: 组织机构ID
1990 schema:
1991 type: string
1992 requestBody:
1993 description: 岗位-组织机构-帐号关系的列表
1994 required: true
1995 content:
1996 application/json:
1997 schema:
1998 $ref: '#/components/schemas/GroupOrganizationAccountSaveRequest'
1999 responses:
2000 '200':
2001 description: 保存结果
2002 content:
2003 application/json:
2004 schema:
2005 $ref: '#/components/schemas/GroupOrganizationAccountSaveResponse'
2006 default:
2007 $ref: '#/components/responses/DefaultErrorResponse'
2008
2009 '/admin/posts/organizationId/{organizationId}/group/{groupId}/accounts':
2010 post:
2011 summary: 根据组织机构Id、岗位Id保存人员
2012 operationId: saveAccountsByOrganizationPost
2013 tags:
2014 - PostAdmin
2015 security:
2016 - oauth2:
2017 - "user:v1:writePost"
2018 parameters:
2019 - name: organizationId
2020 in: path
2021 required: true
2022 description: 组织机构ID
2023 schema:
2024 type: string
2025 - name: groupId
2026 in: path
2027 required: true
2028 description: 岗位（用户组）ID
2029 schema:
2030 type: string
2031 requestBody:
2032 description: 岗位-组织机构-帐号关系的列表
2033 required: true
2034 content:
2035 application/json:
2036 schema:
2037 $ref: '#/components/schemas/GroupOrganizationAccountSaveRequest'
2038 responses:
2039 '200':
2040 description: 保存结果
2041 content:
2042 application/json:
2043 schema:
2044 $ref: '#/components/schemas/GroupOrganizationAccountSaveResponse'
2045 default:
2046 $ref: '#/components/responses/DefaultErrorResponse'
2047
2048components:
2049
2050 # Security Schemes
2051
2052 securitySchemes:
2053 oauth2:
2054 type: oauth2
2055 flows:
2056 clientCredentials:
2057 tokenUrl: ${POA_SERVER_URL}/oauth2/token
2058 scopes:
2059 "user:v1:readUser": "读取用户"
2060 "user:v1:readUserSecret": "读取用户私密信息"
2061 "user:v1:readOrganization": "读取组织机构"
2062 "user:v1:readGroup": "读取用户组"
2063 "user:v1:readLabel": "读取用户标签"
2064 "user:v1:readPost": "读取岗位"
2065 "user:v1:writePost": "写入岗位"
2066
2067 responses:
2068 'ErrorResponse400':
2069 description: unexpected error
2070 content:
2071 application/json:
2072 schema:
2073 $ref: '#/components/schemas/ErrorResponse'
2074
2075 DefaultErrorResponse:
2076 description: unexpected error
2077 content:
2078 application/json:
2079 schema:
2080 $ref: '#/components/schemas/ErrorResponse'
2081
2082 schemas:
2083
2084 # Error
2085
2086 ErrorResponse:
2087 title: '异常响应'
刘洪青f3b5fc82021-01-11 23:54:40 +0800[diff] [blame]2088 type: object
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2089 required:
2090 - code
2091 - message
2092 properties:
2093 code:
2094 title: 异常代码
2095 type: integer
2096 format: int32
2097 default: -1
2098 message:
2099 title: 异常信息
2100 type: string
2101 default: "未知错误"
2102
2103 # Entity
2104
2105 BaseEntity:
2106 title: 实体 - 基类
2107 type: object
2108 properties:
2109 id:
2110 title: ID
2111 type: string
2112 #companyId:
2113 # title: 'Company ID, 固定 1'
2114 # type: string
2115 # default: '1'
2116 #deleted:
2117 # title: 是否删除
2118 # type: boolean
2119 # default: false
2120 #addAccount:
2121 # title: 创建人
2122 # type: string
2123 #addTime:
2124 # title: 创建时间
2125 # type: string
2126 # format: date-time
2127 #editAccount:
2128 # title: 修改人
2129 # type: string
2130 #editTime:
2131 # title: 修改时间
2132 # type: string
2133 # format: date-time
2134 #deleteAccount:
2135 # title: 删除人
2136 # type: string
2137 #deleteTime:
2138 # title: 删除时间
2139 # type: string
2140 # format: date-time
2141 #isDataCenter:
2142 # title: 是否来源数据中心
2143 # type: boolean
2144 # default: false
2145
2146 DictionaryType:
2147 title: 实体 - 字典
2148 allOf:
2149 - $ref: '#/components/schemas/BaseEntity'
2150 - type: object
2151 title: 实体属性
2152 properties:
2153 code:
2154 title: 代码
2155 type: string
2156 name:
2157 title: 名称
2158 type: string
2159 enable:
2160 title: 是否启用
2161 type: boolean
2162 default: true
2163 sort:
2164 title: 排序
2165 type: integer
2166 format: int64
2167 multiLevel:
2168 title: 是否多层级
2169 type: boolean
2170
2171 Dictionary:
2172 title: 实体 - 字典
2173 allOf:
2174 - $ref: '#/components/schemas/BaseEntity'
2175 - type: object
2176 title: 实体属性
2177 properties:
2178 code:
2179 title: 代码
2180 type: string
2181 name:
2182 title: 名称
2183 type: string
2184 enable:
2185 title: 是否启用
2186 type: boolean
2187 default: true
2188 sort:
2189 title: 排序
2190 type: integer
2191 format: int64
2192 dictionaryType:
2193 title: 字典类型
2194 allOf:
2195 - $ref: '#/components/schemas/DictionaryType'
2196 parentDictionary:
2197 title: 父字典
2198 allOf:
2199 - $ref: '#/components/schemas/Dictionary'
2200
2201 IdentityType:
2202 title: 实体 - 字典
2203 allOf:
2204 - $ref: '#/components/schemas/BaseEntity'
2205 - type: object
2206 title: 实体属性
2207 properties:
2208 code:
2209 title: 代码
2210 type: string
2211 name:
2212 title: 名称
2213 type: string
2214 enable:
2215 title: 是否启用
2216 type: boolean
2217 sort:
2218 title: 排序
2219 type: integer
2220 format: int64
2221 parentIdentityType:
2222 title: 父身份类型
2223 allOf:
2224 - $ref: '#/components/schemas/IdentityType'
2225
2226 User:
2227 title: 实体 - 用户
2228 allOf:
2229 - $ref: '#/components/schemas/BaseEntity'
2230 - type: object
2231 title: 实体属性
2232 properties:
2233 uid:
2234 title: 用户标识
2235 type: string
2236 passWord:
2237 title: 密码
2238 type: string
2239 name:
2240 title: 名称
2241 type: string
2242 fullNameSpelling:
2243 title: 姓名全拼,根据姓名生成
2244 type: string
2245 nameSpelling:
2246 title: 姓名简拼,根据姓名生成
2247 type: string
2248 email:
2249 title: 名称
2250 type: string
2251 phoneNumber:
2252 title: 名称
2253 type: string
2254 imageUrl:
2255 title: 个人照片地址
2256 type: string
2257 certificateType:
2258 title: 证件类型
2259 allOf:
2260 - $ref: '#/components/schemas/Dictionary'
2261 certificateNumber:
2262 title: 证件号码
2263 type: string
2264 gender:
2265 title: 性别
2266 allOf:
2267 - $ref: '#/components/schemas/Dictionary'
2268 nation:
2269 title: 民族
2270 allOf:
2271 - $ref: '#/components/schemas/Dictionary'
2272 country:
2273 title: 国家
2274 allOf:
2275 - $ref: '#/components/schemas/Dictionary'
2276 address:
2277 title: 地址
2278 allOf:
2279 - $ref: '#/components/schemas/Dictionary'
2280
2281 Organization:
2282 title: 实体 - 组织机构
2283 allOf:
2284 - $ref: '#/components/schemas/BaseEntity'
2285 - type: object
2286 title: 实体属性
2287 properties:
2288 code:
2289 title: 代码
2290 type: string
2291 name:
2292 title: 名称
2293 type: string
2294 enable:
2295 title: 是否启用
2296 type: boolean
2297 sort:
2298 title: 排序
2299 type: integer
2300 format: int64
2301 state:
2302 title: 状态
2303 type: integer
2304 format: int32
2305 type:
2306 title: 类型
2307 allOf:
2308 - $ref: '#/components/schemas/Dictionary'
2309 parentOrganization:
2310 title: 所属的父级组织机构
2311 allOf:
2312 - $ref: '#/components/schemas/Organization'
2313
2314 Account:
2315 title: 实体 - 帐号
2316 allOf:
2317 - $ref: '#/components/schemas/BaseEntity'
2318 - type: object
2319 title: 实体属性
2320 properties:
2321 accountName:
2322 title: 帐号
2323 type: string
2324 state:
2325 title: 状态
2326 type: string
2327 activation:
2328 title: 是否激活
2329 type: boolean
2330 accountExpiryDate:
2331 title: 失效时间
2332 type: string
2333 format: date-time
2334 identityType:
2335 title: 身份
2336 allOf:
2337 - $ref: '#/components/schemas/IdentityType'
2338 organization:
2339 title: 组织机构
2340 allOf:
2341 - $ref: '#/components/schemas/Organization'
2342 user:
2343 title: 用户信息
2344 allOf:
2345 - $ref: '#/components/schemas/User'
2346
2347
2348 # Model
2349
2350 UserInfoModel:
2351 title: 用户信息
2352 type: object
2353 properties:
2354 id:
2355 title: 账号Id(弃用，请用accountId)
2356 type: string
2357 accountId:
2358 title: 账号Id
2359 type: string
2360 accountName:
2361 title: 帐号
2362 type: string
2363 identityTypeId:
2364 title: 身份（ID）
2365 type: string
2366 identityTypeCode:
2367 title: 身份（代码）
2368 type: string
2369 identityTypeName:
2370 title: 身份（名称）
2371 type: string
2372 organizationId:
2373 title: 组织机构（ID）
2374 type: string
2375 organizationCode:
2376 title: 组织机构（代码）
2377 type: string
2378 organizationName:
2379 title: 组织机构（名称）
2380 type: string
2381 userId:
2382 title: 用户Id
2383 type: string
2384 uid:
2385 title: 用户号（弃用，应该userNo）
2386 type: string
2387 userNo:
2388 title: 用户号
2389 type: string
2390 name:
2391 title: 姓名
2392 type: string
2393 fullNameSpelling:
2394 title: 姓名全拼,根据姓名生成
2395 type: string
2396 nameSpelling:
2397 title: 姓名简拼,根据姓名生成
2398 type: string
2399 email:
刘洪青83c44f32021-01-01 12:15:55 +0800[diff] [blame]2400 title: 邮箱（注意不是安全邮箱）（弃用）
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2401 type: string
2402 phoneNumber:
刘洪青83c44f32021-01-01 12:15:55 +0800[diff] [blame]2403 title: 手机号（注意不是安全手机）（弃用）
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2404 type: string
2405 imageUrl:
刘洪青83c44f32021-01-01 12:15:55 +0800[diff] [blame]2406 title: 个人照片地址（弃用）
2407 type: string
2408 portraitUrl:
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2409 title: 个人照片地址
2410 type: string
2411 certificateTypeId:
刘洪青83c44f32021-01-01 12:15:55 +0800[diff] [blame]2412 title: 证件类型（ID）（弃用）
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2413 type: string
2414 certificateTypeCode:
刘洪青83c44f32021-01-01 12:15:55 +0800[diff] [blame]2415 title: 证件类型（代码）（弃用）
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2416 type: string
2417 certificateTypeName:
刘洪青83c44f32021-01-01 12:15:55 +0800[diff] [blame]2418 title: 证件类型（名称）（弃用）
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2419 type: string
2420 certificateNumber:
刘洪青83c44f32021-01-01 12:15:55 +0800[diff] [blame]2421 title: 证件号码（弃用）
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2422 type: string
2423 genderId:
2424 title: 性别（ID）
2425 type: string
2426 genderCode:
2427 title: 性别（代码）
2428 type: string
2429 genderName:
2430 title: 性别（名称）
2431 type: string
2432 nationId:
2433 title: 民族（ID）
2434 type: string
2435 nationCode:
2436 title: 民族（代码）
2437 type: string
2438 nationName:
2439 title: 民族（名称）
2440 type: string
2441 countryId:
2442 title: 国家（ID）
2443 type: string
2444 countryCode:
2445 title: 国家（代码）
2446 type: string
2447 countryName:
2448 title: 国家（名称）
2449 type: string
2450 addressId:
2451 title: 地址（ID）
2452 type: string
2453 addressCode:
2454 title: 地址（代码）
2455 type: string
2456 addressName:
2457 title: 地址（名称）
2458 type: string
2459
2460 OrganizationModel:
2461 title: 组织机构信息
2462 type: object
2463 properties:
2464 id:
2465 title: ID
2466 type: string
2467 code:
2468 title: 代码
2469 type: string
2470 name:
2471 title: 名称
2472 type: string
2473 description:
2474 title: 描述
2475 type: string
2476 isRootOrganization:
2477 title: 是否根组织机构
2478 type: string
2479 rootOrganizationId:
2480 title: 所在根组织机构（ID）
2481 type: string
2482 parentId:
2483 title: 父级组织机构（ID）
2484 type: string
2485 parentCode:
2486 title: 父级组织机构（代码）
2487 type: string
2488 parentName:
2489 title: 父级组织机构（名称）
2490 type: string
2491 typeId:
2492 title: 类型（ID）
2493 type: string
2494 typeName:
2495 title: 类型（名称）
2496 type: string
2497
2498 GroupModel:
2499 title: 用户组信息
2500 type: object
2501 properties:
2502 id:
2503 title: ID
2504 type: string
2505 code:
2506 title: 代码
2507 type: string
2508 name:
2509 title: 名称
2510 type: string
2511 description:
2512 title: 描述
2513 type: string
2514 type:
2515 title: 类型（1 普通用户组，2 岗位用户组）
2516 type: string
2517
2518 LabelModel:
2519 title: 用户标签信息
2520 type: object
2521 properties:
2522 id:
2523 title: ID
2524 type: string
2525 name:
2526 title: 名称
2527 type: string
2528 description:
2529 title: 描述
2530 type: string
2531
2532 GroupOrganizationModel:
2533 title: 岗位组织机构设置信息
2534 type: object
2535 properties:
2536 id:
2537 title: ID
2538 type: string
2539 groupId:
2540 title: 用户组（岗位）ID
2541 type: string
2542 organizationId:
2543 title: 组织机构ID
2544 type: string
2545
2546 groupCode:
2547 title: 用户组（岗位）代码
2548 type: string
2549 groupName:
2550 title: 用户组（岗位）名称
2551 type: string
2552 groupDescription:
2553 title: 用户组（岗位）描述
2554 type: string
2555 organizationCode:
2556 title: 组织机构代码
2557 type: string
2558 organizationName:
2559 title: 组织机构名称
2560 type: string
2561 organizationDescription:
2562 title: 组织机构描述
2563 type: string
2564
2565 GroupOrganizationAccountModel:
2566 title: 岗位组织机构帐号信息
2567 type: object
2568 properties:
2569 id:
2570 title: ID
2571 type: string
2572 groupId:
2573 title: 用户组（岗位）ID
2574 type: string
2575 organizationId:
2576 title: 组织机构ID
2577 type: string
2578 accountId:
2579 title: 帐号ID
2580 type: string
2581
2582 groupCode:
2583 title: 用户组（岗位）代码
2584 type: string
2585 groupName:
2586 title: 用户组（岗位）名称
2587 type: string
2588 organizationCode:
2589 title: 组织机构代码
2590 type: string
2591 organizationName:
2592 title: 组织机构名称
2593 type: string
2594 accountName:
2595 title: 帐号
2596 type: string
2597 userName:
2598 title: 用户姓名
2599 type: string
2600
2601 accountOrganizationId:
2602 title: 帐号的组织机构ID
2603 type: string
2604 accountOrganizationCode:
2605 title: 帐号的组织机构代码
2606 type: string
2607 accountOrganizationName:
2608 title: 帐号的组织机构名称
2609 type: string
2610
2611
2612 # Request VO
2613 GroupOrganizationAccountSaveRequest:
2614 title: 请求
刘洪青f3b5fc82021-01-11 23:54:40 +0800[diff] [blame]2615 type: object
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2616 properties:
2617 groupOrganizatonAccounts:
2618 title: 岗位组织机构帐号信息列表
2619 type: array
2620 items:
2621 $ref: '#/components/schemas/GroupOrganizationAccountModel'
2622
2623
2624 # Response Data
2625
2626
2627 # Response VO
2628
2629 AbstractApiResponse:
2630 title: 响应
刘洪青f3b5fc82021-01-11 23:54:40 +0800[diff] [blame]2631 type: object
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2632 properties:
2633 acknowleged:
2634 title: 响应结果
2635 type: boolean
2636 default: true
2637 code:
2638 title: 响应代码
2639 type: integer
2640 format: int32
2641 default: 0
2642 message:
2643 title: 响应信息
2644 type: string
2645 DefaultApiResponse:
2646 allOf:
2647 - $ref: '#/components/schemas/AbstractApiResponse'
2648 - type: object
2649 title: 响应数据
2650 properties:
2651 data:
2652 title: 响应数据
2653 type: object
2654
2655
2656 UserInfoPageResponse:
2657 allOf:
2658 - $ref: '#/components/schemas/DefaultApiResponse'
2659 - type: object
2660 title: 响应数据
2661 properties:
2662 data:
2663 allOf:
2664 - type: object
2665 title: 分页数据
2666 properties:
2667 pageCount:
2668 title: 分页总数
2669 type: integer
2670 format: int32
2671 totalCount:
2672 title: 记录总数
2673 type: integer
2674 format: int64
2675 currentItemCount:
2676 title: 当前返回记录数
2677 type: integer
2678 format: int32
2679 items:
2680 title: 当前返回记录集
2681 type: array
2682 items:
2683 $ref: '#/components/schemas/UserInfoModel'
2684
刘洪青61e63732020-10-19 20:00:04 +0800[diff] [blame]2685 UserTotalCountResponse:
2686 allOf:
2687 - $ref: '#/components/schemas/DefaultApiResponse'
2688 - type: object
2689 title: 响应数据
2690 properties:
2691 data:
2692 allOf:
2693 - type: object
2694 title: 结果
2695 properties:
2696 totalCount:
2697 title: 用户总数
2698 type: integer
2699 format: int32
2700
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2701 UserInfoLoadResponse:
2702 allOf:
2703 - $ref: '#/components/schemas/DefaultApiResponse'
2704 - type: object
2705 title: 响应数据
2706 properties:
2707 data:
2708 allOf:
2709 - $ref: '#/components/schemas/UserInfoModel'
2710
2711 UserInfoListResponse:
2712 allOf:
2713 - $ref: '#/components/schemas/DefaultApiResponse'
2714 - type: object
2715 title: 响应数据
2716 properties:
2717 data:
2718 allOf:
2719 - type: object
2720 title: 列表数据
2721 properties:
2722 items:
2723 title: 当前返回记录集
2724 type: array
2725 items:
2726 $ref: '#/components/schemas/UserInfoModel'
2727
2728 UserPortraitLoadResponse:
2729 allOf:
2730 - $ref: '#/components/schemas/DefaultApiResponse'
2731 - type: object
2732 title: 响应数据
2733 properties:
2734 data:
2735 allOf:
2736 - type: object
2737 title: 列表数据
2738 properties:
2739 portraitBase64:
2740 title: 头像数据（Base64）
2741 type: string
2742 UserSafety:
2743 type: object
2744 title: 安全信息
2745 properties:
2746 userId:
2747 title: 用户Id
2748 type: string
2749 accountId:
2750 title: 账号Id
2751 type: string
2752 accountName:
2753 title: 账号名
2754 type: string
2755 securePhone:
2756 title: 安全手机
2757 type: string
2758 secureEmail:
2759 title: 安全邮箱
2760 type: string
2761
2762 UserSafetyList:
2763 allOf:
2764 - $ref: '#/components/schemas/DefaultApiResponse'
2765 - type: object
2766 title: 响应数据
2767 properties:
2768 data:
2769 allOf:
2770 - type: object
2771 title: 列表数据
2772 properties:
2773 items:
2774 title: 当前返回记录集
2775 type: array
2776 items:
2777 $ref: '#/components/schemas/UserSafety'
2778
2779 UserSafetyPhoneNumber:
2780 type: object
2781 title: 安全手机
2782 properties:
2783 userId:
2784 title: 用户Id
2785 type: string
2786 accountId:
2787 title: 账号Id
2788 type: string
2789 accountName:
2790 title: 账号名
2791 type: string
2792 securePhone:
2793 title: 安全手机
2794 type: string
2795
2796 UserSafetyPhoneNumberList:
2797 allOf:
2798 - $ref: '#/components/schemas/DefaultApiResponse'
2799 - type: object
2800 title: 响应数据
2801 properties:
2802 data:
2803 allOf:
2804 - type: object
2805 title: 列表数据
2806 properties:
2807 items:
2808 title: 当前返回记录集
2809 type: array
2810 items:
2811 $ref: '#/components/schemas/UserSafetyPhoneNumber'
2812
2813 UserSafetyEmail:
2814 type: object
2815 title: 安全邮箱
2816 properties:
2817 userId:
2818 title: 用户Id
2819 type: string
2820 accountId:
2821 title: 账号Id
2822 type: string
2823 accountName:
2824 title: 账号名
2825 type: string
2826 secureEmail:
2827 title: 安全邮箱
2828 type: string
2829
2830 UserSafetyEmailList:
2831 allOf:
2832 - $ref: '#/components/schemas/DefaultApiResponse'
2833 - type: object
2834 title: 响应数据
2835 properties:
2836 data:
2837 allOf:
2838 - type: object
2839 title: 列表数据
2840 properties:
2841 items:
2842 title: 当前返回记录集
2843 type: array
2844 items:
2845 $ref: '#/components/schemas/UserSafetyEmail'
2846
2847 UserSafetyLoadResponse:
2848 allOf:
2849 - $ref: '#/components/schemas/DefaultApiResponse'
2850 - type: object
2851 title: 响应数据
2852 properties:
2853 data:
2854 allOf:
2855 - $ref: '#/components/schemas/UserSafety'
2856
2857 UserFederation:
2858 type: object
2859 title: 联合登录信息
2860 properties:
2861 userId:
2862 title: 用户Id
2863 type: string
2864 accountId:
2865 title: 账号Id
2866 type: string
2867 accountName:
2868 title: 账号名
2869 type: string
2870 federatedType:
2871 title: 联合登录类型
2872 type: string
2873 enum:
2874 - qq
2875 - openweixin
2876 - workweixin
2877 - alipay
2878 - dingtalk
2879 federatedId:
2880 title: 联合登录ID
2881 type: string
2882
2883 UserFederationList:
2884 allOf:
2885 - $ref: '#/components/schemas/DefaultApiResponse'
2886 - type: object
2887 title: 响应数据
2888 properties:
2889 data:
2890 allOf:
2891 - type: object
2892 title: 列表数据
2893 properties:
2894 items:
2895 title: 当前返回记录集
2896 type: array
2897 items:
2898 $ref: '#/components/schemas/UserFederation'
2899
2900 UserFederationLoadResponse:
2901 allOf:
2902 - $ref: '#/components/schemas/DefaultApiResponse'
2903 - type: object
2904 title: 响应数据
2905 properties:
2906 data:
2907 allOf:
2908 - $ref: '#/components/schemas/UserFederation'
2909
2910 RootOrganizationListResponse:
2911 allOf:
2912 - $ref: '#/components/schemas/DefaultApiResponse'
2913 - type: object
2914 title: 响应数据
2915 properties:
2916 data:
2917 allOf:
2918 - type: object
2919 title: 列表数据
2920 properties:
2921 items:
2922 title: 当前返回记录集
2923 type: array
2924 items:
2925 $ref: '#/components/schemas/OrganizationModel'
2926
2927 OrganizationListResponse:
2928 allOf:
2929 - $ref: '#/components/schemas/DefaultApiResponse'
2930 - type: object
2931 title: 响应数据
2932 properties:
2933 data:
2934 allOf:
2935 - type: object
2936 title: 列表数据
2937 properties:
2938 items:
2939 title: 当前返回记录集
2940 type: array
2941 items:
2942 $ref: '#/components/schemas/OrganizationModel'
2943
2944 OrganizationLoadResponse:
2945 allOf:
2946 - $ref: '#/components/schemas/DefaultApiResponse'
2947 - type: object
2948 title: 响应数据
2949 properties:
2950 data:
2951 allOf:
2952 - $ref: '#/components/schemas/OrganizationModel'
2953
2954
2955 GroupPageResponse:
2956 allOf:
2957 - $ref: '#/components/schemas/DefaultApiResponse'
2958 - type: object
2959 title: 响应数据
2960 properties:
2961 data:
2962 allOf:
2963 - type: object
2964 title: 分页数据
2965 properties:
2966 pageCount:
2967 title: 分页总数
2968 type: integer
2969 format: int32
2970 totalCount:
2971 title: 记录总数
2972 type: integer
2973 format: int64
2974 currentItemCount:
2975 title: 当前返回记录数
2976 type: integer
2977 format: int32
2978 items:
2979 title: 当前返回记录集
2980 type: array
2981 items:
2982 $ref: '#/components/schemas/GroupModel'
2983
2984 GroupListResponse:
2985 allOf:
2986 - $ref: '#/components/schemas/DefaultApiResponse'
2987 - type: object
2988 title: 响应数据
2989 properties:
2990 data:
2991 allOf:
2992 - type: object
2993 title: 列表数据
2994 properties:
2995 items:
2996 title: 当前返回记录集
2997 type: array
2998 items:
2999 $ref: '#/components/schemas/GroupModel'
3000
3001 GroupLoadResponse:
3002 allOf:
3003 - $ref: '#/components/schemas/DefaultApiResponse'
3004 - type: object
3005 title: 响应数据
3006 properties:
3007 data:
3008 allOf:
3009 - $ref: '#/components/schemas/GroupModel'
3010
3011 AccountGroupResponse:
3012 allOf:
3013 - $ref: '#/components/schemas/DefaultApiResponse'
3014 - type: object
3015 title: 响应数据
3016 properties:
3017 data:
3018 allOf:
3019 - type: object
3020 title: 列表数据
3021 properties:
3022 accountGroupId:
3023 title: 帐号用户组ID
3024 type: string
3025
3026 GroupOrganizationAccountListResponse:
3027 allOf:
3028 - $ref: '#/components/schemas/DefaultApiResponse'
3029 - type: object
3030 title: 响应数据
3031 properties:
3032 data:
3033 allOf:
3034 - type: object
3035 title: 列表数据
3036 properties:
3037 items:
3038 title: 当前返回记录集
3039 type: array
3040 items:
3041 $ref: '#/components/schemas/GroupOrganizationAccountModel'
3042
3043 GroupOrganizationAccountResponse:
3044 allOf:
3045 - $ref: '#/components/schemas/DefaultApiResponse'
3046 - type: object
3047 title: 响应数据
3048 properties:
3049 data:
3050 allOf:
3051 - type: object
3052 title: 列表数据
3053 properties:
3054 groupOrganizationAccountId:
3055 title: 岗位组织机构帐号的关系ID
3056 type: string
3057
3058 LabelPageResponse:
3059 allOf:
3060 - $ref: '#/components/schemas/DefaultApiResponse'
3061 - type: object
3062 title: 响应数据
3063 properties:
3064 data:
3065 allOf:
3066 - type: object
3067 title: 分页数据
3068 properties:
3069 pageCount:
3070 title: 分页总数
3071 type: integer
3072 format: int32
3073 totalCount:
3074 title: 记录总数
3075 type: integer
3076 format: int64
3077 currentItemCount:
3078 title: 当前返回记录数
3079 type: integer
3080 format: int32
3081 items:
3082 title: 当前返回记录集
3083 type: array
3084 items:
3085 $ref: '#/components/schemas/LabelModel'
3086
3087 LabelListResponse:
3088 allOf:
3089 - $ref: '#/components/schemas/DefaultApiResponse'
3090 - type: object
3091 title: 响应数据
3092 properties:
3093 data:
3094 allOf:
3095 - type: object
3096 title: 列表数据
3097 properties:
3098 items:
3099 title: 当前返回记录集
3100 type: array
3101 items:
3102 $ref: '#/components/schemas/LabelModel'
3103
3104 LabelLoadResponse:
3105 allOf:
3106 - $ref: '#/components/schemas/DefaultApiResponse'
3107 - type: object
3108 title: 响应数据
3109 properties:
3110 data:
3111 allOf:
3112 - $ref: '#/components/schemas/LabelModel'
3113
3114 AccountLabelResponse:
3115 allOf:
3116 - $ref: '#/components/schemas/DefaultApiResponse'
3117 - type: object
3118 title: 响应数据
3119 properties:
3120 data:
3121 allOf:
3122 - type: object
3123 title: 列表数据
3124 properties:
3125 accountLabelId:
3126 title: 帐号标签ID
3127 type: string
3128
3129
3130 GroupOrganizationListResponse:
3131 allOf:
3132 - $ref: '#/components/schemas/DefaultApiResponse'
3133 - type: object
3134 title: 响应数据
3135 properties:
3136 data:
3137 allOf:
3138 - type: object
3139 title: 列表数据
3140 properties:
3141 items:
3142 title: 当前返回记录集
3143 type: array
3144 items:
3145 $ref: '#/components/schemas/GroupOrganizationModel'
3146
3147 GroupOrganizationAccountSaveResponse:
3148 allOf:
3149 - $ref: '#/components/schemas/DefaultApiResponse'
3150 - type: object
3151 title: 响应数据
3152 properties:
3153 data:
3154 allOf:
3155 - type: object
3156 title: 列表数据
3157 properties:
3158 message:
3159 title: 保存结果
3160 type: string