Gitiles
Code Review Sign In
source.supwisdom.com / institute / deploy-authx-service / febb8f29e9d1a43f6bda6c68ed73a12dda2f5f20 / . / design / 授权服务开放接口设计文档.doc
blob: a6c275ff5cc9019ca7106348ccc9d5239d1c3831 [file] [log] [blame]
刘洪青ffd8e822020-11-20 16:55:01 +0800[diff] [blame]1<!DOCTYPE html>
2<html>
3<head>
4 <meta http-equiv="Content-Type" content="application/msword; charset=utf-8"/>
5 <title>toWord</title>
6 <style type="text/css">
7 .bg {
8 font-size: 14.5px;
9 font-weight: bold;
10 color: #000;
11 background-color: #559e68;
12 }
13
14 table {
15 border-width: 1px;
16 border-style: solid;
17 border-color: black;
18 table-layout: fixed;
19 }
20
21 tr {
22 height: 32px;
23 font-size: 12px;
24 }
25
26 td {
27 padding-left: 10px;
28 border-width: 1px;
29 border-style: solid;
30 border-color: black;
31 height: 32px;
32 overflow: hidden;
33 word-break: break-all;
34 word-wrap: break-word;
35 font-size: 14.5px;
36 }
37
38 .bg td {
39 font-size: 14.5px;
40 }
41
42 tr td {
43 font-size: 14.5px;
44 }
45
46 .specialHeight {
47 height: 40px;
48 }
49
50 .first_title {
51 height: 60px;
52 line-height: 60px;
53 margin: 0;
54 font-weight: bold;
55 font-size: 21px;
56 }
57
58 .second_title {
59 height: 40px;
60 line-height: 40px;
61 margin: 0;
62 font-size: 18.5px;
63 }
64
65 .doc_title {
66 font-size: 42.5px;
67 text-align: center;
68 }
69
70 .download_btn {
71 float: right;
72 }
73
74 body {
75 font-family: 思源黑体 Normal;
76 }
77 </style>
78</head>
79
80<body>
81<div style="width:1000px; margin: 0 auto">
82 <div>
83 <p class="doc_title">User Authorization Service Platfomr Open APIs（1.0）</p>
84
85 <br>
86 </div>
87 <div style="margin-bottom:20px;">
88 <!--这个是类的说明-->
89 <h4 class="first_title">Role</h4>
90 <div>
91
92 <!--这个是每个请求的说明，方便生成文档后进行整理-->
93 <h5 class="second_title">1）获取用户帐号在某一应用下所拥有的角色</h5>
94
95 <table border="1" cellspacing="0" cellpadding="0" width="100%">
96 <tr class="bg">
97 <td colspan="5">获取用户帐号在某一应用下所拥有的角色</td>
98 </tr>
99 <tr>
100 <td width="25%">接口描述</td>
101 <td colspan="4">获取用户帐号在某一应用下所拥有的角色</td>
102 </tr>
103 <tr>
104 <td>URL</td>
105 <td colspan="4">/v1/application/{applicationId}/account/{username}/roles</td>
106 </tr>
107 <tr>
108 <td>请求方式</td>
109 <td colspan="4">get</td>
110 </tr>
111 <tr>
112 <td>请求类型</td>
113 <td colspan="4"></td>
114 </tr>
115 <tr>
116 <td>返回类型</td>
117 <td colspan="4">*/*</td>
118 </tr>
119
120 <tr class="bg">
121 <td>参数名</td>
122 <td width="15%">数据类型</td>
123 <td width="15%">参数类型</td>
124 <td width="15%">是否必填</td>
125 <td width="29%">说明</td>
126 </tr>
127
128
129 <tr>
130 <td align="left">1.applicationId</td>
131 <td>string</td>
132 <td>path</td>
133 <td>Y</td>
134
135 <td>applicationId</td>
136 <!-- <td th:if="${request.modelAttr}" th:text="asdfagadfg"></td>-->
137 </tr>
138
139
140
141
142 <tr>
143 <td align="left">2.username</td>
144 <td>string</td>
145 <td>path</td>
146 <td>Y</td>
147
148 <td>username</td>
149 <!-- <td th:if="${request.modelAttr}" th:text="asdfagadfg"></td>-->
150 </tr>
151
152
153
154
155
156 <tr class="bg">
157 <td>状态码</td>
158 <td colspan="2">描述</td>
159 <td colspan="2">说明</td>
160 </tr>
161
162 <tr>
163 <td>200</td>
164 <td colspan="2">OK</td>
165 <td colspan="2"></td>
166 </tr>
167
168 <tr>
169 <td>401</td>
170 <td colspan="2">Unauthorized</td>
171 <td colspan="2"></td>
172 </tr>
173
174 <tr>
175 <td>403</td>
176 <td colspan="2">Forbidden</td>
177 <td colspan="2"></td>
178 </tr>
179
180 <tr>
181 <td>404</td>
182 <td colspan="2">Not Found</td>
183 <td colspan="2"></td>
184 </tr>
185
186 <tr class="bg">
187 <td>返回属性名</td>
188 <td colspan="2">类型</td>
189 <td colspan="2">说明</td>
190 </tr>
191
192<!-- 对返回参数 递归生成行-->
193 <tbody>
194
195 <tr>
196 <td align="left" style="padding-left:10px">1.code</td>
197 <td colspan="2">integer(int32)</td>
198 <td colspan="2"></td>
199 </tr>
200
201
202 <tr>
203 <td align="left" style="padding-left:10px">2.data</td>
204 <td colspan="2">object:AccountApplicationRolesResponseData</td>
205 <td colspan="2"></td>
206 </tr>
207
208
209 <tr>
210 <td align="left" style="padding-left:20px">2.1.applicationId</td>
211 <td colspan="2">string</td>
212 <td colspan="2"></td>
213 </tr>
214
215
216 <tr>
217 <td align="left" style="padding-left:20px">2.2.roles</td>
218 <td colspan="2">array:Role</td>
219 <td colspan="2"></td>
220 </tr>
221
222
223 <tr>
224 <td align="left" style="padding-left:30px">2.2.1.applicationId</td>
225 <td colspan="2">string</td>
226 <td colspan="2"></td>
227 </tr>
228
229
230 <tr>
231 <td align="left" style="padding-left:30px">2.2.2.code</td>
232 <td colspan="2">string</td>
233 <td colspan="2"></td>
234 </tr>
235
236
237 <tr>
238 <td align="left" style="padding-left:30px">2.2.3.description</td>
239 <td colspan="2">string</td>
240 <td colspan="2"></td>
241 </tr>
242
243
244 <tr>
245 <td align="left" style="padding-left:30px">2.2.4.enabled</td>
246 <td colspan="2">boolean</td>
247 <td colspan="2"></td>
248 </tr>
249
250
251 <tr>
252 <td align="left" style="padding-left:30px">2.2.5.externalId</td>
253 <td colspan="2">string</td>
254 <td colspan="2"></td>
255 </tr>
256
257
258 <tr>
259 <td align="left" style="padding-left:30px">2.2.6.id</td>
260 <td colspan="2">string</td>
261 <td colspan="2">ID</td>
262 </tr>
263
264
265 <tr>
266 <td align="left" style="padding-left:30px">2.2.7.name</td>
267 <td colspan="2">string</td>
268 <td colspan="2"></td>
269 </tr>
270
271
272
273
274 <tr>
275 <td align="left" style="padding-left:20px">2.3.username</td>
276 <td colspan="2">string</td>
277 <td colspan="2"></td>
278 </tr>
279
280
281
282
283 <tr>
284 <td align="left" style="padding-left:10px">3.message</td>
285 <td colspan="2">string</td>
286 <td colspan="2"></td>
287 </tr>
288
289
290</tbody>
291
292 <tr class="bg">
293 <td colspan="5">示例</td>
294 </tr>
295 <tr class="specialHeight">
296 <td class="bg">请求参数</td>
297 <td colspan="4"></td>
298 </tr>
299 <tr class="specialHeight">
300 <td class="bg">返回值</td>
301 <td colspan="4">{&quot;code&quot;:0,&quot;data&quot;:{&quot;applicationId&quot;:&quot;string&quot;,&quot;roles&quot;:[{&quot;applicationId&quot;:&quot;string&quot;,&quot;code&quot;:&quot;string&quot;,&quot;description&quot;:&quot;string&quot;,&quot;enabled&quot;:true,&quot;externalId&quot;:&quot;string&quot;,&quot;id&quot;:&quot;string&quot;,&quot;name&quot;:&quot;string&quot;}],&quot;username&quot;:&quot;string&quot;},&quot;message&quot;:&quot;string&quot;}</td>
302 </tr>
303
304 </table>
305 </div>
306 <div>
307
308 <!--这个是每个请求的说明，方便生成文档后进行整理-->
309 <h5 class="second_title">2）获取应用下的一个角色的用户帐号</h5>
310
311 <table border="1" cellspacing="0" cellpadding="0" width="100%">
312 <tr class="bg">
313 <td colspan="5">获取应用下的一个角色的用户帐号</td>
314 </tr>
315 <tr>
316 <td width="25%">接口描述</td>
317 <td colspan="4">获取应用下的一个角色的用户帐号</td>
318 </tr>
319 <tr>
320 <td>URL</td>
321 <td colspan="4">/v1/application/{applicationId}/role/{rolecode}/accounts</td>
322 </tr>
323 <tr>
324 <td>请求方式</td>
325 <td colspan="4">get</td>
326 </tr>
327 <tr>
328 <td>请求类型</td>
329 <td colspan="4"></td>
330 </tr>
331 <tr>
332 <td>返回类型</td>
333 <td colspan="4">*/*</td>
334 </tr>
335
336 <tr class="bg">
337 <td>参数名</td>
338 <td width="15%">数据类型</td>
339 <td width="15%">参数类型</td>
340 <td width="15%">是否必填</td>
341 <td width="29%">说明</td>
342 </tr>
343
344
345 <tr>
346 <td align="left">1.applicationId</td>
347 <td>string</td>
348 <td>path</td>
349 <td>Y</td>
350
351 <td>applicationId</td>
352 <!-- <td th:if="${request.modelAttr}" th:text="asdfagadfg"></td>-->
353 </tr>
354
355
356
357
358 <tr>
359 <td align="left">2.loadAll</td>
360 <td>boolean</td>
361 <td>query</td>
362
363 <td>N</td>
364 <td>loadAll</td>
365 <!-- <td th:if="${request.modelAttr}" th:text="asdfagadfg"></td>-->
366 </tr>
367
368
369
370
371 <tr>
372 <td align="left">3.pageIndex</td>
373 <td>integer(int32)</td>
374 <td>query</td>
375
376 <td>N</td>
377 <td>pageIndex</td>
378 <!-- <td th:if="${request.modelAttr}" th:text="asdfagadfg"></td>-->
379 </tr>
380
381
382
383
384 <tr>
385 <td align="left">4.pageSize</td>
386 <td>integer(int32)</td>
387 <td>query</td>
388
389 <td>N</td>
390 <td>pageSize</td>
391 <!-- <td th:if="${request.modelAttr}" th:text="asdfagadfg"></td>-->
392 </tr>
393
394
395
396
397 <tr>
398 <td align="left">5.rolecode</td>
399 <td>string</td>
400 <td>path</td>
401 <td>Y</td>
402
403 <td>rolecode</td>
404 <!-- <td th:if="${request.modelAttr}" th:text="asdfagadfg"></td>-->
405 </tr>
406
407
408
409
410
411 <tr class="bg">
412 <td>状态码</td>
413 <td colspan="2">描述</td>
414 <td colspan="2">说明</td>
415 </tr>
416
417 <tr>
418 <td>200</td>
419 <td colspan="2">OK</td>
420 <td colspan="2"></td>
421 </tr>
422
423 <tr>
424 <td>401</td>
425 <td colspan="2">Unauthorized</td>
426 <td colspan="2"></td>
427 </tr>
428
429 <tr>
430 <td>403</td>
431 <td colspan="2">Forbidden</td>
432 <td colspan="2"></td>
433 </tr>
434
435 <tr>
436 <td>404</td>
437 <td colspan="2">Not Found</td>
438 <td colspan="2"></td>
439 </tr>
440
441 <tr class="bg">
442 <td>返回属性名</td>
443 <td colspan="2">类型</td>
444 <td colspan="2">说明</td>
445 </tr>
446
447<!-- 对返回参数 递归生成行-->
448 <tbody>
449
450 <tr>
451 <td align="left" style="padding-left:10px">1.code</td>
452 <td colspan="2">integer(int32)</td>
453 <td colspan="2"></td>
454 </tr>
455
456
457 <tr>
458 <td align="left" style="padding-left:10px">2.data</td>
459 <td colspan="2">object:ApplicationRoleAccountsResponseData</td>
460 <td colspan="2"></td>
461 </tr>
462
463
464 <tr>
465 <td align="left" style="padding-left:20px">2.1.accounts</td>
466 <td colspan="2">array</td>
467 <td colspan="2"></td>
468 </tr>
469
470
471 <tr>
472 <td align="left" style="padding-left:20px">2.2.applicationId</td>
473 <td colspan="2">string</td>
474 <td colspan="2"></td>
475 </tr>
476
477
478 <tr>
479 <td align="left" style="padding-left:20px">2.3.rolecode</td>
480 <td colspan="2">string</td>
481 <td colspan="2"></td>
482 </tr>
483
484
485
486
487 <tr>
488 <td align="left" style="padding-left:10px">3.message</td>
489 <td colspan="2">string</td>
490 <td colspan="2"></td>
491 </tr>
492
493
494</tbody>
495
496 <tr class="bg">
497 <td colspan="5">示例</td>
498 </tr>
499 <tr class="specialHeight">
500 <td class="bg">请求参数</td>
501 <td colspan="4">loadAll=true&amp;pageIndex=0&amp;pageSize=0</td>
502 </tr>
503 <tr class="specialHeight">
504 <td class="bg">返回值</td>
505 <td colspan="4">{&quot;code&quot;:0,&quot;data&quot;:{&quot;accounts&quot;:[{}],&quot;applicationId&quot;:&quot;string&quot;,&quot;rolecode&quot;:&quot;string&quot;},&quot;message&quot;:&quot;string&quot;}</td>
506 </tr>
507
508 </table>
509 </div>
510 <div>
511
512 <!--这个是每个请求的说明，方便生成文档后进行整理-->
513 <h5 class="second_title">3）获取应用下的一个角色关联的用户组</h5>
514
515 <table border="1" cellspacing="0" cellpadding="0" width="100%">
516 <tr class="bg">
517 <td colspan="5">获取应用下的一个角色关联的用户组</td>
518 </tr>
519 <tr>
520 <td width="25%">接口描述</td>
521 <td colspan="4">获取应用下的一个角色关联的用户组</td>
522 </tr>
523 <tr>
524 <td>URL</td>
525 <td colspan="4">/v1/application/{applicationId}/role/{rolecode}/groups</td>
526 </tr>
527 <tr>
528 <td>请求方式</td>
529 <td colspan="4">get</td>
530 </tr>
531 <tr>
532 <td>请求类型</td>
533 <td colspan="4"></td>
534 </tr>
535 <tr>
536 <td>返回类型</td>
537 <td colspan="4">*/*</td>
538 </tr>
539
540 <tr class="bg">
541 <td>参数名</td>
542 <td width="15%">数据类型</td>
543 <td width="15%">参数类型</td>
544 <td width="15%">是否必填</td>
545 <td width="29%">说明</td>
546 </tr>
547
548
549 <tr>
550 <td align="left">1.applicationId</td>
551 <td>string</td>
552 <td>path</td>
553 <td>Y</td>
554
555 <td>applicationId</td>
556 <!-- <td th:if="${request.modelAttr}" th:text="asdfagadfg"></td>-->
557 </tr>
558
559
560
561
562 <tr>
563 <td align="left">2.groupType</td>
564 <td>string</td>
565 <td>query</td>
566
567 <td>N</td>
568 <td>groupType</td>
569 <!-- <td th:if="${request.modelAttr}" th:text="asdfagadfg"></td>-->
570 </tr>
571
572
573
574
575 <tr>
576 <td align="left">3.rolecode</td>
577 <td>string</td>
578 <td>path</td>
579 <td>Y</td>
580
581 <td>rolecode</td>
582 <!-- <td th:if="${request.modelAttr}" th:text="asdfagadfg"></td>-->
583 </tr>
584
585
586
587
588
589 <tr class="bg">
590 <td>状态码</td>
591 <td colspan="2">描述</td>
592 <td colspan="2">说明</td>
593 </tr>
594
595 <tr>
596 <td>200</td>
597 <td colspan="2">OK</td>
598 <td colspan="2"></td>
599 </tr>
600
601 <tr>
602 <td>401</td>
603 <td colspan="2">Unauthorized</td>
604 <td colspan="2"></td>
605 </tr>
606
607 <tr>
608 <td>403</td>
609 <td colspan="2">Forbidden</td>
610 <td colspan="2"></td>
611 </tr>
612
613 <tr>
614 <td>404</td>
615 <td colspan="2">Not Found</td>
616 <td colspan="2"></td>
617 </tr>
618
619 <tr class="bg">
620 <td>返回属性名</td>
621 <td colspan="2">类型</td>
622 <td colspan="2">说明</td>
623 </tr>
624
625<!-- 对返回参数 递归生成行-->
626 <tbody>
627
628 <tr>
629 <td align="left" style="padding-left:10px">1.code</td>
630 <td colspan="2">integer(int32)</td>
631 <td colspan="2"></td>
632 </tr>
633
634
635 <tr>
636 <td align="left" style="padding-left:10px">2.data</td>
637 <td colspan="2">object:ApplicationRoleGroupsResponseData</td>
638 <td colspan="2"></td>
639 </tr>
640
641
642 <tr>
643 <td align="left" style="padding-left:20px">2.1.applicationId</td>
644 <td colspan="2">string</td>
645 <td colspan="2"></td>
646 </tr>
647
648
649 <tr>
650 <td align="left" style="padding-left:20px">2.2.groupIds</td>
651 <td colspan="2">array</td>
652 <td colspan="2"></td>
653 </tr>
654
655
656 <tr>
657 <td align="left" style="padding-left:20px">2.3.groups</td>
658 <td colspan="2">array:GroupModel</td>
659 <td colspan="2"></td>
660 </tr>
661
662
663 <tr>
664 <td align="left" style="padding-left:30px">2.3.1.applicationId</td>
665 <td colspan="2">string</td>
666 <td colspan="2"></td>
667 </tr>
668
669
670 <tr>
671 <td align="left" style="padding-left:30px">2.3.2.code</td>
672 <td colspan="2">string</td>
673 <td colspan="2"></td>
674 </tr>
675
676
677 <tr>
678 <td align="left" style="padding-left:30px">2.3.3.common</td>
679 <td colspan="2">boolean</td>
680 <td colspan="2"></td>
681 </tr>
682
683
684 <tr>
685 <td align="left" style="padding-left:30px">2.3.4.description</td>
686 <td colspan="2">string</td>
687 <td colspan="2"></td>
688 </tr>
689
690
691 <tr>
692 <td align="left" style="padding-left:30px">2.3.5.id</td>
693 <td colspan="2">string</td>
694 <td colspan="2"></td>
695 </tr>
696
697
698 <tr>
699 <td align="left" style="padding-left:30px">2.3.6.name</td>
700 <td colspan="2">string</td>
701 <td colspan="2"></td>
702 </tr>
703
704
705 <tr>
706 <td align="left" style="padding-left:30px">2.3.7.sort</td>
707 <td colspan="2">integer(int32)</td>
708 <td colspan="2"></td>
709 </tr>
710
711
712 <tr>
713 <td align="left" style="padding-left:30px">2.3.8.state</td>
714 <td colspan="2">integer(int32)</td>
715 <td colspan="2"></td>
716 </tr>
717
718
719 <tr>
720 <td align="left" style="padding-left:30px">2.3.9.type</td>
721 <td colspan="2">string</td>
722 <td colspan="2"></td>
723 </tr>
724
725
726
727
728 <tr>
729 <td align="left" style="padding-left:20px">2.4.rolecode</td>
730 <td colspan="2">string</td>
731 <td colspan="2"></td>
732 </tr>
733
734
735
736
737 <tr>
738 <td align="left" style="padding-left:10px">3.message</td>
739 <td colspan="2">string</td>
740 <td colspan="2"></td>
741 </tr>
742
743
744</tbody>
745
746 <tr class="bg">
747 <td colspan="5">示例</td>
748 </tr>
749 <tr class="specialHeight">
750 <td class="bg">请求参数</td>
751 <td colspan="4">groupType=string</td>
752 </tr>
753 <tr class="specialHeight">
754 <td class="bg">返回值</td>
755 <td colspan="4">{&quot;code&quot;:0,&quot;data&quot;:{&quot;applicationId&quot;:&quot;string&quot;,&quot;groupIds&quot;:[{}],&quot;groups&quot;:[{&quot;applicationId&quot;:&quot;string&quot;,&quot;code&quot;:&quot;string&quot;,&quot;common&quot;:true,&quot;description&quot;:&quot;string&quot;,&quot;id&quot;:&quot;string&quot;,&quot;name&quot;:&quot;string&quot;,&quot;sort&quot;:0,&quot;state&quot;:0,&quot;type&quot;:&quot;string&quot;}],&quot;rolecode&quot;:&quot;string&quot;},&quot;message&quot;:&quot;string&quot;}</td>
756 </tr>
757
758 </table>
759 </div>
760 <div>
761
762 <!--这个是每个请求的说明，方便生成文档后进行整理-->
763 <h5 class="second_title">4）获取应用下的角色列表</h5>
764
765 <table border="1" cellspacing="0" cellpadding="0" width="100%">
766 <tr class="bg">
767 <td colspan="5">获取应用下的角色列表</td>
768 </tr>
769 <tr>
770 <td width="25%">接口描述</td>
771 <td colspan="4">获取应用下的角色列表</td>
772 </tr>
773 <tr>
774 <td>URL</td>
775 <td colspan="4">/v1/application/{applicationId}/roles</td>
776 </tr>
777 <tr>
778 <td>请求方式</td>
779 <td colspan="4">get</td>
780 </tr>
781 <tr>
782 <td>请求类型</td>
783 <td colspan="4"></td>
784 </tr>
785 <tr>
786 <td>返回类型</td>
787 <td colspan="4">*/*</td>
788 </tr>
789
790 <tr class="bg">
791 <td>参数名</td>
792 <td width="15%">数据类型</td>
793 <td width="15%">参数类型</td>
794 <td width="15%">是否必填</td>
795 <td width="29%">说明</td>
796 </tr>
797
798
799 <tr>
800 <td align="left">1.applicationId</td>
801 <td>string</td>
802 <td>path</td>
803 <td>Y</td>
804
805 <td>applicationId</td>
806 <!-- <td th:if="${request.modelAttr}" th:text="asdfagadfg"></td>-->
807 </tr>
808
809
810
811
812
813 <tr class="bg">
814 <td>状态码</td>
815 <td colspan="2">描述</td>
816 <td colspan="2">说明</td>
817 </tr>
818
819 <tr>
820 <td>200</td>
821 <td colspan="2">OK</td>
822 <td colspan="2"></td>
823 </tr>
824
825 <tr>
826 <td>401</td>
827 <td colspan="2">Unauthorized</td>
828 <td colspan="2"></td>
829 </tr>
830
831 <tr>
832 <td>403</td>
833 <td colspan="2">Forbidden</td>
834 <td colspan="2"></td>
835 </tr>
836
837 <tr>
838 <td>404</td>
839 <td colspan="2">Not Found</td>
840 <td colspan="2"></td>
841 </tr>
842
843 <tr class="bg">
844 <td>返回属性名</td>
845 <td colspan="2">类型</td>
846 <td colspan="2">说明</td>
847 </tr>
848
849<!-- 对返回参数 递归生成行-->
850 <tbody>
851
852 <tr>
853 <td align="left" style="padding-left:10px">1.code</td>
854 <td colspan="2">integer(int32)</td>
855 <td colspan="2"></td>
856 </tr>
857
858
859 <tr>
860 <td align="left" style="padding-left:10px">2.data</td>
861 <td colspan="2">object:ApplicationRolesResponseData</td>
862 <td colspan="2"></td>
863 </tr>
864
865
866 <tr>
867 <td align="left" style="padding-left:20px">2.1.applicationId</td>
868 <td colspan="2">string</td>
869 <td colspan="2"></td>
870 </tr>
871
872
873 <tr>
874 <td align="left" style="padding-left:20px">2.2.roles</td>
875 <td colspan="2">array:Role</td>
876 <td colspan="2"></td>
877 </tr>
878
879
880 <tr>
881 <td align="left" style="padding-left:30px">2.2.1.applicationId</td>
882 <td colspan="2">string</td>
883 <td colspan="2"></td>
884 </tr>
885
886
887 <tr>
888 <td align="left" style="padding-left:30px">2.2.2.code</td>
889 <td colspan="2">string</td>
890 <td colspan="2"></td>
891 </tr>
892
893
894 <tr>
895 <td align="left" style="padding-left:30px">2.2.3.description</td>
896 <td colspan="2">string</td>
897 <td colspan="2"></td>
898 </tr>
899
900
901 <tr>
902 <td align="left" style="padding-left:30px">2.2.4.enabled</td>
903 <td colspan="2">boolean</td>
904 <td colspan="2"></td>
905 </tr>
906
907
908 <tr>
909 <td align="left" style="padding-left:30px">2.2.5.externalId</td>
910 <td colspan="2">string</td>
911 <td colspan="2"></td>
912 </tr>
913
914
915 <tr>
916 <td align="left" style="padding-left:30px">2.2.6.id</td>
917 <td colspan="2">string</td>
918 <td colspan="2">ID</td>
919 </tr>
920
921
922 <tr>
923 <td align="left" style="padding-left:30px">2.2.7.name</td>
924 <td colspan="2">string</td>
925 <td colspan="2"></td>
926 </tr>
927
928
929
930
931
932
933 <tr>
934 <td align="left" style="padding-left:10px">3.message</td>
935 <td colspan="2">string</td>
936 <td colspan="2"></td>
937 </tr>
938
939
940</tbody>
941
942 <tr class="bg">
943 <td colspan="5">示例</td>
944 </tr>
945 <tr class="specialHeight">
946 <td class="bg">请求参数</td>
947 <td colspan="4"></td>
948 </tr>
949 <tr class="specialHeight">
950 <td class="bg">返回值</td>
951 <td colspan="4">{&quot;code&quot;:0,&quot;data&quot;:{&quot;applicationId&quot;:&quot;string&quot;,&quot;roles&quot;:[{&quot;applicationId&quot;:&quot;string&quot;,&quot;code&quot;:&quot;string&quot;,&quot;description&quot;:&quot;string&quot;,&quot;enabled&quot;:true,&quot;externalId&quot;:&quot;string&quot;,&quot;id&quot;:&quot;string&quot;,&quot;name&quot;:&quot;string&quot;}]},&quot;message&quot;:&quot;string&quot;}</td>
952 </tr>
953
954 </table>
955 </div>
956 <div>
957
958 <!--这个是每个请求的说明，方便生成文档后进行整理-->
959 <h5 class="second_title">5）获取应用下的多个角色的用户帐号</h5>
960
961 <table border="1" cellspacing="0" cellpadding="0" width="100%">
962 <tr class="bg">
963 <td colspan="5">获取应用下的多个角色的用户帐号</td>
964 </tr>
965 <tr>
966 <td width="25%">接口描述</td>
967 <td colspan="4">获取应用下的多个角色的用户帐号</td>
968 </tr>
969 <tr>
970 <td>URL</td>
971 <td colspan="4">/v1/application/{applicationId}/roles/accounts</td>
972 </tr>
973 <tr>
974 <td>请求方式</td>
975 <td colspan="4">post</td>
976 </tr>
977 <tr>
978 <td>请求类型</td>
979 <td colspan="4">application/json</td>
980 </tr>
981 <tr>
982 <td>返回类型</td>
983 <td colspan="4">*/*</td>
984 </tr>
985
986 <tr class="bg">
987 <td>参数名</td>
988 <td width="15%">数据类型</td>
989 <td width="15%">参数类型</td>
990 <td width="15%">是否必填</td>
991 <td width="29%">说明</td>
992 </tr>
993
994
995 <tr>
996 <td align="left">1.applicationId</td>
997 <td>string</td>
998 <td>path</td>
999 <td>Y</td>
1000
1001 <td>applicationId</td>
1002 <!-- <td th:if="${request.modelAttr}" th:text="asdfagadfg"></td>-->
1003 </tr>
1004
1005
1006
1007
1008 <tr>
1009 <td align="left">2.loadAll</td>
1010 <td>boolean</td>
1011 <td>query</td>
1012
1013 <td>N</td>
1014 <td>loadAll</td>
1015 <!-- <td th:if="${request.modelAttr}" th:text="asdfagadfg"></td>-->
1016 </tr>
1017
1018
1019
1020
1021 <tr>
1022 <td align="left">3.pageIndex</td>
1023 <td>integer(int32)</td>
1024 <td>query</td>
1025
1026 <td>N</td>
1027 <td>pageIndex</td>
1028 <!-- <td th:if="${request.modelAttr}" th:text="asdfagadfg"></td>-->
1029 </tr>
1030
1031
1032
1033
1034 <tr>
1035 <td align="left">4.pageSize</td>
1036 <td>integer(int32)</td>
1037 <td>query</td>
1038
1039 <td>N</td>
1040 <td>pageSize</td>
1041 <!-- <td th:if="${request.modelAttr}" th:text="asdfagadfg"></td>-->
1042 </tr>
1043
1044
1045
1046
1047 <tr>
1048 <td align="left">5.roleIds</td>
1049 <td>array</td>
1050 <td>body</td>
1051 <td>Y</td>
1052
1053 <td>roleIds</td>
1054 <!-- <td th:if="${request.modelAttr}" th:text="asdfagadfg"></td>-->
1055 </tr>
1056
1057
1058
1059
1060
1061 <tr class="bg">
1062 <td>状态码</td>
1063 <td colspan="2">描述</td>
1064 <td colspan="2">说明</td>
1065 </tr>
1066
1067 <tr>
1068 <td>200</td>
1069 <td colspan="2">OK</td>
1070 <td colspan="2"></td>
1071 </tr>
1072
1073 <tr>
1074 <td>201</td>
1075 <td colspan="2">Created</td>
1076 <td colspan="2"></td>
1077 </tr>
1078
1079 <tr>
1080 <td>401</td>
1081 <td colspan="2">Unauthorized</td>
1082 <td colspan="2"></td>
1083 </tr>
1084
1085 <tr>
1086 <td>403</td>
1087 <td colspan="2">Forbidden</td>
1088 <td colspan="2"></td>
1089 </tr>
1090
1091 <tr>
1092 <td>404</td>
1093 <td colspan="2">Not Found</td>
1094 <td colspan="2"></td>
1095 </tr>
1096
1097 <tr class="bg">
1098 <td>返回属性名</td>
1099 <td colspan="2">类型</td>
1100 <td colspan="2">说明</td>
1101 </tr>
1102
1103<!-- 对返回参数 递归生成行-->
1104 <tbody>
1105
1106 <tr>
1107 <td align="left" style="padding-left:10px">1.code</td>
1108 <td colspan="2">integer(int32)</td>
1109 <td colspan="2"></td>
1110 </tr>
1111
1112
1113 <tr>
1114 <td align="left" style="padding-left:10px">2.data</td>
1115 <td colspan="2">object:ApplicationRolesAccountsResponseData</td>
1116 <td colspan="2"></td>
1117 </tr>
1118
1119
1120 <tr>
1121 <td align="left" style="padding-left:20px">2.1.accounts</td>
1122 <td colspan="2">array</td>
1123 <td colspan="2"></td>
1124 </tr>
1125
1126
1127 <tr>
1128 <td align="left" style="padding-left:20px">2.2.applicationId</td>
1129 <td colspan="2">string</td>
1130 <td colspan="2"></td>
1131 </tr>
1132
1133
1134 <tr>
1135 <td align="left" style="padding-left:20px">2.3.roleIds</td>
1136 <td colspan="2">array</td>
1137 <td colspan="2"></td>
1138 </tr>
1139
1140
1141
1142
1143 <tr>
1144 <td align="left" style="padding-left:10px">3.message</td>
1145 <td colspan="2">string</td>
1146 <td colspan="2"></td>
1147 </tr>
1148
1149
1150</tbody>
1151
1152 <tr class="bg">
1153 <td colspan="5">示例</td>
1154 </tr>
1155 <tr class="specialHeight">
1156 <td class="bg">请求参数</td>
1157 <td colspan="4">loadAll=true&amp;pageIndex=0&amp;pageSize=0 -d &#39;[{}]&#39;</td>
1158 </tr>
1159 <tr class="specialHeight">
1160 <td class="bg">返回值</td>
1161 <td colspan="4">{&quot;code&quot;:0,&quot;data&quot;:{&quot;accounts&quot;:[{}],&quot;applicationId&quot;:&quot;string&quot;,&quot;roleIds&quot;:[{}]},&quot;message&quot;:&quot;string&quot;}</td>
1162 </tr>
1163
1164 </table>
1165 </div>
1166 </div>
1167</div>
1168
1169
1170
1171
1172
1173
1174
1175
1176</body>
1177</html>