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