Gitiles
Code Review Sign In
source.supwisdom.com / institute / deploy-authx-service / refs/heads/1.5.x / . / poa-api-docs / api-docs / user-data-service-poa.v1.yaml
blob: 6624a5e7ee75d23a129255cc44093bfca5f7b6e2 [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
刘洪青bdf33af2021-05-08 17:13:24 +0800[diff] [blame]874 '/organizations/{organizationId}/organizationChain':
875 get:
876 summary: 根据组织机构ID获取组织机构链
877 operationId: getOrganizationChain
878 tags:
879 - Organization
880 security:
881 - oauth2:
882 - "user:v1:readOrganization"
883 parameters:
884 - name: organizationId
885 in: path
886 required: true
887 description: 组织机构ID
888 schema:
889 type: string
890 responses:
891 '200':
892 description: 组织机构信息
893 content:
894 application/json:
895 schema:
896 $ref: '#/components/schemas/OrganizationListResponse'
897 default:
898 $ref: '#/components/responses/DefaultErrorResponse'
899
900 '/organizations/organizationCode/{organizationCode}/organizationChain':
901 get:
902 summary: 根据组织机构代码获取组织机构链
903 operationId: getOrganizationChainByCode
904 tags:
905 - Organization
906 security:
907 - oauth2:
908 - "user:v1:readOrganization"
909 parameters:
910 - name: organizationCode
911 in: path
912 required: true
913 description: 组织机构代码
914 schema:
915 type: string
916 responses:
917 '200':
918 description: 组织机构信息
919 content:
920 application/json:
921 schema:
922 $ref: '#/components/schemas/OrganizationListResponse'
923 default:
924 $ref: '#/components/responses/DefaultErrorResponse'
925
926
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]927 '/organizations/{organizationId}/users':
928 get:
929 summary: 获取组织机构下的用户列表（弃用）
930 description: 弃用，应该使用 /organizations/users
931 operationId: listUsersByOrganization
932 tags:
933 - Organization
934 security:
935 - oauth2:
936 - "user:v1:readOrganization"
937 parameters:
938 - name: organizationId
939 in: path
940 required: true
941 description: 组织机构ID
942 schema:
943 type: string
944 - name: pageIndex
945 in: query
946 required: true
947 description: 分页-页码
948 schema:
949 type: integer
950 format: int32
951 default: 0
952 - name: pageSize
953 in: query
954 required: true
955 description: 分页-每页记录数
956 schema:
957 type: integer
958 format: int32
959 default: 20
960 - name: mapBean
961 in: query
962 required: false
963 description: 查询条件
964 style: deepObject
965 explode: true
966 schema:
967 type: object
968 properties:
969 keyword:
970 title: 查询条件 - 关键字(模糊，帐号、姓名等)
971 type: string
972 accountName:
973 title: 查询条件 - 账户名(模糊)
974 type: string
975 name:
976 title: 查询条件 - 姓名(模糊)
977 type: string
978 responses:
979 '200':
980 description: 用户分页列表
981 content:
982 application/json:
983 schema:
984 $ref: '#/components/schemas/UserInfoPageResponse'
985 default:
986 $ref: '#/components/responses/DefaultErrorResponse'
987
988 '/organizations/{organizationId}/allSub/users':
989 get:
990 summary: 获取组织机构(及其子集)下的用户列表（弃用）
991 description: 弃用，应该使用 /organizations/users
992 operationId: listUsersByOrganizationAllSub
993 tags:
994 - Organization
995 security:
996 - oauth2:
997 - "user:v1:readOrganization"
998 parameters:
999 - name: organizationId
1000 in: path
1001 required: true
1002 description: 组织机构ID
1003 schema:
1004 type: string
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 keyword:
1031 title: 查询条件 - 关键字(模糊，帐号、姓名等)
1032 type: string
1033 accountName:
1034 title: 查询条件 - 账户名(模糊)
1035 type: string
1036 name:
1037 title: 查询条件 - 姓名(模糊)
1038 type: string
1039 responses:
1040 '200':
1041 description: 用户分页列表
1042 content:
1043 application/json:
1044 schema:
1045 $ref: '#/components/schemas/UserInfoPageResponse'
1046 default:
1047 $ref: '#/components/responses/DefaultErrorResponse'
1048
1049 '/organizations/users':
1050 get:
1051 summary: 获取组织机构下的用户列表
1052 description: organizationId和organizationCode二选一
1053 operationId: listOrganizationUsers
1054 tags:
1055 - Organization
1056 security:
1057 - oauth2:
1058 - "user:v1:readOrganization"
1059 parameters:
1060 - name: organizationId
1061 in: query
1062 description: 组织机构Id
1063 schema:
1064 type: string
1065 - name: organizationCode
1066 in: query
1067 description: 组织机构Code
1068 schema:
1069 type: string
1070 - name: fetchSub
1071 in: query
1072 description: 是否包含子组织机构的用户
1073 schema:
1074 type: boolean
1075 default: false
1076 - name: pageIndex
1077 in: query
1078 required: true
1079 description: 分页-页码
1080 schema:
1081 type: integer
1082 format: int32
1083 default: 0
1084 - name: pageSize
1085 in: query
1086 required: true
1087 description: 分页-每页记录数
1088 schema:
1089 type: integer
1090 format: int32
1091 default: 20
1092 - name: mapBean
1093 in: query
1094 required: false
1095 description: 查询条件
1096 style: deepObject
1097 explode: true
1098 schema:
1099 type: object
1100 properties:
1101 keyword:
1102 title: 查询条件 - 关键字(模糊，帐号、姓名等)
1103 type: string
1104 accountName:
1105 title: 查询条件 - 账户名(模糊)
1106 type: string
1107 name:
1108 title: 查询条件 - 姓名(模糊)
1109 type: string
1110 responses:
1111 '200':
1112 description: 用户分页列表
1113 content:
1114 application/json:
1115 schema:
1116 $ref: '#/components/schemas/UserInfoPageResponse'
1117 default:
1118 $ref: '#/components/responses/DefaultErrorResponse'
1119
1120 '/organizations/accountId/{accountId}/rootOrganization/{rootOrganizationId}/organizationChain':
1121 get:
1122 summary: 获取帐号在根组织机构下的所属组织机构
1123 operationId: getAccountOrganizationsOfRoot
1124 tags:
1125 - Organization
1126 security:
1127 - oauth2:
1128 - "user:v1:readOrganization"
1129 parameters:
1130 - name: rootOrganizationId
1131 in: path
1132 required: true
1133 description: 根组织机构ID
1134 schema:
1135 type: string
1136 - name: accountId
1137 in: path
1138 required: true
1139 description: 帐号
1140 schema:
1141 type: string
1142 responses:
1143 '200':
1144 description: 组织机构列表
1145 content:
1146 application/json:
1147 schema:
1148 $ref: '#/components/schemas/OrganizationListResponse'
1149 default:
1150 $ref: '#/components/responses/DefaultErrorResponse'
1151
1152
1153 '/groups':
1154 get:
1155 summary: 获取用户组（所有）的列表
1156 operationId: pageGroups
1157 tags:
1158 - Group
1159 security:
1160 - oauth2:
1161 - "user:v1:readGroup"
1162 parameters:
1163 - name: pageIndex
1164 in: query
1165 required: true
1166 description: 分页-页码
1167 schema:
1168 type: integer
1169 format: int32
1170 default: 0
1171 - name: pageSize
1172 in: query
1173 required: true
1174 description: 分页-每页记录数
1175 schema:
1176 type: integer
1177 format: int32
1178 default: 20
1179 - name: mapBean
1180 in: query
1181 required: false
1182 description: 查询条件
1183 style: deepObject
1184 explode: true
1185 schema:
1186 type: object
1187 properties:
1188 ids:
1189 title: 查询条件 - IDs(多个用逗号隔开)
1190 type: string
1191 keyword:
1192 title: 查询条件 - 关键字(模糊，名称、描述等)
1193 type: string
1194 name:
1195 title: 查询条件 - 名称(模糊)
1196 type: string
1197 description:
1198 title: 查询条件 - 描述(模糊)
1199 type: string
1200 type:
1201 title: 查询条件 - 类型(精确，1 普通用户组，2 岗位用户组)
1202 type: string
1203 responses:
1204 '200':
1205 description: 用户组分页列表
1206 content:
1207 application/json:
1208 schema:
1209 $ref: '#/components/schemas/GroupPageResponse'
1210 default:
1211 $ref: '#/components/responses/DefaultErrorResponse'
1212
1213 '/groups/{groupId}':
1214 get:
1215 summary: 根据用户组ID获取用户组（所有）的基本信息
1216 operationId: getGroup
1217 tags:
1218 - Group
1219 security:
1220 - oauth2:
1221 - "user:v1:readGroup"
1222 parameters:
1223 - name: groupId
1224 in: path
1225 required: true
1226 description: 用户组ID
1227 schema:
1228 type: string
1229 responses:
1230 '200':
1231 description: 用户组信息
1232 content:
1233 application/json:
1234 schema:
1235 $ref: '#/components/schemas/GroupLoadResponse'
1236 default:
1237 $ref: '#/components/responses/DefaultErrorResponse'
1238
1239 '/groups/groupCode/{groupCode}':
1240 get:
1241 summary: 根据用户组代码获取用户组（所有）的基本信息
1242 operationId: getGroupByCode
1243 tags:
1244 - Group
1245 security:
1246 - oauth2:
1247 - "user:v1:readGroup"
1248 parameters:
1249 - name: groupCode
1250 in: path
1251 required: true
1252 description: 用户组代码
1253 schema:
1254 type: string
1255 responses:
1256 '200':
1257 description: 用户组信息
1258 content:
1259 application/json:
1260 schema:
1261 $ref: '#/components/schemas/GroupLoadResponse'
1262 default:
1263 $ref: '#/components/responses/DefaultErrorResponse'
1264
1265
1266 '/groups/{groupId}/users':
1267 get:
1268 summary: 获取用户组（所有）下的用户列表（弃用）
1269 description: 弃用，应该使用 /groups/users
1270 operationId: listUsersByGroup
1271 tags:
1272 - Group
1273 security:
1274 - oauth2:
1275 - "user:v1:readGroup"
1276 parameters:
1277 - name: groupId
1278 in: path
1279 required: true
1280 description: 用户组ID
1281 schema:
1282 type: string
1283 - name: pageIndex
1284 in: query
1285 required: true
1286 description: 分页-页码
1287 schema:
1288 type: integer
1289 format: int32
1290 default: 0
1291 - name: pageSize
1292 in: query
1293 required: true
1294 description: 分页-每页记录数
1295 schema:
1296 type: integer
1297 format: int32
1298 default: 20
1299 - name: mapBean
1300 in: query
1301 required: false
1302 description: 查询条件
1303 style: deepObject
1304 explode: true
1305 schema:
1306 type: object
1307 properties:
1308 keyword:
1309 title: 查询条件 - 关键字(模糊，帐号、姓名等)
1310 type: string
1311 accountName:
1312 title: 查询条件 - 账户名(模糊)
1313 type: string
1314 name:
1315 title: 查询条件 - 姓名(模糊)
1316 type: string
1317 responses:
1318 '200':
1319 description: 用户分页列表
1320 content:
1321 application/json:
1322 schema:
1323 $ref: '#/components/schemas/UserInfoPageResponse'
1324 default:
1325 $ref: '#/components/responses/DefaultErrorResponse'
1326
1327 '/groups/users':
1328 get:
1329 summary: 获取用户组（所有）下的用户列表
1330 description: groupId和groupCode二选一
1331 operationId: listGroupUsers
1332 tags:
1333 - Group
1334 security:
1335 - oauth2:
1336 - "user:v1:readGroup"
1337 parameters:
1338 - name: groupId
1339 in: query
1340 description: 用户组ID
1341 schema:
1342 type: string
1343 - name: groupCode
1344 in: query
1345 description: 用户组Code
1346 schema:
1347 type: string
1348 - name: pageIndex
1349 in: query
1350 required: true
1351 description: 分页-页码
1352 schema:
1353 type: integer
1354 format: int32
1355 default: 0
1356 - name: pageSize
1357 in: query
1358 required: true
1359 description: 分页-每页记录数
1360 schema:
1361 type: integer
1362 format: int32
1363 default: 20
1364 - name: mapBean
1365 in: query
1366 required: false
1367 description: 查询条件
1368 style: deepObject
1369 explode: true
1370 schema:
1371 type: object
1372 properties:
1373 keyword:
1374 title: 查询条件 - 关键字(模糊，帐号、姓名等)
1375 type: string
1376 accountName:
1377 title: 查询条件 - 账户名(模糊)
1378 type: string
1379 name:
1380 title: 查询条件 - 姓名(模糊)
1381 type: string
1382 responses:
1383 '200':
1384 description: 用户分页列表
1385 content:
1386 application/json:
1387 schema:
1388 $ref: '#/components/schemas/UserInfoPageResponse'
1389 default:
1390 $ref: '#/components/responses/DefaultErrorResponse'
1391
1392 '/groups/{groupId}/organizationId/{organizationId}/users':
1393 get:
1394 summary: 获取用户组（所有）、部门下的用户列表
1395 operationId: listUsersByGroupOrganization
1396 tags:
1397 - Group
1398 security:
1399 - oauth2:
1400 - "user:v1:readGroup"
1401 parameters:
1402 - name: groupId
1403 in: path
1404 required: true
1405 description: 用户组ID
1406 schema:
1407 type: string
1408 - name: organizationId
1409 in: path
1410 required: true
1411 description: 组织机构ID
1412 schema:
1413 type: string
1414 - name: pageIndex
1415 in: query
1416 required: true
1417 description: 分页-页码
1418 schema:
1419 type: integer
1420 format: int32
1421 default: 0
1422 - name: pageSize
1423 in: query
1424 required: true
1425 description: 分页-每页记录数
1426 schema:
1427 type: integer
1428 format: int32
1429 default: 20
1430 - name: mapBean
1431 in: query
1432 required: false
1433 description: 查询条件
1434 style: deepObject
1435 explode: true
1436 schema:
1437 type: object
1438 properties:
1439 keyword:
1440 title: 查询条件 - 关键字(模糊，帐号、姓名等)
1441 type: string
1442 accountName:
1443 title: 查询条件 - 账户名(模糊)
1444 type: string
1445 name:
1446 title: 查询条件 - 姓名(模糊)
1447 type: string
1448 responses:
1449 '200':
1450 description: 用户分页列表
1451 content:
1452 application/json:
1453 schema:
1454 $ref: '#/components/schemas/UserInfoPageResponse'
1455 default:
1456 $ref: '#/components/responses/DefaultErrorResponse'
1457
1458 '/groups/{groupId}/accountId/{accountId}':
1459 get:
1460 summary: 获取用户组（普通）下指定帐号的关系
1461 operationId: loadAccountGroup
1462 tags:
1463 - Group
1464 security:
1465 - oauth2:
1466 - "user:v1:readGroup"
1467 parameters:
1468 - name: groupId
1469 in: path
1470 required: true
1471 description: 用户组ID
1472 schema:
1473 type: string
1474 - name: accountId
1475 in: path
1476 required: true
1477 description: 帐号
1478 schema:
1479 type: string
1480 responses:
1481 '200':
1482 description: 帐号-用户组
1483 content:
1484 application/json:
1485 schema:
1486 $ref: '#/components/schemas/AccountGroupResponse'
1487 default:
1488 $ref: '#/components/responses/DefaultErrorResponse'
1489
1490 '/groups/accountId/{accountId}/groups':
1491 get:
1492 summary: 获取帐号的用户组（普通）
1493 operationId: listAccountGroups
1494 tags:
1495 - Group
1496 security:
1497 - oauth2:
1498 - "user:v1:readGroup"
1499 parameters:
1500 - name: accountId
1501 in: path
1502 required: true
1503 description: 帐号
1504 schema:
1505 type: string
1506 responses:
1507 '200':
1508 description: 用户组
1509 content:
1510 application/json:
1511 schema:
1512 $ref: '#/components/schemas/GroupListResponse'
1513 default:
1514 $ref: '#/components/responses/DefaultErrorResponse'
1515
1516
刘洪青b7e29702020-11-05 19:07:13 +0800[diff] [blame]1517 '/groups/groupOrganizationSettings':
1518 get:
1519 summary: 获取所有的用户组（岗位）下设置的组织机构
1520 operationId: listGroupOrganizationSettings
1521 tags:
1522 - Group
1523 security:
1524 - oauth2:
1525 - "user:v1:readGroup"
1526 responses:
1527 '200':
1528 description: 岗位-组织机构设置的列表
1529 content:
1530 application/json:
1531 schema:
1532 $ref: '#/components/schemas/GroupOrganizationListResponse'
1533 default:
1534 $ref: '#/components/responses/DefaultErrorResponse'
1535
1536
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]1537 '/groups/{groupId}/accountOrganizations':
1538 get:
1539 summary: 获取用户组（岗位）下的帐号 - 组织机构列表
1540 operationId: listAccountOrganizationsByGroup
1541 tags:
1542 - Group
1543 security:
1544 - oauth2:
1545 - "user:v1:readGroup"
1546 parameters:
1547 - name: groupId
1548 in: path
1549 required: true
1550 description: 用户组ID
1551 schema:
1552 type: string
1553 responses:
1554 '200':
1555 description: 岗位-组织机构-帐号关系的列表
1556 content:
1557 application/json:
1558 schema:
1559 $ref: '#/components/schemas/GroupOrganizationAccountListResponse'
1560 default:
1561 $ref: '#/components/responses/DefaultErrorResponse'
1562
1563 '/groups/accountId/{accountId}/groupOrganizations':
1564 get:
1565 summary: 获取帐号的用户组（岗位） - 组织机构列表
1566 operationId: listGroupOrganizationsByAccount
1567 tags:
1568 - Group
1569 security:
1570 - oauth2:
1571 - "user:v1:readGroup"
1572 parameters:
1573 - name: accountId
1574 in: path
1575 required: true
1576 description: 帐号ID
1577 schema:
1578 type: string
1579 responses:
1580 '200':
1581 description: 岗位-组织机构-帐号关系的列表
1582 content:
1583 application/json:
1584 schema:
1585 $ref: '#/components/schemas/GroupOrganizationAccountListResponse'
1586 default:
1587 $ref: '#/components/responses/DefaultErrorResponse'
1588
1589 '/groups/organizationId/{organizationId}/accountGroups':
1590 get:
1591 summary: 获取组织机构下的帐号 - 用户组（岗位）列表
1592 operationId: listAccountGroupsByOrganization
1593 tags:
1594 - Group
1595 security:
1596 - oauth2:
1597 - "user:v1:readGroup"
1598 parameters:
1599 - name: organizationId
1600 in: path
1601 required: true
1602 description: 组织机构ID
1603 schema:
1604 type: string
1605 responses:
1606 '200':
1607 description: 岗位-组织机构-帐号关系的列表
1608 content:
1609 application/json:
1610 schema:
1611 $ref: '#/components/schemas/GroupOrganizationAccountListResponse'
1612 default:
1613 $ref: '#/components/responses/DefaultErrorResponse'
1614
1615 '/groups/{groupId}/accountId/{accountId}/organizations':
1616 get:
1617 summary: 获取用户组（岗位）下指定帐号 的 组织机构
1618 operationId: listOrganizationsByAccountGroup
1619 tags:
1620 - Group
1621 security:
1622 - oauth2:
1623 - "user:v1:readGroup"
1624 parameters:
1625 - name: groupId
1626 in: path
1627 required: true
1628 description: 用户组ID
1629 schema:
1630 type: string
1631 - name: accountId
1632 in: path
1633 required: true
1634 description: 帐号ID
1635 schema:
1636 type: string
1637 responses:
1638 '200':
1639 description: 岗位-组织机构-帐号关系的列表
1640 content:
1641 application/json:
1642 schema:
1643 $ref: '#/components/schemas/GroupOrganizationAccountListResponse'
1644 default:
1645 $ref: '#/components/responses/DefaultErrorResponse'
1646
1647 '/groups/{groupId}/organizationId/{organizationId}/accounts':
1648 get:
1649 summary: 获取用户组（岗位）下指定组织机构 的 帐号
1650 operationId: listAccountsByGroupOrganization
1651 tags:
1652 - Group
1653 security:
1654 - oauth2:
1655 - "user:v1:readGroup"
1656 parameters:
1657 - name: groupId
1658 in: path
1659 required: true
1660 description: 用户组ID
1661 schema:
1662 type: string
1663 - name: organizationId
1664 in: path
1665 required: true
1666 description: 组织机构ID
1667 schema:
1668 type: string
1669 responses:
1670 '200':
1671 description: 岗位-组织机构-帐号关系的列表
1672 content:
1673 application/json:
1674 schema:
1675 $ref: '#/components/schemas/GroupOrganizationAccountListResponse'
1676 default:
1677 $ref: '#/components/responses/DefaultErrorResponse'
1678
1679 '/groups/{groupId}/accountId/{accountId}/organizationId/{organizationId}':
1680 get:
1681 summary: 获取用户组（岗位）下指定帐号、组织机构的关系
1682 operationId: loadAccountGroupOrganization
1683 tags:
1684 - Group
1685 security:
1686 - oauth2:
1687 - "user:v1:readGroup"
1688 parameters:
1689 - name: groupId
1690 in: path
1691 required: true
1692 description: 用户组ID
1693 schema:
1694 type: string
1695 - name: accountId
1696 in: path
1697 required: true
1698 description: 帐号ID
1699 schema:
1700 type: string
1701 - name: organizationId
1702 in: path
1703 required: true
1704 description: 组织机构ID
1705 schema:
1706 type: string
1707 responses:
1708 '200':
1709 description: 岗位-组织机构-帐号关系
1710 content:
1711 application/json:
1712 schema:
1713 $ref: '#/components/schemas/GroupOrganizationAccountResponse'
1714 default:
1715 $ref: '#/components/responses/DefaultErrorResponse'
1716
1717
1718 '/labels':
1719 get:
1720 summary: 获取用户标签列表
1721 operationId: pageLabels
1722 tags:
1723 - Label
1724 security:
1725 - oauth2:
1726 - "user:v1:readLabel"
1727 parameters:
1728 - name: pageIndex
1729 in: query
1730 required: true
1731 description: 分页-页码
1732 schema:
1733 type: integer
1734 format: int32
1735 default: 0
1736 - name: pageSize
1737 in: query
1738 required: true
1739 description: 分页-每页记录数
1740 schema:
1741 type: integer
1742 format: int32
1743 default: 20
1744 - name: mapBean
1745 in: query
1746 required: false
1747 description: 查询条件
1748 style: deepObject
1749 explode: true
1750 schema:
1751 type: object
1752 properties:
1753 keyword:
1754 title: 查询条件 - 关键字(模糊，名称、描述等)
1755 type: string
1756 name:
1757 title: 查询条件 - 名称(模糊)
1758 type: string
1759 description:
1760 title: 查询条件 - 描述(模糊)
1761 type: string
1762 responses:
1763 '200':
1764 description: 用户标签分页列表
1765 content:
1766 application/json:
1767 schema:
1768 $ref: '#/components/schemas/LabelPageResponse'
1769 default:
1770 $ref: '#/components/responses/DefaultErrorResponse'
1771
1772 '/labels/{labelId}':
1773 get:
1774 summary: 获取用户标签
1775 operationId: getLabel
1776 tags:
1777 - Label
1778 security:
1779 - oauth2:
1780 - "user:v1:readLabel"
1781 parameters:
1782 - name: labelId
1783 in: path
1784 required: true
1785 description: 用户标签ID
1786 schema:
1787 type: string
1788 responses:
1789 '200':
1790 description: 用户标签信息
1791 content:
1792 application/json:
1793 schema:
1794 $ref: '#/components/schemas/LabelLoadResponse'
1795 default:
1796 $ref: '#/components/responses/DefaultErrorResponse'
1797
1798 '/labels/{labelId}/accountId/{accountId}':
1799 get:
1800 summary: 获取用户标签下指定帐号的关系
1801 operationId: loadAccountLabel
1802 tags:
1803 - Label
1804 security:
1805 - oauth2:
1806 - "user:v1:readLabel"
1807 parameters:
1808 - name: accountId
1809 in: path
1810 required: true
1811 description: 帐号
1812 schema:
1813 type: string
1814 - name: labelId
1815 in: path
1816 required: true
1817 description: 用户标签ID
1818 schema:
1819 type: string
1820 responses:
1821 '200':
1822 description: 用户标签
1823 content:
1824 application/json:
1825 schema:
1826 $ref: '#/components/schemas/AccountLabelResponse'
1827 default:
1828 $ref: '#/components/responses/DefaultErrorResponse'
1829
1830 '/labels/{labelId}/users':
1831 get:
1832 summary: 获取用户标签下的用户列表
1833 operationId: listUsersByLabel
1834 tags:
1835 - Label
1836 security:
1837 - oauth2:
1838 - "user:v1:readLabel"
1839 parameters:
1840 - name: labelId
1841 in: path
1842 required: true
1843 description: 用户标签ID
1844 schema:
1845 type: string
1846 - name: pageIndex
1847 in: query
1848 required: true
1849 description: 分页-页码
1850 schema:
1851 type: integer
1852 format: int32
1853 default: 0
1854 - name: pageSize
1855 in: query
1856 required: true
1857 description: 分页-每页记录数
1858 schema:
1859 type: integer
1860 format: int32
1861 default: 20
1862 - name: mapBean
1863 in: query
1864 required: false
1865 description: 查询条件
1866 style: deepObject
1867 explode: true
1868 schema:
1869 type: object
1870 properties:
1871 keyword:
1872 title: 查询条件 - 关键字(模糊，帐号、姓名等)
1873 type: string
1874 accountName:
1875 title: 查询条件 - 账户名(模糊)
1876 type: string
1877 name:
1878 title: 查询条件 - 姓名(模糊)
1879 type: string
1880 responses:
1881 '200':
1882 description: 用户分页列表
1883 content:
1884 application/json:
1885 schema:
1886 $ref: '#/components/schemas/UserInfoPageResponse'
1887 default:
1888 $ref: '#/components/responses/DefaultErrorResponse'
1889
1890 '/labels/accountId/{accountId}/labels':
1891 get:
1892 summary: 获取帐号的用户标签
1893 operationId: listAccountLabels
1894 tags:
1895 - Label
1896 security:
1897 - oauth2:
1898 - "user:v1:readLabel"
1899 parameters:
1900 - name: accountId
1901 in: path
1902 required: true
1903 description: 帐号
1904 schema:
1905 type: string
1906 responses:
1907 '200':
1908 description: 用户标签
1909 content:
1910 application/json:
1911 schema:
1912 $ref: '#/components/schemas/LabelListResponse'
1913 default:
1914 $ref: '#/components/responses/DefaultErrorResponse'
1915
1916
1917
1918
1919 '/admin/posts/accountName/{accountName}/manOrganizations':
1920 get:
1921 summary: 根据帐号获取可管理的组织机构列表
1922 operationId: loadManOrganizationsByAccount
1923 tags:
1924 - PostAdmin
1925 security:
1926 - oauth2:
1927 - "user:v1:readPost"
1928 parameters:
1929 - name: accountName
1930 in: path
1931 required: true
1932 description: 帐号
1933 schema:
1934 type: string
1935 responses:
1936 '200':
1937 description: 岗位-组织机构-帐号关系的列表
1938 content:
1939 application/json:
1940 schema:
1941 $ref: '#/components/schemas/GroupOrganizationAccountListResponse'
1942 default:
1943 $ref: '#/components/responses/DefaultErrorResponse'
1944
1945 '/admin/posts/organizationId/{organizationId}/accountName/{accountName}/manPosts':
1946 get:
1947 summary: 根据组织机构Id、帐号获取该帐号在组织机构下的可管理岗位
1948 operationId: loadManPostsByOrganizationOfAccount
1949 tags:
1950 - PostAdmin
1951 security:
1952 - oauth2:
1953 - "user:v1:readPost"
1954 parameters:
1955 - name: organizationId
1956 in: path
1957 required: true
1958 description: 组织机构ID
1959 schema:
1960 type: string
1961 - name: accountName
1962 in: path
1963 required: true
1964 description: 帐号
1965 schema:
1966 type: string
1967 responses:
1968 '200':
1969 description: 岗位-组织机构设置的列表
1970 content:
1971 application/json:
1972 schema:
1973 $ref: '#/components/schemas/GroupOrganizationListResponse'
1974 default:
1975 $ref: '#/components/responses/DefaultErrorResponse'
1976
1977 '/admin/posts/organizationId/{organizationId}/posts':
1978 get:
1979 summary: 根据组织机构Id获取组织机构下的所有岗位
1980 operationId: loadPostsByOrganization
1981 tags:
1982 - PostAdmin
1983 security:
1984 - oauth2:
1985 - "user:v1:readPost"
1986 parameters:
1987 - name: organizationId
1988 in: path
1989 required: true
1990 description: 组织机构ID
1991 schema:
1992 type: string
1993 responses:
1994 '200':
1995 description: 岗位-组织机构设置的列表
1996 content:
1997 application/json:
1998 schema:
1999 $ref: '#/components/schemas/GroupOrganizationListResponse'
2000 default:
2001 $ref: '#/components/responses/DefaultErrorResponse'
2002
2003
2004 '/admin/posts/organizationId/{organizationId}/postAccounts':
2005 get:
2006 summary: 根据组织机构Id获取组织机构下的岗位人员
2007 operationId: listPostAccountsByOrganization
2008 tags:
2009 - PostAdmin
2010 security:
2011 - oauth2:
2012 - "user:v1:readPost"
2013 parameters:
2014 - name: organizationId
2015 in: path
2016 required: true
2017 description: 组织机构ID
2018 schema:
2019 type: string
2020 responses:
2021 '200':
2022 description: 岗位-组织机构-帐号关系的列表
2023 content:
2024 application/json:
2025 schema:
2026 $ref: '#/components/schemas/GroupOrganizationAccountListResponse'
2027 default:
2028 $ref: '#/components/responses/DefaultErrorResponse'
2029
2030 post:
2031 summary: 根据组织机构Id保存组织机构下的岗位人员
2032 operationId: savePostAccountsByOrganization
2033 tags:
2034 - PostAdmin
2035 security:
2036 - oauth2:
2037 - "user:v1:writePost"
2038 parameters:
2039 - name: organizationId
2040 in: path
2041 required: true
2042 description: 组织机构ID
2043 schema:
2044 type: string
2045 requestBody:
2046 description: 岗位-组织机构-帐号关系的列表
2047 required: true
2048 content:
2049 application/json:
2050 schema:
2051 $ref: '#/components/schemas/GroupOrganizationAccountSaveRequest'
2052 responses:
2053 '200':
2054 description: 保存结果
2055 content:
2056 application/json:
2057 schema:
2058 $ref: '#/components/schemas/GroupOrganizationAccountSaveResponse'
2059 default:
2060 $ref: '#/components/responses/DefaultErrorResponse'
2061
2062 '/admin/posts/organizationId/{organizationId}/group/{groupId}/accounts':
2063 post:
2064 summary: 根据组织机构Id、岗位Id保存人员
2065 operationId: saveAccountsByOrganizationPost
2066 tags:
2067 - PostAdmin
2068 security:
2069 - oauth2:
2070 - "user:v1:writePost"
2071 parameters:
2072 - name: organizationId
2073 in: path
2074 required: true
2075 description: 组织机构ID
2076 schema:
2077 type: string
2078 - name: groupId
2079 in: path
2080 required: true
2081 description: 岗位（用户组）ID
2082 schema:
2083 type: string
2084 requestBody:
2085 description: 岗位-组织机构-帐号关系的列表
2086 required: true
2087 content:
2088 application/json:
2089 schema:
2090 $ref: '#/components/schemas/GroupOrganizationAccountSaveRequest'
2091 responses:
2092 '200':
2093 description: 保存结果
2094 content:
2095 application/json:
2096 schema:
2097 $ref: '#/components/schemas/GroupOrganizationAccountSaveResponse'
2098 default:
2099 $ref: '#/components/responses/DefaultErrorResponse'
2100
2101components:
2102
2103 # Security Schemes
2104
2105 securitySchemes:
2106 oauth2:
2107 type: oauth2
2108 flows:
2109 clientCredentials:
2110 tokenUrl: ${POA_SERVER_URL}/oauth2/token
2111 scopes:
2112 "user:v1:readUser": "读取用户"
2113 "user:v1:readUserSecret": "读取用户私密信息"
2114 "user:v1:readOrganization": "读取组织机构"
2115 "user:v1:readGroup": "读取用户组"
2116 "user:v1:readLabel": "读取用户标签"
2117 "user:v1:readPost": "读取岗位"
2118 "user:v1:writePost": "写入岗位"
2119
2120 responses:
2121 'ErrorResponse400':
2122 description: unexpected error
2123 content:
2124 application/json:
2125 schema:
2126 $ref: '#/components/schemas/ErrorResponse'
2127
2128 DefaultErrorResponse:
2129 description: unexpected error
2130 content:
2131 application/json:
2132 schema:
2133 $ref: '#/components/schemas/ErrorResponse'
2134
2135 schemas:
2136
2137 # Error
2138
2139 ErrorResponse:
2140 title: '异常响应'
刘洪青f3b5fc82021-01-11 23:54:40 +0800[diff] [blame]2141 type: object
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2142 required:
2143 - code
2144 - message
2145 properties:
2146 code:
2147 title: 异常代码
2148 type: integer
2149 format: int32
2150 default: -1
2151 message:
2152 title: 异常信息
2153 type: string
2154 default: "未知错误"
2155
2156 # Entity
2157
2158 BaseEntity:
2159 title: 实体 - 基类
2160 type: object
2161 properties:
2162 id:
2163 title: ID
2164 type: string
2165 #companyId:
2166 # title: 'Company ID, 固定 1'
2167 # type: string
2168 # default: '1'
2169 #deleted:
2170 # title: 是否删除
2171 # type: boolean
2172 # default: false
2173 #addAccount:
2174 # title: 创建人
2175 # type: string
2176 #addTime:
2177 # title: 创建时间
2178 # type: string
2179 # format: date-time
2180 #editAccount:
2181 # title: 修改人
2182 # type: string
2183 #editTime:
2184 # title: 修改时间
2185 # type: string
2186 # format: date-time
2187 #deleteAccount:
2188 # title: 删除人
2189 # type: string
2190 #deleteTime:
2191 # title: 删除时间
2192 # type: string
2193 # format: date-time
2194 #isDataCenter:
2195 # title: 是否来源数据中心
2196 # type: boolean
2197 # default: false
2198
2199 DictionaryType:
2200 title: 实体 - 字典
2201 allOf:
2202 - $ref: '#/components/schemas/BaseEntity'
2203 - type: object
2204 title: 实体属性
2205 properties:
2206 code:
2207 title: 代码
2208 type: string
2209 name:
2210 title: 名称
2211 type: string
2212 enable:
2213 title: 是否启用
2214 type: boolean
2215 default: true
2216 sort:
2217 title: 排序
2218 type: integer
2219 format: int64
2220 multiLevel:
2221 title: 是否多层级
2222 type: boolean
2223
2224 Dictionary:
2225 title: 实体 - 字典
2226 allOf:
2227 - $ref: '#/components/schemas/BaseEntity'
2228 - type: object
2229 title: 实体属性
2230 properties:
2231 code:
2232 title: 代码
2233 type: string
2234 name:
2235 title: 名称
2236 type: string
2237 enable:
2238 title: 是否启用
2239 type: boolean
2240 default: true
2241 sort:
2242 title: 排序
2243 type: integer
2244 format: int64
2245 dictionaryType:
2246 title: 字典类型
2247 allOf:
2248 - $ref: '#/components/schemas/DictionaryType'
2249 parentDictionary:
2250 title: 父字典
2251 allOf:
2252 - $ref: '#/components/schemas/Dictionary'
2253
2254 IdentityType:
2255 title: 实体 - 字典
2256 allOf:
2257 - $ref: '#/components/schemas/BaseEntity'
2258 - type: object
2259 title: 实体属性
2260 properties:
2261 code:
2262 title: 代码
2263 type: string
2264 name:
2265 title: 名称
2266 type: string
2267 enable:
2268 title: 是否启用
2269 type: boolean
2270 sort:
2271 title: 排序
2272 type: integer
2273 format: int64
2274 parentIdentityType:
2275 title: 父身份类型
2276 allOf:
2277 - $ref: '#/components/schemas/IdentityType'
2278
2279 User:
2280 title: 实体 - 用户
2281 allOf:
2282 - $ref: '#/components/schemas/BaseEntity'
2283 - type: object
2284 title: 实体属性
2285 properties:
2286 uid:
2287 title: 用户标识
2288 type: string
2289 passWord:
2290 title: 密码
2291 type: string
2292 name:
2293 title: 名称
2294 type: string
2295 fullNameSpelling:
2296 title: 姓名全拼,根据姓名生成
2297 type: string
2298 nameSpelling:
2299 title: 姓名简拼,根据姓名生成
2300 type: string
2301 email:
2302 title: 名称
2303 type: string
2304 phoneNumber:
2305 title: 名称
2306 type: string
2307 imageUrl:
2308 title: 个人照片地址
2309 type: string
2310 certificateType:
2311 title: 证件类型
2312 allOf:
2313 - $ref: '#/components/schemas/Dictionary'
2314 certificateNumber:
2315 title: 证件号码
2316 type: string
2317 gender:
2318 title: 性别
2319 allOf:
2320 - $ref: '#/components/schemas/Dictionary'
2321 nation:
2322 title: 民族
2323 allOf:
2324 - $ref: '#/components/schemas/Dictionary'
2325 country:
2326 title: 国家
2327 allOf:
2328 - $ref: '#/components/schemas/Dictionary'
2329 address:
2330 title: 地址
2331 allOf:
2332 - $ref: '#/components/schemas/Dictionary'
2333
2334 Organization:
2335 title: 实体 - 组织机构
2336 allOf:
2337 - $ref: '#/components/schemas/BaseEntity'
2338 - type: object
2339 title: 实体属性
2340 properties:
2341 code:
2342 title: 代码
2343 type: string
2344 name:
2345 title: 名称
2346 type: string
2347 enable:
2348 title: 是否启用
2349 type: boolean
2350 sort:
2351 title: 排序
2352 type: integer
2353 format: int64
2354 state:
2355 title: 状态
2356 type: integer
2357 format: int32
2358 type:
2359 title: 类型
2360 allOf:
2361 - $ref: '#/components/schemas/Dictionary'
2362 parentOrganization:
2363 title: 所属的父级组织机构
2364 allOf:
2365 - $ref: '#/components/schemas/Organization'
2366
2367 Account:
2368 title: 实体 - 帐号
2369 allOf:
2370 - $ref: '#/components/schemas/BaseEntity'
2371 - type: object
2372 title: 实体属性
2373 properties:
2374 accountName:
2375 title: 帐号
2376 type: string
2377 state:
2378 title: 状态
2379 type: string
2380 activation:
2381 title: 是否激活
2382 type: boolean
2383 accountExpiryDate:
2384 title: 失效时间
2385 type: string
2386 format: date-time
2387 identityType:
2388 title: 身份
2389 allOf:
2390 - $ref: '#/components/schemas/IdentityType'
2391 organization:
2392 title: 组织机构
2393 allOf:
2394 - $ref: '#/components/schemas/Organization'
2395 user:
2396 title: 用户信息
2397 allOf:
2398 - $ref: '#/components/schemas/User'
2399
2400
2401 # Model
2402
2403 UserInfoModel:
2404 title: 用户信息
2405 type: object
2406 properties:
2407 id:
2408 title: 账号Id(弃用，请用accountId)
2409 type: string
2410 accountId:
2411 title: 账号Id
2412 type: string
2413 accountName:
2414 title: 帐号
2415 type: string
2416 identityTypeId:
2417 title: 身份（ID）
2418 type: string
2419 identityTypeCode:
2420 title: 身份（代码）
2421 type: string
2422 identityTypeName:
2423 title: 身份（名称）
2424 type: string
2425 organizationId:
2426 title: 组织机构（ID）
2427 type: string
2428 organizationCode:
2429 title: 组织机构（代码）
2430 type: string
2431 organizationName:
2432 title: 组织机构（名称）
2433 type: string
2434 userId:
2435 title: 用户Id
2436 type: string
2437 uid:
2438 title: 用户号（弃用，应该userNo）
2439 type: string
2440 userNo:
2441 title: 用户号
2442 type: string
2443 name:
2444 title: 姓名
2445 type: string
2446 fullNameSpelling:
2447 title: 姓名全拼,根据姓名生成
2448 type: string
2449 nameSpelling:
2450 title: 姓名简拼,根据姓名生成
2451 type: string
2452 email:
刘洪青83c44f32021-01-01 12:15:55 +0800[diff] [blame]2453 title: 邮箱（注意不是安全邮箱）（弃用）
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2454 type: string
2455 phoneNumber:
刘洪青83c44f32021-01-01 12:15:55 +0800[diff] [blame]2456 title: 手机号（注意不是安全手机）（弃用）
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2457 type: string
2458 imageUrl:
刘洪青83c44f32021-01-01 12:15:55 +0800[diff] [blame]2459 title: 个人照片地址（弃用）
2460 type: string
2461 portraitUrl:
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2462 title: 个人照片地址
2463 type: string
2464 certificateTypeId:
刘洪青83c44f32021-01-01 12:15:55 +0800[diff] [blame]2465 title: 证件类型（ID）（弃用）
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2466 type: string
2467 certificateTypeCode:
刘洪青83c44f32021-01-01 12:15:55 +0800[diff] [blame]2468 title: 证件类型（代码）（弃用）
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2469 type: string
2470 certificateTypeName:
刘洪青83c44f32021-01-01 12:15:55 +0800[diff] [blame]2471 title: 证件类型（名称）（弃用）
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2472 type: string
2473 certificateNumber:
刘洪青83c44f32021-01-01 12:15:55 +0800[diff] [blame]2474 title: 证件号码（弃用）
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2475 type: string
2476 genderId:
2477 title: 性别（ID）
2478 type: string
2479 genderCode:
2480 title: 性别（代码）
2481 type: string
2482 genderName:
2483 title: 性别（名称）
2484 type: string
2485 nationId:
2486 title: 民族（ID）
2487 type: string
2488 nationCode:
2489 title: 民族（代码）
2490 type: string
2491 nationName:
2492 title: 民族（名称）
2493 type: string
2494 countryId:
2495 title: 国家（ID）
2496 type: string
2497 countryCode:
2498 title: 国家（代码）
2499 type: string
2500 countryName:
2501 title: 国家（名称）
2502 type: string
2503 addressId:
2504 title: 地址（ID）
2505 type: string
2506 addressCode:
2507 title: 地址（代码）
2508 type: string
2509 addressName:
2510 title: 地址（名称）
2511 type: string
2512
2513 OrganizationModel:
2514 title: 组织机构信息
2515 type: object
2516 properties:
2517 id:
2518 title: ID
2519 type: string
2520 code:
2521 title: 代码
2522 type: string
2523 name:
2524 title: 名称
2525 type: string
2526 description:
2527 title: 描述
2528 type: string
2529 isRootOrganization:
2530 title: 是否根组织机构
2531 type: string
2532 rootOrganizationId:
2533 title: 所在根组织机构（ID）
2534 type: string
2535 parentId:
2536 title: 父级组织机构（ID）
2537 type: string
2538 parentCode:
2539 title: 父级组织机构（代码）
2540 type: string
2541 parentName:
2542 title: 父级组织机构（名称）
2543 type: string
2544 typeId:
2545 title: 类型（ID）
2546 type: string
2547 typeName:
2548 title: 类型（名称）
2549 type: string
2550
2551 GroupModel:
2552 title: 用户组信息
2553 type: object
2554 properties:
2555 id:
2556 title: ID
2557 type: string
2558 code:
2559 title: 代码
2560 type: string
2561 name:
2562 title: 名称
2563 type: string
2564 description:
2565 title: 描述
2566 type: string
2567 type:
2568 title: 类型（1 普通用户组，2 岗位用户组）
2569 type: string
2570
2571 LabelModel:
2572 title: 用户标签信息
2573 type: object
2574 properties:
2575 id:
2576 title: ID
2577 type: string
2578 name:
2579 title: 名称
2580 type: string
2581 description:
2582 title: 描述
2583 type: string
2584
2585 GroupOrganizationModel:
2586 title: 岗位组织机构设置信息
2587 type: object
2588 properties:
2589 id:
2590 title: ID
2591 type: string
2592 groupId:
2593 title: 用户组（岗位）ID
2594 type: string
2595 organizationId:
2596 title: 组织机构ID
2597 type: string
2598
2599 groupCode:
2600 title: 用户组（岗位）代码
2601 type: string
2602 groupName:
2603 title: 用户组（岗位）名称
2604 type: string
2605 groupDescription:
2606 title: 用户组（岗位）描述
2607 type: string
2608 organizationCode:
2609 title: 组织机构代码
2610 type: string
2611 organizationName:
2612 title: 组织机构名称
2613 type: string
2614 organizationDescription:
2615 title: 组织机构描述
2616 type: string
2617
2618 GroupOrganizationAccountModel:
2619 title: 岗位组织机构帐号信息
2620 type: object
2621 properties:
2622 id:
2623 title: ID
2624 type: string
2625 groupId:
2626 title: 用户组（岗位）ID
2627 type: string
2628 organizationId:
2629 title: 组织机构ID
2630 type: string
2631 accountId:
2632 title: 帐号ID
2633 type: string
2634
2635 groupCode:
2636 title: 用户组（岗位）代码
2637 type: string
2638 groupName:
2639 title: 用户组（岗位）名称
2640 type: string
2641 organizationCode:
2642 title: 组织机构代码
2643 type: string
2644 organizationName:
2645 title: 组织机构名称
2646 type: string
2647 accountName:
2648 title: 帐号
2649 type: string
2650 userName:
2651 title: 用户姓名
2652 type: string
2653
2654 accountOrganizationId:
2655 title: 帐号的组织机构ID
2656 type: string
2657 accountOrganizationCode:
2658 title: 帐号的组织机构代码
2659 type: string
2660 accountOrganizationName:
2661 title: 帐号的组织机构名称
2662 type: string
2663
2664
2665 # Request VO
2666 GroupOrganizationAccountSaveRequest:
2667 title: 请求
刘洪青f3b5fc82021-01-11 23:54:40 +0800[diff] [blame]2668 type: object
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2669 properties:
2670 groupOrganizatonAccounts:
2671 title: 岗位组织机构帐号信息列表
2672 type: array
2673 items:
2674 $ref: '#/components/schemas/GroupOrganizationAccountModel'
2675
2676
2677 # Response Data
2678
2679
2680 # Response VO
2681
2682 AbstractApiResponse:
2683 title: 响应
刘洪青f3b5fc82021-01-11 23:54:40 +0800[diff] [blame]2684 type: object
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2685 properties:
2686 acknowleged:
2687 title: 响应结果
2688 type: boolean
2689 default: true
2690 code:
2691 title: 响应代码
2692 type: integer
2693 format: int32
2694 default: 0
2695 message:
2696 title: 响应信息
2697 type: string
2698 DefaultApiResponse:
2699 allOf:
2700 - $ref: '#/components/schemas/AbstractApiResponse'
2701 - type: object
2702 title: 响应数据
2703 properties:
2704 data:
2705 title: 响应数据
2706 type: object
2707
2708
2709 UserInfoPageResponse:
2710 allOf:
2711 - $ref: '#/components/schemas/DefaultApiResponse'
2712 - type: object
2713 title: 响应数据
2714 properties:
2715 data:
2716 allOf:
2717 - type: object
2718 title: 分页数据
2719 properties:
2720 pageCount:
2721 title: 分页总数
2722 type: integer
2723 format: int32
2724 totalCount:
2725 title: 记录总数
2726 type: integer
2727 format: int64
2728 currentItemCount:
2729 title: 当前返回记录数
2730 type: integer
2731 format: int32
2732 items:
2733 title: 当前返回记录集
2734 type: array
2735 items:
2736 $ref: '#/components/schemas/UserInfoModel'
2737
刘洪青61e63732020-10-19 20:00:04 +0800[diff] [blame]2738 UserTotalCountResponse:
2739 allOf:
2740 - $ref: '#/components/schemas/DefaultApiResponse'
2741 - type: object
2742 title: 响应数据
2743 properties:
2744 data:
2745 allOf:
2746 - type: object
2747 title: 结果
2748 properties:
2749 totalCount:
2750 title: 用户总数
2751 type: integer
2752 format: int32
2753
刘洪青47205852020-08-14 13:39:30 +0800[diff] [blame]2754 UserInfoLoadResponse:
2755 allOf:
2756 - $ref: '#/components/schemas/DefaultApiResponse'
2757 - type: object
2758 title: 响应数据
2759 properties:
2760 data:
2761 allOf:
2762 - $ref: '#/components/schemas/UserInfoModel'
2763
2764 UserInfoListResponse:
2765 allOf:
2766 - $ref: '#/components/schemas/DefaultApiResponse'
2767 - type: object
2768 title: 响应数据
2769 properties:
2770 data:
2771 allOf:
2772 - type: object
2773 title: 列表数据
2774 properties:
2775 items:
2776 title: 当前返回记录集
2777 type: array
2778 items:
2779 $ref: '#/components/schemas/UserInfoModel'
2780
2781 UserPortraitLoadResponse:
2782 allOf:
2783 - $ref: '#/components/schemas/DefaultApiResponse'
2784 - type: object
2785 title: 响应数据
2786 properties:
2787 data:
2788 allOf:
2789 - type: object
2790 title: 列表数据
2791 properties:
2792 portraitBase64:
2793 title: 头像数据（Base64）
2794 type: string
2795 UserSafety:
2796 type: object
2797 title: 安全信息
2798 properties:
2799 userId:
2800 title: 用户Id
2801 type: string
2802 accountId:
2803 title: 账号Id
2804 type: string
2805 accountName:
2806 title: 账号名
2807 type: string
2808 securePhone:
2809 title: 安全手机
2810 type: string
2811 secureEmail:
2812 title: 安全邮箱
2813 type: string
2814
2815 UserSafetyList:
2816 allOf:
2817 - $ref: '#/components/schemas/DefaultApiResponse'
2818 - type: object
2819 title: 响应数据
2820 properties:
2821 data:
2822 allOf:
2823 - type: object
2824 title: 列表数据
2825 properties:
2826 items:
2827 title: 当前返回记录集
2828 type: array
2829 items:
2830 $ref: '#/components/schemas/UserSafety'
2831
2832 UserSafetyPhoneNumber:
2833 type: object
2834 title: 安全手机
2835 properties:
2836 userId:
2837 title: 用户Id
2838 type: string
2839 accountId:
2840 title: 账号Id
2841 type: string
2842 accountName:
2843 title: 账号名
2844 type: string
2845 securePhone:
2846 title: 安全手机
2847 type: string
2848
2849 UserSafetyPhoneNumberList:
2850 allOf:
2851 - $ref: '#/components/schemas/DefaultApiResponse'
2852 - type: object
2853 title: 响应数据
2854 properties:
2855 data:
2856 allOf:
2857 - type: object
2858 title: 列表数据
2859 properties:
2860 items:
2861 title: 当前返回记录集
2862 type: array
2863 items:
2864 $ref: '#/components/schemas/UserSafetyPhoneNumber'
2865
2866 UserSafetyEmail:
2867 type: object
2868 title: 安全邮箱
2869 properties:
2870 userId:
2871 title: 用户Id
2872 type: string
2873 accountId:
2874 title: 账号Id
2875 type: string
2876 accountName:
2877 title: 账号名
2878 type: string
2879 secureEmail:
2880 title: 安全邮箱
2881 type: string
2882
2883 UserSafetyEmailList:
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/UserSafetyEmail'
2899
2900 UserSafetyLoadResponse:
2901 allOf:
2902 - $ref: '#/components/schemas/DefaultApiResponse'
2903 - type: object
2904 title: 响应数据
2905 properties:
2906 data:
2907 allOf:
2908 - $ref: '#/components/schemas/UserSafety'
2909
2910 UserFederation:
2911 type: object
2912 title: 联合登录信息
2913 properties:
2914 userId:
2915 title: 用户Id
2916 type: string
2917 accountId:
2918 title: 账号Id
2919 type: string
2920 accountName:
2921 title: 账号名
2922 type: string
2923 federatedType:
2924 title: 联合登录类型
2925 type: string
2926 enum:
2927 - qq
2928 - openweixin
2929 - workweixin
2930 - alipay
2931 - dingtalk
2932 federatedId:
2933 title: 联合登录ID
2934 type: string
2935
2936 UserFederationList:
2937 allOf:
2938 - $ref: '#/components/schemas/DefaultApiResponse'
2939 - type: object
2940 title: 响应数据
2941 properties:
2942 data:
2943 allOf:
2944 - type: object
2945 title: 列表数据
2946 properties:
2947 items:
2948 title: 当前返回记录集
2949 type: array
2950 items:
2951 $ref: '#/components/schemas/UserFederation'
2952
2953 UserFederationLoadResponse:
2954 allOf:
2955 - $ref: '#/components/schemas/DefaultApiResponse'
2956 - type: object
2957 title: 响应数据
2958 properties:
2959 data:
2960 allOf:
2961 - $ref: '#/components/schemas/UserFederation'
2962
2963 RootOrganizationListResponse:
2964 allOf:
2965 - $ref: '#/components/schemas/DefaultApiResponse'
2966 - type: object
2967 title: 响应数据
2968 properties:
2969 data:
2970 allOf:
2971 - type: object
2972 title: 列表数据
2973 properties:
2974 items:
2975 title: 当前返回记录集
2976 type: array
2977 items:
2978 $ref: '#/components/schemas/OrganizationModel'
2979
2980 OrganizationListResponse:
2981 allOf:
2982 - $ref: '#/components/schemas/DefaultApiResponse'
2983 - type: object
2984 title: 响应数据
2985 properties:
2986 data:
2987 allOf:
2988 - type: object
2989 title: 列表数据
2990 properties:
2991 items:
2992 title: 当前返回记录集
2993 type: array
2994 items:
2995 $ref: '#/components/schemas/OrganizationModel'
2996
2997 OrganizationLoadResponse:
2998 allOf:
2999 - $ref: '#/components/schemas/DefaultApiResponse'
3000 - type: object
3001 title: 响应数据
3002 properties:
3003 data:
3004 allOf:
3005 - $ref: '#/components/schemas/OrganizationModel'
3006
3007
3008 GroupPageResponse:
3009 allOf:
3010 - $ref: '#/components/schemas/DefaultApiResponse'
3011 - type: object
3012 title: 响应数据
3013 properties:
3014 data:
3015 allOf:
3016 - type: object
3017 title: 分页数据
3018 properties:
3019 pageCount:
3020 title: 分页总数
3021 type: integer
3022 format: int32
3023 totalCount:
3024 title: 记录总数
3025 type: integer
3026 format: int64
3027 currentItemCount:
3028 title: 当前返回记录数
3029 type: integer
3030 format: int32
3031 items:
3032 title: 当前返回记录集
3033 type: array
3034 items:
3035 $ref: '#/components/schemas/GroupModel'
3036
3037 GroupListResponse:
3038 allOf:
3039 - $ref: '#/components/schemas/DefaultApiResponse'
3040 - type: object
3041 title: 响应数据
3042 properties:
3043 data:
3044 allOf:
3045 - type: object
3046 title: 列表数据
3047 properties:
3048 items:
3049 title: 当前返回记录集
3050 type: array
3051 items:
3052 $ref: '#/components/schemas/GroupModel'
3053
3054 GroupLoadResponse:
3055 allOf:
3056 - $ref: '#/components/schemas/DefaultApiResponse'
3057 - type: object
3058 title: 响应数据
3059 properties:
3060 data:
3061 allOf:
3062 - $ref: '#/components/schemas/GroupModel'
3063
3064 AccountGroupResponse:
3065 allOf:
3066 - $ref: '#/components/schemas/DefaultApiResponse'
3067 - type: object
3068 title: 响应数据
3069 properties:
3070 data:
3071 allOf:
3072 - type: object
3073 title: 列表数据
3074 properties:
3075 accountGroupId:
3076 title: 帐号用户组ID
3077 type: string
3078
3079 GroupOrganizationAccountListResponse:
3080 allOf:
3081 - $ref: '#/components/schemas/DefaultApiResponse'
3082 - type: object
3083 title: 响应数据
3084 properties:
3085 data:
3086 allOf:
3087 - type: object
3088 title: 列表数据
3089 properties:
3090 items:
3091 title: 当前返回记录集
3092 type: array
3093 items:
3094 $ref: '#/components/schemas/GroupOrganizationAccountModel'
3095
3096 GroupOrganizationAccountResponse:
3097 allOf:
3098 - $ref: '#/components/schemas/DefaultApiResponse'
3099 - type: object
3100 title: 响应数据
3101 properties:
3102 data:
3103 allOf:
3104 - type: object
3105 title: 列表数据
3106 properties:
3107 groupOrganizationAccountId:
3108 title: 岗位组织机构帐号的关系ID
3109 type: string
3110
3111 LabelPageResponse:
3112 allOf:
3113 - $ref: '#/components/schemas/DefaultApiResponse'
3114 - type: object
3115 title: 响应数据
3116 properties:
3117 data:
3118 allOf:
3119 - type: object
3120 title: 分页数据
3121 properties:
3122 pageCount:
3123 title: 分页总数
3124 type: integer
3125 format: int32
3126 totalCount:
3127 title: 记录总数
3128 type: integer
3129 format: int64
3130 currentItemCount:
3131 title: 当前返回记录数
3132 type: integer
3133 format: int32
3134 items:
3135 title: 当前返回记录集
3136 type: array
3137 items:
3138 $ref: '#/components/schemas/LabelModel'
3139
3140 LabelListResponse:
3141 allOf:
3142 - $ref: '#/components/schemas/DefaultApiResponse'
3143 - type: object
3144 title: 响应数据
3145 properties:
3146 data:
3147 allOf:
3148 - type: object
3149 title: 列表数据
3150 properties:
3151 items:
3152 title: 当前返回记录集
3153 type: array
3154 items:
3155 $ref: '#/components/schemas/LabelModel'
3156
3157 LabelLoadResponse:
3158 allOf:
3159 - $ref: '#/components/schemas/DefaultApiResponse'
3160 - type: object
3161 title: 响应数据
3162 properties:
3163 data:
3164 allOf:
3165 - $ref: '#/components/schemas/LabelModel'
3166
3167 AccountLabelResponse:
3168 allOf:
3169 - $ref: '#/components/schemas/DefaultApiResponse'
3170 - type: object
3171 title: 响应数据
3172 properties:
3173 data:
3174 allOf:
3175 - type: object
3176 title: 列表数据
3177 properties:
3178 accountLabelId:
3179 title: 帐号标签ID
3180 type: string
3181
3182
3183 GroupOrganizationListResponse:
3184 allOf:
3185 - $ref: '#/components/schemas/DefaultApiResponse'
3186 - type: object
3187 title: 响应数据
3188 properties:
3189 data:
3190 allOf:
3191 - type: object
3192 title: 列表数据
3193 properties:
3194 items:
3195 title: 当前返回记录集
3196 type: array
3197 items:
3198 $ref: '#/components/schemas/GroupOrganizationModel'
3199
3200 GroupOrganizationAccountSaveResponse:
3201 allOf:
3202 - $ref: '#/components/schemas/DefaultApiResponse'
3203 - type: object
3204 title: 响应数据
3205 properties:
3206 data:
3207 allOf:
3208 - type: object
3209 title: 列表数据
3210 properties:
3211 message:
3212 title: 保存结果
3213 type: string