-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
646 lines (646 loc) · 21.6 KB
/
openapi.yaml
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
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
openapi: 3.0.1
info:
title: magiclinks.dev
description: "The v2 API specification for the magiclinksdev project. \n\n The default\
\ JWK Set relative URL path is `/api/v2/jwks.json`. \n\n The documentation site\
\ is at https://docs.magiclinks.dev \n This is an Apache License 2.0 project:\
\ https://github.com/MicahParks/magiclinksdev \n The optional SaaS platform's\
\ landing page is: https://magiclinks.dev "
version: 2.0.0
servers:
- url: https://magiclinks.dev/api/v2
security:
- apiKey: []
tags:
- name: admin
description: Endpoints for service accounts authorized with an admin API key.
paths:
/ready:
get:
summary: Check if the service is ready to accept requests.
operationId: ready
responses:
"200":
description: The service is ready to accept requests.
content: {}
default:
description: The service is not ready to accept requests.
content: {}
/admin/service-account/create:
post:
tags:
- admin
summary: Create a new service account.
operationId: serviceAccountCreate
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceAccountCreateRequest'
required: true
responses:
"201":
description: The service account has been created.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceAccountCreateResponse'
default:
description: An unexpected error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-codegen-request-body-name: body
/jwt/create:
post:
summary: "Create a JWT, typically after OTP verification or a JWT refresh."
operationId: jwtCreate
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JWTCreateRequest'
required: true
responses:
"201":
description: The JWT was created.
content:
application/json:
schema:
$ref: '#/components/schemas/JWTCreateResponse'
default:
description: An unexpected error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-codegen-request-body-name: body
/jwt/validate:
post:
summary: Verify and validate a JWT.
operationId: jwtValidate
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JWTValidateRequest'
required: true
responses:
"200":
description: The JWT is verified and validated.
content:
application/json:
schema:
$ref: '#/components/schemas/JWTValidateResponse'
"422":
description: The JWT failed verification and validation.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: An unexpected error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-codegen-request-body-name: body
/magic-link/create:
post:
summary: Create a magic link.
operationId: magicLinkCreate
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MagicLinkCreateRequest'
required: true
responses:
"201":
description: The magic link was created.
content:
application/json:
schema:
$ref: '#/components/schemas/MagicLinkCreateResponse'
default:
description: An unexpected error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-codegen-request-body-name: body
/magic-link-email/create:
post:
summary: Create a magic link and send it via email.
operationId: magicLinkEmailCreate
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MagicLinkEmailCreateRequest'
required: true
responses:
"201":
description: The magic link has been created and the email request has been
accepted by the provider.
content:
application/json:
schema:
$ref: '#/components/schemas/MagicLinkEmailCreateResponse'
default:
description: An unexpected error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-codegen-request-body-name: body
/otp/create:
post:
summary: Create a One-Time Password (OTP).
operationId: otpCreate
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OTPCreateRequest'
required: true
responses:
"201":
description: The OTP was created.
content:
application/json:
schema:
$ref: '#/components/schemas/OTPCreateResponse'
default:
description: An unexpected error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-codegen-request-body-name: body
/otp/validate:
post:
summary: Verify and validate a One-Time Password (OTP) given its ID.
operationId: otpValidate
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OTPValidateRequest'
required: true
responses:
"200":
description: The OTP is verified and valid for the given ID.
content:
application/json:
schema:
$ref: '#/components/schemas/OTPValidateResponse'
"400":
description: The OTP failed verification or validation for the given ID.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: An unexpected error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-codegen-request-body-name: body
/otp-email/create:
post:
summary: Create a One-Time Password (OTP) and sent it via email.
operationId: otpEmailCreate
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OTPEmailCreateRequest'
required: true
responses:
"201":
description: The OTP has been created and the email request has been accepted
by the provider.
content:
application/json:
schema:
$ref: '#/components/schemas/OTPEmailCreateResponse'
default:
description: An unexpected error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-codegen-request-body-name: body
components:
schemas:
Error:
type: object
properties:
code:
type: integer
description: A copy of the HTTP response status code.
format: int32
message:
type: string
description: A human-readable error message.
requestMetadata:
$ref: '#/components/schemas/RequestMetadata'
RequestMetadata:
type: object
properties:
uuid:
type: string
description: A UUID that uniquely identifies the request.
format: uuid
ServiceAccount:
type: object
properties:
uuid:
type: string
format: uuid
apiKey:
type: string
aud:
type: string
admin:
type: boolean
JWTCreateParams:
type: object
properties:
alg:
type: string
description: The algorithm to use when signing the JWT. It defaults depends
on the server's configuration. The default server configuration is "EdDSA".
The default server options are "EdDSA" and "RS256".
claims:
type: object
properties: {}
description: Any valid JSON object. Do not provide any JSON attributes mentioned
in RFC 7519 section 4.1 as this will cause an error. These are JWT "Registered
Claim Names".
lifespanSeconds:
type: integer
description: "The lifespan of the JWT in seconds. The JWT's lifespan starts\
\ after creation. For magic links, after the magic link has been visited.\
\ It defaults to 5 minutes. The minimum value is 5 seconds and the maximum\
\ value is 7905600000 seconds, which is a bit over 250 years."
description: Parameters used to create a JWT.
JWTCreateRequest:
required:
- jwtCreateParams
type: object
properties:
jwtCreateParams:
$ref: '#/components/schemas/JWTCreateParams'
description: The request body for the /jwt/create endpoint.
JWTCreateResults:
type: object
properties:
jwt:
type: string
description: The signed JWT.
description: The results for creating a JWT.
JWTCreateResponse:
type: object
properties:
jwtCreateResults:
$ref: '#/components/schemas/JWTCreateResults'
requestMetadata:
$ref: '#/components/schemas/RequestMetadata'
description: The response body for the /jwt/create endpoint.
JWTValidateParams:
type: object
properties:
jwt:
type: string
description: The JWT to validate.
description: Parameters used to validate a JWT.
JWTValidateRequest:
required:
- jwtValidateParams
type: object
properties:
jwtValidateParams:
$ref: '#/components/schemas/JWTValidateParams'
description: The request body for the /jwt/validate endpoint.
JWTValidateResults:
type: object
properties:
claims:
type: object
properties: {}
description: Any valid JSON object. Do not provide any JSON attributes mentioned
in RFC 7519 section 4.1 as this will cause an error. These are JWT "Registered
Claim Names".
description: The results for validateing a JWT.
JWTValidateResponse:
type: object
properties:
jwtValidateResults:
$ref: '#/components/schemas/JWTValidateResults'
requestMetadata:
$ref: '#/components/schemas/RequestMetadata'
description: The response body for the /jwt/validate endpoint.
MagicLinkCreateParams:
required:
- redirectURL
type: object
properties:
jwtCreateParams:
$ref: '#/components/schemas/JWTCreateParams'
lifespanSeconds:
type: integer
description: "The lifespan of the magic link in seconds. The magic link's\
\ lifespan starts after it has been created. It defaults to 1 hour. The\
\ minimum value is 5 seconds and the maximum value is 7905600000 seconds,\
\ which is a bit over 250 years."
redirectQueryKey:
type: string
description: "The URL query key in the redirectURL to contain the signed\
\ JWT when the magic link is used. By default, \"jwt\" is used."
redirectURL:
type: string
description: The URL to redirect to with the signed JWT when the magic link
is used.
description: Parameters to create a magic link.
MagicLinkCreateRequest:
required:
- magicLinkCreateParams
type: object
properties:
magicLinkCreateParams:
$ref: '#/components/schemas/MagicLinkCreateParams'
MagicLinkCreateResults:
type: object
properties:
magicLink:
type: string
description: "The URL that will act as a magic link. When this URL is visited,\
\ a new JWT will be created. A redirect wil be performed with this new\
\ JWT in the redirect URL's query parameter."
secret:
type: string
description: The secret embedded in the magic link.
MagicLinkCreateResponse:
type: object
properties:
magicLinkCreateResults:
$ref: '#/components/schemas/MagicLinkCreateResults'
requestMetadata:
$ref: '#/components/schemas/RequestMetadata'
MagicLinkEmailCreateParams:
required:
- serviceName
- subject
- title
- toEmail
type: object
properties:
buttonText:
type: string
description: The text to display on the button in the email. It defaults
to "Magic link".
example: Login
default: Magic link
greeting:
type: string
description: The smaller text above the title.
example: "Hello Jane Doe,"
logoClickURL:
type: string
description: The URL to redirect to when the logo is clicked.
example: https://example.com
logoImageURL:
type: string
description: The URL to the logo image to display in the email.
example: https://example.com/logo.png
serviceName:
type: string
description: The name of your service. This is used in invisible email metadata.
example: example.com
subject:
type: string
description: The subject of the email. It must be between 5 and 100 characters
inclusive. Make sure to include the name of your application.
example: Login to example.com
subTitle:
type: string
description: "The smaller text, right above the magic link button."
example: Login using the button below.
title:
type: string
description: "The larger text, right above the subtitle. It must be between\
\ 5 and 256 characters inclusive. Make sure to include the name of your\
\ application."
example: Login to example.com with a magic link
toEmail:
type: string
description: The email address to send the magic link to.
format: email
example: jane.doe@example.com
toName:
type: string
description: The name of the recipient.
example: Jane Doe
description: Parameters to create a magic link email.
MagicLinkEmailCreateRequest:
required:
- magicLinkCreateParams
- magicLinkEmailCreateParams
type: object
properties:
magicLinkCreateParams:
$ref: '#/components/schemas/MagicLinkCreateParams'
magicLinkEmailCreateParams:
$ref: '#/components/schemas/MagicLinkEmailCreateParams'
MagicLinkEmailCreateResults:
type: object
properties:
magicLinkCreateResults:
$ref: '#/components/schemas/MagicLinkCreateResults'
description: The results for creating a magic link email.
MagicLinkEmailCreateResponse:
type: object
properties:
magicLinkEmailCreateResults:
$ref: '#/components/schemas/MagicLinkEmailCreateResults'
requestMetadata:
$ref: '#/components/schemas/RequestMetadata'
OTPCreateParams:
type: object
properties:
charSetAlphaLower:
type: boolean
description: Include a chance to use lowercase letters in the OTP.
charSetAlphaUpper:
type: boolean
description: Include a chance to use uppercase letters in the OTP.
charSetNumeric:
type: boolean
description: Include a chance to use numbers in the OTP.
length:
type: integer
description: The length of the OTP. It defaults to 6. The minimum value
is 1 and the maximum value is 12.
lifespanSeconds:
type: integer
description: "The lifespan of the OTP in seconds. The OTP's lifespan starts\
\ after it has been created. It defaults to 1 hour. The minimum value\
\ is 5 seconds and the maximum value is 7905600000 seconds, which is a\
\ bit over 250 years."
description: Parameters to create a One-Time Password (OTP).
OTPCreateRequest:
required:
- otpCreateParams
type: object
properties:
otpCreateParams:
$ref: '#/components/schemas/OTPCreateParams'
OTPCreateResults:
type: object
properties:
id:
type: string
description: The ID of the OTP.
otp:
type: string
description: The One-Time Password.
description: The results for creating a One-Time Password (OTP).
OTPCreateResponse:
type: object
properties:
otpCreateResults:
$ref: '#/components/schemas/OTPCreateResults'
requestMetadata:
$ref: '#/components/schemas/RequestMetadata'
OTPEmailCreateParams:
required:
- serviceName
- subject
- title
- toEmail
type: object
properties:
greeting:
type: string
description: The smaller text above the title.
example: "Hello Jane Doe,"
logoClickURL:
type: string
description: The URL to redirect to when the logo is clicked.
example: https://example.com
logoImageURL:
type: string
description: The URL to the logo image to display in the email.
example: https://example.com/logo.png
serviceName:
type: string
description: The name of your service. This is used in invisible email metadata.
example: example.com
subject:
type: string
description: The subject of the email. It must be between 5 and 100 characters
inclusive. Make sure to include the name of your application.
example: Login to example.com
subTitle:
type: string
description: "The smaller text, right above the magic link button."
example: Login using the button below.
title:
type: string
description: "The larger text, right above the subtitle. It must be between\
\ 5 and 256 characters inclusive. Make sure to include the name of your\
\ application."
example: Login to example.com with a magic link
toEmail:
type: string
description: The email address to send the magic link to.
format: email
example: jane.doe@example.com
toName:
type: string
description: The name of the recipient.
example: Jane Doe
description: Parameters to create a One-Time Password (OTP) email.
OTPEmailCreateRequest:
required:
- otpCreateParams
- otpEmailCreateParams
type: object
properties:
otpCreateParams:
$ref: '#/components/schemas/OTPCreateParams'
otpEmailCreateParams:
$ref: '#/components/schemas/OTPEmailCreateParams'
OTPEmailCreateResults:
type: object
properties:
otpCreateResults:
$ref: '#/components/schemas/OTPCreateResults'
description: The results for creating a One-Time Password (OTP) email.
OTPEmailCreateResponse:
type: object
properties:
otpEmailCreateResults:
$ref: '#/components/schemas/OTPEmailCreateResults'
requestMetadata:
$ref: '#/components/schemas/RequestMetadata'
OTPValidateParams:
type: object
properties:
id:
type: string
description: The ID of the OTP to validate.
otp:
type: string
description: The user provided One-Time Password to validate.
description: Parameters to validate a One-Time Password (OTP).
OTPValidateRequest:
type: object
properties:
otpValidateParams:
$ref: '#/components/schemas/OTPValidateParams'
OTPValidateResults:
type: object
OTPValidateResponse:
required:
- otpValidateResults
- requestMetadata
type: object
properties:
otpValidateResults:
$ref: '#/components/schemas/OTPValidateResults'
requestMetadata:
$ref: '#/components/schemas/RequestMetadata'
ServiceAccountCreateParams:
type: object
description: Parameters to create a service account.
ServiceAccountCreateRequest:
type: object
properties:
serviceAccountCreateParams:
$ref: '#/components/schemas/ServiceAccountCreateParams'
description: The request body for the /admin/service-account/create endpoint.
ServiceAccountCreateResults:
type: object
properties:
serviceAccount:
$ref: '#/components/schemas/ServiceAccount'
description: The results for creating a service account.
ServiceAccountCreateResponse:
type: object
properties:
serviceAccountCreateResults:
$ref: '#/components/schemas/ServiceAccountCreateResults'
requestMetadata:
$ref: '#/components/schemas/RequestMetadata'
description: The response body for the /admin/service-account/create endpoint.
securitySchemes:
apiKey:
type: apiKey
name: X-API-KEY
in: header
x-original-swagger-version: "2.0"