@foldspace-fe/casdoor-next-auth-kit 0.1.1
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.
- package/dist/billing/index.d.ts +16 -0
- package/dist/billing/index.js +28 -0
- package/dist/billing/index.js.map +1 -0
- package/dist/callback-BTzHQK_r.d.ts +12 -0
- package/dist/casdoor/index.d.ts +28 -0
- package/dist/casdoor/index.js +40 -0
- package/dist/casdoor/index.js.map +1 -0
- package/dist/chunk-6E27SZ7V.js +291 -0
- package/dist/chunk-6E27SZ7V.js.map +1 -0
- package/dist/chunk-DONQHN4U.js +56 -0
- package/dist/chunk-DONQHN4U.js.map +1 -0
- package/dist/chunk-IQEVUR77.js +909 -0
- package/dist/chunk-IQEVUR77.js.map +1 -0
- package/dist/chunk-RGTVPBH7.js +182 -0
- package/dist/chunk-RGTVPBH7.js.map +1 -0
- package/dist/chunk-T2M5MVPE.js +20 -0
- package/dist/chunk-T2M5MVPE.js.map +1 -0
- package/dist/chunk-XMBHIEYL.js +1 -0
- package/dist/chunk-XMBHIEYL.js.map +1 -0
- package/dist/chunk-Y4GJ2AEI.js +192 -0
- package/dist/chunk-Y4GJ2AEI.js.map +1 -0
- package/dist/cli.d.ts +2 -0
- package/dist/cli.js +437 -0
- package/dist/cli.js.map +1 -0
- package/dist/index.d.ts +77 -0
- package/dist/index.js +148 -0
- package/dist/index.js.map +1 -0
- package/dist/next/index.d.ts +17 -0
- package/dist/next/index.js +24 -0
- package/dist/next/index.js.map +1 -0
- package/dist/options-JUwZSXu2.d.ts +40 -0
- package/dist/react/index.d.ts +242 -0
- package/dist/react/index.js +774 -0
- package/dist/react/index.js.map +1 -0
- package/dist/skills/casdoor-next-auth-kit/SKILL.md +158 -0
- package/dist/skills/casdoor-next-auth-kit/references/casdoor-api-reference.md +2387 -0
- package/dist/skills/casdoor-next-auth-kit/references/swagger.json +3686 -0
- package/dist/types-BPsPs5Rv.d.ts +337 -0
- package/dist/types-DqVXdUge.d.ts +121 -0
- package/package.json +69 -0
|
@@ -0,0 +1,2387 @@
|
|
|
1
|
+
# Casdoor 个人操作 API 参考
|
|
2
|
+
|
|
3
|
+
> 仅包含个人/用户/商品/支付/订阅相关的 API 端点。
|
|
4
|
+
> 所有路径均已添加 `/auth/` 部署前缀。
|
|
5
|
+
> 基于 Casdoor v1.503.0
|
|
6
|
+
|
|
7
|
+
## 概览
|
|
8
|
+
|
|
9
|
+
| 分类 | 端点数 |
|
|
10
|
+
|---|---|
|
|
11
|
+
| 账户 API | 5 |
|
|
12
|
+
| 邺请 API | 5 |
|
|
13
|
+
| 登录 API | 11 |
|
|
14
|
+
| 多因素认证 API | 5 |
|
|
15
|
+
| 订单 API | 4 |
|
|
16
|
+
| 支付 API | 5 |
|
|
17
|
+
| 计划 API | 2 |
|
|
18
|
+
| 定价 API | 2 |
|
|
19
|
+
| 商品 API | 3 |
|
|
20
|
+
| 资源 API | 3 |
|
|
21
|
+
| 会话 API | 2 |
|
|
22
|
+
| 订阅 API | 2 |
|
|
23
|
+
| 令牌 API | 4 |
|
|
24
|
+
| 交易 API | 2 |
|
|
25
|
+
| 用户 API | 7 |
|
|
26
|
+
| 验证 API | 3 |
|
|
27
|
+
| **合计** | **65** |
|
|
28
|
+
|
|
29
|
+
## 账户 API
|
|
30
|
+
|
|
31
|
+
### GET `/auth/api/get-account`
|
|
32
|
+
**操作**: `ApiController.GetAccount`
|
|
33
|
+
**描述**: 获取当前账户详情
|
|
34
|
+
|
|
35
|
+
**响应**:
|
|
36
|
+
|
|
37
|
+
- **200**: The Response object
|
|
38
|
+
|
|
39
|
+
- `data`: object
|
|
40
|
+
- `data2`: object
|
|
41
|
+
- `data3`: object
|
|
42
|
+
- `msg`: string
|
|
43
|
+
- `name`: string
|
|
44
|
+
- `status`: string
|
|
45
|
+
- `sub`: string
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
### POST `/auth/api/reset-email-or-phone`
|
|
50
|
+
**操作**: `ApiController.ResetEmailOrPhone`
|
|
51
|
+
|
|
52
|
+
**响应**:
|
|
53
|
+
|
|
54
|
+
- **200**: The Response object
|
|
55
|
+
|
|
56
|
+
- `address`: string
|
|
57
|
+
- `aud`: string
|
|
58
|
+
- `email`: string
|
|
59
|
+
- `email_verified`: boolean
|
|
60
|
+
- `groups`: Array<string>
|
|
61
|
+
- `iss`: string
|
|
62
|
+
- `name`: string
|
|
63
|
+
- `permissions`: Array<string>
|
|
64
|
+
- `phone`: string
|
|
65
|
+
- `picture`: string
|
|
66
|
+
- `preferred_username`: string
|
|
67
|
+
- `roles`: Array<string>
|
|
68
|
+
- `sub`: string
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
### POST `/auth/api/set-password`
|
|
73
|
+
**操作**: `ApiController.SetPassword`
|
|
74
|
+
**描述**: 设置密码
|
|
75
|
+
|
|
76
|
+
**参数**:
|
|
77
|
+
|
|
78
|
+
- `userOwner` (表单参数, string *(必填)*) — The owner of the user
|
|
79
|
+
- `userName` (表单参数, string *(必填)*) — The name of the user
|
|
80
|
+
- `oldPassword` (表单参数, string *(必填)*) — The old password of the user
|
|
81
|
+
- `newPassword` (表单参数, string *(必填)*) — The new password of the user
|
|
82
|
+
|
|
83
|
+
**响应**:
|
|
84
|
+
|
|
85
|
+
- **200**: The Response object
|
|
86
|
+
|
|
87
|
+
- `data`: object
|
|
88
|
+
- `data2`: object
|
|
89
|
+
- `data3`: object
|
|
90
|
+
- `msg`: string
|
|
91
|
+
- `name`: string
|
|
92
|
+
- `status`: string
|
|
93
|
+
- `sub`: string
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
### GET `/auth/api/user`
|
|
98
|
+
**操作**: `ApiController.UserInfo2`
|
|
99
|
+
**描述**: 返回 Laravel 兼容的用户信息(OAuth 2.0)
|
|
100
|
+
|
|
101
|
+
**响应**:
|
|
102
|
+
|
|
103
|
+
- **200**: The Response object
|
|
104
|
+
|
|
105
|
+
- `created_at`: string
|
|
106
|
+
- `email`: string
|
|
107
|
+
- `email_verified_at`: string
|
|
108
|
+
- `id`: string
|
|
109
|
+
- `name`: string
|
|
110
|
+
- `updated_at`: string
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
### GET `/auth/api/userinfo`
|
|
115
|
+
**操作**: `ApiController.UserInfo`
|
|
116
|
+
**描述**: 返回用户信息(OIDC 标准)
|
|
117
|
+
|
|
118
|
+
**响应**:
|
|
119
|
+
|
|
120
|
+
- **200**: The Response object
|
|
121
|
+
|
|
122
|
+
- `address`: string
|
|
123
|
+
- `aud`: string
|
|
124
|
+
- `email`: string
|
|
125
|
+
- `email_verified`: boolean
|
|
126
|
+
- `groups`: Array<string>
|
|
127
|
+
- `iss`: string
|
|
128
|
+
- `name`: string
|
|
129
|
+
- `permissions`: Array<string>
|
|
130
|
+
- `phone`: string
|
|
131
|
+
- `picture`: string
|
|
132
|
+
- `preferred_username`: string
|
|
133
|
+
- `roles`: Array<string>
|
|
134
|
+
- `sub`: string
|
|
135
|
+
|
|
136
|
+
---
|
|
137
|
+
|
|
138
|
+
## 邺请 API
|
|
139
|
+
|
|
140
|
+
### GET `/auth/api/get-invitation`
|
|
141
|
+
**操作**: `ApiController.GetInvitation`
|
|
142
|
+
**描述**: 获取邺请信息
|
|
143
|
+
|
|
144
|
+
**参数**:
|
|
145
|
+
|
|
146
|
+
- `id` (查询参数, string *(必填)*) — The id ( owner/name ) of the invitation
|
|
147
|
+
|
|
148
|
+
**响应**:
|
|
149
|
+
|
|
150
|
+
- **200**: The Response object
|
|
151
|
+
|
|
152
|
+
- `application`: string
|
|
153
|
+
- `code`: string
|
|
154
|
+
- `createdTime`: string
|
|
155
|
+
- `defaultCode`: string
|
|
156
|
+
- `displayName`: string
|
|
157
|
+
- `email`: string
|
|
158
|
+
- `isRegexp`: boolean
|
|
159
|
+
- `name`: string
|
|
160
|
+
- `owner`: string
|
|
161
|
+
- `phone`: string
|
|
162
|
+
- `quota`: integer
|
|
163
|
+
- `signupGroup`: string
|
|
164
|
+
- `state`: string
|
|
165
|
+
- `updatedTime`: string
|
|
166
|
+
- `usedCount`: integer
|
|
167
|
+
- `username`: string
|
|
168
|
+
|
|
169
|
+
---
|
|
170
|
+
|
|
171
|
+
### GET `/auth/api/get-invitation-info`
|
|
172
|
+
**操作**: `ApiController.GetInvitationCodeInfo`
|
|
173
|
+
**描述**: 获取邺请码详情
|
|
174
|
+
|
|
175
|
+
**参数**:
|
|
176
|
+
|
|
177
|
+
- `code` (查询参数, string *(必填)*) — Invitation code
|
|
178
|
+
|
|
179
|
+
**响应**:
|
|
180
|
+
|
|
181
|
+
- **200**: The Response object
|
|
182
|
+
|
|
183
|
+
- `application`: string
|
|
184
|
+
- `code`: string
|
|
185
|
+
- `createdTime`: string
|
|
186
|
+
- `defaultCode`: string
|
|
187
|
+
- `displayName`: string
|
|
188
|
+
- `email`: string
|
|
189
|
+
- `isRegexp`: boolean
|
|
190
|
+
- `name`: string
|
|
191
|
+
- `owner`: string
|
|
192
|
+
- `phone`: string
|
|
193
|
+
- `quota`: integer
|
|
194
|
+
- `signupGroup`: string
|
|
195
|
+
- `state`: string
|
|
196
|
+
- `updatedTime`: string
|
|
197
|
+
- `usedCount`: integer
|
|
198
|
+
- `username`: string
|
|
199
|
+
|
|
200
|
+
---
|
|
201
|
+
|
|
202
|
+
### GET `/auth/api/get-invitations`
|
|
203
|
+
**操作**: `ApiController.GetInvitations`
|
|
204
|
+
**描述**: 获取邺请列表
|
|
205
|
+
|
|
206
|
+
**参数**:
|
|
207
|
+
|
|
208
|
+
- `owner` (查询参数, string *(必填)*) — The owner of invitations
|
|
209
|
+
|
|
210
|
+
**响应**:
|
|
211
|
+
|
|
212
|
+
- **200**: The Response object
|
|
213
|
+
Array<object.Invitation>
|
|
214
|
+
|
|
215
|
+
---
|
|
216
|
+
|
|
217
|
+
### POST `/auth/api/send-invitation`
|
|
218
|
+
**操作**: `ApiController.VerifyInvitation`
|
|
219
|
+
**描述**: 验证邺请码
|
|
220
|
+
|
|
221
|
+
**参数**:
|
|
222
|
+
|
|
223
|
+
- `id` (查询参数, string *(必填)*) — The id ( owner/name ) of the invitation
|
|
224
|
+
- `body` (请求体, array *(必填)*) — The details of the invitation
|
|
225
|
+
|
|
226
|
+
**响应**:
|
|
227
|
+
|
|
228
|
+
- **200**: The Response object
|
|
229
|
+
|
|
230
|
+
- `data`: object
|
|
231
|
+
- `data2`: object
|
|
232
|
+
- `data3`: object
|
|
233
|
+
- `msg`: string
|
|
234
|
+
- `name`: string
|
|
235
|
+
- `status`: string
|
|
236
|
+
- `sub`: string
|
|
237
|
+
|
|
238
|
+
---
|
|
239
|
+
|
|
240
|
+
### GET `/auth/api/verify-invitation`
|
|
241
|
+
**操作**: `ApiController.VerifyInvitation`
|
|
242
|
+
**描述**: 验证邺请码
|
|
243
|
+
|
|
244
|
+
**参数**:
|
|
245
|
+
|
|
246
|
+
- `id` (查询参数, string *(必填)*) — The id ( owner/name ) of the invitation
|
|
247
|
+
|
|
248
|
+
**响应**:
|
|
249
|
+
|
|
250
|
+
- **200**: The Response object
|
|
251
|
+
|
|
252
|
+
- `data`: object
|
|
253
|
+
- `data2`: object
|
|
254
|
+
- `data3`: object
|
|
255
|
+
- `msg`: string
|
|
256
|
+
- `name`: string
|
|
257
|
+
- `status`: string
|
|
258
|
+
- `sub`: string
|
|
259
|
+
|
|
260
|
+
---
|
|
261
|
+
|
|
262
|
+
## 登录 API
|
|
263
|
+
|
|
264
|
+
### GET `/auth/api/faceid-signin-begin`
|
|
265
|
+
**操作**: `ApiController.FaceIDSigninBegin`
|
|
266
|
+
**描述**: FaceID 登录流程第一阶段
|
|
267
|
+
|
|
268
|
+
**参数**:
|
|
269
|
+
|
|
270
|
+
- `owner` (查询参数, string *(必填)*) — owner
|
|
271
|
+
- `name` (查询参数, string *(必填)*) — name
|
|
272
|
+
|
|
273
|
+
**响应**:
|
|
274
|
+
|
|
275
|
+
- **200**: The Response object
|
|
276
|
+
|
|
277
|
+
- `data`: object
|
|
278
|
+
- `data2`: object
|
|
279
|
+
- `data3`: object
|
|
280
|
+
- `msg`: string
|
|
281
|
+
- `name`: string
|
|
282
|
+
- `status`: string
|
|
283
|
+
- `sub`: string
|
|
284
|
+
|
|
285
|
+
---
|
|
286
|
+
|
|
287
|
+
### GET `/auth/api/get-app-login`
|
|
288
|
+
**操作**: `ApiController.GetApplicationLogin`
|
|
289
|
+
**描述**: 获取应用登录信息
|
|
290
|
+
|
|
291
|
+
**参数**:
|
|
292
|
+
|
|
293
|
+
- `clientId` (查询参数, string *(必填)*) — client id
|
|
294
|
+
- `responseType` (查询参数, string *(必填)*) — response type
|
|
295
|
+
- `redirectUri` (查询参数, string *(必填)*) — redirect uri
|
|
296
|
+
- `scope` (查询参数, string *(必填)*) — scope
|
|
297
|
+
- `state` (查询参数, string *(必填)*) — state
|
|
298
|
+
|
|
299
|
+
**响应**:
|
|
300
|
+
|
|
301
|
+
- **200**: The Response object
|
|
302
|
+
|
|
303
|
+
- `data`: object
|
|
304
|
+
- `data2`: object
|
|
305
|
+
- `data3`: object
|
|
306
|
+
- `msg`: string
|
|
307
|
+
- `name`: string
|
|
308
|
+
- `status`: string
|
|
309
|
+
- `sub`: string
|
|
310
|
+
|
|
311
|
+
---
|
|
312
|
+
|
|
313
|
+
### GET `/auth/api/get-captcha`
|
|
314
|
+
**操作**: `ApiController.GetCaptcha`
|
|
315
|
+
|
|
316
|
+
**响应**:
|
|
317
|
+
|
|
318
|
+
- **200**: The Response object
|
|
319
|
+
|
|
320
|
+
- `address`: string
|
|
321
|
+
- `aud`: string
|
|
322
|
+
- `email`: string
|
|
323
|
+
- `email_verified`: boolean
|
|
324
|
+
- `groups`: Array<string>
|
|
325
|
+
- `iss`: string
|
|
326
|
+
- `name`: string
|
|
327
|
+
- `permissions`: Array<string>
|
|
328
|
+
- `phone`: string
|
|
329
|
+
- `picture`: string
|
|
330
|
+
- `preferred_username`: string
|
|
331
|
+
- `roles`: Array<string>
|
|
332
|
+
- `sub`: string
|
|
333
|
+
|
|
334
|
+
---
|
|
335
|
+
|
|
336
|
+
### POST `/auth/api/login`
|
|
337
|
+
**操作**: `ApiController.Login`
|
|
338
|
+
**描述**: 登录
|
|
339
|
+
|
|
340
|
+
**参数**:
|
|
341
|
+
|
|
342
|
+
- `clientId` (查询参数, string *(必填)*) — clientId
|
|
343
|
+
- `responseType` (查询参数, string *(必填)*) — responseType
|
|
344
|
+
- `redirectUri` (查询参数, string *(必填)*) — redirectUri
|
|
345
|
+
- `scope` (查询参数, string) — scope
|
|
346
|
+
- `state` (查询参数, string) — state
|
|
347
|
+
- `nonce` (查询参数, string) — nonce
|
|
348
|
+
- `code_challenge_method` (查询参数, string) — code_challenge_method
|
|
349
|
+
- `code_challenge` (查询参数, string) — code_challenge
|
|
350
|
+
- `form` (请求体, object *(必填)*) — Login information
|
|
351
|
+
|
|
352
|
+
**响应**:
|
|
353
|
+
|
|
354
|
+
- **200**: The Response object
|
|
355
|
+
|
|
356
|
+
- `data`: object
|
|
357
|
+
- `data2`: object
|
|
358
|
+
- `data3`: object
|
|
359
|
+
- `msg`: string
|
|
360
|
+
- `name`: string
|
|
361
|
+
- `status`: string
|
|
362
|
+
- `sub`: string
|
|
363
|
+
|
|
364
|
+
---
|
|
365
|
+
|
|
366
|
+
### POST `/auth/api/logout`
|
|
367
|
+
**操作**: `ApiController.Logout`
|
|
368
|
+
**描述**: 注销当前用户
|
|
369
|
+
|
|
370
|
+
**参数**:
|
|
371
|
+
|
|
372
|
+
- `id_token_hint` (查询参数, string) — id_token_hint
|
|
373
|
+
- `post_logout_redirect_uri` (查询参数, string) — post_logout_redirect_uri
|
|
374
|
+
- `state` (查询参数, string) — state
|
|
375
|
+
|
|
376
|
+
**响应**:
|
|
377
|
+
|
|
378
|
+
- **200**: The Response object
|
|
379
|
+
|
|
380
|
+
- `data`: object
|
|
381
|
+
- `data2`: object
|
|
382
|
+
- `data3`: object
|
|
383
|
+
- `msg`: string
|
|
384
|
+
- `name`: string
|
|
385
|
+
- `status`: string
|
|
386
|
+
- `sub`: string
|
|
387
|
+
|
|
388
|
+
---
|
|
389
|
+
|
|
390
|
+
### POST `/auth/api/signup`
|
|
391
|
+
**操作**: `ApiController.Signup`
|
|
392
|
+
**描述**: 注册新用户
|
|
393
|
+
|
|
394
|
+
**参数**:
|
|
395
|
+
|
|
396
|
+
- `username` (表单参数, string *(必填)*) — The username to sign up
|
|
397
|
+
- `password` (表单参数, string *(必填)*) — The password
|
|
398
|
+
|
|
399
|
+
**响应**:
|
|
400
|
+
|
|
401
|
+
- **200**: The Response object
|
|
402
|
+
|
|
403
|
+
- `data`: object
|
|
404
|
+
- `data2`: object
|
|
405
|
+
- `data3`: object
|
|
406
|
+
- `msg`: string
|
|
407
|
+
- `name`: string
|
|
408
|
+
- `status`: string
|
|
409
|
+
- `sub`: string
|
|
410
|
+
|
|
411
|
+
---
|
|
412
|
+
|
|
413
|
+
### GET `/auth/api/sso-logout`
|
|
414
|
+
**操作**: `ApiController.SsoLogout`
|
|
415
|
+
**描述**: 从所有应用注销当前用户
|
|
416
|
+
|
|
417
|
+
**响应**:
|
|
418
|
+
|
|
419
|
+
- **200**: The Response object
|
|
420
|
+
|
|
421
|
+
- `data`: object
|
|
422
|
+
- `data2`: object
|
|
423
|
+
- `data3`: object
|
|
424
|
+
- `msg`: string
|
|
425
|
+
- `name`: string
|
|
426
|
+
- `status`: string
|
|
427
|
+
- `sub`: string
|
|
428
|
+
|
|
429
|
+
---
|
|
430
|
+
|
|
431
|
+
### POST `/auth/api/sso-logout`
|
|
432
|
+
**操作**: `ApiController.SsoLogout`
|
|
433
|
+
**描述**: 从所有应用注销当前用户
|
|
434
|
+
|
|
435
|
+
**响应**:
|
|
436
|
+
|
|
437
|
+
- **200**: The Response object
|
|
438
|
+
|
|
439
|
+
- `data`: object
|
|
440
|
+
- `data2`: object
|
|
441
|
+
- `data3`: object
|
|
442
|
+
- `msg`: string
|
|
443
|
+
- `name`: string
|
|
444
|
+
- `status`: string
|
|
445
|
+
- `sub`: string
|
|
446
|
+
|
|
447
|
+
---
|
|
448
|
+
|
|
449
|
+
### POST `/auth/api/unlink`
|
|
450
|
+
**操作**: `ApiController.Unlink`
|
|
451
|
+
|
|
452
|
+
**响应**:
|
|
453
|
+
|
|
454
|
+
- **200**: The Response object
|
|
455
|
+
|
|
456
|
+
- `address`: string
|
|
457
|
+
- `aud`: string
|
|
458
|
+
- `email`: string
|
|
459
|
+
- `email_verified`: boolean
|
|
460
|
+
- `groups`: Array<string>
|
|
461
|
+
- `iss`: string
|
|
462
|
+
- `name`: string
|
|
463
|
+
- `permissions`: Array<string>
|
|
464
|
+
- `phone`: string
|
|
465
|
+
- `picture`: string
|
|
466
|
+
- `preferred_username`: string
|
|
467
|
+
- `roles`: Array<string>
|
|
468
|
+
- `sub`: string
|
|
469
|
+
|
|
470
|
+
---
|
|
471
|
+
|
|
472
|
+
### GET `/auth/api/webauthn/signin/begin`
|
|
473
|
+
**操作**: `ApiController.WebAuthnSigninBegin`
|
|
474
|
+
**描述**: WebAuthn 登录流程第一阶段
|
|
475
|
+
|
|
476
|
+
**参数**:
|
|
477
|
+
|
|
478
|
+
- `owner` (查询参数, string *(必填)*) — owner
|
|
479
|
+
- `name` (查询参数, string *(必填)*) — name
|
|
480
|
+
|
|
481
|
+
**响应**:
|
|
482
|
+
|
|
483
|
+
- **200**: The CredentialAssertion object
|
|
484
|
+
object
|
|
485
|
+
|
|
486
|
+
---
|
|
487
|
+
|
|
488
|
+
### POST `/auth/api/webauthn/signin/finish`
|
|
489
|
+
**操作**: `ApiController.WebAuthnSigninFinish`
|
|
490
|
+
**描述**: WebAuthn 登录流程第二阶段
|
|
491
|
+
|
|
492
|
+
**参数**:
|
|
493
|
+
|
|
494
|
+
- `body` (请求体, object *(必填)*) — authenticator assertion Response
|
|
495
|
+
|
|
496
|
+
**响应**:
|
|
497
|
+
|
|
498
|
+
- **200**: "The Response object"
|
|
499
|
+
|
|
500
|
+
- `data`: object
|
|
501
|
+
- `data2`: object
|
|
502
|
+
- `data3`: object
|
|
503
|
+
- `msg`: string
|
|
504
|
+
- `name`: string
|
|
505
|
+
- `status`: string
|
|
506
|
+
- `sub`: string
|
|
507
|
+
|
|
508
|
+
---
|
|
509
|
+
|
|
510
|
+
## 多因素认证 API
|
|
511
|
+
|
|
512
|
+
### POST `/auth/api/delete-mfa/`
|
|
513
|
+
**操作**: `ApiController.DeleteMfa`
|
|
514
|
+
**描述**: 删除多因素认证
|
|
515
|
+
|
|
516
|
+
**响应**:
|
|
517
|
+
|
|
518
|
+
- **200**: The Response object
|
|
519
|
+
|
|
520
|
+
- `data`: object
|
|
521
|
+
- `data2`: object
|
|
522
|
+
- `data3`: object
|
|
523
|
+
- `msg`: string
|
|
524
|
+
- `name`: string
|
|
525
|
+
- `status`: string
|
|
526
|
+
- `sub`: string
|
|
527
|
+
|
|
528
|
+
---
|
|
529
|
+
|
|
530
|
+
### POST `/auth/api/mfa/setup/enable`
|
|
531
|
+
**操作**: `ApiController.MfaSetupEnable`
|
|
532
|
+
**描述**: 启用 TOTP
|
|
533
|
+
|
|
534
|
+
**响应**:
|
|
535
|
+
|
|
536
|
+
- **200**: The Response object
|
|
537
|
+
|
|
538
|
+
- `data`: object
|
|
539
|
+
- `data2`: object
|
|
540
|
+
- `data3`: object
|
|
541
|
+
- `msg`: string
|
|
542
|
+
- `name`: string
|
|
543
|
+
- `status`: string
|
|
544
|
+
- `sub`: string
|
|
545
|
+
|
|
546
|
+
---
|
|
547
|
+
|
|
548
|
+
### POST `/auth/api/mfa/setup/initiate`
|
|
549
|
+
**操作**: `ApiController.MfaSetupInitiate`
|
|
550
|
+
**描述**: 设置多因素认证
|
|
551
|
+
|
|
552
|
+
**响应**:
|
|
553
|
+
|
|
554
|
+
- **200**: The Response object
|
|
555
|
+
|
|
556
|
+
- `data`: object
|
|
557
|
+
- `data2`: object
|
|
558
|
+
- `data3`: object
|
|
559
|
+
- `msg`: string
|
|
560
|
+
- `name`: string
|
|
561
|
+
- `status`: string
|
|
562
|
+
- `sub`: string
|
|
563
|
+
|
|
564
|
+
---
|
|
565
|
+
|
|
566
|
+
### POST `/auth/api/mfa/setup/verify`
|
|
567
|
+
**操作**: `ApiController.MfaSetupVerify`
|
|
568
|
+
**描述**: 验证 TOTP 设置
|
|
569
|
+
|
|
570
|
+
**响应**:
|
|
571
|
+
|
|
572
|
+
- **200**: The Response object
|
|
573
|
+
|
|
574
|
+
- `data`: object
|
|
575
|
+
- `data2`: object
|
|
576
|
+
- `data3`: object
|
|
577
|
+
- `msg`: string
|
|
578
|
+
- `name`: string
|
|
579
|
+
- `status`: string
|
|
580
|
+
- `sub`: string
|
|
581
|
+
|
|
582
|
+
---
|
|
583
|
+
|
|
584
|
+
### POST `/auth/api/set-preferred-mfa`
|
|
585
|
+
**操作**: `ApiController.SetPreferredMfa`
|
|
586
|
+
**描述**: 设置首选多因素认证方式
|
|
587
|
+
|
|
588
|
+
**响应**:
|
|
589
|
+
|
|
590
|
+
- **200**: The Response object
|
|
591
|
+
|
|
592
|
+
- `data`: object
|
|
593
|
+
- `data2`: object
|
|
594
|
+
- `data3`: object
|
|
595
|
+
- `msg`: string
|
|
596
|
+
- `name`: string
|
|
597
|
+
- `status`: string
|
|
598
|
+
- `sub`: string
|
|
599
|
+
|
|
600
|
+
---
|
|
601
|
+
|
|
602
|
+
## 订单 API
|
|
603
|
+
|
|
604
|
+
### POST `/auth/api/add-order`
|
|
605
|
+
**操作**: `ApiController.AddOrder`
|
|
606
|
+
**描述**: 新增订单
|
|
607
|
+
|
|
608
|
+
**参数**:
|
|
609
|
+
|
|
610
|
+
- `body` (请求体, object *(必填)*) — The details of the order
|
|
611
|
+
|
|
612
|
+
**响应**:
|
|
613
|
+
|
|
614
|
+
- **200**: The Response object
|
|
615
|
+
|
|
616
|
+
- `data`: object
|
|
617
|
+
- `data2`: object
|
|
618
|
+
- `data3`: object
|
|
619
|
+
- `msg`: string
|
|
620
|
+
- `name`: string
|
|
621
|
+
- `status`: string
|
|
622
|
+
- `sub`: string
|
|
623
|
+
|
|
624
|
+
---
|
|
625
|
+
|
|
626
|
+
### GET `/auth/api/get-order`
|
|
627
|
+
**操作**: `ApiController.GetOrder`
|
|
628
|
+
**描述**: 获取订单
|
|
629
|
+
|
|
630
|
+
**参数**:
|
|
631
|
+
|
|
632
|
+
- `id` (查询参数, string *(必填)*) — The id ( owner/name ) of the order
|
|
633
|
+
|
|
634
|
+
**响应**:
|
|
635
|
+
|
|
636
|
+
- **200**: The Response object
|
|
637
|
+
|
|
638
|
+
- `createdTime`: string
|
|
639
|
+
- `displayName`: string
|
|
640
|
+
- `endTime`: string
|
|
641
|
+
- `message`: string
|
|
642
|
+
- `name`: string
|
|
643
|
+
- `owner`: string
|
|
644
|
+
- `payment`: string
|
|
645
|
+
- `productName`: string
|
|
646
|
+
- `startTime`: string
|
|
647
|
+
- `state`: string
|
|
648
|
+
- `user`: string
|
|
649
|
+
|
|
650
|
+
---
|
|
651
|
+
|
|
652
|
+
### GET `/auth/api/get-orders`
|
|
653
|
+
**操作**: `ApiController.GetOrders`
|
|
654
|
+
**描述**: 获取订单列表
|
|
655
|
+
|
|
656
|
+
**参数**:
|
|
657
|
+
|
|
658
|
+
- `owner` (查询参数, string *(必填)*) — The owner of orders
|
|
659
|
+
|
|
660
|
+
**响应**:
|
|
661
|
+
|
|
662
|
+
- **200**: The Response object
|
|
663
|
+
Array<object.Order>
|
|
664
|
+
|
|
665
|
+
---
|
|
666
|
+
|
|
667
|
+
### GET `/auth/api/get-user-orders`
|
|
668
|
+
**操作**: `ApiController.GetUserOrders`
|
|
669
|
+
**描述**: 获取用户订单
|
|
670
|
+
|
|
671
|
+
**参数**:
|
|
672
|
+
|
|
673
|
+
- `owner` (查询参数, string *(必填)*) — The owner of orders
|
|
674
|
+
- `user` (查询参数, string *(必填)*) — The username of the user
|
|
675
|
+
|
|
676
|
+
**响应**:
|
|
677
|
+
|
|
678
|
+
- **200**: The Response object
|
|
679
|
+
Array<object.Order>
|
|
680
|
+
|
|
681
|
+
---
|
|
682
|
+
|
|
683
|
+
## 支付 API
|
|
684
|
+
|
|
685
|
+
### GET `/auth/api/get-payment`
|
|
686
|
+
**操作**: `ApiController.GetPayment`
|
|
687
|
+
**描述**: 获取支付信息
|
|
688
|
+
|
|
689
|
+
**参数**:
|
|
690
|
+
|
|
691
|
+
- `id` (查询参数, string *(必填)*) — The id ( owner/name ) of the payment
|
|
692
|
+
|
|
693
|
+
**响应**:
|
|
694
|
+
|
|
695
|
+
- **200**: The Response object
|
|
696
|
+
|
|
697
|
+
- `createdTime`: string
|
|
698
|
+
- `currency`: string
|
|
699
|
+
- `detail`: string
|
|
700
|
+
- `displayName`: string
|
|
701
|
+
- `invoiceRemark`: string
|
|
702
|
+
- `invoiceTaxId`: string
|
|
703
|
+
- `invoiceTitle`: string
|
|
704
|
+
- `invoiceType`: string
|
|
705
|
+
- `invoiceUrl`: string
|
|
706
|
+
- `isRecharge`: boolean
|
|
707
|
+
- `message`: string
|
|
708
|
+
- `name`: string
|
|
709
|
+
- `outOrderId`: string
|
|
710
|
+
- `owner`: string
|
|
711
|
+
- `payUrl`: string
|
|
712
|
+
- `personEmail`: string
|
|
713
|
+
- `personIdCard`: string
|
|
714
|
+
- `personName`: string
|
|
715
|
+
- `personPhone`: string
|
|
716
|
+
- `price`: number
|
|
717
|
+
- `productDisplayName`: string
|
|
718
|
+
- `productName`: string
|
|
719
|
+
- `provider`: string
|
|
720
|
+
- `returnUrl`: string
|
|
721
|
+
- `state`: string
|
|
722
|
+
- `successUrl`: string
|
|
723
|
+
- `tag`: string
|
|
724
|
+
- `type`: string
|
|
725
|
+
- `user`: string
|
|
726
|
+
|
|
727
|
+
---
|
|
728
|
+
|
|
729
|
+
### GET `/auth/api/get-payments`
|
|
730
|
+
**操作**: `ApiController.GetPayments`
|
|
731
|
+
**描述**: 获取支付列表
|
|
732
|
+
|
|
733
|
+
**参数**:
|
|
734
|
+
|
|
735
|
+
- `owner` (查询参数, string *(必填)*) — The owner of payments
|
|
736
|
+
|
|
737
|
+
**响应**:
|
|
738
|
+
|
|
739
|
+
- **200**: The Response object
|
|
740
|
+
Array<object.Payment>
|
|
741
|
+
|
|
742
|
+
---
|
|
743
|
+
|
|
744
|
+
### GET `/auth/api/get-user-payments`
|
|
745
|
+
**操作**: `ApiController.GetUserPayments`
|
|
746
|
+
**描述**: 获取用户支付记录
|
|
747
|
+
|
|
748
|
+
**参数**:
|
|
749
|
+
|
|
750
|
+
- `owner` (查询参数, string *(必填)*) — The owner of payments
|
|
751
|
+
- `organization` (查询参数, string *(必填)*) — The organization of the user
|
|
752
|
+
- `user` (查询参数, string *(必填)*) — The username of the user
|
|
753
|
+
|
|
754
|
+
**响应**:
|
|
755
|
+
|
|
756
|
+
- **200**: The Response object
|
|
757
|
+
Array<object.Payment>
|
|
758
|
+
|
|
759
|
+
---
|
|
760
|
+
|
|
761
|
+
### POST `/auth/api/invoice-payment`
|
|
762
|
+
**操作**: `ApiController.InvoicePayment`
|
|
763
|
+
**描述**: 开具发票
|
|
764
|
+
|
|
765
|
+
**参数**:
|
|
766
|
+
|
|
767
|
+
- `id` (查询参数, string *(必填)*) — The id ( owner/name ) of the payment
|
|
768
|
+
|
|
769
|
+
**响应**:
|
|
770
|
+
|
|
771
|
+
- **200**: The Response object
|
|
772
|
+
|
|
773
|
+
- `data`: object
|
|
774
|
+
- `data2`: object
|
|
775
|
+
- `data3`: object
|
|
776
|
+
- `msg`: string
|
|
777
|
+
- `name`: string
|
|
778
|
+
- `status`: string
|
|
779
|
+
- `sub`: string
|
|
780
|
+
|
|
781
|
+
---
|
|
782
|
+
|
|
783
|
+
### POST `/auth/api/notify-payment`
|
|
784
|
+
**操作**: `ApiController.NotifyPayment`
|
|
785
|
+
**描述**: 支付通知
|
|
786
|
+
|
|
787
|
+
**参数**:
|
|
788
|
+
|
|
789
|
+
- `body` (请求体, object *(必填)*) — The details of the payment
|
|
790
|
+
|
|
791
|
+
**响应**:
|
|
792
|
+
|
|
793
|
+
- **200**: The Response object
|
|
794
|
+
|
|
795
|
+
- `data`: object
|
|
796
|
+
- `data2`: object
|
|
797
|
+
- `data3`: object
|
|
798
|
+
- `msg`: string
|
|
799
|
+
- `name`: string
|
|
800
|
+
- `status`: string
|
|
801
|
+
- `sub`: string
|
|
802
|
+
|
|
803
|
+
---
|
|
804
|
+
|
|
805
|
+
## 计划 API
|
|
806
|
+
|
|
807
|
+
### GET `/auth/api/get-plan`
|
|
808
|
+
**操作**: `ApiController.GetPlan`
|
|
809
|
+
**描述**: 获取计划
|
|
810
|
+
|
|
811
|
+
**参数**:
|
|
812
|
+
|
|
813
|
+
- `id` (查询参数, string *(必填)*) — The id ( owner/name ) of the plan
|
|
814
|
+
- `includeOption` (查询参数, boolean) — Should include plan's option
|
|
815
|
+
|
|
816
|
+
**响应**:
|
|
817
|
+
|
|
818
|
+
- **200**: The Response object
|
|
819
|
+
|
|
820
|
+
- `createdTime`: string
|
|
821
|
+
- `currency`: string
|
|
822
|
+
- `description`: string
|
|
823
|
+
- `displayName`: string
|
|
824
|
+
- `isEnabled`: boolean
|
|
825
|
+
- `name`: string
|
|
826
|
+
- `options`: Array<string>
|
|
827
|
+
- `owner`: string
|
|
828
|
+
- `paymentProviders`: Array<string>
|
|
829
|
+
- `period`: string
|
|
830
|
+
- `price`: number
|
|
831
|
+
- `product`: string
|
|
832
|
+
- `role`: string
|
|
833
|
+
|
|
834
|
+
---
|
|
835
|
+
|
|
836
|
+
### GET `/auth/api/get-plans`
|
|
837
|
+
**操作**: `ApiController.GetPlans`
|
|
838
|
+
**描述**: 获取计划列表
|
|
839
|
+
|
|
840
|
+
**参数**:
|
|
841
|
+
|
|
842
|
+
- `owner` (查询参数, string *(必填)*) — The owner of plans
|
|
843
|
+
|
|
844
|
+
**响应**:
|
|
845
|
+
|
|
846
|
+
- **200**: The Response object
|
|
847
|
+
Array<object.Plan>
|
|
848
|
+
|
|
849
|
+
---
|
|
850
|
+
|
|
851
|
+
## 定价 API
|
|
852
|
+
|
|
853
|
+
### GET `/auth/api/get-pricing`
|
|
854
|
+
**操作**: `ApiController.GetPricing`
|
|
855
|
+
**描述**: 获取定价
|
|
856
|
+
|
|
857
|
+
**参数**:
|
|
858
|
+
|
|
859
|
+
- `id` (查询参数, string *(必填)*) — The id ( owner/name ) of the pricing
|
|
860
|
+
|
|
861
|
+
**响应**:
|
|
862
|
+
|
|
863
|
+
- **200**: The Response object
|
|
864
|
+
|
|
865
|
+
- `application`: string
|
|
866
|
+
- `createdTime`: string
|
|
867
|
+
- `description`: string
|
|
868
|
+
- `displayName`: string
|
|
869
|
+
- `isEnabled`: boolean
|
|
870
|
+
- `name`: string
|
|
871
|
+
- `owner`: string
|
|
872
|
+
- `plans`: Array<string>
|
|
873
|
+
- `trialDuration`: integer
|
|
874
|
+
|
|
875
|
+
---
|
|
876
|
+
|
|
877
|
+
### GET `/auth/api/get-pricings`
|
|
878
|
+
**操作**: `ApiController.GetPricings`
|
|
879
|
+
**描述**: 获取定价列表
|
|
880
|
+
|
|
881
|
+
**参数**:
|
|
882
|
+
|
|
883
|
+
- `owner` (查询参数, string *(必填)*) — The owner of pricings
|
|
884
|
+
|
|
885
|
+
**响应**:
|
|
886
|
+
|
|
887
|
+
- **200**: The Response object
|
|
888
|
+
Array<object.Pricing>
|
|
889
|
+
|
|
890
|
+
---
|
|
891
|
+
|
|
892
|
+
## 商品 API
|
|
893
|
+
|
|
894
|
+
### POST `/auth/api/buy-product`
|
|
895
|
+
**操作**: `ApiController.BuyProduct`
|
|
896
|
+
**描述**: 购买商品
|
|
897
|
+
|
|
898
|
+
**参数**:
|
|
899
|
+
|
|
900
|
+
- `id` (查询参数, string *(必填)*) — The id ( owner/name ) of the product
|
|
901
|
+
- `providerName` (查询参数, string *(必填)*) — The name of the provider
|
|
902
|
+
|
|
903
|
+
**响应**:
|
|
904
|
+
|
|
905
|
+
- **200**: The Response object
|
|
906
|
+
|
|
907
|
+
- `data`: object
|
|
908
|
+
- `data2`: object
|
|
909
|
+
- `data3`: object
|
|
910
|
+
- `msg`: string
|
|
911
|
+
- `name`: string
|
|
912
|
+
- `status`: string
|
|
913
|
+
- `sub`: string
|
|
914
|
+
|
|
915
|
+
---
|
|
916
|
+
|
|
917
|
+
### GET `/auth/api/get-product`
|
|
918
|
+
**操作**: `ApiController.GetProduct`
|
|
919
|
+
**描述**: 获取商品
|
|
920
|
+
|
|
921
|
+
**参数**:
|
|
922
|
+
|
|
923
|
+
- `id` (查询参数, string *(必填)*) — The id ( owner/name ) of the product
|
|
924
|
+
|
|
925
|
+
**响应**:
|
|
926
|
+
|
|
927
|
+
- **200**: The Response object
|
|
928
|
+
|
|
929
|
+
- `createdTime`: string
|
|
930
|
+
- `currency`: string
|
|
931
|
+
- `description`: string
|
|
932
|
+
- `detail`: string
|
|
933
|
+
- `displayName`: string
|
|
934
|
+
- `image`: string
|
|
935
|
+
- `isRecharge`: boolean
|
|
936
|
+
- `name`: string
|
|
937
|
+
- `owner`: string
|
|
938
|
+
- `price`: number
|
|
939
|
+
- `providerObjs`: Array<object.Provider>
|
|
940
|
+
- `providers`: Array<string>
|
|
941
|
+
- `quantity`: integer
|
|
942
|
+
- `returnUrl`: string
|
|
943
|
+
- `sold`: integer
|
|
944
|
+
- `state`: string
|
|
945
|
+
- `successUrl`: string
|
|
946
|
+
- `tag`: string
|
|
947
|
+
|
|
948
|
+
---
|
|
949
|
+
|
|
950
|
+
### GET `/auth/api/get-products`
|
|
951
|
+
**操作**: `ApiController.GetProducts`
|
|
952
|
+
**描述**: 获取商品列表
|
|
953
|
+
|
|
954
|
+
**参数**:
|
|
955
|
+
|
|
956
|
+
- `owner` (查询参数, string *(必填)*) — The owner of products
|
|
957
|
+
|
|
958
|
+
**响应**:
|
|
959
|
+
|
|
960
|
+
- **200**: The Response object
|
|
961
|
+
Array<object.Product>
|
|
962
|
+
|
|
963
|
+
---
|
|
964
|
+
|
|
965
|
+
## 资源 API
|
|
966
|
+
|
|
967
|
+
### GET `/auth/api/get-resource`
|
|
968
|
+
**操作**: `ApiController.GetResource`
|
|
969
|
+
**描述**: 获取资源
|
|
970
|
+
|
|
971
|
+
**参数**:
|
|
972
|
+
|
|
973
|
+
- `id` (查询参数, string *(必填)*) — The id ( owner/name ) of resource
|
|
974
|
+
|
|
975
|
+
**响应**:
|
|
976
|
+
|
|
977
|
+
- **200**: The Response object
|
|
978
|
+
|
|
979
|
+
- `application`: string
|
|
980
|
+
- `createdTime`: string
|
|
981
|
+
- `description`: string
|
|
982
|
+
- `fileFormat`: string
|
|
983
|
+
- `fileName`: string
|
|
984
|
+
- `fileSize`: integer
|
|
985
|
+
- `fileType`: string
|
|
986
|
+
- `name`: string
|
|
987
|
+
- `owner`: string
|
|
988
|
+
- `parent`: string
|
|
989
|
+
- `provider`: string
|
|
990
|
+
- `tag`: string
|
|
991
|
+
- `url`: string
|
|
992
|
+
- `user`: string
|
|
993
|
+
|
|
994
|
+
---
|
|
995
|
+
|
|
996
|
+
### GET `/auth/api/get-resources`
|
|
997
|
+
**操作**: `ApiController.GetResources`
|
|
998
|
+
**描述**: 获取资源列表
|
|
999
|
+
|
|
1000
|
+
**参数**:
|
|
1001
|
+
|
|
1002
|
+
- `owner` (查询参数, string *(必填)*) — Owner
|
|
1003
|
+
- `user` (查询参数, string *(必填)*) — User
|
|
1004
|
+
- `pageSize` (查询参数, integer) — Page Size
|
|
1005
|
+
- `p` (查询参数, integer) — Page Number
|
|
1006
|
+
- `field` (查询参数, string) — Field
|
|
1007
|
+
- `value` (查询参数, string) — Value
|
|
1008
|
+
- `sortField` (查询参数, string) — Sort Field
|
|
1009
|
+
- `sortOrder` (查询参数, string) — Sort Order
|
|
1010
|
+
|
|
1011
|
+
**响应**:
|
|
1012
|
+
|
|
1013
|
+
- **200**: The Response object
|
|
1014
|
+
Array<object.Resource>
|
|
1015
|
+
|
|
1016
|
+
---
|
|
1017
|
+
|
|
1018
|
+
### POST `/auth/api/upload-resource`
|
|
1019
|
+
**操作**: `ApiController.UploadResource`
|
|
1020
|
+
|
|
1021
|
+
**参数**:
|
|
1022
|
+
|
|
1023
|
+
- `owner` (查询参数, string *(必填)*) — Owner
|
|
1024
|
+
- `user` (查询参数, string *(必填)*) — User
|
|
1025
|
+
- `application` (查询参数, string *(必填)*) — Application
|
|
1026
|
+
- `tag` (查询参数, string) — Tag
|
|
1027
|
+
- `parent` (查询参数, string) — Parent
|
|
1028
|
+
- `fullFilePath` (查询参数, string *(必填)*) — Full File Path
|
|
1029
|
+
- `createdTime` (查询参数, string) — Created Time
|
|
1030
|
+
- `description` (查询参数, string) — Description
|
|
1031
|
+
- `file` (表单参数, file *(必填)*) — Resource file
|
|
1032
|
+
|
|
1033
|
+
**响应**:
|
|
1034
|
+
|
|
1035
|
+
- **200**: FileUrl, objectKey
|
|
1036
|
+
|
|
1037
|
+
- `application`: string
|
|
1038
|
+
- `createdTime`: string
|
|
1039
|
+
- `description`: string
|
|
1040
|
+
- `fileFormat`: string
|
|
1041
|
+
- `fileName`: string
|
|
1042
|
+
- `fileSize`: integer
|
|
1043
|
+
- `fileType`: string
|
|
1044
|
+
- `name`: string
|
|
1045
|
+
- `owner`: string
|
|
1046
|
+
- `parent`: string
|
|
1047
|
+
- `provider`: string
|
|
1048
|
+
- `tag`: string
|
|
1049
|
+
- `url`: string
|
|
1050
|
+
- `user`: string
|
|
1051
|
+
|
|
1052
|
+
---
|
|
1053
|
+
|
|
1054
|
+
## 会话 API
|
|
1055
|
+
|
|
1056
|
+
### GET `/auth/api/get-session`
|
|
1057
|
+
**操作**: `ApiController.GetSingleSession`
|
|
1058
|
+
**描述**: 获取用户在某个应用中的会话
|
|
1059
|
+
|
|
1060
|
+
**参数**:
|
|
1061
|
+
|
|
1062
|
+
- `sessionPkId` (查询参数, string *(必填)*) — The id(organization/user/application) of session
|
|
1063
|
+
|
|
1064
|
+
**响应**:
|
|
1065
|
+
|
|
1066
|
+
- **200**: The Response object
|
|
1067
|
+
Array<string>
|
|
1068
|
+
|
|
1069
|
+
---
|
|
1070
|
+
|
|
1071
|
+
### GET `/auth/api/is-session-duplicated`
|
|
1072
|
+
**操作**: `ApiController.IsSessionDuplicated`
|
|
1073
|
+
**描述**: 检查用户在某个应用中是否存在重复会话
|
|
1074
|
+
|
|
1075
|
+
**参数**:
|
|
1076
|
+
|
|
1077
|
+
- `sessionPkId` (查询参数, string *(必填)*) — The id(organization/user/application) of session
|
|
1078
|
+
- `sessionId` (查询参数, string *(必填)*) — sessionId to be checked
|
|
1079
|
+
|
|
1080
|
+
**响应**:
|
|
1081
|
+
|
|
1082
|
+
- **200**: The Response object
|
|
1083
|
+
Array<string>
|
|
1084
|
+
|
|
1085
|
+
---
|
|
1086
|
+
|
|
1087
|
+
## 订阅 API
|
|
1088
|
+
|
|
1089
|
+
### GET `/auth/api/get-subscription`
|
|
1090
|
+
**操作**: `ApiController.GetSubscription`
|
|
1091
|
+
**描述**: 获取订阅
|
|
1092
|
+
|
|
1093
|
+
**参数**:
|
|
1094
|
+
|
|
1095
|
+
- `id` (查询参数, string *(必填)*) — The id ( owner/name ) of the subscription
|
|
1096
|
+
|
|
1097
|
+
**响应**:
|
|
1098
|
+
|
|
1099
|
+
- **200**: The Response object
|
|
1100
|
+
|
|
1101
|
+
- `createdTime`: string
|
|
1102
|
+
- `description`: string
|
|
1103
|
+
- `displayName`: string
|
|
1104
|
+
- `endTime`: string
|
|
1105
|
+
- `name`: string
|
|
1106
|
+
- `owner`: string
|
|
1107
|
+
- `payment`: string
|
|
1108
|
+
- `period`: string
|
|
1109
|
+
- `plan`: string
|
|
1110
|
+
- `pricing`: string
|
|
1111
|
+
- `startTime`: string
|
|
1112
|
+
- `state`: string
|
|
1113
|
+
- `user`: string
|
|
1114
|
+
|
|
1115
|
+
---
|
|
1116
|
+
|
|
1117
|
+
### GET `/auth/api/get-subscriptions`
|
|
1118
|
+
**操作**: `ApiController.GetSubscriptions`
|
|
1119
|
+
**描述**: 获取订阅列表
|
|
1120
|
+
|
|
1121
|
+
**参数**:
|
|
1122
|
+
|
|
1123
|
+
- `owner` (查询参数, string *(必填)*) — The owner of subscriptions
|
|
1124
|
+
|
|
1125
|
+
**响应**:
|
|
1126
|
+
|
|
1127
|
+
- **200**: The Response object
|
|
1128
|
+
Array<object.Subscription>
|
|
1129
|
+
|
|
1130
|
+
---
|
|
1131
|
+
|
|
1132
|
+
## 令牌 API
|
|
1133
|
+
|
|
1134
|
+
### GET `/auth/api/get-captcha-status`
|
|
1135
|
+
**操作**: `ApiController.GetCaptchaStatus`
|
|
1136
|
+
**描述**: 获取登录错误次数
|
|
1137
|
+
|
|
1138
|
+
**参数**:
|
|
1139
|
+
|
|
1140
|
+
- `id` (查询参数, string *(必填)*) — The id ( owner/name ) of user
|
|
1141
|
+
|
|
1142
|
+
**响应**:
|
|
1143
|
+
|
|
1144
|
+
- **200**: The Response object
|
|
1145
|
+
|
|
1146
|
+
- `data`: object
|
|
1147
|
+
- `data2`: object
|
|
1148
|
+
- `data3`: object
|
|
1149
|
+
- `msg`: string
|
|
1150
|
+
- `name`: string
|
|
1151
|
+
- `status`: string
|
|
1152
|
+
- `sub`: string
|
|
1153
|
+
|
|
1154
|
+
---
|
|
1155
|
+
|
|
1156
|
+
### GET `/auth/api/get-token`
|
|
1157
|
+
**操作**: `ApiController.GetToken`
|
|
1158
|
+
**描述**: 获取令牌
|
|
1159
|
+
|
|
1160
|
+
**参数**:
|
|
1161
|
+
|
|
1162
|
+
- `id` (查询参数, string *(必填)*) — The id ( owner/name ) of token
|
|
1163
|
+
|
|
1164
|
+
**响应**:
|
|
1165
|
+
|
|
1166
|
+
- **200**: The Response object
|
|
1167
|
+
|
|
1168
|
+
- `accessToken`: string
|
|
1169
|
+
- `accessTokenHash`: string
|
|
1170
|
+
- `application`: string
|
|
1171
|
+
- `code`: string
|
|
1172
|
+
- `codeChallenge`: string
|
|
1173
|
+
- `codeExpireIn`: integer
|
|
1174
|
+
- `codeIsUsed`: boolean
|
|
1175
|
+
- `createdTime`: string
|
|
1176
|
+
- `expiresIn`: integer
|
|
1177
|
+
- `name`: string
|
|
1178
|
+
- `organization`: string
|
|
1179
|
+
- `owner`: string
|
|
1180
|
+
- `refreshToken`: string
|
|
1181
|
+
- `refreshTokenHash`: string
|
|
1182
|
+
- `scope`: string
|
|
1183
|
+
- `tokenType`: string
|
|
1184
|
+
- `user`: string
|
|
1185
|
+
|
|
1186
|
+
---
|
|
1187
|
+
|
|
1188
|
+
### POST `/auth/api/login/oauth/access_token`
|
|
1189
|
+
**操作**: `ApiController.GetOAuthToken`
|
|
1190
|
+
**描述**: 获取 OAuth 访问令牌
|
|
1191
|
+
|
|
1192
|
+
**参数**:
|
|
1193
|
+
|
|
1194
|
+
- `grant_type` (查询参数, string *(必填)*) — OAuth grant type
|
|
1195
|
+
- `client_id` (查询参数, string *(必填)*) — OAuth client id
|
|
1196
|
+
- `client_secret` (查询参数, string *(必填)*) — OAuth client secret
|
|
1197
|
+
- `code` (查询参数, string *(必填)*) — OAuth code
|
|
1198
|
+
|
|
1199
|
+
**响应**:
|
|
1200
|
+
|
|
1201
|
+
- **200**: The Response object
|
|
1202
|
+
|
|
1203
|
+
- `access_token`: string
|
|
1204
|
+
- `expires_in`: integer
|
|
1205
|
+
- `id_token`: string
|
|
1206
|
+
- `refresh_token`: string
|
|
1207
|
+
- `scope`: string
|
|
1208
|
+
- `token_type`: string
|
|
1209
|
+
- **400**: The Response object
|
|
1210
|
+
|
|
1211
|
+
- `error`: string
|
|
1212
|
+
- `error_description`: string
|
|
1213
|
+
- **401**: The Response object
|
|
1214
|
+
|
|
1215
|
+
- `error`: string
|
|
1216
|
+
- `error_description`: string
|
|
1217
|
+
|
|
1218
|
+
---
|
|
1219
|
+
|
|
1220
|
+
### POST `/auth/api/login/oauth/refresh_token`
|
|
1221
|
+
**操作**: `ApiController.RefreshToken`
|
|
1222
|
+
**描述**: 刷新 OAuth 访问令牌
|
|
1223
|
+
|
|
1224
|
+
**参数**:
|
|
1225
|
+
|
|
1226
|
+
- `grant_type` (查询参数, string *(必填)*) — OAuth grant type
|
|
1227
|
+
- `refresh_token` (查询参数, string *(必填)*) — OAuth refresh token
|
|
1228
|
+
- `scope` (查询参数, string *(必填)*) — OAuth scope
|
|
1229
|
+
- `client_id` (查询参数, string *(必填)*) — OAuth client id
|
|
1230
|
+
- `client_secret` (查询参数, string) — OAuth client secret
|
|
1231
|
+
|
|
1232
|
+
**响应**:
|
|
1233
|
+
|
|
1234
|
+
- **200**: The Response object
|
|
1235
|
+
|
|
1236
|
+
- `access_token`: string
|
|
1237
|
+
- `expires_in`: integer
|
|
1238
|
+
- `id_token`: string
|
|
1239
|
+
- `refresh_token`: string
|
|
1240
|
+
- `scope`: string
|
|
1241
|
+
- `token_type`: string
|
|
1242
|
+
- **400**: The Response object
|
|
1243
|
+
|
|
1244
|
+
- `error`: string
|
|
1245
|
+
- `error_description`: string
|
|
1246
|
+
- **401**: The Response object
|
|
1247
|
+
|
|
1248
|
+
- `error`: string
|
|
1249
|
+
- `error_description`: string
|
|
1250
|
+
|
|
1251
|
+
---
|
|
1252
|
+
|
|
1253
|
+
## 交易 API
|
|
1254
|
+
|
|
1255
|
+
### GET `/auth/api/get-transaction`
|
|
1256
|
+
**操作**: `ApiController.GetTransaction`
|
|
1257
|
+
**描述**: 获取交易
|
|
1258
|
+
|
|
1259
|
+
**参数**:
|
|
1260
|
+
|
|
1261
|
+
- `id` (查询参数, string *(必填)*) — The id ( owner/name ) of the transaction
|
|
1262
|
+
|
|
1263
|
+
**响应**:
|
|
1264
|
+
|
|
1265
|
+
- **200**: The Response object
|
|
1266
|
+
|
|
1267
|
+
- `amount`: number
|
|
1268
|
+
- `application`: string
|
|
1269
|
+
- `category`: string
|
|
1270
|
+
- `createdTime`: string
|
|
1271
|
+
- `currency`: string
|
|
1272
|
+
- `displayName`: string
|
|
1273
|
+
- `domain`: string
|
|
1274
|
+
- `name`: string
|
|
1275
|
+
- `owner`: string
|
|
1276
|
+
- `payment`: string
|
|
1277
|
+
- `provider`: string
|
|
1278
|
+
- `state`: string
|
|
1279
|
+
- `subtype`: string
|
|
1280
|
+
- `tag`: string
|
|
1281
|
+
- `type`: string
|
|
1282
|
+
- `user`: string
|
|
1283
|
+
|
|
1284
|
+
---
|
|
1285
|
+
|
|
1286
|
+
### GET `/auth/api/get-transactions`
|
|
1287
|
+
**操作**: `ApiController.GetTransactions`
|
|
1288
|
+
**描述**: 获取交易列表
|
|
1289
|
+
|
|
1290
|
+
**参数**:
|
|
1291
|
+
|
|
1292
|
+
- `owner` (查询参数, string *(必填)*) — The owner of transactions
|
|
1293
|
+
|
|
1294
|
+
**响应**:
|
|
1295
|
+
|
|
1296
|
+
- **200**: The Response object
|
|
1297
|
+
Array<object.Transaction>
|
|
1298
|
+
|
|
1299
|
+
---
|
|
1300
|
+
|
|
1301
|
+
## 用户 API
|
|
1302
|
+
|
|
1303
|
+
### POST `/auth/api/add-user-keys`
|
|
1304
|
+
**操作**: `ApiController.AddUserKeys`
|
|
1305
|
+
|
|
1306
|
+
**响应**:
|
|
1307
|
+
|
|
1308
|
+
- **200**: The Response object
|
|
1309
|
+
|
|
1310
|
+
- `address`: string
|
|
1311
|
+
- `aud`: string
|
|
1312
|
+
- `email`: string
|
|
1313
|
+
- `email_verified`: boolean
|
|
1314
|
+
- `groups`: Array<string>
|
|
1315
|
+
- `iss`: string
|
|
1316
|
+
- `name`: string
|
|
1317
|
+
- `permissions`: Array<string>
|
|
1318
|
+
- `phone`: string
|
|
1319
|
+
- `picture`: string
|
|
1320
|
+
- `preferred_username`: string
|
|
1321
|
+
- `roles`: Array<string>
|
|
1322
|
+
- `sub`: string
|
|
1323
|
+
|
|
1324
|
+
---
|
|
1325
|
+
|
|
1326
|
+
### POST `/auth/api/check-user-password`
|
|
1327
|
+
**操作**: `ApiController.CheckUserPassword`
|
|
1328
|
+
|
|
1329
|
+
**响应**:
|
|
1330
|
+
|
|
1331
|
+
- **200**: The Response object
|
|
1332
|
+
|
|
1333
|
+
- `address`: string
|
|
1334
|
+
- `aud`: string
|
|
1335
|
+
- `email`: string
|
|
1336
|
+
- `email_verified`: boolean
|
|
1337
|
+
- `groups`: Array<string>
|
|
1338
|
+
- `iss`: string
|
|
1339
|
+
- `name`: string
|
|
1340
|
+
- `permissions`: Array<string>
|
|
1341
|
+
- `phone`: string
|
|
1342
|
+
- `picture`: string
|
|
1343
|
+
- `preferred_username`: string
|
|
1344
|
+
- `roles`: Array<string>
|
|
1345
|
+
- `sub`: string
|
|
1346
|
+
|
|
1347
|
+
---
|
|
1348
|
+
|
|
1349
|
+
### GET `/auth/api/get-email-and-phone`
|
|
1350
|
+
**操作**: `ApiController.GetEmailAndPhone`
|
|
1351
|
+
**描述**: 通过用户名获取邮箱和手机号
|
|
1352
|
+
|
|
1353
|
+
**参数**:
|
|
1354
|
+
|
|
1355
|
+
- `username` (表单参数, string *(必填)*) — The username of the user
|
|
1356
|
+
- `organization` (表单参数, string *(必填)*) — The organization of the user
|
|
1357
|
+
|
|
1358
|
+
**响应**:
|
|
1359
|
+
|
|
1360
|
+
- **200**: The Response object
|
|
1361
|
+
|
|
1362
|
+
- `data`: object
|
|
1363
|
+
- `data2`: object
|
|
1364
|
+
- `data3`: object
|
|
1365
|
+
- `msg`: string
|
|
1366
|
+
- `name`: string
|
|
1367
|
+
- `status`: string
|
|
1368
|
+
- `sub`: string
|
|
1369
|
+
|
|
1370
|
+
---
|
|
1371
|
+
|
|
1372
|
+
### GET `/auth/api/get-user`
|
|
1373
|
+
**操作**: `ApiController.GetUser`
|
|
1374
|
+
**描述**: 获取用户
|
|
1375
|
+
|
|
1376
|
+
**参数**:
|
|
1377
|
+
|
|
1378
|
+
- `id` (查询参数, string) — The id ( owner/name ) of the user
|
|
1379
|
+
- `owner` (查询参数, string) — The owner of the user
|
|
1380
|
+
- `email` (查询参数, string) — The email of the user
|
|
1381
|
+
- `phone` (查询参数, string) — The phone of the user
|
|
1382
|
+
- `userId` (查询参数, string) — The userId of the user
|
|
1383
|
+
|
|
1384
|
+
**响应**:
|
|
1385
|
+
|
|
1386
|
+
- **200**: The Response object
|
|
1387
|
+
|
|
1388
|
+
- `accessKey`: string
|
|
1389
|
+
- `accessSecret`: string
|
|
1390
|
+
- `accessToken`: string
|
|
1391
|
+
- `address`: Array<string>
|
|
1392
|
+
- `adfs`: string
|
|
1393
|
+
- `affiliation`: string
|
|
1394
|
+
- `alipay`: string
|
|
1395
|
+
- `amazon`: string
|
|
1396
|
+
- `apple`: string
|
|
1397
|
+
- `auth0`: string
|
|
1398
|
+
- `avatar`: string
|
|
1399
|
+
- `avatarType`: string
|
|
1400
|
+
- `azuread`: string
|
|
1401
|
+
- `azureadb2c`: string
|
|
1402
|
+
- `baidu`: string
|
|
1403
|
+
- `balance`: number
|
|
1404
|
+
- `balanceCredit`: number
|
|
1405
|
+
- `balanceCurrency`: string
|
|
1406
|
+
- `battlenet`: string
|
|
1407
|
+
- `bilibili`: string
|
|
1408
|
+
- `bio`: string
|
|
1409
|
+
- `birthday`: string
|
|
1410
|
+
- `bitbucket`: string
|
|
1411
|
+
- `box`: string
|
|
1412
|
+
- `casdoor`: string
|
|
1413
|
+
- `cloudfoundry`: string
|
|
1414
|
+
- `countryCode`: string
|
|
1415
|
+
- `createdIp`: string
|
|
1416
|
+
- `createdTime`: string
|
|
1417
|
+
- `currency`: string
|
|
1418
|
+
- `custom`: string
|
|
1419
|
+
- `custom10`: string
|
|
1420
|
+
- `custom2`: string
|
|
1421
|
+
- `custom3`: string
|
|
1422
|
+
- `custom4`: string
|
|
1423
|
+
- `custom5`: string
|
|
1424
|
+
- `custom6`: string
|
|
1425
|
+
- `custom7`: string
|
|
1426
|
+
- `custom8`: string
|
|
1427
|
+
- `custom9`: string
|
|
1428
|
+
- `dailymotion`: string
|
|
1429
|
+
- `deezer`: string
|
|
1430
|
+
- `deletedTime`: string
|
|
1431
|
+
- `digitalocean`: string
|
|
1432
|
+
- `dingtalk`: string
|
|
1433
|
+
- `discord`: string
|
|
1434
|
+
- `displayName`: string
|
|
1435
|
+
- `douyin`: string
|
|
1436
|
+
- `dropbox`: string
|
|
1437
|
+
- `education`: string
|
|
1438
|
+
- `email`: string
|
|
1439
|
+
- `emailVerified`: boolean
|
|
1440
|
+
- `eveonline`: string
|
|
1441
|
+
- `externalId`: string
|
|
1442
|
+
- `faceIds`: Array<object.FaceId>
|
|
1443
|
+
- `facebook`: string
|
|
1444
|
+
- `firstName`: string
|
|
1445
|
+
- `fitbit`: string
|
|
1446
|
+
- `gender`: string
|
|
1447
|
+
- `gitea`: string
|
|
1448
|
+
- `gitee`: string
|
|
1449
|
+
- `github`: string
|
|
1450
|
+
- `gitlab`: string
|
|
1451
|
+
- `google`: string
|
|
1452
|
+
- `groups`: Array<string>
|
|
1453
|
+
- `hash`: string
|
|
1454
|
+
- `heroku`: string
|
|
1455
|
+
- `homepage`: string
|
|
1456
|
+
- `id`: string
|
|
1457
|
+
- `idCard`: string
|
|
1458
|
+
- `idCardType`: string
|
|
1459
|
+
- `influxcloud`: string
|
|
1460
|
+
- `infoflow`: string
|
|
1461
|
+
- `instagram`: string
|
|
1462
|
+
- `intercom`: string
|
|
1463
|
+
- `invitation`: string
|
|
1464
|
+
- `invitationCode`: string
|
|
1465
|
+
- `ipWhitelist`: string
|
|
1466
|
+
- `isAdmin`: boolean
|
|
1467
|
+
- `isDefaultAvatar`: boolean
|
|
1468
|
+
- `isDeleted`: boolean
|
|
1469
|
+
- `isForbidden`: boolean
|
|
1470
|
+
- `isOnline`: boolean
|
|
1471
|
+
- `kakao`: string
|
|
1472
|
+
- `karma`: integer
|
|
1473
|
+
- `kwai`: string
|
|
1474
|
+
- `language`: string
|
|
1475
|
+
- `lark`: string
|
|
1476
|
+
- `lastChangePasswordTime`: string
|
|
1477
|
+
- `lastName`: string
|
|
1478
|
+
- `lastSigninIp`: string
|
|
1479
|
+
- `lastSigninTime`: string
|
|
1480
|
+
- `lastSigninWrongTime`: string
|
|
1481
|
+
- `lastfm`: string
|
|
1482
|
+
- `ldap`: string
|
|
1483
|
+
- `line`: string
|
|
1484
|
+
- `linkedin`: string
|
|
1485
|
+
- `location`: string
|
|
1486
|
+
- `mailru`: string
|
|
1487
|
+
- `managedAccounts`: Array<object.ManagedAccount>
|
|
1488
|
+
- `meetup`: string
|
|
1489
|
+
- `metamask`: string
|
|
1490
|
+
- `mfaAccounts`: Array<object.MfaAccount>
|
|
1491
|
+
- `mfaEmailEnabled`: boolean
|
|
1492
|
+
- `mfaItems`: Array<object.MfaItem>
|
|
1493
|
+
- `mfaPhoneEnabled`: boolean
|
|
1494
|
+
- `mfaPushEnabled`: boolean
|
|
1495
|
+
- `mfaPushProvider`: string
|
|
1496
|
+
- `mfaPushReceiver`: string
|
|
1497
|
+
- `mfaRadiusEnabled`: boolean
|
|
1498
|
+
- `mfaRadiusProvider`: string
|
|
1499
|
+
- `mfaRadiusUsername`: string
|
|
1500
|
+
- `mfaRememberDeadline`: string
|
|
1501
|
+
- `microsoftonline`: string
|
|
1502
|
+
- `multiFactorAuths`: Array<object.MfaProps>
|
|
1503
|
+
- `name`: string
|
|
1504
|
+
- `naver`: string
|
|
1505
|
+
- `needUpdatePassword`: boolean
|
|
1506
|
+
- `nextcloud`: string
|
|
1507
|
+
- `okta`: string
|
|
1508
|
+
- `onedrive`: string
|
|
1509
|
+
- `originalToken`: string
|
|
1510
|
+
- `oura`: string
|
|
1511
|
+
- `owner`: string
|
|
1512
|
+
- `password`: string
|
|
1513
|
+
- `passwordSalt`: string
|
|
1514
|
+
- `passwordType`: string
|
|
1515
|
+
- `patreon`: string
|
|
1516
|
+
- `paypal`: string
|
|
1517
|
+
- `permanentAvatar`: string
|
|
1518
|
+
- `permissions`: Array<object.Permission>
|
|
1519
|
+
- `phone`: string
|
|
1520
|
+
- `preHash`: string
|
|
1521
|
+
- `preferredMfaType`: string
|
|
1522
|
+
- `properties`: object
|
|
1523
|
+
- `qq`: string
|
|
1524
|
+
- `ranking`: integer
|
|
1525
|
+
- `recoveryCodes`: Array<string>
|
|
1526
|
+
- `region`: string
|
|
1527
|
+
- `registerSource`: string
|
|
1528
|
+
- `registerType`: string
|
|
1529
|
+
- `roles`: Array<object.Role>
|
|
1530
|
+
- `salesforce`: string
|
|
1531
|
+
- `score`: integer
|
|
1532
|
+
- `shopify`: string
|
|
1533
|
+
- `signinWrongTimes`: integer
|
|
1534
|
+
- `signupApplication`: string
|
|
1535
|
+
- `slack`: string
|
|
1536
|
+
- `soundcloud`: string
|
|
1537
|
+
- `spotify`: string
|
|
1538
|
+
- `steam`: string
|
|
1539
|
+
- `strava`: string
|
|
1540
|
+
- `stripe`: string
|
|
1541
|
+
- `tag`: string
|
|
1542
|
+
- `tiktok`: string
|
|
1543
|
+
- `title`: string
|
|
1544
|
+
- `totpSecret`: string
|
|
1545
|
+
- `tumblr`: string
|
|
1546
|
+
- `twitch`: string
|
|
1547
|
+
- `twitter`: string
|
|
1548
|
+
- `type`: string
|
|
1549
|
+
- `typetalk`: string
|
|
1550
|
+
- `uber`: string
|
|
1551
|
+
- `updatedTime`: string
|
|
1552
|
+
- `vk`: string
|
|
1553
|
+
- `web3onboard`: string
|
|
1554
|
+
- `webauthnCredentials`: Array<webauthn.Credential>
|
|
1555
|
+
- `wechat`: string
|
|
1556
|
+
- `wecom`: string
|
|
1557
|
+
- `weibo`: string
|
|
1558
|
+
- `wepay`: string
|
|
1559
|
+
- `xero`: string
|
|
1560
|
+
- `yahoo`: string
|
|
1561
|
+
- `yammer`: string
|
|
1562
|
+
- `yandex`: string
|
|
1563
|
+
- `zoom`: string
|
|
1564
|
+
|
|
1565
|
+
---
|
|
1566
|
+
|
|
1567
|
+
### POST `/auth/api/update-user`
|
|
1568
|
+
**操作**: `ApiController.UpdateUser`
|
|
1569
|
+
**描述**: 更新用户
|
|
1570
|
+
|
|
1571
|
+
**参数**:
|
|
1572
|
+
|
|
1573
|
+
- `id` (查询参数, string) — The id ( owner/name ) of the user
|
|
1574
|
+
- `userId` (查询参数, string) — The userId (UUID) of the user
|
|
1575
|
+
- `owner` (查询参数, string) — The owner of the user (required when using userId)
|
|
1576
|
+
- `body` (请求体, object *(必填)*) — The details of the user
|
|
1577
|
+
|
|
1578
|
+
**响应**:
|
|
1579
|
+
|
|
1580
|
+
- **200**: The Response object
|
|
1581
|
+
|
|
1582
|
+
- `data`: object
|
|
1583
|
+
- `data2`: object
|
|
1584
|
+
- `data3`: object
|
|
1585
|
+
- `msg`: string
|
|
1586
|
+
- `name`: string
|
|
1587
|
+
- `status`: string
|
|
1588
|
+
- `sub`: string
|
|
1589
|
+
|
|
1590
|
+
---
|
|
1591
|
+
|
|
1592
|
+
### GET `/auth/api/webauthn/signup/begin`
|
|
1593
|
+
**操作**: `ApiController.WebAuthnSignupBegin`
|
|
1594
|
+
**描述**: WebAuthn 注册流程第一阶段
|
|
1595
|
+
|
|
1596
|
+
**响应**:
|
|
1597
|
+
|
|
1598
|
+
- **200**: The CredentialCreationOptions object
|
|
1599
|
+
object
|
|
1600
|
+
|
|
1601
|
+
---
|
|
1602
|
+
|
|
1603
|
+
### POST `/auth/api/webauthn/signup/finish`
|
|
1604
|
+
**操作**: `ApiController.WebAuthnSignupFinish`
|
|
1605
|
+
**描述**: WebAuthn 注册流程第二阶段
|
|
1606
|
+
|
|
1607
|
+
**参数**:
|
|
1608
|
+
|
|
1609
|
+
- `body` (请求体, object *(必填)*) — authenticator attestation Response
|
|
1610
|
+
|
|
1611
|
+
**响应**:
|
|
1612
|
+
|
|
1613
|
+
- **200**: "The Response object"
|
|
1614
|
+
|
|
1615
|
+
- `data`: object
|
|
1616
|
+
- `data2`: object
|
|
1617
|
+
- `data3`: object
|
|
1618
|
+
- `msg`: string
|
|
1619
|
+
- `name`: string
|
|
1620
|
+
- `status`: string
|
|
1621
|
+
- `sub`: string
|
|
1622
|
+
|
|
1623
|
+
---
|
|
1624
|
+
|
|
1625
|
+
## 验证 API
|
|
1626
|
+
|
|
1627
|
+
### POST `/auth/api/send-verification-code`
|
|
1628
|
+
**操作**: `ApiController.SendVerificationCode`
|
|
1629
|
+
|
|
1630
|
+
**响应**:
|
|
1631
|
+
|
|
1632
|
+
- **200**: The Response object
|
|
1633
|
+
|
|
1634
|
+
- `address`: string
|
|
1635
|
+
- `aud`: string
|
|
1636
|
+
- `email`: string
|
|
1637
|
+
- `email_verified`: boolean
|
|
1638
|
+
- `groups`: Array<string>
|
|
1639
|
+
- `iss`: string
|
|
1640
|
+
- `name`: string
|
|
1641
|
+
- `permissions`: Array<string>
|
|
1642
|
+
- `phone`: string
|
|
1643
|
+
- `picture`: string
|
|
1644
|
+
- `preferred_username`: string
|
|
1645
|
+
- `roles`: Array<string>
|
|
1646
|
+
- `sub`: string
|
|
1647
|
+
|
|
1648
|
+
---
|
|
1649
|
+
|
|
1650
|
+
### POST `/auth/api/verify-captcha`
|
|
1651
|
+
**操作**: `ApiController.VerifyCaptcha`
|
|
1652
|
+
|
|
1653
|
+
**响应**:
|
|
1654
|
+
|
|
1655
|
+
- **200**: The Response object
|
|
1656
|
+
|
|
1657
|
+
- `address`: string
|
|
1658
|
+
- `aud`: string
|
|
1659
|
+
- `email`: string
|
|
1660
|
+
- `email_verified`: boolean
|
|
1661
|
+
- `groups`: Array<string>
|
|
1662
|
+
- `iss`: string
|
|
1663
|
+
- `name`: string
|
|
1664
|
+
- `permissions`: Array<string>
|
|
1665
|
+
- `phone`: string
|
|
1666
|
+
- `picture`: string
|
|
1667
|
+
- `preferred_username`: string
|
|
1668
|
+
- `roles`: Array<string>
|
|
1669
|
+
- `sub`: string
|
|
1670
|
+
|
|
1671
|
+
---
|
|
1672
|
+
|
|
1673
|
+
### POST `/auth/api/verify-code`
|
|
1674
|
+
**操作**: `ApiController.VerifyCode`
|
|
1675
|
+
|
|
1676
|
+
**响应**:
|
|
1677
|
+
|
|
1678
|
+
- **200**: The Response object
|
|
1679
|
+
|
|
1680
|
+
- `address`: string
|
|
1681
|
+
- `aud`: string
|
|
1682
|
+
- `email`: string
|
|
1683
|
+
- `email_verified`: boolean
|
|
1684
|
+
- `groups`: Array<string>
|
|
1685
|
+
- `iss`: string
|
|
1686
|
+
- `name`: string
|
|
1687
|
+
- `permissions`: Array<string>
|
|
1688
|
+
- `phone`: string
|
|
1689
|
+
- `picture`: string
|
|
1690
|
+
- `preferred_username`: string
|
|
1691
|
+
- `roles`: Array<string>
|
|
1692
|
+
- `sub`: string
|
|
1693
|
+
|
|
1694
|
+
---
|
|
1695
|
+
|
|
1696
|
+
## 数据模型
|
|
1697
|
+
|
|
1698
|
+
### `controllers.AuthForm`
|
|
1699
|
+
类型: object
|
|
1700
|
+
|
|
1701
|
+
---
|
|
1702
|
+
|
|
1703
|
+
### `controllers.LaravelResponse`
|
|
1704
|
+
类型: object
|
|
1705
|
+
|
|
1706
|
+
| 字段 | 类型 | 说明 |
|
|
1707
|
+
|---|---|---|
|
|
1708
|
+
| `created_at` | string | |
|
|
1709
|
+
| `email` | string | |
|
|
1710
|
+
| `email_verified_at` | string | |
|
|
1711
|
+
| `id` | string | |
|
|
1712
|
+
| `name` | string | |
|
|
1713
|
+
| `updated_at` | string | |
|
|
1714
|
+
|
|
1715
|
+
---
|
|
1716
|
+
|
|
1717
|
+
### `controllers.Response`
|
|
1718
|
+
类型: object
|
|
1719
|
+
|
|
1720
|
+
| 字段 | 类型 | 说明 |
|
|
1721
|
+
|---|---|---|
|
|
1722
|
+
| `data` | object | |
|
|
1723
|
+
| `data2` | object | |
|
|
1724
|
+
| `data3` | object | |
|
|
1725
|
+
| `msg` | string | |
|
|
1726
|
+
| `name` | string | |
|
|
1727
|
+
| `status` | string | |
|
|
1728
|
+
| `sub` | string | |
|
|
1729
|
+
|
|
1730
|
+
---
|
|
1731
|
+
|
|
1732
|
+
### `object.FaceId`
|
|
1733
|
+
类型: object
|
|
1734
|
+
|
|
1735
|
+
| 字段 | 类型 | 说明 |
|
|
1736
|
+
|---|---|---|
|
|
1737
|
+
| `ImageUrl` | string | |
|
|
1738
|
+
| `faceIdData` | array | |
|
|
1739
|
+
| `name` | string | |
|
|
1740
|
+
|
|
1741
|
+
---
|
|
1742
|
+
|
|
1743
|
+
### `object.Invitation`
|
|
1744
|
+
类型: object
|
|
1745
|
+
|
|
1746
|
+
| 字段 | 类型 | 说明 |
|
|
1747
|
+
|---|---|---|
|
|
1748
|
+
| `application` | string | |
|
|
1749
|
+
| `code` | string | |
|
|
1750
|
+
| `createdTime` | string | |
|
|
1751
|
+
| `defaultCode` | string | |
|
|
1752
|
+
| `displayName` | string | |
|
|
1753
|
+
| `email` | string | |
|
|
1754
|
+
| `isRegexp` | boolean | |
|
|
1755
|
+
| `name` | string | |
|
|
1756
|
+
| `owner` | string | |
|
|
1757
|
+
| `phone` | string | |
|
|
1758
|
+
| `quota` | integer | |
|
|
1759
|
+
| `signupGroup` | string | |
|
|
1760
|
+
| `state` | string | |
|
|
1761
|
+
| `updatedTime` | string | |
|
|
1762
|
+
| `usedCount` | integer | |
|
|
1763
|
+
| `username` | string | |
|
|
1764
|
+
|
|
1765
|
+
---
|
|
1766
|
+
|
|
1767
|
+
### `object.ManagedAccount`
|
|
1768
|
+
类型: object
|
|
1769
|
+
|
|
1770
|
+
| 字段 | 类型 | 说明 |
|
|
1771
|
+
|---|---|---|
|
|
1772
|
+
| `application` | string | |
|
|
1773
|
+
| `password` | string | |
|
|
1774
|
+
| `signinUrl` | string | |
|
|
1775
|
+
| `username` | string | |
|
|
1776
|
+
|
|
1777
|
+
---
|
|
1778
|
+
|
|
1779
|
+
### `object.MfaAccount`
|
|
1780
|
+
类型: object
|
|
1781
|
+
|
|
1782
|
+
| 字段 | 类型 | 说明 |
|
|
1783
|
+
|---|---|---|
|
|
1784
|
+
| `accountName` | string | |
|
|
1785
|
+
| `issuer` | string | |
|
|
1786
|
+
| `origin` | string | |
|
|
1787
|
+
| `secretKey` | string | |
|
|
1788
|
+
|
|
1789
|
+
---
|
|
1790
|
+
|
|
1791
|
+
### `object.MfaItem`
|
|
1792
|
+
类型: object
|
|
1793
|
+
|
|
1794
|
+
| 字段 | 类型 | 说明 |
|
|
1795
|
+
|---|---|---|
|
|
1796
|
+
| `name` | string | |
|
|
1797
|
+
| `rule` | string | |
|
|
1798
|
+
|
|
1799
|
+
---
|
|
1800
|
+
|
|
1801
|
+
### `object.MfaProps`
|
|
1802
|
+
类型: object
|
|
1803
|
+
|
|
1804
|
+
| 字段 | 类型 | 说明 |
|
|
1805
|
+
|---|---|---|
|
|
1806
|
+
| `countryCode` | string | |
|
|
1807
|
+
| `enabled` | boolean | |
|
|
1808
|
+
| `isPreferred` | boolean | |
|
|
1809
|
+
| `mfaRememberInHours` | integer | |
|
|
1810
|
+
| `mfaType` | string | |
|
|
1811
|
+
| `recoveryCodes` | array | |
|
|
1812
|
+
| `secret` | string | |
|
|
1813
|
+
| `url` | string | |
|
|
1814
|
+
|
|
1815
|
+
---
|
|
1816
|
+
|
|
1817
|
+
### `object.Order`
|
|
1818
|
+
类型: object
|
|
1819
|
+
|
|
1820
|
+
| 字段 | 类型 | 说明 |
|
|
1821
|
+
|---|---|---|
|
|
1822
|
+
| `createdTime` | string | |
|
|
1823
|
+
| `displayName` | string | |
|
|
1824
|
+
| `endTime` | string | |
|
|
1825
|
+
| `message` | string | |
|
|
1826
|
+
| `name` | string | |
|
|
1827
|
+
| `owner` | string | |
|
|
1828
|
+
| `payment` | string | |
|
|
1829
|
+
| `productName` | string | |
|
|
1830
|
+
| `startTime` | string | |
|
|
1831
|
+
| `state` | string | |
|
|
1832
|
+
| `user` | string | |
|
|
1833
|
+
|
|
1834
|
+
---
|
|
1835
|
+
|
|
1836
|
+
### `object.Payment`
|
|
1837
|
+
类型: object
|
|
1838
|
+
|
|
1839
|
+
| 字段 | 类型 | 说明 |
|
|
1840
|
+
|---|---|---|
|
|
1841
|
+
| `createdTime` | string | |
|
|
1842
|
+
| `currency` | string | |
|
|
1843
|
+
| `detail` | string | |
|
|
1844
|
+
| `displayName` | string | |
|
|
1845
|
+
| `invoiceRemark` | string | |
|
|
1846
|
+
| `invoiceTaxId` | string | |
|
|
1847
|
+
| `invoiceTitle` | string | |
|
|
1848
|
+
| `invoiceType` | string | |
|
|
1849
|
+
| `invoiceUrl` | string | |
|
|
1850
|
+
| `isRecharge` | boolean | |
|
|
1851
|
+
| `message` | string | |
|
|
1852
|
+
| `name` | string | |
|
|
1853
|
+
| `outOrderId` | string | |
|
|
1854
|
+
| `owner` | string | |
|
|
1855
|
+
| `payUrl` | string | |
|
|
1856
|
+
| `personEmail` | string | |
|
|
1857
|
+
| `personIdCard` | string | |
|
|
1858
|
+
| `personName` | string | |
|
|
1859
|
+
| `personPhone` | string | |
|
|
1860
|
+
| `price` | number | |
|
|
1861
|
+
| `productDisplayName` | string | |
|
|
1862
|
+
| `productName` | string | |
|
|
1863
|
+
| `provider` | string | |
|
|
1864
|
+
| `returnUrl` | string | |
|
|
1865
|
+
| `state` | pp.PaymentState | |
|
|
1866
|
+
| `successUrl` | string | |
|
|
1867
|
+
| `tag` | string | |
|
|
1868
|
+
| `type` | string | |
|
|
1869
|
+
| `user` | string | |
|
|
1870
|
+
|
|
1871
|
+
---
|
|
1872
|
+
|
|
1873
|
+
### `object.Permission`
|
|
1874
|
+
类型: object
|
|
1875
|
+
|
|
1876
|
+
| 字段 | 类型 | 说明 |
|
|
1877
|
+
|---|---|---|
|
|
1878
|
+
| `actions` | array | |
|
|
1879
|
+
| `adapter` | string | |
|
|
1880
|
+
| `approveTime` | string | |
|
|
1881
|
+
| `approver` | string | |
|
|
1882
|
+
| `createdTime` | string | |
|
|
1883
|
+
| `description` | string | |
|
|
1884
|
+
| `displayName` | string | |
|
|
1885
|
+
| `domains` | array | |
|
|
1886
|
+
| `effect` | string | |
|
|
1887
|
+
| `groups` | array | |
|
|
1888
|
+
| `isEnabled` | boolean | |
|
|
1889
|
+
| `model` | string | |
|
|
1890
|
+
| `name` | string | |
|
|
1891
|
+
| `owner` | string | |
|
|
1892
|
+
| `resourceType` | string | |
|
|
1893
|
+
| `resources` | array | |
|
|
1894
|
+
| `roles` | array | |
|
|
1895
|
+
| `state` | string | |
|
|
1896
|
+
| `submitter` | string | |
|
|
1897
|
+
| `users` | array | |
|
|
1898
|
+
|
|
1899
|
+
---
|
|
1900
|
+
|
|
1901
|
+
### `object.Plan`
|
|
1902
|
+
类型: object
|
|
1903
|
+
|
|
1904
|
+
| 字段 | 类型 | 说明 |
|
|
1905
|
+
|---|---|---|
|
|
1906
|
+
| `createdTime` | string | |
|
|
1907
|
+
| `currency` | string | |
|
|
1908
|
+
| `description` | string | |
|
|
1909
|
+
| `displayName` | string | |
|
|
1910
|
+
| `isEnabled` | boolean | |
|
|
1911
|
+
| `name` | string | |
|
|
1912
|
+
| `options` | array | |
|
|
1913
|
+
| `owner` | string | |
|
|
1914
|
+
| `paymentProviders` | array | |
|
|
1915
|
+
| `period` | string | |
|
|
1916
|
+
| `price` | number | |
|
|
1917
|
+
| `product` | string | |
|
|
1918
|
+
| `role` | string | |
|
|
1919
|
+
|
|
1920
|
+
---
|
|
1921
|
+
|
|
1922
|
+
### `object.Pricing`
|
|
1923
|
+
类型: object
|
|
1924
|
+
|
|
1925
|
+
| 字段 | 类型 | 说明 |
|
|
1926
|
+
|---|---|---|
|
|
1927
|
+
| `application` | string | |
|
|
1928
|
+
| `createdTime` | string | |
|
|
1929
|
+
| `description` | string | |
|
|
1930
|
+
| `displayName` | string | |
|
|
1931
|
+
| `isEnabled` | boolean | |
|
|
1932
|
+
| `name` | string | |
|
|
1933
|
+
| `owner` | string | |
|
|
1934
|
+
| `plans` | array | |
|
|
1935
|
+
| `trialDuration` | integer | |
|
|
1936
|
+
|
|
1937
|
+
---
|
|
1938
|
+
|
|
1939
|
+
### `object.Product`
|
|
1940
|
+
类型: object
|
|
1941
|
+
|
|
1942
|
+
| 字段 | 类型 | 说明 |
|
|
1943
|
+
|---|---|---|
|
|
1944
|
+
| `createdTime` | string | |
|
|
1945
|
+
| `currency` | string | |
|
|
1946
|
+
| `description` | string | |
|
|
1947
|
+
| `detail` | string | |
|
|
1948
|
+
| `displayName` | string | |
|
|
1949
|
+
| `image` | string | |
|
|
1950
|
+
| `isRecharge` | boolean | |
|
|
1951
|
+
| `name` | string | |
|
|
1952
|
+
| `owner` | string | |
|
|
1953
|
+
| `price` | number | |
|
|
1954
|
+
| `providerObjs` | Array<object.Provider> | |
|
|
1955
|
+
| `providers` | array | |
|
|
1956
|
+
| `quantity` | integer | |
|
|
1957
|
+
| `returnUrl` | string | |
|
|
1958
|
+
| `sold` | integer | |
|
|
1959
|
+
| `state` | string | |
|
|
1960
|
+
| `successUrl` | string | |
|
|
1961
|
+
| `tag` | string | |
|
|
1962
|
+
|
|
1963
|
+
---
|
|
1964
|
+
|
|
1965
|
+
### `object.Provider`
|
|
1966
|
+
类型: object
|
|
1967
|
+
|
|
1968
|
+
| 字段 | 类型 | 说明 |
|
|
1969
|
+
|---|---|---|
|
|
1970
|
+
| `appId` | string | |
|
|
1971
|
+
| `bucket` | string | |
|
|
1972
|
+
| `category` | string | |
|
|
1973
|
+
| `cert` | string | |
|
|
1974
|
+
| `clientId` | string | |
|
|
1975
|
+
| `clientId2` | string | |
|
|
1976
|
+
| `clientSecret` | string | |
|
|
1977
|
+
| `clientSecret2` | string | |
|
|
1978
|
+
| `content` | string | |
|
|
1979
|
+
| `createdTime` | string | |
|
|
1980
|
+
| `customAuthUrl` | string | |
|
|
1981
|
+
| `customLogo` | string | |
|
|
1982
|
+
| `customTokenUrl` | string | |
|
|
1983
|
+
| `customUserInfoUrl` | string | |
|
|
1984
|
+
| `disableSsl` | boolean | |
|
|
1985
|
+
| `displayName` | string | |
|
|
1986
|
+
| `domain` | string | |
|
|
1987
|
+
| `emailRegex` | string | |
|
|
1988
|
+
| `enableProxy` | boolean | |
|
|
1989
|
+
| `enableSignAuthnRequest` | boolean | |
|
|
1990
|
+
| `endpoint` | string | |
|
|
1991
|
+
| `host` | string | |
|
|
1992
|
+
| `httpHeaders` | object | |
|
|
1993
|
+
| `idP` | string | |
|
|
1994
|
+
| `intranetEndpoint` | string | |
|
|
1995
|
+
| `issuerUrl` | string | |
|
|
1996
|
+
| `metadata` | string | |
|
|
1997
|
+
| `method` | string | |
|
|
1998
|
+
| `name` | string | |
|
|
1999
|
+
| `owner` | string | |
|
|
2000
|
+
| `pathPrefix` | string | |
|
|
2001
|
+
| `port` | integer | |
|
|
2002
|
+
| `providerUrl` | string | |
|
|
2003
|
+
| `receiver` | string | |
|
|
2004
|
+
| `regionId` | string | |
|
|
2005
|
+
| `scopes` | string | |
|
|
2006
|
+
| `signName` | string | |
|
|
2007
|
+
| `subType` | string | |
|
|
2008
|
+
| `templateCode` | string | |
|
|
2009
|
+
| `title` | string | |
|
|
2010
|
+
| `type` | string | |
|
|
2011
|
+
| `userMapping` | object | |
|
|
2012
|
+
|
|
2013
|
+
---
|
|
2014
|
+
|
|
2015
|
+
### `object.Resource`
|
|
2016
|
+
类型: object
|
|
2017
|
+
|
|
2018
|
+
| 字段 | 类型 | 说明 |
|
|
2019
|
+
|---|---|---|
|
|
2020
|
+
| `application` | string | |
|
|
2021
|
+
| `createdTime` | string | |
|
|
2022
|
+
| `description` | string | |
|
|
2023
|
+
| `fileFormat` | string | |
|
|
2024
|
+
| `fileName` | string | |
|
|
2025
|
+
| `fileSize` | integer | |
|
|
2026
|
+
| `fileType` | string | |
|
|
2027
|
+
| `name` | string | |
|
|
2028
|
+
| `owner` | string | |
|
|
2029
|
+
| `parent` | string | |
|
|
2030
|
+
| `provider` | string | |
|
|
2031
|
+
| `tag` | string | |
|
|
2032
|
+
| `url` | string | |
|
|
2033
|
+
| `user` | string | |
|
|
2034
|
+
|
|
2035
|
+
---
|
|
2036
|
+
|
|
2037
|
+
### `object.Role`
|
|
2038
|
+
类型: object
|
|
2039
|
+
|
|
2040
|
+
| 字段 | 类型 | 说明 |
|
|
2041
|
+
|---|---|---|
|
|
2042
|
+
| `createdTime` | string | |
|
|
2043
|
+
| `description` | string | |
|
|
2044
|
+
| `displayName` | string | |
|
|
2045
|
+
| `domains` | array | |
|
|
2046
|
+
| `groups` | array | |
|
|
2047
|
+
| `isEnabled` | boolean | |
|
|
2048
|
+
| `name` | string | |
|
|
2049
|
+
| `owner` | string | |
|
|
2050
|
+
| `roles` | array | |
|
|
2051
|
+
| `users` | array | |
|
|
2052
|
+
|
|
2053
|
+
---
|
|
2054
|
+
|
|
2055
|
+
### `object.Subscription`
|
|
2056
|
+
类型: object
|
|
2057
|
+
|
|
2058
|
+
| 字段 | 类型 | 说明 |
|
|
2059
|
+
|---|---|---|
|
|
2060
|
+
| `createdTime` | string | |
|
|
2061
|
+
| `description` | string | |
|
|
2062
|
+
| `displayName` | string | |
|
|
2063
|
+
| `endTime` | string | |
|
|
2064
|
+
| `name` | string | |
|
|
2065
|
+
| `owner` | string | |
|
|
2066
|
+
| `payment` | string | |
|
|
2067
|
+
| `period` | string | |
|
|
2068
|
+
| `plan` | string | |
|
|
2069
|
+
| `pricing` | string | |
|
|
2070
|
+
| `startTime` | string | |
|
|
2071
|
+
| `state` | object.SubscriptionState | |
|
|
2072
|
+
| `user` | string | |
|
|
2073
|
+
|
|
2074
|
+
---
|
|
2075
|
+
|
|
2076
|
+
### `object.SubscriptionState`
|
|
2077
|
+
类型: string
|
|
2078
|
+
|
|
2079
|
+
---
|
|
2080
|
+
|
|
2081
|
+
### `object.Token`
|
|
2082
|
+
类型: object
|
|
2083
|
+
|
|
2084
|
+
| 字段 | 类型 | 说明 |
|
|
2085
|
+
|---|---|---|
|
|
2086
|
+
| `accessToken` | string | |
|
|
2087
|
+
| `accessTokenHash` | string | |
|
|
2088
|
+
| `application` | string | |
|
|
2089
|
+
| `code` | string | |
|
|
2090
|
+
| `codeChallenge` | string | |
|
|
2091
|
+
| `codeExpireIn` | integer | |
|
|
2092
|
+
| `codeIsUsed` | boolean | |
|
|
2093
|
+
| `createdTime` | string | |
|
|
2094
|
+
| `expiresIn` | integer | |
|
|
2095
|
+
| `name` | string | |
|
|
2096
|
+
| `organization` | string | |
|
|
2097
|
+
| `owner` | string | |
|
|
2098
|
+
| `refreshToken` | string | |
|
|
2099
|
+
| `refreshTokenHash` | string | |
|
|
2100
|
+
| `scope` | string | |
|
|
2101
|
+
| `tokenType` | string | |
|
|
2102
|
+
| `user` | string | |
|
|
2103
|
+
|
|
2104
|
+
---
|
|
2105
|
+
|
|
2106
|
+
### `object.TokenError`
|
|
2107
|
+
类型: object
|
|
2108
|
+
|
|
2109
|
+
| 字段 | 类型 | 说明 |
|
|
2110
|
+
|---|---|---|
|
|
2111
|
+
| `error` | string | |
|
|
2112
|
+
| `error_description` | string | |
|
|
2113
|
+
|
|
2114
|
+
---
|
|
2115
|
+
|
|
2116
|
+
### `object.TokenWrapper`
|
|
2117
|
+
类型: object
|
|
2118
|
+
|
|
2119
|
+
| 字段 | 类型 | 说明 |
|
|
2120
|
+
|---|---|---|
|
|
2121
|
+
| `access_token` | string | |
|
|
2122
|
+
| `expires_in` | integer | |
|
|
2123
|
+
| `id_token` | string | |
|
|
2124
|
+
| `refresh_token` | string | |
|
|
2125
|
+
| `scope` | string | |
|
|
2126
|
+
| `token_type` | string | |
|
|
2127
|
+
|
|
2128
|
+
---
|
|
2129
|
+
|
|
2130
|
+
### `object.Transaction`
|
|
2131
|
+
类型: object
|
|
2132
|
+
|
|
2133
|
+
| 字段 | 类型 | 说明 |
|
|
2134
|
+
|---|---|---|
|
|
2135
|
+
| `amount` | number | |
|
|
2136
|
+
| `application` | string | |
|
|
2137
|
+
| `category` | string | |
|
|
2138
|
+
| `createdTime` | string | |
|
|
2139
|
+
| `currency` | string | |
|
|
2140
|
+
| `displayName` | string | |
|
|
2141
|
+
| `domain` | string | |
|
|
2142
|
+
| `name` | string | |
|
|
2143
|
+
| `owner` | string | |
|
|
2144
|
+
| `payment` | string | |
|
|
2145
|
+
| `provider` | string | |
|
|
2146
|
+
| `state` | pp.PaymentState | |
|
|
2147
|
+
| `subtype` | string | |
|
|
2148
|
+
| `tag` | string | |
|
|
2149
|
+
| `type` | string | |
|
|
2150
|
+
| `user` | string | |
|
|
2151
|
+
|
|
2152
|
+
---
|
|
2153
|
+
|
|
2154
|
+
### `object.User`
|
|
2155
|
+
类型: object
|
|
2156
|
+
|
|
2157
|
+
| 字段 | 类型 | 说明 |
|
|
2158
|
+
|---|---|---|
|
|
2159
|
+
| `accessKey` | string | |
|
|
2160
|
+
| `accessSecret` | string | |
|
|
2161
|
+
| `accessToken` | string | |
|
|
2162
|
+
| `address` | array | |
|
|
2163
|
+
| `adfs` | string | |
|
|
2164
|
+
| `affiliation` | string | |
|
|
2165
|
+
| `alipay` | string | |
|
|
2166
|
+
| `amazon` | string | |
|
|
2167
|
+
| `apple` | string | |
|
|
2168
|
+
| `auth0` | string | |
|
|
2169
|
+
| `avatar` | string | |
|
|
2170
|
+
| `avatarType` | string | |
|
|
2171
|
+
| `azuread` | string | |
|
|
2172
|
+
| `azureadb2c` | string | |
|
|
2173
|
+
| `baidu` | string | |
|
|
2174
|
+
| `balance` | number | |
|
|
2175
|
+
| `balanceCredit` | number | |
|
|
2176
|
+
| `balanceCurrency` | string | |
|
|
2177
|
+
| `battlenet` | string | |
|
|
2178
|
+
| `bilibili` | string | |
|
|
2179
|
+
| `bio` | string | |
|
|
2180
|
+
| `birthday` | string | |
|
|
2181
|
+
| `bitbucket` | string | |
|
|
2182
|
+
| `box` | string | |
|
|
2183
|
+
| `casdoor` | string | |
|
|
2184
|
+
| `cloudfoundry` | string | |
|
|
2185
|
+
| `countryCode` | string | |
|
|
2186
|
+
| `createdIp` | string | |
|
|
2187
|
+
| `createdTime` | string | |
|
|
2188
|
+
| `currency` | string | |
|
|
2189
|
+
| `custom` | string | |
|
|
2190
|
+
| `custom10` | string | |
|
|
2191
|
+
| `custom2` | string | |
|
|
2192
|
+
| `custom3` | string | |
|
|
2193
|
+
| `custom4` | string | |
|
|
2194
|
+
| `custom5` | string | |
|
|
2195
|
+
| `custom6` | string | |
|
|
2196
|
+
| `custom7` | string | |
|
|
2197
|
+
| `custom8` | string | |
|
|
2198
|
+
| `custom9` | string | |
|
|
2199
|
+
| `dailymotion` | string | |
|
|
2200
|
+
| `deezer` | string | |
|
|
2201
|
+
| `deletedTime` | string | |
|
|
2202
|
+
| `digitalocean` | string | |
|
|
2203
|
+
| `dingtalk` | string | |
|
|
2204
|
+
| `discord` | string | |
|
|
2205
|
+
| `displayName` | string | |
|
|
2206
|
+
| `douyin` | string | |
|
|
2207
|
+
| `dropbox` | string | |
|
|
2208
|
+
| `education` | string | |
|
|
2209
|
+
| `email` | string | |
|
|
2210
|
+
| `emailVerified` | boolean | |
|
|
2211
|
+
| `eveonline` | string | |
|
|
2212
|
+
| `externalId` | string | |
|
|
2213
|
+
| `faceIds` | Array<object.FaceId> | |
|
|
2214
|
+
| `facebook` | string | |
|
|
2215
|
+
| `firstName` | string | |
|
|
2216
|
+
| `fitbit` | string | |
|
|
2217
|
+
| `gender` | string | |
|
|
2218
|
+
| `gitea` | string | |
|
|
2219
|
+
| `gitee` | string | |
|
|
2220
|
+
| `github` | string | |
|
|
2221
|
+
| `gitlab` | string | |
|
|
2222
|
+
| `google` | string | |
|
|
2223
|
+
| `groups` | array | |
|
|
2224
|
+
| `hash` | string | |
|
|
2225
|
+
| `heroku` | string | |
|
|
2226
|
+
| `homepage` | string | |
|
|
2227
|
+
| `id` | string | |
|
|
2228
|
+
| `idCard` | string | |
|
|
2229
|
+
| `idCardType` | string | |
|
|
2230
|
+
| `influxcloud` | string | |
|
|
2231
|
+
| `infoflow` | string | |
|
|
2232
|
+
| `instagram` | string | |
|
|
2233
|
+
| `intercom` | string | |
|
|
2234
|
+
| `invitation` | string | |
|
|
2235
|
+
| `invitationCode` | string | |
|
|
2236
|
+
| `ipWhitelist` | string | |
|
|
2237
|
+
| `isAdmin` | boolean | |
|
|
2238
|
+
| `isDefaultAvatar` | boolean | |
|
|
2239
|
+
| `isDeleted` | boolean | |
|
|
2240
|
+
| `isForbidden` | boolean | |
|
|
2241
|
+
| `isOnline` | boolean | |
|
|
2242
|
+
| `kakao` | string | |
|
|
2243
|
+
| `karma` | integer | |
|
|
2244
|
+
| `kwai` | string | |
|
|
2245
|
+
| `language` | string | |
|
|
2246
|
+
| `lark` | string | |
|
|
2247
|
+
| `lastChangePasswordTime` | string | |
|
|
2248
|
+
| `lastName` | string | |
|
|
2249
|
+
| `lastSigninIp` | string | |
|
|
2250
|
+
| `lastSigninTime` | string | |
|
|
2251
|
+
| `lastSigninWrongTime` | string | |
|
|
2252
|
+
| `lastfm` | string | |
|
|
2253
|
+
| `ldap` | string | |
|
|
2254
|
+
| `line` | string | |
|
|
2255
|
+
| `linkedin` | string | |
|
|
2256
|
+
| `location` | string | |
|
|
2257
|
+
| `mailru` | string | |
|
|
2258
|
+
| `managedAccounts` | Array<object.ManagedAccount> | |
|
|
2259
|
+
| `meetup` | string | |
|
|
2260
|
+
| `metamask` | string | |
|
|
2261
|
+
| `mfaAccounts` | Array<object.MfaAccount> | |
|
|
2262
|
+
| `mfaEmailEnabled` | boolean | |
|
|
2263
|
+
| `mfaItems` | Array<object.MfaItem> | |
|
|
2264
|
+
| `mfaPhoneEnabled` | boolean | |
|
|
2265
|
+
| `mfaPushEnabled` | boolean | |
|
|
2266
|
+
| `mfaPushProvider` | string | |
|
|
2267
|
+
| `mfaPushReceiver` | string | |
|
|
2268
|
+
| `mfaRadiusEnabled` | boolean | |
|
|
2269
|
+
| `mfaRadiusProvider` | string | |
|
|
2270
|
+
| `mfaRadiusUsername` | string | |
|
|
2271
|
+
| `mfaRememberDeadline` | string | |
|
|
2272
|
+
| `microsoftonline` | string | |
|
|
2273
|
+
| `multiFactorAuths` | Array<object.MfaProps> | |
|
|
2274
|
+
| `name` | string | |
|
|
2275
|
+
| `naver` | string | |
|
|
2276
|
+
| `needUpdatePassword` | boolean | |
|
|
2277
|
+
| `nextcloud` | string | |
|
|
2278
|
+
| `okta` | string | |
|
|
2279
|
+
| `onedrive` | string | |
|
|
2280
|
+
| `originalToken` | string | |
|
|
2281
|
+
| `oura` | string | |
|
|
2282
|
+
| `owner` | string | |
|
|
2283
|
+
| `password` | string | |
|
|
2284
|
+
| `passwordSalt` | string | |
|
|
2285
|
+
| `passwordType` | string | |
|
|
2286
|
+
| `patreon` | string | |
|
|
2287
|
+
| `paypal` | string | |
|
|
2288
|
+
| `permanentAvatar` | string | |
|
|
2289
|
+
| `permissions` | Array<object.Permission> | |
|
|
2290
|
+
| `phone` | string | |
|
|
2291
|
+
| `preHash` | string | |
|
|
2292
|
+
| `preferredMfaType` | string | |
|
|
2293
|
+
| `properties` | object | |
|
|
2294
|
+
| `qq` | string | |
|
|
2295
|
+
| `ranking` | integer | |
|
|
2296
|
+
| `recoveryCodes` | array | |
|
|
2297
|
+
| `region` | string | |
|
|
2298
|
+
| `registerSource` | string | |
|
|
2299
|
+
| `registerType` | string | |
|
|
2300
|
+
| `roles` | Array<object.Role> | |
|
|
2301
|
+
| `salesforce` | string | |
|
|
2302
|
+
| `score` | integer | |
|
|
2303
|
+
| `shopify` | string | |
|
|
2304
|
+
| `signinWrongTimes` | integer | |
|
|
2305
|
+
| `signupApplication` | string | |
|
|
2306
|
+
| `slack` | string | |
|
|
2307
|
+
| `soundcloud` | string | |
|
|
2308
|
+
| `spotify` | string | |
|
|
2309
|
+
| `steam` | string | |
|
|
2310
|
+
| `strava` | string | |
|
|
2311
|
+
| `stripe` | string | |
|
|
2312
|
+
| `tag` | string | |
|
|
2313
|
+
| `tiktok` | string | |
|
|
2314
|
+
| `title` | string | |
|
|
2315
|
+
| `totpSecret` | string | |
|
|
2316
|
+
| `tumblr` | string | |
|
|
2317
|
+
| `twitch` | string | |
|
|
2318
|
+
| `twitter` | string | |
|
|
2319
|
+
| `type` | string | |
|
|
2320
|
+
| `typetalk` | string | |
|
|
2321
|
+
| `uber` | string | |
|
|
2322
|
+
| `updatedTime` | string | |
|
|
2323
|
+
| `vk` | string | |
|
|
2324
|
+
| `web3onboard` | string | |
|
|
2325
|
+
| `webauthnCredentials` | Array<webauthn.Credential> | |
|
|
2326
|
+
| `wechat` | string | |
|
|
2327
|
+
| `wecom` | string | |
|
|
2328
|
+
| `weibo` | string | |
|
|
2329
|
+
| `wepay` | string | |
|
|
2330
|
+
| `xero` | string | |
|
|
2331
|
+
| `yahoo` | string | |
|
|
2332
|
+
| `yammer` | string | |
|
|
2333
|
+
| `yandex` | string | |
|
|
2334
|
+
| `zoom` | string | |
|
|
2335
|
+
|
|
2336
|
+
---
|
|
2337
|
+
|
|
2338
|
+
### `object.Userinfo`
|
|
2339
|
+
类型: object
|
|
2340
|
+
|
|
2341
|
+
| 字段 | 类型 | 说明 |
|
|
2342
|
+
|---|---|---|
|
|
2343
|
+
| `address` | string | |
|
|
2344
|
+
| `aud` | string | |
|
|
2345
|
+
| `email` | string | |
|
|
2346
|
+
| `email_verified` | boolean | |
|
|
2347
|
+
| `groups` | array | |
|
|
2348
|
+
| `iss` | string | |
|
|
2349
|
+
| `name` | string | |
|
|
2350
|
+
| `permissions` | array | |
|
|
2351
|
+
| `phone` | string | |
|
|
2352
|
+
| `picture` | string | |
|
|
2353
|
+
| `preferred_username` | string | |
|
|
2354
|
+
| `roles` | array | |
|
|
2355
|
+
| `sub` | string | |
|
|
2356
|
+
|
|
2357
|
+
---
|
|
2358
|
+
|
|
2359
|
+
### `pp.PaymentState`
|
|
2360
|
+
类型: string
|
|
2361
|
+
|
|
2362
|
+
---
|
|
2363
|
+
|
|
2364
|
+
### `protocol.CredentialAssertion`
|
|
2365
|
+
类型: object
|
|
2366
|
+
|
|
2367
|
+
---
|
|
2368
|
+
|
|
2369
|
+
### `protocol.CredentialAssertionResponse`
|
|
2370
|
+
类型: object
|
|
2371
|
+
|
|
2372
|
+
---
|
|
2373
|
+
|
|
2374
|
+
### `protocol.CredentialCreation`
|
|
2375
|
+
类型: object
|
|
2376
|
+
|
|
2377
|
+
---
|
|
2378
|
+
|
|
2379
|
+
### `protocol.CredentialCreationResponse`
|
|
2380
|
+
类型: object
|
|
2381
|
+
|
|
2382
|
+
---
|
|
2383
|
+
|
|
2384
|
+
### `webauthn.Credential`
|
|
2385
|
+
类型: object
|
|
2386
|
+
|
|
2387
|
+
---
|