generated from mintlify/starter
-
Notifications
You must be signed in to change notification settings - Fork 11
/
openapi-admin.yaml
847 lines (842 loc) · 24.2 KB
/
openapi-admin.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
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
openapi: 3.0.0
info:
version: "0.9.1"
title: "Hanko Admin API"
description: |
## Introduction
This is the OpenAPI specification for the [Hanko Admin API](https://github.com/teamhanko/hanko/blob/main/backend/README.md#start-private-api).
## Authentication
The Admin API must be protected by an access management system.
---
contact:
email: [email protected]
license:
name: AGPL-3.0-or-later
url: https://www.gnu.org/licenses/agpl-3.0.txt
externalDocs:
description: More about Hanko
url: https://github.com/teamhanko/hanko
servers:
# - url: "http://localhost:8001"
- url: "https://{tenant_id}.hanko.io"
variables:
tenant_id:
default: "default"
description: "Tenant ID to be provided by the user"
paths:
/:
get:
summary: Status page
description: Return information about the API status. Returns a 500 if there are issues with database connectivity.
operationId: status
tags:
- Status
responses:
"200":
description: "API is running"
content:
text/html:
schema:
type: string
"500":
description: "API is not functioning properly"
content:
text/html:
schema:
type: string
/users:
get:
summary: "Get a list of users"
operationId: listUsers
tags:
- User Management
parameters:
- in: query
name: page
schema:
type: integer
default: 1
description: The page which should be returned
- in: query
name: per_page
schema:
type: integer
default: 20
description: The number of returned items
- in: query
name: user_id
schema:
allOf:
- $ref: "#/components/schemas/UUID4"
example: c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c
description: Only users with the specified user_id are included
- in: query
name: email
schema:
type: string
format: email
example: [email protected]
description: Only users with the specified email are included
- in: query
name: sort_direction
schema:
type: string
enum:
- asc
- desc
description: The sort direction of the returned list (always sorted by created_at)
responses:
"200":
description: "Details about users"
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/User"
headers:
X-Total-Count:
$ref: "#/components/headers/X-Total-Count"
Link:
$ref: "#/components/headers/Link"
"500":
$ref: "#/components/responses/InternalServerError"
"400":
$ref: "#/components/responses/BadRequest"
post:
summary: Create a new user
operationId: createUser
tags:
- User Management
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
description: The ID of the new user
allOf:
- $ref: "#/components/schemas/UUID4"
emails:
description: The email addresses of the new user
type: array
items:
type: object
properties:
address:
type: string
is_primary:
type: boolean
is_verified:
type: boolean
required:
- address
- is_primary
created_at:
description: Time of creation of the user
type: string
format: date-time
required:
- emails
responses:
"200":
description: "Details of the newly created user"
content:
application/json:
schema:
$ref: "#/components/schemas/User"
"400":
$ref: "#/components/responses/BadRequest"
"409":
$ref: "#/components/responses/Conflict"
"500":
$ref: "#/components/responses/InternalServerError"
/users/{id}:
delete:
summary: "Delete a user by ID"
operationId: deleteUser
tags:
- User Management
parameters:
- name: id
in: path
description: ID of the user
required: true
schema:
$ref: "#/components/schemas/UUID4"
responses:
"204":
description: "Deleted"
"404":
$ref: "#/components/responses/NotFound"
"500":
$ref: "#/components/responses/InternalServerError"
get:
summary: "Get a user by ID"
operationId: getUser
tags:
- User Management
parameters:
- name: id
in: path
description: ID of the user
required: true
schema:
$ref: "#/components/schemas/UUID4"
responses:
"200":
description: "Details about the user"
content:
application/json:
schema:
$ref: "#/components/schemas/User"
"400":
$ref: "#/components/responses/BadRequest"
"404":
$ref: "#/components/responses/NotFound"
"500":
$ref: "#/components/responses/InternalServerError"
/audit_logs:
get:
summary: "Get a list of audit logs"
operationId: listAuditLogs
tags:
- Audit Logs
parameters:
- in: query
name: page
schema:
type: integer
default: 1
description: The page which should be returned
- in: query
name: per_page
schema:
type: integer
default: 20
description: The number of returned items
- in: query
name: start_time
schema:
type: string
example: 2022-09-12T12:48:48Z
description: Date and time from which the logs are included
- in: query
name: end_time
schema:
type: string
example: 2022-09-15T12:48:48Z
description: Date and time to which the logs are included
- in: query
name: actor_user_id
schema:
allOf:
- $ref: "#/components/schemas/UUID4"
example: c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c
description: Only audit logs with the specified user_id are included
- in: query
name: actor_email
schema:
type: string
format: email
example: [email protected]
description: Only audit logs with the specified email are included
- in: query
name: meta_source_ip
schema:
allOf:
- type: string
format: ipv4
- type: string
format: ipv6
example: 127.0.0.1
description: Only audit logs with the specified ip address are included
- in: query
name: q
schema:
type: string
example: example.com
description: Only audit logs are included when the search string matches values in meta_source_ip or actor_user_id or actor_email
- in: query
name: type
schema:
type: array
items:
allOf:
- $ref: "#/components/schemas/AuditLogTypes"
example: user_created
style: form
explode: true
description: Only audit logs with the specified type are included
responses:
"200":
description: "Details about audit logs"
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/AuditLog"
headers:
X-Total-Count:
$ref: "#/components/headers/X-Total-Count"
Link:
$ref: "#/components/headers/Link"
"500":
$ref: "#/components/responses/InternalServerError"
/metrics:
get:
summary: "Get Prometheus metrics."
operationId: getMetrics
tags:
- Metrics
responses:
"200":
description: "Prometheus Metrics for details about the format see: https://prometheus.io/docs/instrumenting/exposition_formats/#text-format-details"
content:
text/plain:
schema:
type: string
example: 'go_gc_duration_seconds{quantile="0"} 2.5875e-05'
/webhooks:
get:
summary: Get a list of webhooks
description: "Returns a list of all configured webhooks. "
operationId: list-webhooks
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
properties:
database:
type: array
items:
$ref: "#/components/schemas/DatabaseWebhook"
config:
type: array
items:
$ref: "#/components/schemas/Webhook"
"500":
$ref: "#/components/responses/InternalServerError"
post:
summary: Create a new database webhook
description: ""
operationId: create-db-webhooks
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Webhook"
responses:
"201":
description: Created
content:
application/json:
schema:
$ref: "#/components/schemas/DatabaseWebhook"
"400":
$ref: "#/components/responses/BadRequest"
"500":
$ref: "#/components/responses/InternalServerError"
"/webhooks/{id}":
get:
summary: Get a webhook by ID
operationId: get-webhooks-id
parameters:
- $ref: "#/components/parameters/Id"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/DatabaseWebhook"
"400":
$ref: "#/components/responses/BadRequest"
"404":
$ref: "#/components/responses/NotFound"
"500":
$ref: "#/components/responses/InternalServerError"
delete:
summary: Delete a webhook by ID
operationId: delete-webhooks-id
parameters:
- $ref: "#/components/parameters/Id"
responses:
"204":
description: No Content
"400":
$ref: "#/components/responses/BadRequest"
"404":
$ref: "#/components/responses/NotFound"
"500":
description: Internal Server Error
put:
summary: Update a webhook by ID
operationId: put-webhooks-id
parameters:
- $ref: "#/components/parameters/Id"
requestBody:
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/Webhook"
- type: object
properties:
enabled:
type: boolean
required:
- enabled
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/DatabaseWebhook"
"400":
$ref: "#/components/responses/BadRequest"
"404":
$ref: "#/components/responses/NotFound"
"500":
$ref: "#/components/responses/InternalServerError"
"/users/{id}/emails":
get:
summary: Get a list of emails for a user
operationId: get-users-id-emails
parameters:
- $ref: "#/components/parameters/Id"
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Email"
"400":
$ref: "#/components/responses/BadRequest"
"500":
$ref: "#/components/responses/InternalServerError"
post:
summary: Create an email for a user
operationId: post-users-id-emails
parameters:
- $ref: "#/components/parameters/Id"
requestBody:
$ref: "#/components/requestBodies/CreateEmail"
responses:
"201":
description: Created
content:
application/json:
schema:
$ref: "#/components/schemas/Email"
"400":
$ref: "#/components/responses/BadRequest"
"404":
$ref: "#/components/responses/NotFound"
"409":
$ref: "#/components/responses/Conflict"
"500":
$ref: "#/components/responses/InternalServerError"
"/users/{id}/emails/{email_id}":
get:
summary: Get an email of a user
operationId: get-users-id-emails-email_id
parameters:
- $ref: "#/components/parameters/Id"
- name: email_id
in: path
description: UUID of the requested email
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/Email"
"400":
$ref: "#/components/responses/BadRequest"
"404":
$ref: "#/components/responses/NotFound"
"500":
$ref: "#/components/responses/InternalServerError"
delete:
summary: Remove an email from a user
operationId: delete-users-emails-email_id
parameters:
- $ref: "#/components/parameters/Id"
- name: email_id
in: path
description: UUID of the requested email
required: true
schema:
type: string
responses:
"204":
description: No Content
"400":
$ref: "#/components/responses/BadRequest"
"404":
$ref: "#/components/responses/NotFound"
"409":
$ref: "#/components/responses/Conflict"
"500":
$ref: "#/components/responses/InternalServerError"
"/users/{id}/emails/{email_id}/set_primary":
post:
summary: Set email as primary
operationId: post-users-emails-email_id-set_primary
parameters:
- $ref: "#/components/parameters/Id"
- name: email_id
in: path
required: true
schema:
type: string
responses:
"204":
description: No Content
"400":
$ref: "#/components/responses/BadRequest"
"404":
$ref: "#/components/responses/NotFound"
"500":
$ref: "#/components/responses/InternalServerError"
components:
parameters:
Id:
name: id
in: path
description: UUID of the requested object
required: true
schema:
type: string
format: uuid
requestBodies:
CreateEmail:
description: Request Body for creating an email for a user
content:
application/json:
schema:
type: object
properties:
address:
type: string
format: email
is_primary:
type: boolean
is_verified:
type: boolean
required:
- address
responses:
BadRequest:
description: Bad Request
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
code: 400
message: Bad Request
Conflict:
description: Conflict
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
code: 409
message: Conflict
InternalServerError:
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
code: 500
message: Internal Server Error
NotFound:
description: Not Found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
code: 404
message: Not found
schemas:
UUID4:
type: string
format: uuid4
example: c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c
User:
type: object
required:
- id
- created_at
- updated_at
properties:
id:
description: The ID of the user
allOf:
- $ref: "#/components/schemas/UUID4"
created_at:
description: Time of creation of the user
type: string
format: date-time
updated_at:
description: Time of last update of the user
type: string
format: date-time
webauthn_credentials:
description: List of registered Webauthn credentials
type: array
items:
$ref: "#/components/schemas/WebAuthnCredential"
emails:
description: List of emails associated to the user
type: array
items:
$ref: "#/components/schemas/Email"
WebAuthnCredential:
type: object
required:
- id
- public_key
- attestation_type
- aaguid
- created_at
properties:
id:
description: The ID of the credential
allOf:
- $ref: "#/components/schemas/UUID4"
name:
description: A name that the user choose
type: string
public_key:
description: The public key of the credential
type: string
attestation_type:
description: The attestation type the credential was registered with
type: string
aaguid:
description: The AAGUID of the authenticator the credentials was created on
type: string
transports:
description: The ways the authenticator is connected
type: array
items:
type: string
created_at:
description: Time of creation of the credential
type: string
format: date-time
Email:
type: object
required:
- id
- address
- is_verified
- is_primary
- created_at
- updated_at
properties:
id:
description: The ID of the email
allOf:
- $ref: "#/components/schemas/UUID4"
address:
description: The email address
type: string
format: email
is_verified:
description: Indicated the email has been verified.
type: boolean
is_primary:
description: Indicates it's the primary email address.
type: boolean
created_at:
description: Time of creation of the email
type: string
format: date-time
updated_at:
description: Time of last update of the email
type: string
format: date-time
AuditLog:
type: object
required:
- id
- type
- meta_http_request_id
- meta_source_ip
- meta_user_agent
- created_at
- updated_at
properties:
id:
description: The ID of the audit log
allOf:
- $ref: "#/components/schemas/UUID4"
type:
allOf:
- $ref: "#/components/schemas/AuditLogTypes"
error:
description: A more detailed message why something failed
type: string
meta_http_request_id:
description: The ID of the corresponding http request
type: string
example: 0a2xsrhlhiQv49FIpq8KV8uQVq6ky9Bw
meta_source_ip:
description: The IP from where the http request came from
type: string
format: ip-address
example: 172.27.0.1
meta_user_agent:
description: The user agent from where the http request came from
type: string
actor_user_id:
description: The userID from the actor
allOf:
- $ref: "#/components/schemas/UUID4"
actor_email:
description: The email from the actor
type: string
format: email
created_at:
description: Time of creation of the audit log
type: string
format: date-time
example: "2022-09-14T12:15:09.788784Z"
DatabaseWebhookEvent:
type: object
title: DatabaseWebhookEvent
properties:
id:
type: string
format: uuid
event:
type: string
enum:
- user
- user.create
- user.delete
- user.update
- user.update.email
- user.update.email.create
- user.update.email.delete
- user.update.email.primary
DatabaseWebhook:
type: object
title: DatabaseWebhook
properties:
id:
type: string
format: uuid
callback:
type: string
format: uri
enabled:
type: boolean
failures:
type: integer
minimum: 0
expires_at:
type: string
format: date-time
events:
type: array
items:
$ref: "#/components/schemas/DatabaseWebhookEvent"
created_at:
type: string
format: date-time
updated_at:
description: Time of last update of the audit log
type: string
format: date-time
example: "2022-09-14T12:15:09.788784Z"
Webhook:
type: object
title: Webhook
properties:
callback:
type: string
format: uri
events:
type: array
minItems: 1
items:
type: string
enum:
- user
- user.create
- user.delete
- user.update
- user.update.email
- user.update.email.create
- user.update.email.delete
- user.update.email.primary
required:
- callback
- events
Error:
type: object
required:
- code
- message
properties:
code:
type: integer
format: int32
message:
type: string
AuditLogTypes:
description: The type of the audit log
type: string
enum:
- user_created
- password_set_succeeded
- password_set_failed
- password_login_succeeded
- password_login_failed
- passcode_login_init_succeeded
- passcode_login_init_failed
- passcode_login_final_succeeded
- passcode_login_final_failed
- webauthn_registration_init_succeeded
- webauthn_registration_init_failed
- webauthn_registration_final_succeeded
- webauthn_registration_final_failed
- webauthn_authentication_init_succeeded
- webauthn_authentication_init_failed
- webauthn_authentication_final_succeeded
- webauthn_authentication_final_failed
- thirdparty_signup_succeeded
- thirdparty_signin_succeeded
headers:
X-Total-Count:
schema:
type: string
description: The total count of the requested resource considering query parameter
example: 1234
Link:
schema:
type: string
description: Web Linking as described in RFC5988
example: <http://localhost:8001/resource?page=1&per_page=10>; rel="first",<http://localhost:8001/resource?page=16&per_page=10>; rel="last",<http://localhost:8001/resource?page=6&per_page=10>; rel="next",<http://localhost:8001/resource?page=4&per_page=10>; rel="prev"