@kne/fastify-account 1.0.0-alpha.8 → 2.0.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/README.md +6 -2046
  2. package/index.js +33 -20
  3. package/libs/controllers/account.js +246 -173
  4. package/libs/controllers/admin-user.js +110 -0
  5. package/libs/controllers/admin.js +55 -146
  6. package/libs/controllers/user.js +7 -24
  7. package/libs/models/example._js +13 -0
  8. package/libs/models/user-account.js +13 -32
  9. package/libs/models/user.js +37 -36
  10. package/libs/models/verification-code.js +16 -21
  11. package/libs/services/account.js +124 -149
  12. package/libs/services/admin.js +21 -75
  13. package/libs/services/user.js +52 -58
  14. package/package.json +24 -28
  15. package/libs/controllers/adminPermission.js +0 -237
  16. package/libs/controllers/adminRole.js +0 -146
  17. package/libs/controllers/adminTenant.js +0 -464
  18. package/libs/controllers/tenant.js +0 -34
  19. package/libs/models/admin-role.js +0 -15
  20. package/libs/models/application.js +0 -42
  21. package/libs/models/login-log.js +0 -11
  22. package/libs/models/permission.js +0 -51
  23. package/libs/models/tenant-application.js +0 -26
  24. package/libs/models/tenant-org.js +0 -26
  25. package/libs/models/tenant-permission.js +0 -26
  26. package/libs/models/tenant-role-application.js +0 -37
  27. package/libs/models/tenant-role-permission.js +0 -34
  28. package/libs/models/tenant-role.js +0 -23
  29. package/libs/models/tenant-share-group-permission.js +0 -18
  30. package/libs/models/tenant-share-group.js +0 -18
  31. package/libs/models/tenant-source-user-share-group.js +0 -18
  32. package/libs/models/tenant-token.js +0 -30
  33. package/libs/models/tenant-user-org.js +0 -23
  34. package/libs/models/tenant-user-role.js +0 -23
  35. package/libs/models/tenant-user-share-group.js +0 -18
  36. package/libs/models/tenant-user.js +0 -75
  37. package/libs/models/tenant.js +0 -46
  38. package/libs/services/application.js +0 -151
  39. package/libs/services/permission.js +0 -367
  40. package/libs/services/tenant-invite.js +0 -62
  41. package/libs/services/tenant-org.js +0 -97
  42. package/libs/services/tenant-role.js +0 -108
  43. package/libs/services/tenant-user.js +0 -549
  44. package/libs/services/tenant.js +0 -132
package/README.md CHANGED
@@ -1,16 +1,16 @@
1
1
 
2
- # fastify-account
2
+ # fastify-user
3
3
 
4
4
 
5
5
  ### 描述
6
6
 
7
- fastify的用户管理账号等实现
7
+ 用于用户注册登录认证
8
8
 
9
9
 
10
10
  ### 安装
11
11
 
12
12
  ```shell
13
- npm i --save @kne/fastify-account
13
+ npm i --save @kne/fastify-user
14
14
  ```
15
15
 
16
16
  ### 示例
@@ -21,2047 +21,7 @@ npm i --save @kne/fastify-account
21
21
 
22
22
  ### API
23
23
 
24
- ---
25
- title: "@kne/fastify-account v1.0.0-alpha.7"
26
- language_tabs:
27
- - shell: Shell
28
- - http: HTTP
29
- - javascript: JavaScript
30
- - ruby: Ruby
31
- - python: Python
32
- - php: PHP
33
- - java: Java
34
- - go: Go
35
- toc_footers: []
36
- includes: []
37
- search: true
38
- highlight_theme: darkula
39
- headingLevel: 2
40
-
41
- ---
42
-
43
- <!-- Generator: Widdershins v4.0.1 -->
44
-
45
- <h1 id="-kne-fastify-account">@kne/fastify-account v1.0.0-alpha.7</h1>
46
-
47
- > Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
48
-
49
- fastify的用户管理账号等实现
50
-
51
- <h1 id="-kne-fastify-account-default">Default</h1>
52
-
53
- ## post__api_v1_account_sendEmailCode
54
-
55
- `POST /api/v1/account/sendEmailCode`
56
-
57
- > Body parameter
58
-
59
- ```json
60
- {
61
- "type": "object",
62
- "required": [
63
- "email"
64
- ],
65
- "properties": {
66
- "email": {
67
- "type": "string",
68
- "description": "邮箱"
69
- }
70
- }
71
- }
72
- ```
73
-
74
- <h3 id="post__api_v1_account_sendemailcode-parameters">Parameters</h3>
75
-
76
- |Name|In|Type|Required|Description|
77
- |---|---|---|---|---|
78
- |body|body|object|true|none|
79
- |» email|body|string|true|邮箱|
80
-
81
- > Example responses
82
-
83
- > 200 Response
84
-
85
- ```json
86
- {
87
- "type": "object",
88
- "properties": {
89
- "code": {
90
- "type": "number"
91
- },
92
- "data": {
93
- "type": "object",
94
- "properties": {
95
- "code": {
96
- "type": "string",
97
- "description": "验证码"
98
- }
99
- }
100
- },
101
- "msg": {
102
- "type": "string"
103
- }
104
- }
105
- }
106
- ```
107
-
108
- <h3 id="post__api_v1_account_sendemailcode-responses">Responses</h3>
109
-
110
- |Status|Meaning|Description|Schema|
111
- |---|---|---|---|
112
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|Inline|
113
-
114
- <h3 id="post__api_v1_account_sendemailcode-responseschema">Response Schema</h3>
115
-
116
- Status Code **200**
117
-
118
- |Name|Type|Required|Restrictions|Description|
119
- |---|---|---|---|---|
120
- |» code|number|false|none|none|
121
- |» data|object|false|none|none|
122
- |»» code|string|false|none|验证码|
123
- |» msg|string|false|none|none|
124
-
125
- <aside class="success">
126
- This operation does not require authentication
127
- </aside>
128
-
129
- ## post__api_v1_account_sendSMSCode
130
-
131
- `POST /api/v1/account/sendSMSCode`
132
-
133
- > Body parameter
134
-
135
- ```json
136
- {
137
- "type": "object",
138
- "required": [
139
- "phone"
140
- ],
141
- "properties": {
142
- "phone": {
143
- "type": "string",
144
- "description": "电话"
145
- }
146
- }
147
- }
148
- ```
149
-
150
- <h3 id="post__api_v1_account_sendsmscode-parameters">Parameters</h3>
151
-
152
- |Name|In|Type|Required|Description|
153
- |---|---|---|---|---|
154
- |body|body|object|true|none|
155
- |» phone|body|string|true|电话|
156
-
157
- <h3 id="post__api_v1_account_sendsmscode-responses">Responses</h3>
158
-
159
- |Status|Meaning|Description|Schema|
160
- |---|---|---|---|
161
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
162
-
163
- <aside class="success">
164
- This operation does not require authentication
165
- </aside>
166
-
167
- ## post__api_v1_account_validateCode
168
-
169
- `POST /api/v1/account/validateCode`
170
-
171
- > Body parameter
172
-
173
- ```json
174
- {
175
- "type": "object",
176
- "required": [
177
- "name",
178
- "type",
179
- "code"
180
- ],
181
- "properties": {
182
- "name": {
183
- "type": "string",
184
- "description": "被验证的账号,手机或邮箱"
185
- },
186
- "type": {
187
- "type": "number",
188
- "description": "0:手机注册,1:邮箱注册,2:手机登录,3:邮箱登录,4:验证租户管理员"
189
- },
190
- "code": {
191
- "type": "string",
192
- "description": "接受到的验证码"
193
- }
194
- }
195
- }
196
- ```
197
-
198
- <h3 id="post__api_v1_account_validatecode-parameters">Parameters</h3>
199
-
200
- |Name|In|Type|Required|Description|
201
- |---|---|---|---|---|
202
- |body|body|object|true|none|
203
- |» name|body|string|true|被验证的账号,手机或邮箱|
204
- |» type|body|number|true|0:手机注册,1:邮箱注册,2:手机登录,3:邮箱登录,4:验证租户管理员|
205
- |» code|body|string|true|接受到的验证码|
206
-
207
- <h3 id="post__api_v1_account_validatecode-responses">Responses</h3>
208
-
209
- |Status|Meaning|Description|Schema|
210
- |---|---|---|---|
211
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
212
-
213
- <aside class="success">
214
- This operation does not require authentication
215
- </aside>
216
-
217
- ## post__api_v1_account_accountIsExists
218
-
219
- `POST /api/v1/account/accountIsExists`
220
-
221
- > Body parameter
222
-
223
- ```json
224
- {
225
- "oneOf": [
226
- {
227
- "type": "object",
228
- "required": [
229
- "phone"
230
- ],
231
- "properties": {
232
- "phone": {
233
- "type": "string"
234
- }
235
- }
236
- },
237
- {
238
- "type": "object",
239
- "required": [
240
- "email"
241
- ],
242
- "properties": {
243
- "email": {
244
- "type": "string"
245
- }
246
- }
247
- }
248
- ]
249
- }
250
- ```
251
-
252
- <h3 id="post__api_v1_account_accountisexists-parameters">Parameters</h3>
253
-
254
- |Name|In|Type|Required|Description|
255
- |---|---|---|---|---|
256
- |body|body|any|false|none|
257
-
258
- <h3 id="post__api_v1_account_accountisexists-responses">Responses</h3>
259
-
260
- |Status|Meaning|Description|Schema|
261
- |---|---|---|---|
262
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
263
-
264
- <aside class="success">
265
- This operation does not require authentication
266
- </aside>
267
-
268
- ## post__api_v1_account_register
269
-
270
- `POST /api/v1/account/register`
271
-
272
- > Body parameter
273
-
274
- ```json
275
- {
276
- "oneOf": [
277
- {
278
- "type": "object",
279
- "required": [
280
- "phone",
281
- "password",
282
- "code"
283
- ],
284
- "properties": {
285
- "avatar": {
286
- "type": "string"
287
- },
288
- "phone": {
289
- "type": "string"
290
- },
291
- "code": {
292
- "type": "string"
293
- },
294
- "password": {
295
- "type": "string"
296
- },
297
- "invitationCode": {
298
- "type": "string"
299
- },
300
- "nickname": {
301
- "type": "string"
302
- },
303
- "gender": {
304
- "type": "string"
305
- },
306
- "birthday": {
307
- "type": "string",
308
- "format": "date"
309
- },
310
- "description": {
311
- "type": "string"
312
- }
313
- }
314
- },
315
- {
316
- "type": "object",
317
- "required": [
318
- "email",
319
- "password",
320
- "code"
321
- ],
322
- "properties": {
323
- "avatar": {
324
- "type": "string"
325
- },
326
- "email": {
327
- "type": "string"
328
- },
329
- "code": {
330
- "type": "string"
331
- },
332
- "password": {
333
- "type": "string"
334
- },
335
- "invitationCode": {
336
- "type": "string"
337
- },
338
- "nickname": {
339
- "type": "string"
340
- },
341
- "gender": {
342
- "type": "string"
343
- },
344
- "birthday": {
345
- "type": "string",
346
- "format": "date"
347
- },
348
- "description": {
349
- "type": "string"
350
- }
351
- }
352
- }
353
- ]
354
- }
355
- ```
356
-
357
- <h3 id="post__api_v1_account_register-parameters">Parameters</h3>
358
-
359
- |Name|In|Type|Required|Description|
360
- |---|---|---|---|---|
361
- |body|body|any|false|none|
362
-
363
- <h3 id="post__api_v1_account_register-responses">Responses</h3>
364
-
365
- |Status|Meaning|Description|Schema|
366
- |---|---|---|---|
367
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
368
-
369
- <aside class="success">
370
- This operation does not require authentication
371
- </aside>
372
-
373
- ## post__api_v1_account_login
374
-
375
- `POST /api/v1/account/login`
376
-
377
- > Body parameter
378
-
379
- ```json
380
- {
381
- "type": "object",
382
- "required": [
383
- "username",
384
- "password"
385
- ],
386
- "properties": {
387
- "username": {
388
- "type": "string"
389
- },
390
- "password": {
391
- "type": "string"
392
- }
393
- }
394
- }
395
- ```
396
-
397
- <h3 id="post__api_v1_account_login-parameters">Parameters</h3>
398
-
399
- |Name|In|Type|Required|Description|
400
- |---|---|---|---|---|
401
- |body|body|object|true|none|
402
- |» username|body|string|true|none|
403
- |» password|body|string|true|none|
404
-
405
- <h3 id="post__api_v1_account_login-responses">Responses</h3>
406
-
407
- |Status|Meaning|Description|Schema|
408
- |---|---|---|---|
409
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
410
-
411
- <aside class="success">
412
- This operation does not require authentication
413
- </aside>
414
-
415
- ## post__api_v1_account_initSuperAdmin
416
-
417
- `POST /api/v1/account/initSuperAdmin`
418
-
419
- <h3 id="post__api_v1_account_initsuperadmin-responses">Responses</h3>
420
-
421
- |Status|Meaning|Description|Schema|
422
- |---|---|---|---|
423
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
424
-
425
- <aside class="success">
426
- This operation does not require authentication
427
- </aside>
428
-
429
- ## get__api_v1_account_admin_getSuperAdminInfo
430
-
431
- `GET /api/v1/account/admin/getSuperAdminInfo`
432
-
433
- <h3 id="get__api_v1_account_admin_getsuperadmininfo-responses">Responses</h3>
434
-
435
- |Status|Meaning|Description|Schema|
436
- |---|---|---|---|
437
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
438
-
439
- <aside class="success">
440
- This operation does not require authentication
441
- </aside>
442
-
443
- ## post__api_v1_account_admin_addUser
444
-
445
- `POST /api/v1/account/admin/addUser`
446
-
447
- > Body parameter
448
-
449
- ```json
450
- {
451
- "type": "object",
452
- "properties": {}
453
- }
454
- ```
455
-
456
- <h3 id="post__api_v1_account_admin_adduser-parameters">Parameters</h3>
457
-
458
- |Name|In|Type|Required|Description|
459
- |---|---|---|---|---|
460
- |body|body|object|false|none|
461
-
462
- <h3 id="post__api_v1_account_admin_adduser-responses">Responses</h3>
463
-
464
- |Status|Meaning|Description|Schema|
465
- |---|---|---|---|
466
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
467
-
468
- <aside class="success">
469
- This operation does not require authentication
470
- </aside>
471
-
472
- ## get__api_v1_account_admin_getAllUserList
473
-
474
- `GET /api/v1/account/admin/getAllUserList`
475
-
476
- <h3 id="get__api_v1_account_admin_getalluserlist-responses">Responses</h3>
477
-
478
- |Status|Meaning|Description|Schema|
479
- |---|---|---|---|
480
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
481
-
482
- <aside class="success">
483
- This operation does not require authentication
484
- </aside>
485
-
486
- ## post__api_v1_account_admin_resetUserPassword
487
-
488
- `POST /api/v1/account/admin/resetUserPassword`
489
-
490
- > Body parameter
491
-
492
- ```json
493
- {
494
- "type": "object",
495
- "required": [
496
- "userId",
497
- "password"
498
- ],
499
- "properties": {
500
- "password": {
501
- "type": "string"
502
- },
503
- "userId": {
504
- "type": "string"
505
- }
506
- }
507
- }
508
- ```
509
-
510
- <h3 id="post__api_v1_account_admin_resetuserpassword-parameters">Parameters</h3>
511
-
512
- |Name|In|Type|Required|Description|
513
- |---|---|---|---|---|
514
- |body|body|object|true|none|
515
- |» password|body|string|true|none|
516
- |» userId|body|string|true|none|
517
-
518
- <h3 id="post__api_v1_account_admin_resetuserpassword-responses">Responses</h3>
519
-
520
- |Status|Meaning|Description|Schema|
521
- |---|---|---|---|
522
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
523
-
524
- <aside class="success">
525
- This operation does not require authentication
526
- </aside>
527
-
528
- ## post__api_v1_account_admin_saveUser
529
-
530
- `POST /api/v1/account/admin/saveUser`
531
-
532
- > Body parameter
533
-
534
- ```json
535
- {
536
- "type": "object",
537
- "required": [
538
- "id"
539
- ],
540
- "properties": {
541
- "id": {
542
- "type": "string"
543
- },
544
- "avatar": {
545
- "type": "string"
546
- },
547
- "nickname": {
548
- "type": "string"
549
- },
550
- "phone": {
551
- "type": "string"
552
- },
553
- "email": {
554
- "type": "string"
555
- },
556
- "description": {
557
- "type": "string"
558
- }
559
- }
560
- }
561
- ```
562
-
563
- <h3 id="post__api_v1_account_admin_saveuser-parameters">Parameters</h3>
564
-
565
- |Name|In|Type|Required|Description|
566
- |---|---|---|---|---|
567
- |body|body|object|true|none|
568
- |» id|body|string|true|none|
569
- |» avatar|body|string|false|none|
570
- |» nickname|body|string|false|none|
571
- |» phone|body|string|false|none|
572
- |» email|body|string|false|none|
573
- |» description|body|string|false|none|
574
-
575
- <h3 id="post__api_v1_account_admin_saveuser-responses">Responses</h3>
576
-
577
- |Status|Meaning|Description|Schema|
578
- |---|---|---|---|
579
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
580
-
581
- <aside class="success">
582
- This operation does not require authentication
583
- </aside>
584
-
585
- ## post__api_v1_account_admin_closeUser
586
-
587
- `POST /api/v1/account/admin/closeUser`
588
-
589
- > Body parameter
590
-
591
- ```json
592
- {
593
- "type": "object",
594
- "required": [
595
- "id"
596
- ],
597
- "properties": {
598
- "id": {
599
- "type": "string"
600
- }
601
- }
602
- }
603
- ```
604
-
605
- <h3 id="post__api_v1_account_admin_closeuser-parameters">Parameters</h3>
606
-
607
- |Name|In|Type|Required|Description|
608
- |---|---|---|---|---|
609
- |body|body|object|true|none|
610
- |» id|body|string|true|none|
611
-
612
- <h3 id="post__api_v1_account_admin_closeuser-responses">Responses</h3>
613
-
614
- |Status|Meaning|Description|Schema|
615
- |---|---|---|---|
616
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
617
-
618
- <aside class="success">
619
- This operation does not require authentication
620
- </aside>
621
-
622
- ## post__api_v1_account_admin_openUser
623
-
624
- `POST /api/v1/account/admin/openUser`
625
-
626
- > Body parameter
627
-
628
- ```json
629
- {
630
- "type": "object",
631
- "required": [
632
- "id"
633
- ],
634
- "properties": {
635
- "id": {
636
- "type": "string"
637
- }
638
- }
639
- }
640
- ```
641
-
642
- <h3 id="post__api_v1_account_admin_openuser-parameters">Parameters</h3>
643
-
644
- |Name|In|Type|Required|Description|
645
- |---|---|---|---|---|
646
- |body|body|object|true|none|
647
- |» id|body|string|true|none|
648
-
649
- <h3 id="post__api_v1_account_admin_openuser-responses">Responses</h3>
650
-
651
- |Status|Meaning|Description|Schema|
652
- |---|---|---|---|
653
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
654
-
655
- <aside class="success">
656
- This operation does not require authentication
657
- </aside>
658
-
659
- ## post__api_v1_account_admin_addApplication
660
-
661
- `POST /api/v1/account/admin/addApplication`
662
-
663
- > Body parameter
664
-
665
- ```json
666
- {
667
- "type": "object",
668
- "required": [
669
- "name",
670
- "code"
671
- ],
672
- "properties": {
673
- "name": {
674
- "type": "string"
675
- },
676
- "url": {
677
- "type": "string"
678
- },
679
- "avatar": {
680
- "type": "string"
681
- },
682
- "code": {
683
- "type": "string"
684
- },
685
- "description": {
686
- "type": "string"
687
- }
688
- }
689
- }
690
- ```
691
-
692
- <h3 id="post__api_v1_account_admin_addapplication-parameters">Parameters</h3>
693
-
694
- |Name|In|Type|Required|Description|
695
- |---|---|---|---|---|
696
- |body|body|object|true|none|
697
- |» name|body|string|true|none|
698
- |» url|body|string|false|none|
699
- |» avatar|body|string|false|none|
700
- |» code|body|string|true|none|
701
- |» description|body|string|false|none|
702
-
703
- <h3 id="post__api_v1_account_admin_addapplication-responses">Responses</h3>
704
-
705
- |Status|Meaning|Description|Schema|
706
- |---|---|---|---|
707
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
708
-
709
- <aside class="success">
710
- This operation does not require authentication
711
- </aside>
712
-
713
- ## post__api_v1_account_admin_saveApplication
714
-
715
- `POST /api/v1/account/admin/saveApplication`
716
-
717
- > Body parameter
718
-
719
- ```json
720
- {
721
- "type": "object",
722
- "required": [
723
- "id",
724
- "name",
725
- "code"
726
- ],
727
- "properties": {
728
- "id": {
729
- "type": "string"
730
- },
731
- "url": {
732
- "type": "string"
733
- },
734
- "name": {
735
- "type": "string"
736
- },
737
- "avatar": {
738
- "type": "string"
739
- },
740
- "code": {
741
- "type": "string"
742
- },
743
- "description": {
744
- "type": "string"
745
- }
746
- }
747
- }
748
- ```
749
-
750
- <h3 id="post__api_v1_account_admin_saveapplication-parameters">Parameters</h3>
751
-
752
- |Name|In|Type|Required|Description|
753
- |---|---|---|---|---|
754
- |body|body|object|true|none|
755
- |» id|body|string|true|none|
756
- |» url|body|string|false|none|
757
- |» name|body|string|true|none|
758
- |» avatar|body|string|false|none|
759
- |» code|body|string|true|none|
760
- |» description|body|string|false|none|
761
-
762
- <h3 id="post__api_v1_account_admin_saveapplication-responses">Responses</h3>
763
-
764
- |Status|Meaning|Description|Schema|
765
- |---|---|---|---|
766
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
767
-
768
- <aside class="success">
769
- This operation does not require authentication
770
- </aside>
771
-
772
- ## post__api_v1_account_admin_deleteApplication
773
-
774
- `POST /api/v1/account/admin/deleteApplication`
775
-
776
- > Body parameter
777
-
778
- ```json
779
- {
780
- "type": "object",
781
- "required": [
782
- "id"
783
- ],
784
- "properties": {
785
- "id": {
786
- "type": "string"
787
- }
788
- }
789
- }
790
- ```
791
-
792
- <h3 id="post__api_v1_account_admin_deleteapplication-parameters">Parameters</h3>
793
-
794
- |Name|In|Type|Required|Description|
795
- |---|---|---|---|---|
796
- |body|body|object|true|none|
797
- |» id|body|string|true|none|
798
-
799
- <h3 id="post__api_v1_account_admin_deleteapplication-responses">Responses</h3>
800
-
801
- |Status|Meaning|Description|Schema|
802
- |---|---|---|---|
803
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
804
-
805
- <aside class="success">
806
- This operation does not require authentication
807
- </aside>
808
-
809
- ## get__api_v1_account_admin_getApplicationList
810
-
811
- `GET /api/v1/account/admin/getApplicationList`
812
-
813
- <h3 id="get__api_v1_account_admin_getapplicationlist-parameters">Parameters</h3>
814
-
815
- |Name|In|Type|Required|Description|
816
- |---|---|---|---|---|
817
- |tenantId|query|string|false|none|
818
-
819
- <h3 id="get__api_v1_account_admin_getapplicationlist-responses">Responses</h3>
820
-
821
- |Status|Meaning|Description|Schema|
822
- |---|---|---|---|
823
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
824
-
825
- <aside class="success">
826
- This operation does not require authentication
827
- </aside>
828
-
829
- ## post__api_v1_account_admin_addPermission
830
-
831
- `POST /api/v1/account/admin/addPermission`
832
-
833
- > Body parameter
834
-
835
- ```json
836
- {
837
- "type": "object",
838
- "required": [
839
- "applicationId",
840
- "name",
841
- "code"
842
- ],
843
- "properties": {
844
- "applicationId": {
845
- "type": "string"
846
- },
847
- "name": {
848
- "type": "string"
849
- },
850
- "code": {
851
- "type": "string"
852
- },
853
- "type": {
854
- "type": "number"
855
- },
856
- "isModule": {
857
- "type": "number"
858
- },
859
- "isMust": {
860
- "type": "number"
861
- },
862
- "pid": {
863
- "type": "number"
864
- },
865
- "description": {
866
- "type": "string"
867
- }
868
- }
869
- }
870
- ```
871
-
872
- <h3 id="post__api_v1_account_admin_addpermission-parameters">Parameters</h3>
873
-
874
- |Name|In|Type|Required|Description|
875
- |---|---|---|---|---|
876
- |body|body|object|true|none|
877
- |» applicationId|body|string|true|none|
878
- |» name|body|string|true|none|
879
- |» code|body|string|true|none|
880
- |» type|body|number|false|none|
881
- |» isModule|body|number|false|none|
882
- |» isMust|body|number|false|none|
883
- |» pid|body|number|false|none|
884
- |» description|body|string|false|none|
885
-
886
- <h3 id="post__api_v1_account_admin_addpermission-responses">Responses</h3>
887
-
888
- |Status|Meaning|Description|Schema|
889
- |---|---|---|---|
890
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
891
-
892
- <aside class="success">
893
- This operation does not require authentication
894
- </aside>
895
-
896
- ## get__api_v1_account_admin_getPermissionList
897
-
898
- `GET /api/v1/account/admin/getPermissionList`
899
-
900
- <h3 id="get__api_v1_account_admin_getpermissionlist-parameters">Parameters</h3>
901
-
902
- |Name|In|Type|Required|Description|
903
- |---|---|---|---|---|
904
- |applicationId|query|string|true|none|
905
- |tenantId|query|string|false|none|
906
-
907
- <h3 id="get__api_v1_account_admin_getpermissionlist-responses">Responses</h3>
908
-
909
- |Status|Meaning|Description|Schema|
910
- |---|---|---|---|
911
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
912
-
913
- <aside class="success">
914
- This operation does not require authentication
915
- </aside>
916
-
917
- ## post__api_v1_account_admin_deletePermission
918
-
919
- `POST /api/v1/account/admin/deletePermission`
920
-
921
- > Body parameter
922
-
923
- ```json
924
- {
925
- "type": "object",
926
- "required": [
927
- "id"
928
- ],
929
- "properties": {
930
- "id": {
931
- "type": "string"
932
- }
933
- }
934
- }
935
- ```
936
-
937
- <h3 id="post__api_v1_account_admin_deletepermission-parameters">Parameters</h3>
938
-
939
- |Name|In|Type|Required|Description|
940
- |---|---|---|---|---|
941
- |body|body|object|true|none|
942
- |» id|body|string|true|none|
943
-
944
- <h3 id="post__api_v1_account_admin_deletepermission-responses">Responses</h3>
945
-
946
- |Status|Meaning|Description|Schema|
947
- |---|---|---|---|
948
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
949
-
950
- <aside class="success">
951
- This operation does not require authentication
952
- </aside>
953
-
954
- ## post__api_v1_account_admin_savePermission
955
-
956
- `POST /api/v1/account/admin/savePermission`
957
-
958
- > Body parameter
959
-
960
- ```json
961
- {
962
- "type": "object",
963
- "required": [
964
- "id"
965
- ],
966
- "properties": {
967
- "id": {
968
- "type": "string"
969
- },
970
- "name": {
971
- "type": "string"
972
- },
973
- "type": {
974
- "type": "number"
975
- },
976
- "isMust": {
977
- "type": "number"
978
- },
979
- "description": {
980
- "type": "string"
981
- }
982
- }
983
- }
984
- ```
985
-
986
- <h3 id="post__api_v1_account_admin_savepermission-parameters">Parameters</h3>
987
-
988
- |Name|In|Type|Required|Description|
989
- |---|---|---|---|---|
990
- |body|body|object|true|none|
991
- |» id|body|string|true|none|
992
- |» name|body|string|false|none|
993
- |» type|body|number|false|none|
994
- |» isMust|body|number|false|none|
995
- |» description|body|string|false|none|
996
-
997
- <h3 id="post__api_v1_account_admin_savepermission-responses">Responses</h3>
998
-
999
- |Status|Meaning|Description|Schema|
1000
- |---|---|---|---|
1001
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1002
-
1003
- <aside class="success">
1004
- This operation does not require authentication
1005
- </aside>
1006
-
1007
- ## post__api_v1_account_admin_saveTenantPermissionList
1008
-
1009
- `POST /api/v1/account/admin/saveTenantPermissionList`
1010
-
1011
- > Body parameter
1012
-
1013
- ```json
1014
- {
1015
- "type": "object",
1016
- "required": [
1017
- "tenantId",
1018
- "applications",
1019
- "permissions"
1020
- ],
1021
- "properties": {
1022
- "tenantId": {
1023
- "type": "string"
1024
- },
1025
- "applications": {
1026
- "type": "array",
1027
- "items": {
1028
- "type": "string"
1029
- }
1030
- },
1031
- "permissions": {
1032
- "type": "array",
1033
- "items": {
1034
- "type": "number"
1035
- }
1036
- }
1037
- }
1038
- }
1039
- ```
1040
-
1041
- <h3 id="post__api_v1_account_admin_savetenantpermissionlist-parameters">Parameters</h3>
1042
-
1043
- |Name|In|Type|Required|Description|
1044
- |---|---|---|---|---|
1045
- |body|body|object|true|none|
1046
- |» tenantId|body|string|true|none|
1047
- |» applications|body|[string]|true|none|
1048
- |» permissions|body|[number]|true|none|
1049
-
1050
- <h3 id="post__api_v1_account_admin_savetenantpermissionlist-responses">Responses</h3>
1051
-
1052
- |Status|Meaning|Description|Schema|
1053
- |---|---|---|---|
1054
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1055
-
1056
- <aside class="success">
1057
- This operation does not require authentication
1058
- </aside>
1059
-
1060
- ## get__api_v1_account_admin_getTenantPermissionList
1061
-
1062
- `GET /api/v1/account/admin/getTenantPermissionList`
1063
-
1064
- <h3 id="get__api_v1_account_admin_gettenantpermissionlist-parameters">Parameters</h3>
1065
-
1066
- |Name|In|Type|Required|Description|
1067
- |---|---|---|---|---|
1068
- |tenantId|query|string|true|none|
1069
-
1070
- <h3 id="get__api_v1_account_admin_gettenantpermissionlist-responses">Responses</h3>
1071
-
1072
- |Status|Meaning|Description|Schema|
1073
- |---|---|---|---|
1074
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1075
-
1076
- <aside class="success">
1077
- This operation does not require authentication
1078
- </aside>
1079
-
1080
- ## get__api_v1_account_admin_getRoleList
1081
-
1082
- `GET /api/v1/account/admin/getRoleList`
1083
-
1084
- <h3 id="get__api_v1_account_admin_getrolelist-parameters">Parameters</h3>
1085
-
1086
- |Name|In|Type|Required|Description|
1087
- |---|---|---|---|---|
1088
- |tenantId|query|string|true|none|
1089
- |filter|query|object|false|none|
1090
-
1091
- <h3 id="get__api_v1_account_admin_getrolelist-responses">Responses</h3>
1092
-
1093
- |Status|Meaning|Description|Schema|
1094
- |---|---|---|---|
1095
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1096
-
1097
- <aside class="success">
1098
- This operation does not require authentication
1099
- </aside>
1100
-
1101
- ## post__api_v1_account_admin_addRole
1102
-
1103
- `POST /api/v1/account/admin/addRole`
1104
-
1105
- > Body parameter
1106
-
1107
- ```json
1108
- {
1109
- "type": "object",
1110
- "required": [
1111
- "tenantId",
1112
- "name"
1113
- ],
1114
- "properties": {
1115
- "tenantId": {
1116
- "type": "string"
1117
- },
1118
- "name": {
1119
- "type": "string"
1120
- },
1121
- "description": {
1122
- "type": "string"
1123
- }
1124
- }
1125
- }
1126
- ```
1127
-
1128
- <h3 id="post__api_v1_account_admin_addrole-parameters">Parameters</h3>
1129
-
1130
- |Name|In|Type|Required|Description|
1131
- |---|---|---|---|---|
1132
- |body|body|object|true|none|
1133
- |» tenantId|body|string|true|none|
1134
- |» name|body|string|true|none|
1135
- |» description|body|string|false|none|
1136
-
1137
- <h3 id="post__api_v1_account_admin_addrole-responses">Responses</h3>
1138
-
1139
- |Status|Meaning|Description|Schema|
1140
- |---|---|---|---|
1141
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1142
-
1143
- <aside class="success">
1144
- This operation does not require authentication
1145
- </aside>
1146
-
1147
- ## post__api_v1_account_admin_saveRole
1148
-
1149
- `POST /api/v1/account/admin/saveRole`
1150
-
1151
- > Body parameter
1152
-
1153
- ```json
1154
- {
1155
- "type": "object",
1156
- "required": [
1157
- "name",
1158
- "id"
1159
- ],
1160
- "properties": {
1161
- "id": {
1162
- "type": "number"
1163
- },
1164
- "name": {
1165
- "type": "string"
1166
- },
1167
- "description": {
1168
- "type": "string"
1169
- }
1170
- }
1171
- }
1172
- ```
1173
-
1174
- <h3 id="post__api_v1_account_admin_saverole-parameters">Parameters</h3>
1175
-
1176
- |Name|In|Type|Required|Description|
1177
- |---|---|---|---|---|
1178
- |body|body|object|true|none|
1179
- |» id|body|number|true|none|
1180
- |» name|body|string|true|none|
1181
- |» description|body|string|false|none|
1182
-
1183
- <h3 id="post__api_v1_account_admin_saverole-responses">Responses</h3>
1184
-
1185
- |Status|Meaning|Description|Schema|
1186
- |---|---|---|---|
1187
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1188
-
1189
- <aside class="success">
1190
- This operation does not require authentication
1191
- </aside>
1192
-
1193
- ## post__api_v1_account_admin_removeRole
1194
-
1195
- `POST /api/v1/account/admin/removeRole`
1196
-
1197
- > Body parameter
1198
-
1199
- ```json
1200
- {
1201
- "type": "object",
1202
- "required": [
1203
- "id"
1204
- ],
1205
- "properties": {
1206
- "id": {
1207
- "type": "number"
1208
- }
1209
- }
1210
- }
1211
- ```
1212
-
1213
- <h3 id="post__api_v1_account_admin_removerole-parameters">Parameters</h3>
1214
-
1215
- |Name|In|Type|Required|Description|
1216
- |---|---|---|---|---|
1217
- |body|body|object|true|none|
1218
- |» id|body|number|true|none|
1219
-
1220
- <h3 id="post__api_v1_account_admin_removerole-responses">Responses</h3>
1221
-
1222
- |Status|Meaning|Description|Schema|
1223
- |---|---|---|---|
1224
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1225
-
1226
- <aside class="success">
1227
- This operation does not require authentication
1228
- </aside>
1229
-
1230
- ## get__api_v1_account_admin_getRolePermissionList
1231
-
1232
- `GET /api/v1/account/admin/getRolePermissionList`
1233
-
1234
- <h3 id="get__api_v1_account_admin_getrolepermissionlist-parameters">Parameters</h3>
1235
-
1236
- |Name|In|Type|Required|Description|
1237
- |---|---|---|---|---|
1238
- |id|query|number|true|none|
1239
-
1240
- <h3 id="get__api_v1_account_admin_getrolepermissionlist-responses">Responses</h3>
1241
-
1242
- |Status|Meaning|Description|Schema|
1243
- |---|---|---|---|
1244
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1245
-
1246
- <aside class="success">
1247
- This operation does not require authentication
1248
- </aside>
1249
-
1250
- ## post__api_v1_account_admin_saveRolePermissionList
1251
-
1252
- `POST /api/v1/account/admin/saveRolePermissionList`
1253
-
1254
- <h3 id="post__api_v1_account_admin_saverolepermissionlist-responses">Responses</h3>
1255
-
1256
- |Status|Meaning|Description|Schema|
1257
- |---|---|---|---|
1258
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1259
-
1260
- <aside class="success">
1261
- This operation does not require authentication
1262
- </aside>
1263
-
1264
- ## get__api_v1_account_admin_getAllTenantList
1265
-
1266
- `GET /api/v1/account/admin/getAllTenantList`
1267
-
1268
- <h3 id="get__api_v1_account_admin_getalltenantlist-parameters">Parameters</h3>
1269
-
1270
- |Name|In|Type|Required|Description|
1271
- |---|---|---|---|---|
1272
- |name|query|string|false|none|
1273
- |serviceStartTime|query|string(date-time)|false|none|
1274
- |serviceEndTime|query|string(date-time)|false|none|
1275
- |perPage|query|number|false|none|
1276
- |currentPage|query|number|false|none|
1277
-
1278
- <h3 id="get__api_v1_account_admin_getalltenantlist-responses">Responses</h3>
1279
-
1280
- |Status|Meaning|Description|Schema|
1281
- |---|---|---|---|
1282
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1283
-
1284
- <aside class="success">
1285
- This operation does not require authentication
1286
- </aside>
1287
-
1288
- ## get__api_v1_account_admin_getTenantInfo
1289
-
1290
- `GET /api/v1/account/admin/getTenantInfo`
1291
-
1292
- <h3 id="get__api_v1_account_admin_gettenantinfo-parameters">Parameters</h3>
1293
-
1294
- |Name|In|Type|Required|Description|
1295
- |---|---|---|---|---|
1296
- |id|query|string|false|none|
1297
-
1298
- <h3 id="get__api_v1_account_admin_gettenantinfo-responses">Responses</h3>
1299
-
1300
- |Status|Meaning|Description|Schema|
1301
- |---|---|---|---|
1302
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1303
-
1304
- <aside class="success">
1305
- This operation does not require authentication
1306
- </aside>
1307
-
1308
- ## post__api_v1_account_admin_addTenant
1309
-
1310
- `POST /api/v1/account/admin/addTenant`
1311
-
1312
- > Body parameter
1313
-
1314
- ```json
1315
- {
1316
- "type": "object",
1317
- "required": [
1318
- "name",
1319
- "accountNumber",
1320
- "serviceStartTime",
1321
- "serviceEndTime"
1322
- ],
1323
- "properties": {
1324
- "name": {
1325
- "type": "string"
1326
- },
1327
- "accountNumber": {
1328
- "type": "number"
1329
- },
1330
- "serviceStartTime": {
1331
- "type": "string",
1332
- "format": "date-time"
1333
- },
1334
- "serviceEndTime": {
1335
- "type": "string",
1336
- "format": "date-time"
1337
- }
1338
- }
1339
- }
1340
- ```
1341
-
1342
- <h3 id="post__api_v1_account_admin_addtenant-parameters">Parameters</h3>
1343
-
1344
- |Name|In|Type|Required|Description|
1345
- |---|---|---|---|---|
1346
- |body|body|object|true|none|
1347
- |» name|body|string|true|none|
1348
- |» accountNumber|body|number|true|none|
1349
- |» serviceStartTime|body|string(date-time)|true|none|
1350
- |» serviceEndTime|body|string(date-time)|true|none|
1351
-
1352
- <h3 id="post__api_v1_account_admin_addtenant-responses">Responses</h3>
1353
-
1354
- |Status|Meaning|Description|Schema|
1355
- |---|---|---|---|
1356
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1357
-
1358
- <aside class="success">
1359
- This operation does not require authentication
1360
- </aside>
1361
-
1362
- ## post__api_v1_account_admin_saveTenant
1363
-
1364
- `POST /api/v1/account/admin/saveTenant`
1365
-
1366
- > Body parameter
1367
-
1368
- ```json
1369
- {
1370
- "type": "object",
1371
- "required": [
1372
- "id",
1373
- "name",
1374
- "accountNumber",
1375
- "serviceStartTime",
1376
- "serviceEndTime"
1377
- ],
1378
- "properties": {
1379
- "id": {
1380
- "type": "string"
1381
- },
1382
- "name": {
1383
- "type": "string"
1384
- },
1385
- "accountNumber": {
1386
- "type": "number"
1387
- },
1388
- "serviceStartTime": {
1389
- "type": "string",
1390
- "format": "date-time"
1391
- },
1392
- "serviceEndTime": {
1393
- "type": "string",
1394
- "format": "date-time"
1395
- }
1396
- }
1397
- }
1398
- ```
1399
-
1400
- <h3 id="post__api_v1_account_admin_savetenant-parameters">Parameters</h3>
1401
-
1402
- |Name|In|Type|Required|Description|
1403
- |---|---|---|---|---|
1404
- |body|body|object|true|none|
1405
- |» id|body|string|true|none|
1406
- |» name|body|string|true|none|
1407
- |» accountNumber|body|number|true|none|
1408
- |» serviceStartTime|body|string(date-time)|true|none|
1409
- |» serviceEndTime|body|string(date-time)|true|none|
1410
-
1411
- <h3 id="post__api_v1_account_admin_savetenant-responses">Responses</h3>
1412
-
1413
- |Status|Meaning|Description|Schema|
1414
- |---|---|---|---|
1415
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1416
-
1417
- <aside class="success">
1418
- This operation does not require authentication
1419
- </aside>
1420
-
1421
- ## post__api_v1_account_admin_tenant_addOrg
1422
-
1423
- `POST /api/v1/account/admin/tenant/addOrg`
1424
-
1425
- <h3 id="post__api_v1_account_admin_tenant_addorg-responses">Responses</h3>
1426
-
1427
- |Status|Meaning|Description|Schema|
1428
- |---|---|---|---|
1429
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1430
-
1431
- <aside class="success">
1432
- This operation does not require authentication
1433
- </aside>
1434
-
1435
- ## get__api_v1_account_admin_tenant_orgList
1436
-
1437
- `GET /api/v1/account/admin/tenant/orgList`
1438
-
1439
- <h3 id="get__api_v1_account_admin_tenant_orglist-parameters">Parameters</h3>
1440
-
1441
- |Name|In|Type|Required|Description|
1442
- |---|---|---|---|---|
1443
- |id|query|string|false|none|
1444
-
1445
- <h3 id="get__api_v1_account_admin_tenant_orglist-responses">Responses</h3>
1446
-
1447
- |Status|Meaning|Description|Schema|
1448
- |---|---|---|---|
1449
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1450
-
1451
- <aside class="success">
1452
- This operation does not require authentication
1453
- </aside>
1454
-
1455
- ## post__api_v1_account_admin_tenant_editOrg
1456
-
1457
- `POST /api/v1/account/admin/tenant/editOrg`
1458
-
1459
- <h3 id="post__api_v1_account_admin_tenant_editorg-responses">Responses</h3>
1460
-
1461
- |Status|Meaning|Description|Schema|
1462
- |---|---|---|---|
1463
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1464
-
1465
- <aside class="success">
1466
- This operation does not require authentication
1467
- </aside>
1468
-
1469
- ## post__api_v1_account_admin_tenant_removeOrg
1470
-
1471
- `POST /api/v1/account/admin/tenant/removeOrg`
1472
-
1473
- <h3 id="post__api_v1_account_admin_tenant_removeorg-responses">Responses</h3>
1474
-
1475
- |Status|Meaning|Description|Schema|
1476
- |---|---|---|---|
1477
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1478
-
1479
- <aside class="success">
1480
- This operation does not require authentication
1481
- </aside>
1482
-
1483
- ## get__api_v1_account_admin_getTenantUserList
1484
-
1485
- `GET /api/v1/account/admin/getTenantUserList`
1486
-
1487
- <h3 id="get__api_v1_account_admin_gettenantuserlist-parameters">Parameters</h3>
1488
-
1489
- |Name|In|Type|Required|Description|
1490
- |---|---|---|---|---|
1491
- |tenantId|query|string|false|none|
1492
-
1493
- <h3 id="get__api_v1_account_admin_gettenantuserlist-responses">Responses</h3>
1494
-
1495
- |Status|Meaning|Description|Schema|
1496
- |---|---|---|---|
1497
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1498
-
1499
- <aside class="success">
1500
- This operation does not require authentication
1501
- </aside>
1502
-
1503
- ## post__api_v1_account_admin_addTenantUser
1504
-
1505
- `POST /api/v1/account/admin/addTenantUser`
1506
-
1507
- > Body parameter
1508
-
1509
- ```json
1510
- {
1511
- "type": "object",
1512
- "required": [
1513
- "tenantId",
1514
- "userId",
1515
- "name"
1516
- ],
1517
- "properties": {
1518
- "tenantId": {
1519
- "type": "string"
1520
- },
1521
- "roleIds": {
1522
- "type": "array",
1523
- "items": {
1524
- "type": "number"
1525
- },
1526
- "default": []
1527
- },
1528
- "orgIds": {
1529
- "type": "array",
1530
- "items": {
1531
- "type": "number"
1532
- },
1533
- "default": []
1534
- },
1535
- "userId": {
1536
- "type": "string"
1537
- },
1538
- "name": {
1539
- "type": "string"
1540
- },
1541
- "avatar": {
1542
- "type": "string"
1543
- },
1544
- "phone": {
1545
- "type": "string"
1546
- },
1547
- "email": {
1548
- "type": "string"
1549
- },
1550
- "description": {
1551
- "type": "string"
1552
- }
1553
- }
1554
- }
1555
- ```
1556
-
1557
- <h3 id="post__api_v1_account_admin_addtenantuser-parameters">Parameters</h3>
1558
-
1559
- |Name|In|Type|Required|Description|
1560
- |---|---|---|---|---|
1561
- |body|body|object|true|none|
1562
- |» tenantId|body|string|true|none|
1563
- |» roleIds|body|[number]|false|none|
1564
- |» orgIds|body|[number]|false|none|
1565
- |» userId|body|string|true|none|
1566
- |» name|body|string|true|none|
1567
- |» avatar|body|string|false|none|
1568
- |» phone|body|string|false|none|
1569
- |» email|body|string|false|none|
1570
- |» description|body|string|false|none|
1571
-
1572
- <h3 id="post__api_v1_account_admin_addtenantuser-responses">Responses</h3>
1573
-
1574
- |Status|Meaning|Description|Schema|
1575
- |---|---|---|---|
1576
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1577
-
1578
- <aside class="success">
1579
- This operation does not require authentication
1580
- </aside>
1581
-
1582
- ## post__api_v1_account_admin_saveTenantUser
1583
-
1584
- `POST /api/v1/account/admin/saveTenantUser`
1585
-
1586
- > Body parameter
1587
-
1588
- ```json
1589
- {
1590
- "type": "object",
1591
- "required": [
1592
- "tenantId",
1593
- "name"
1594
- ],
1595
- "properties": {
1596
- "tenantId": {
1597
- "type": "string"
1598
- },
1599
- "roleIds": {
1600
- "type": "array",
1601
- "items": {
1602
- "type": "number"
1603
- },
1604
- "default": []
1605
- },
1606
- "orgIds": {
1607
- "type": "array",
1608
- "items": {
1609
- "type": "number"
1610
- },
1611
- "default": []
1612
- },
1613
- "name": {
1614
- "type": "string"
1615
- },
1616
- "avatar": {
1617
- "type": "string"
1618
- },
1619
- "phone": {
1620
- "type": "string"
1621
- },
1622
- "email": {
1623
- "type": "string"
1624
- },
1625
- "description": {
1626
- "type": "string"
1627
- }
1628
- }
1629
- }
1630
- ```
1631
-
1632
- <h3 id="post__api_v1_account_admin_savetenantuser-parameters">Parameters</h3>
1633
-
1634
- |Name|In|Type|Required|Description|
1635
- |---|---|---|---|---|
1636
- |body|body|object|true|none|
1637
- |» tenantId|body|string|true|none|
1638
- |» roleIds|body|[number]|false|none|
1639
- |» orgIds|body|[number]|false|none|
1640
- |» name|body|string|true|none|
1641
- |» avatar|body|string|false|none|
1642
- |» phone|body|string|false|none|
1643
- |» email|body|string|false|none|
1644
- |» description|body|string|false|none|
1645
-
1646
- <h3 id="post__api_v1_account_admin_savetenantuser-responses">Responses</h3>
1647
-
1648
- |Status|Meaning|Description|Schema|
1649
- |---|---|---|---|
1650
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1651
-
1652
- <aside class="success">
1653
- This operation does not require authentication
1654
- </aside>
1655
-
1656
- ## post__api_v1_account_admin_deleteTenantUser
1657
-
1658
- `POST /api/v1/account/admin/deleteTenantUser`
1659
-
1660
- > Body parameter
1661
-
1662
- ```json
1663
- {
1664
- "type": "object",
1665
- "required": [
1666
- "tenantId",
1667
- "tenantUserId"
1668
- ],
1669
- "properties": {
1670
- "tenantId": {
1671
- "type": "string"
1672
- },
1673
- "tenantUserId": {
1674
- "type": "string"
1675
- }
1676
- }
1677
- }
1678
- ```
1679
-
1680
- <h3 id="post__api_v1_account_admin_deletetenantuser-parameters">Parameters</h3>
1681
-
1682
- |Name|In|Type|Required|Description|
1683
- |---|---|---|---|---|
1684
- |body|body|object|true|none|
1685
- |» tenantId|body|string|true|none|
1686
- |» tenantUserId|body|string|true|none|
1687
-
1688
- <h3 id="post__api_v1_account_admin_deletetenantuser-responses">Responses</h3>
1689
-
1690
- |Status|Meaning|Description|Schema|
1691
- |---|---|---|---|
1692
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1693
-
1694
- <aside class="success">
1695
- This operation does not require authentication
1696
- </aside>
1697
-
1698
- ## post__api_v1_account_admin_closeTenant
1699
-
1700
- `POST /api/v1/account/admin/closeTenant`
1701
-
1702
- > Body parameter
1703
-
1704
- ```json
1705
- {
1706
- "type": "object",
1707
- "required": [
1708
- "tenantId"
1709
- ],
1710
- "properties": {
1711
- "tenantId": {
1712
- "type": "string"
1713
- }
1714
- }
1715
- }
1716
- ```
1717
-
1718
- <h3 id="post__api_v1_account_admin_closetenant-parameters">Parameters</h3>
1719
-
1720
- |Name|In|Type|Required|Description|
1721
- |---|---|---|---|---|
1722
- |body|body|object|true|none|
1723
- |» tenantId|body|string|true|none|
1724
-
1725
- <h3 id="post__api_v1_account_admin_closetenant-responses">Responses</h3>
1726
-
1727
- |Status|Meaning|Description|Schema|
1728
- |---|---|---|---|
1729
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1730
-
1731
- <aside class="success">
1732
- This operation does not require authentication
1733
- </aside>
1734
-
1735
- ## post__api_v1_account_admin_openTenant
1736
-
1737
- `POST /api/v1/account/admin/openTenant`
1738
-
1739
- > Body parameter
1740
-
1741
- ```json
1742
- {
1743
- "type": "object",
1744
- "required": [
1745
- "tenantId"
1746
- ],
1747
- "properties": {
1748
- "tenantId": {
1749
- "type": "string"
1750
- }
1751
- }
1752
- }
1753
- ```
1754
-
1755
- <h3 id="post__api_v1_account_admin_opentenant-parameters">Parameters</h3>
1756
-
1757
- |Name|In|Type|Required|Description|
1758
- |---|---|---|---|---|
1759
- |body|body|object|true|none|
1760
- |» tenantId|body|string|true|none|
1761
-
1762
- <h3 id="post__api_v1_account_admin_opentenant-responses">Responses</h3>
1763
-
1764
- |Status|Meaning|Description|Schema|
1765
- |---|---|---|---|
1766
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1767
-
1768
- <aside class="success">
1769
- This operation does not require authentication
1770
- </aside>
1771
-
1772
- ## post__api_v1_account_admin_closeTenantUser
1773
-
1774
- `POST /api/v1/account/admin/closeTenantUser`
1775
-
1776
- > Body parameter
1777
-
1778
- ```json
1779
- {
1780
- "type": "object",
1781
- "required": [
1782
- "tenantId",
1783
- "tenantUserId"
1784
- ],
1785
- "properties": {
1786
- "tenantId": {
1787
- "type": "string"
1788
- },
1789
- "tenantUserId": {
1790
- "type": "string"
1791
- }
1792
- }
1793
- }
1794
- ```
1795
-
1796
- <h3 id="post__api_v1_account_admin_closetenantuser-parameters">Parameters</h3>
1797
-
1798
- |Name|In|Type|Required|Description|
1799
- |---|---|---|---|---|
1800
- |body|body|object|true|none|
1801
- |» tenantId|body|string|true|none|
1802
- |» tenantUserId|body|string|true|none|
1803
-
1804
- <h3 id="post__api_v1_account_admin_closetenantuser-responses">Responses</h3>
1805
-
1806
- |Status|Meaning|Description|Schema|
1807
- |---|---|---|---|
1808
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1809
-
1810
- <aside class="success">
1811
- This operation does not require authentication
1812
- </aside>
1813
-
1814
- ## post__api_v1_account_admin_openTenantUser
1815
-
1816
- `POST /api/v1/account/admin/openTenantUser`
1817
-
1818
- > Body parameter
1819
-
1820
- ```json
1821
- {
1822
- "type": "object",
1823
- "required": [
1824
- "tenantId",
1825
- "tenantUserId"
1826
- ],
1827
- "properties": {
1828
- "tenantId": {
1829
- "type": "string"
1830
- },
1831
- "tenantUserId": {
1832
- "type": "string"
1833
- }
1834
- }
1835
- }
1836
- ```
1837
-
1838
- <h3 id="post__api_v1_account_admin_opentenantuser-parameters">Parameters</h3>
1839
-
1840
- |Name|In|Type|Required|Description|
1841
- |---|---|---|---|---|
1842
- |body|body|object|true|none|
1843
- |» tenantId|body|string|true|none|
1844
- |» tenantUserId|body|string|true|none|
1845
-
1846
- <h3 id="post__api_v1_account_admin_opentenantuser-responses">Responses</h3>
1847
-
1848
- |Status|Meaning|Description|Schema|
1849
- |---|---|---|---|
1850
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1851
-
1852
- <aside class="success">
1853
- This operation does not require authentication
1854
- </aside>
1855
-
1856
- ## get__api_v1_account_admin_getInviteList
1857
-
1858
- `GET /api/v1/account/admin/getInviteList`
1859
-
1860
- <h3 id="get__api_v1_account_admin_getinvitelist-parameters">Parameters</h3>
1861
-
1862
- |Name|In|Type|Required|Description|
1863
- |---|---|---|---|---|
1864
- |tenantId|query|string|true|none|
1865
-
1866
- <h3 id="get__api_v1_account_admin_getinvitelist-responses">Responses</h3>
1867
-
1868
- |Status|Meaning|Description|Schema|
1869
- |---|---|---|---|
1870
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1871
-
1872
- <aside class="success">
1873
- This operation does not require authentication
1874
- </aside>
1875
-
1876
- ## post__api_v1_account_admin_addInviteToken
1877
-
1878
- `POST /api/v1/account/admin/addInviteToken`
1879
-
1880
- > Body parameter
1881
-
1882
- ```json
1883
- {
1884
- "type": "object",
1885
- "required": [
1886
- "tenantId"
1887
- ],
1888
- "properties": {
1889
- "tenantId": {
1890
- "type": "string"
1891
- },
1892
- "info": {
1893
- "type": "object",
1894
- "properties": {
1895
- "roleIds": {
1896
- "type": "array",
1897
- "items": {
1898
- "type": "number"
1899
- },
1900
- "default": []
1901
- },
1902
- "orgIds": {
1903
- "type": "array",
1904
- "items": {
1905
- "type": "number"
1906
- },
1907
- "default": []
1908
- }
1909
- }
1910
- }
1911
- }
1912
- }
1913
- ```
1914
-
1915
- <h3 id="post__api_v1_account_admin_addinvitetoken-parameters">Parameters</h3>
1916
-
1917
- |Name|In|Type|Required|Description|
1918
- |---|---|---|---|---|
1919
- |body|body|object|true|none|
1920
- |» tenantId|body|string|true|none|
1921
- |» info|body|object|false|none|
1922
- |»» roleIds|body|[number]|false|none|
1923
- |»» orgIds|body|[number]|false|none|
1924
-
1925
- <h3 id="post__api_v1_account_admin_addinvitetoken-responses">Responses</h3>
1926
-
1927
- |Status|Meaning|Description|Schema|
1928
- |---|---|---|---|
1929
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1930
-
1931
- <aside class="success">
1932
- This operation does not require authentication
1933
- </aside>
1934
-
1935
- ## post__api_v1_account_admin_deleteInviteToken
1936
-
1937
- `POST /api/v1/account/admin/deleteInviteToken`
1938
-
1939
- > Body parameter
1940
-
1941
- ```json
1942
- {
1943
- "type": "object",
1944
- "required": [
1945
- "id"
1946
- ],
1947
- "properties": {
1948
- "id": {
1949
- "type": "number"
1950
- }
1951
- }
1952
- }
1953
- ```
1954
-
1955
- <h3 id="post__api_v1_account_admin_deleteinvitetoken-parameters">Parameters</h3>
1956
-
1957
- |Name|In|Type|Required|Description|
1958
- |---|---|---|---|---|
1959
- |body|body|object|true|none|
1960
- |» id|body|number|true|none|
1961
-
1962
- <h3 id="post__api_v1_account_admin_deleteinvitetoken-responses">Responses</h3>
1963
-
1964
- |Status|Meaning|Description|Schema|
1965
- |---|---|---|---|
1966
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1967
-
1968
- <aside class="success">
1969
- This operation does not require authentication
1970
- </aside>
1971
-
1972
- ## get__api_v1_account_tenant_getUserTenant
1973
-
1974
- `GET /api/v1/account/tenant/getUserTenant`
1975
-
1976
- <h3 id="get__api_v1_account_tenant_getusertenant-responses">Responses</h3>
1977
-
1978
- |Status|Meaning|Description|Schema|
1979
- |---|---|---|---|
1980
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1981
-
1982
- <aside class="success">
1983
- This operation does not require authentication
1984
- </aside>
1985
-
1986
- ## get__api_v1_account_tenant_getTenantUserInfo
1987
-
1988
- `GET /api/v1/account/tenant/getTenantUserInfo`
1989
-
1990
- <h3 id="get__api_v1_account_tenant_gettenantuserinfo-responses">Responses</h3>
1991
-
1992
- |Status|Meaning|Description|Schema|
1993
- |---|---|---|---|
1994
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1995
-
1996
- <aside class="success">
1997
- This operation does not require authentication
1998
- </aside>
1999
-
2000
- ## get__api_v1_account_tenant_orgList
2001
-
2002
- `GET /api/v1/account/tenant/orgList`
2003
-
2004
- <h3 id="get__api_v1_account_tenant_orglist-responses">Responses</h3>
2005
-
2006
- |Status|Meaning|Description|Schema|
2007
- |---|---|---|---|
2008
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
2009
-
2010
- <aside class="success">
2011
- This operation does not require authentication
2012
- </aside>
2013
-
2014
- ## get__api_v1_account_getUserInfo
2015
-
2016
- `GET /api/v1/account/getUserInfo`
2017
-
2018
- <h3 id="get__api_v1_account_getuserinfo-responses">Responses</h3>
2019
-
2020
- |Status|Meaning|Description|Schema|
2021
- |---|---|---|---|
2022
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
2023
-
2024
- <aside class="success">
2025
- This operation does not require authentication
2026
- </aside>
2027
-
2028
- ## post__api_v1_account_setCurrentTenantId
2029
-
2030
- `POST /api/v1/account/setCurrentTenantId`
2031
-
2032
- > Body parameter
2033
-
2034
- ```json
2035
- {
2036
- "type": "object",
2037
- "required": [
2038
- "tenantId"
2039
- ],
2040
- "properties": {
2041
- "tenantId": {
2042
- "type": "string"
2043
- }
2044
- }
2045
- }
2046
- ```
2047
-
2048
- <h3 id="post__api_v1_account_setcurrenttenantid-parameters">Parameters</h3>
2049
-
2050
- |Name|In|Type|Required|Description|
2051
- |---|---|---|---|---|
2052
- |body|body|object|true|none|
2053
- |» tenantId|body|string|true|none|
2054
-
2055
- <h3 id="post__api_v1_account_setcurrenttenantid-responses">Responses</h3>
2056
-
2057
- |Status|Meaning|Description|Schema|
2058
- |---|---|---|---|
2059
- |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
2060
-
2061
- <aside class="success">
2062
- This operation does not require authentication
2063
- </aside>
2064
-
2065
- # Schemas
2066
-
24
+ | 属性名 | 说明 | 类型 | 默认值 |
25
+ |-----|----|----|-----|
26
+ | | | | |
2067
27