-
Notifications
You must be signed in to change notification settings - Fork 2
/
auth.openapi.json
508 lines (508 loc) · 19.7 KB
/
auth.openapi.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
{
"openapi": "3.1.0",
"info": {
"title": "Brainstory Authentication API",
"description": "\n<a href=\"/\">👈 Back home</a>\n\n**General error handling information**\n\n| HTTP Status Code | Description | Expected way to handle |\n| ---------------- | -------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |\n| HTTP 400 | Malformed request | See logs to debug |\n| HTTP 401 | Could not authenticate (see below) | Ensure all required inputs are correct, otherwise try logging in again |\n| HTTP 230 | Authentication at external provider was successful, but an unknown error occurred | See logs to debug |\n| HTTP 231 | User hasn't accepted the terms yet | Redirect user to terms page, accept terms |\n| HTTP 233 | User e-mail not verified past 2 weeks of creation | Redirect user to e-mail not verified page, prompt them to verify their e-mail |\n| HTTP 234 | Submitted access token expired | Try exchange refresh token for a new access token, otherwise try logging in again | \n\nFor 401s, see the notice in the response for specifics - issue could be various things:\n\n- user does not exist on our end;\n- invalid tokens;\n- some sort of hackery;\n- CSRF not set up or set up incorrectly;\n\netc...\n\n",
"version": "Release 1"
},
"servers": [
{
"url": "/auth-brainstory/v1"
}
],
"paths": {
"/flow/apilogin": {
"post": {
"tags": [
"User Flow"
],
"summary": "Login with a user and API key for an access token",
"description": "Login with a user and API key for an access token.",
"operationId": "login_with_api_key_flow_apilogin_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flow/user": {
"get": {
"tags": [
"User Flow"
],
"summary": "[FusionAuth] Begin user flow with",
"description": "Begin user flow with FusionAuth. Clients are expected to follow the returned redirect.\n\n*You don't need this call as an end-user.*",
"operationId": "flow_user_flow_user_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/flow/oauth-callback": {
"get": {
"tags": [
"User Flow"
],
"summary": "[FusionAuth] OAuth callback",
"description": "Do OAuth callback. Redirects back to original client caller.\n\n*You don't need this call as an end-user.*",
"operationId": "flow_oauth_callback_flow_oauth_callback_get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Code"
},
"name": "code",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flow/exchange": {
"get": {
"tags": [
"User Flow"
],
"summary": "[FusionAuth] Exchange a refresh token for an access token.",
"description": "Exchange a refresh token for an updated access token.\n\n*You don't need this call as an end-user.*",
"operationId": "flow_exchange_flow_exchange_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoticeResponse"
}
}
}
}
}
}
},
"/flow/verified-email-redirect": {
"get": {
"tags": [
"User Flow"
],
"summary": "[FusionAuth] Redirect after e-mail verified",
"description": "Redirect after e-mail has been verified.\n\n*You don't need this call as an end-user.*",
"operationId": "flow_email_verified_redirect_flow_verified_email_redirect_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/flow/resend-verification": {
"get": {
"tags": [
"User Flow"
],
"summary": "[FusionAuth] Re-send e-mail verification e-mail",
"description": "Re-send e-mail verification e-mail.\n\n*You don't need this call as an end-user.*",
"operationId": "flow_resend_verification_flow_resend_verification_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoticeResponse"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
]
}
},
"/flow/logout": {
"get": {
"tags": [
"User Flow"
],
"summary": "[FusionAuth] Logout",
"description": "Log out, will remove current session.\n\n*You don't need this call as an end-user.*",
"operationId": "flow_logout_flow_logout_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/reset-password": {
"post": {
"tags": [
"General"
],
"summary": "Request a password reset",
"description": "Request a password reset.\n\n*You don't need this call as an end-user.*",
"operationId": "reset_password_reset_password_post",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoticeResponse"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
]
}
},
"/regenerate-api-key": {
"post": {
"tags": [
"General"
],
"summary": "Regenerate API key",
"description": "Regenerate API key for a user.",
"operationId": "regenerate_api_key_regenerate_api_key_post",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiKeyResponse"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
]
}
},
"/change-full-name": {
"post": {
"tags": [
"General"
],
"summary": "Change user full name",
"description": "Change full name of the user.\n\n*You don't need this call as an end-user.*",
"operationId": "change_full_name_change_full_name_post",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "New Name"
},
"name": "new_name",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoticeResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
]
}
},
"/delete-user": {
"post": {
"tags": [
"General"
],
"summary": "Delete the current user",
"description": "Delete the current user.\n\n*You don't need this call as an end-user.*",
"operationId": "delete_user_delete_user_post",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoticeResponse"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
]
}
},
"/csrf": {
"get": {
"tags": [
"Security"
],
"summary": "Apply CSRF cookie and return the same security token in the response.",
"description": "Apply CSRF security token in the response.\n\n*You don't need this call as an end-user.*",
"operationId": "csrf_csrf_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/webhook": {
"post": {
"tags": [
"Webhook"
],
"summary": "[FusionAuth] Incoming webhook",
"description": "Incoming FusionAuth webhook handler.\n\n*You don't need this call as an end-user.*",
"operationId": "flow_webhook_webhook_post",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoticeResponse"
}
}
}
}
},
"security": [
{
"HTTPBasic": []
}
]
}
}
},
"components": {
"schemas": {
"ApiKeyResponse": {
"properties": {
"api_key": {
"type": "string",
"title": "Api Key"
}
},
"type": "object",
"required": [
"api_key"
],
"title": "ApiKeyResponse",
"description": "API key response model."
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"LoginRequest": {
"properties": {
"user_email": {
"type": "string",
"format": "email",
"title": "User e-mail",
"description": "The e-mail address of the user."
},
"api_key": {
"type": "string",
"minLength": 43,
"title": "API key",
"description": "API key of the user",
"default": ""
}
},
"type": "object",
"required": [
"user_email"
],
"title": "LoginRequest",
"description": "Login with e-mail and API key request model."
},
"NoticeResponse": {
"properties": {
"notice": {
"type": "string",
"title": "Notice"
}
},
"type": "object",
"required": [
"notice"
],
"title": "NoticeResponse",
"description": "Notice response model."
},
"TokenResponse": {
"properties": {
"access_token": {
"type": "string",
"title": "Access Token"
}
},
"type": "object",
"required": [
"access_token"
],
"title": "TokenResponse",
"description": "Token response model."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
}
},
"securitySchemes": {
"HTTPBearer": {
"type": "http",
"scheme": "bearer"
},
"HTTPBasic": {
"type": "http",
"scheme": "basic"
}
}
}
}