forked from teamhanko/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi-public.yaml
1598 lines (1573 loc) · 55.4 KB
/
openapi-public.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
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
version: '0.8.0'
title: 'Hanko Public API'
description: |
## Introduction
This is the OpenAPI specification for the [Hanko Public API](https://github.com/teamhanko/hanko/blob/main/backend/README.md#basic-usage).
## Authentication
The API uses [JSON Web Tokens](https://www.rfc-editor.org/rfc/rfc7519.html) (JWTs) for authentication.
JWTs are verified using [JSON Web Keys](https://www.rfc-editor.org/rfc/rfc7517) (JWK).
JWKs can be [configured](https://github.com/teamhanko/hanko/blob/main/backend/docs/Config.md#all-available-config-options)
through the `secrets.keys` options. The API also publishes public cryptographic keys as a
[JWK set](https://www.rfc-editor.org/rfc/rfc7517#section-2) through the `.well-known/jwks.json` endpoint
to enable clients to verify token signatures.
JWTs must be provided on requests to protected endpoints using one of the following schemes:
### CookieAuth
**Security Scheme Type**: `API Key`
**Cookie parameter name**: `hanko`
The JWT must be provided in a Cookie with the name `hanko`.
### BearerTokenAuth
**Security Scheme Type**: `http`
**HTTP Authorization Scheme**: `Bearer`
**Bearer format**: `JWT`
The JWT must be provided in an HTTP Authorization header with bearer type: `Authorization: Bearer <JWT>`.
## Cross-Origin Resource Sharing
Cross-Origin Resource Sharing (CORS) can be currently
[configured](https://github.com/teamhanko/hanko/blob/main/backend/docs/Config.md#all-available-config-options)
for public endpoints via the `server.public.cors` options.
---
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:8000'
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
/passcode/login/initialize:
post:
summary: 'Initialize passcode login'
description: |
Initialize a passcode login for the user identified by `user_id`. Sends an email
containing the actual passcode to the user's primary email address or to the address specified
through `email_id`. Returns a representation of the passcode.
operationId: passcodeInit
tags:
- Passcode
requestBody:
content:
application/json:
schema:
type: object
properties:
user_id:
description: The ID of the user
allOf:
- $ref: '#/components/schemas/UUID4'
email_id:
description: The ID of the email address
allOf:
- $ref: '#/components/schemas/UUID4'
required: [user_id]
responses:
'200':
description: 'Successful passcode login initialization'
content:
application/json:
schema:
$ref: '#/components/schemas/Passcode'
'400':
$ref: '#/components/responses/BadRequest'
'500':
$ref: '#/components/responses/InternalServerError'
/passcode/login/finalize:
post:
summary: 'Finalize passcode login'
description: |
Finalize a passcode login given the `id` of the passcode and the actual `code` provided in the the email sent
to the user during initialization.
On success, sets the User's `verified` status to `true`.
operationId: passcodeFinal
tags:
- Passcode
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
description: The ID of the passcode
allOf:
- $ref: '#/components/schemas/UUID4'
code:
type: string
minLength: 6
maxLength: 6
description: |
The actual passcode from the email sent to the user during initialization,
a string of 6 decimal digits
example: "897481"
responses:
'200':
description: 'Successful passcode login finalization'
headers:
X-Auth-Token:
description: |
Present only when enabled via [configuration](https://github.com/teamhanko/hanko/blob/main/backend/docs/Config.md#hanko-backend-config) option `session.enable_auth_token_header`
for purposes of cross-domain communication between client and Hanko API.
schema:
$ref: '#/components/schemas/X-Auth-Token'
X-Session-Lifetime:
description: |
Contains the seconds until the session expires.
schema:
$ref: '#/components/schemas/X-Session-Lifetime'
Set-Cookie:
description: |
Contains the JSON Web Token (JWT) that must be provided to protected endpoints.
Cookie attributes (e.g. domain) can be set via [configuration](https://github.com/teamhanko/hanko/blob/main/backend/docs/Config.md#hanko-backend-config) option `session.cookie`.
schema:
$ref: '#/components/schemas/CookieSession'
content:
application/json:
schema:
$ref: '#/components/schemas/Passcode'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'408':
$ref: '#/components/responses/RequestTimeOut'
'410':
$ref: '#/components/responses/Gone'
'500':
$ref: '#/components/responses/InternalServerError'
/password/login:
post:
summary: 'Do password login'
description: |
Perform a password login for the user identified by `user_id` and a given `password`.
This endpoint is only available if passwords have been enabled via [configuration](https://github.com/teamhanko/hanko/blob/main/backend/docs/Config.md#hanko-backend-config) option `passwords.enabled`.
operationId: passwordLogin
tags:
- Password
requestBody:
content:
application/json:
schema:
type: object
properties:
user_id:
description: The ID of the user to perform a password login for
allOf:
- $ref: '#/components/schemas/UUID4'
password:
$ref: '#/components/schemas/Password'
required:
- user_id
- password
responses:
'200':
description: 'Successful password login'
headers:
X-Auth-Token:
description: |
Present only when enabled via [configuration](https://github.com/teamhanko/hanko/blob/main/backend/docs/Config.md#hanko-backend-config) option `session.enable_auth_token_header`
for purposes of cross-domain communication between client and Hanko API.
schema:
$ref: '#/components/schemas/X-Auth-Token'
X-Session-Lifetime:
description: |
Contains the seconds until the session expires.
schema:
$ref: '#/components/schemas/X-Session-Lifetime'
Set-Cookie:
description: |
Contains the JSON Web Token (JWT) that must be provided to protected endpoints.
Cookie attributes (e.g. domain) can be set via [configuration](https://github.com/teamhanko/hanko/blob/main/backend/docs/Config.md#hanko-backend-config) option `session.cookie`.
schema:
$ref: '#/components/schemas/CookieSession'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/password:
put:
summary: 'Create/Set a password'
description: |
Create a or update an existing `password` for the user identified by `user_id`.
This endpoint is only available if passwords have been enabled via [configuration](https://github.com/teamhanko/hanko/blob/main/backend/docs/Config.md#hanko-backend-config) option `passwords.enabled`.
operationId: password
tags:
- Password
security:
- CookieAuth: [ ]
- BearerTokenAuth: [ ]
requestBody:
content:
application/json:
schema:
type: object
properties:
user_id:
description: The ID of the user to create/set a password for
allOf:
- $ref: '#/components/schemas/UUID4'
password:
$ref: '#/components/schemas/Password'
required:
- user_id
- password
responses:
'200':
description: 'Successful password update'
'201':
description: 'Successful password creation'
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/webauthn/login/initialize:
post:
summary: 'Initialize WebAuthn login'
description: |
Initialize a login with Webauthn. Returns a JSON representation of CredentialRequestOptions for use
with the Webauthn API's `navigator.credentials.get()`.
Omitting the optional request body or using an empty JSON object results in generation of request options for a
login using a [discoverable credential](https://www.w3.org/TR/webauthn-2/#client-side-discoverable-public-key-credential-source)
(i.e. they will not contain
[allowCredentials](https://www.w3.org/TR/webauthn-2/#dom-publickeycredentialrequestoptions-allowcredentials)).
*Note*: The Webauthn API uses binary data represented by ArrayBuffers for certain input/output values.
The Hanko API returns these values as base64url-encoded, so they must be converted to ArrayBuffers
when passed to the Webauthn API. Similarly, Webauthn API output must be converted to base64url-encoded values
when passed to the Hanko API (e.g. using the [webauthn-json](https://github.com/github/webauthn-json) library).
operationId: webauthnLoginInit
tags:
- WebAuthn
requestBody:
content:
application/json:
schema:
type: object
properties:
user_id:
description: The ID of the user on whose behalf WebAuthn login should be performed
allOf:
- $ref: '#/components/schemas/UUID4'
responses:
'200':
description: 'Successful initialization'
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialRequestOptions'
examples:
non-disco:
summary: Non-Discoverable credentials
value:
publicKey:
challenge: qgOI+0KpGnl9NOqaT6dfsYvi96R87LgpErnvePeOgSU=
timeout: 60000
rpId: localhost
allowCredentials:
- type: public-key
id: Mepptysj5ZZrTlg0qiLbsZ068OtQMeGVAikVy2n1hvvG...
userVerification: required
disco:
summary: Discoverable credentials
value:
challenge: qgOI+0KpGnl9NOqaT6dfsYvi96R87LgpErnvePeOgSU=
timeout: 60000
rpId: localhost
userVerification: required
'400':
$ref: '#/components/responses/BadRequest'
'500':
$ref: '#/components/responses/InternalServerError'
/webauthn/login/finalize:
post:
summary: 'Finalize WebAuthn login'
description: |
Finalize a login with Webauthn using the WebAuthn API response to a `navigator.credentials.get()` call.
*Note*: The Webauthn API uses binary data represented by ArrayBuffers for certain input/output values.
The Hanko API returns these values as base64url-encoded, so they must be converted to ArrayBuffers
when passed to the Webauthn API. Similarly, Webauthn API output must be converted to base64url-encoded values
when passed to the Hanko API (e.g. using the [webauthn-json](https://github.com/github/webauthn-json) library).
operationId: webauthnLoginFinal
tags:
- WebAuthn
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PublicKeyCredentialAssertionResponse'
responses:
'200':
description: 'Successful login'
headers:
X-Auth-Token:
description: |
Present only when enabled via [configuration](https://github.com/teamhanko/hanko/blob/main/backend/docs/Config.md#hanko-backend-config) option `session.enable_auth_token_header`
for purposes of cross-domain communication between client and Hanko API.
schema:
$ref: '#/components/schemas/X-Auth-Token'
X-Session-Lifetime:
description: |
Contains the seconds until the session expires.
schema:
$ref: '#/components/schemas/X-Session-Lifetime'
Set-Cookie:
description: |
Contains the JSON Web Token (JWT) that must be provided to protected endpoints.
Cookie attributes (e.g. domain) can be set via [configuration](https://github.com/teamhanko/hanko/blob/main/backend/docs/Config.md#hanko-backend-config) option `session.cookie`.
schema:
$ref: '#/components/schemas/CookieSession'
content:
application/json:
schema:
$ref: '#/components/schemas/WebauthnLoginResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalServerError'
/webauthn/registration/initialize:
post:
summary: 'Initialize WebAuthn registration'
description: |
Initialize a registration with Webauthn. Returns a JSON representation of CredentialCreationOptions for use
with the Webauthn API's `navigator.credentials.create()`.
*Note*: The Webauthn API uses binary data represented by ArrayBuffers for certain input/output values.
The Hanko API returns these values as base64url-encoded, so they must be converted to ArrayBuffers
when passed to the Webauthn API. Similarly, Webauthn API output must be converted to base64url-encoded values
when passed to the Hanko API (e.g. using the [webauthn-json](https://github.com/github/webauthn-json) library).
operationId: webauthnRegInit
tags:
- WebAuthn
security:
- CookieAuth: [ ]
- BearerTokenAuth: [ ]
responses:
'200':
description: 'Challenge'
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialCreationOptions'
'400':
$ref: '#/components/responses/BadRequest'
'422':
$ref: '#/components/responses/unprocessableEntity'
'500':
$ref: '#/components/responses/InternalServerError'
/webauthn/registration/finalize:
post:
summary: 'Finalize WebAuthn registration'
description: |
Finalize a registration with Webauthn using the WebAuthn API response to a `navigator.credentials.create()` call.
*Note*: The Webauthn API uses binary data represented by ArrayBuffers for certain input/output values.
The Hanko API returns these values as base64url-encoded, so they must be converted to ArrayBuffers
when passed to the Webauthn API. Similarly, Webauthn API output must be converted to base64url-encoded values
when passed to the Hanko API (e.g. using the [webauthn-json](https://github.com/github/webauthn-json) library).
operationId: webauthnRegFinal
tags:
- WebAuthn
security:
- CookieAuth: [ ]
- BearerTokenAuth: [ ]
requestBody:
description: "Challenge response"
content:
application/json:
schema:
$ref: '#/components/schemas/PublicKeyCredentialAttestationResponse'
responses:
'200':
description: 'Successful registration'
content:
application/json:
schema:
type: object
properties:
credential_id:
description: The ID of the created credential
type: string
format: base64
user_id:
description: The ID of the user on whose behalf a credential was created
allOf:
- $ref: '#/components/schemas/UUID4'
'400':
$ref: '#/components/responses/BadRequest'
'500':
$ref: '#/components/responses/InternalServerError'
/webauthn/credentials:
get:
summary: 'Get a list of WebAuthn credentials'
description: |
Returns a list of WebAuthn credentials assigned to the current user.
operationId: listCredentials
tags:
- WebAuthn
security:
- CookieAuth: [ ]
- BearerTokenAuth: [ ]
responses:
'200':
description: 'A list of WebAuthn credentials assigned to the current user'
content:
application/json:
schema:
$ref: '#/components/schemas/WebauthnCredentials'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalServerError'
/webauthn/credentials/{id}:
patch:
summary: 'Updates a WebAuthn credential'
description: |
Updates the specified WebAuthn credential. Only credentials assigned to the current user can be updated.
operationId: updateCredential
tags:
- WebAuthn
security:
- CookieAuth: [ ]
- BearerTokenAuth: [ ]
parameters:
- name: id
in: path
description: ID of the WebAuthn credential
required: true
schema:
$ref: '#/components/schemas/UUID4'
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
description: "A new credential name. Has no technical meaning, only serves as an identification aid for the user."
type: string
responses:
'200':
description: 'Credential updated successfully'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
delete:
summary: 'Deletes a WebAuthn credential'
description: |
Deletes the specified WebAuthn credential.
operationId: deleteCredential
tags:
- WebAuthn
security:
- CookieAuth: [ ]
- BearerTokenAuth: [ ]
parameters:
- name: id
in: path
description: ID of the WebAuthn credential
required: true
schema:
$ref: '#/components/schemas/UUID4'
responses:
'201':
description: 'Credential updated successfully'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/.well-known/jwks.json:
get:
summary: 'Get JSON Web Key Set'
description: |
Retrieve a [JSON Web Key Set](https://www.rfc-editor.org/rfc/rfc7517#section-5) (JWKS) object containing the public `keys` used to verify
JSON Web Tokens (JWT) issued by the Hanko API and signed using the RS256 signing algorithm.
operationId: getJwks
tags:
- .well-known
responses:
'200':
description: 'JSON Web Key Set'
content:
application/json:
schema:
$ref: '#/components/schemas/JSONWebKeySet'
'500':
$ref: '#/components/responses/InternalServerError'
/.well-known/config:
get:
summary: 'Get public Hanko configuration'
description: |
Retrieve public backend configuration options.
Useful for example for conditionally constructing a UI based on the options (e.g. don't show password
inputs when they are disabled).
operationId: getConfig
tags:
- .well-known
responses:
'200':
description: 'Hanko configuration'
content:
application/json:
schema:
$ref: '#/components/schemas/HankoConfiguration'
/thirdparty/auth:
get:
summary: 'Initialize third party login'
description: |
Initialize an OAuth-backed (authorization code grant type) login with a third party provider by redirecting to
the specified provider login URL to retrieve an authorization code.
operationId: thirdPartyAuth
tags:
- Third Party
parameters:
- in: query
name: provider
required: true
schema:
type: string
enum:
- google
- github
description: |
The name of the third party provider to log in with. Only providers enabled in the
[configuration](https://github.com/teamhanko/hanko/blob/main/backend/docs/Config.md#hanko-backend-config)
via the `thirdparty.providers` option can be used. Requesting an unsupported provider results in a
redirect with error details in the location query.
- in: query
name: redirect_to
required: true
schema:
type: string
format: base64url
description: |
Base64url encoded string representing the URL the
[`/callback`](#tag/Third-Party/operation/thirdPartyCallback) eventually redirects to after successful login
with the third party provider. It must match one of the allowed redirect URLs set in the backend
[configuration](https://github.com/teamhanko/hanko/blob/main/backend/docs/Config.md#hanko-backend-config)
through the `third_party.allowed_redirect_urls`.
responses:
'307':
description: 'Redirect to third party provider'
headers:
Location:
schema:
type: string
description: |
Redirect to the third party provider on success. On error, redirects to the `Referer`. If `Referer` is
not present, redirects to the `third_party.error_redirect_url` set in the backend
[configuration](https://github.com/teamhanko/hanko/blob/main/backend/docs/Config.md#hanko-backend-config).
Error details are provided in the location URL in the form of `error` and `error_description`
query params.
/thirdparty/callback:
get:
summary: 'Third party provider callback'
description: Callback endpoint called by the third party provider after successful login.
operationId: thirdPartyCallback
tags:
- Third Party
parameters:
- in: query
name: code
schema:
type: string
description: |
The authorization code that can be exchanged for an access token and to retrieve user provider data
- in: query
name: state
required: true
schema:
type: string
description: The state
- in: query
name: error
schema:
type: string
description: |
An error returned from the third party provider
- in: query
name: error_description
schema:
type: string
description: The description of the error that occurred (if any)
responses:
'307':
description: 'Redirect to requested redirect URL or to configured site redirect URL'
headers:
Location:
schema:
type: string
description: |
Redirect to the URL requested via `redirect_to` query parameter during third party
provider login via [`/auth`](#tag/Third-Party/operation/thirdPartyAuth) endpoint on success. On error,
redirect to the `third_party.error_redirect_url` set in the backend
[configuration](https://github.com/teamhanko/hanko/blob/main/backend/docs/Config.md#hanko-backend-config).
Error details are provided in the location URL in the form of `error` and `error_description`
query params.
X-Auth-Token:
description: |
Present only on successful callback and when enabled via [configuration](https://github.com/teamhanko/hanko/blob/main/backend/docs/Config.md#hanko-backend-config) option `session.enable_auth_token_header`
for purposes of cross-domain communication between client and Hanko API.
schema:
$ref: '#/components/schemas/X-Auth-Token'
Set-Cookie:
description: |
Present only on successful callback. Contains the JSON Web Token (JWT) that must be provided to protected endpoints.
Cookie attributes (e.g. domain) can be set via [configuration](https://github.com/teamhanko/hanko/blob/main/backend/docs/Config.md#hanko-backend-config) option `session.cookie`.
schema:
$ref: '#/components/schemas/CookieSession'
/token:
post:
summary: 'Exchange one time token for session'
description: |
Provide a one time token (e.g. obtained through the [thirdparty callback](#tag/Third-Party/operation/thirdPartyCallback)) to retrieve a session JWT as cookie
and/or via `X-Auth-Token` header.
operationId: token
tags:
- Token
requestBody:
content:
application/json:
schema:
type: object
properties:
value:
type: string
format: base64url
responses:
'200':
description: Successful token exchange
headers:
X-Auth-Token:
description: |
Present only on successful exchange and when enabled via [configuration](https://github.com/teamhanko/hanko/blob/main/backend/docs/Config.md#hanko-backend-config) option `session.enable_auth_token_header`
for purposes of cross-domain communication between client and Hanko API.
schema:
$ref: '#/components/schemas/X-Auth-Token'
X-Session-Lifetime:
description: |
Contains the seconds until the session expires.
schema:
$ref: '#/components/schemas/X-Session-Lifetime'
Set-Cookie:
description: |
Present only on successful exchange. Contains the JSON Web Token (JWT) that must be provided to protected endpoints.
Cookie attributes (e.g. domain) can be set via [configuration](https://github.com/teamhanko/hanko/blob/main/backend/docs/Config.md#hanko-backend-config) option `session.cookie`.
schema:
$ref: '#/components/schemas/CookieSession'
content:
application/json:
schema:
type: object
properties:
user_id:
description: The ID of the user on whose behalf the token was exchanged.
allOf:
- $ref: '#/components/schemas/UUID4'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/unprocessableEntity'
'429':
$ref: '#/components/responses/TooManyRequests'
/user:
post:
summary: 'Get user details by email'
description: Retrieve details for user corresponding to the given `email`.
operationId: getUserId
tags:
- User Management
requestBody:
content:
application/json:
schema:
type: object
properties:
email:
type: string
format: email
responses:
'200':
description: 'User'
content:
application/json:
schema:
type: object
properties:
id:
$ref: '#/components/schemas/UUID4'
email_id:
$ref: '#/components/schemas/UUID4'
verified:
type: boolean
has_webauthn_credential:
type: boolean
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
delete:
summary: 'Deletes the current user'
description: Used to delete the current user. Note that `config.account.allow_deletion` must be set to true.
operationId: deleteUser
tags:
- User Management
security:
- CookieAuth: [ ]
- BearerTokenAuth: [ ]
responses:
'204':
description: 'The user has been deleted'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalServerError'
/me:
get:
summary: 'Get the current user ID'
description: Retrieve the user ID for the current user (i.e. the subject of the JWT).
operationId: IsUserAuthorized
tags:
- User Management
security:
- CookieAuth: [ ]
- BearerTokenAuth: [ ]
responses:
'200':
description: 'User'
content:
application/json:
schema:
type: object
properties:
id:
description: The id of the current user
allOf:
- $ref: '#/components/schemas/UUID4'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalServerError'
/logout:
post:
summary: "Log out the current user"
description: "Logs out the user by removing the authorization cookie."
operationId: logout
tags:
- User Management
security:
- CookieAuth: [ ]
- BearerTokenAuth: [ ]
responses:
'204':
description: 'The user has been logged out'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalServerError'
/users:
post:
summary: 'Create a user'
description: Used to create a new user. To disable this endpoint, `config.account.allow_signup` must be set to false.
operationId: createUser
tags:
- User Management
requestBody:
content:
application/json:
schema:
type: object
properties:
email:
type: string
format: email
required:
- email
responses:
'200':
description: 'Details about the created user'
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUserResponse'
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/Forbidden'
'409':
$ref: '#/components/responses/Conflict'
'500':
$ref: '#/components/responses/InternalServerError'
/users/{id}:
get:
summary: 'Get a user by ID'
operationId: listUser
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'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
/emails:
get:
summary: 'Get a list of emails of the current user.'
operationId: listEmails
tags:
- Email Management
security:
- CookieAuth: [ ]
- BearerTokenAuth: [ ]
responses:
'200':
description: 'A list of emails assigned to the current user'
content:
application/json:
schema:
$ref: '#/components/schemas/Emails'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalServerError'
post:
summary: 'Add a new email address to the current user.'
operationId: createEmail
tags:
- Email Management
security:
- CookieAuth: [ ]
- BearerTokenAuth: [ ]
requestBody:
content:
application/json:
schema:
type: object
properties:
address:
type: string
format: email
required:
- address
responses:
'201':
description: 'Email successfully added'
'400':
$ref: '#/components/responses/BadRequest'
'409':
$ref: '#/components/responses/Conflict'
'500':
$ref: '#/components/responses/InternalServerError'
/emails/{id}/set_primary:
post:
summary: 'Marks the email address as primary email'
operationId: setPrimaryEmail
tags:
- Email Management
security:
- CookieAuth: [ ]
- BearerTokenAuth: [ ]
parameters:
- name: id
in: path
description: ID of the email address
required: true
schema:
$ref: '#/components/schemas/UUID4'
responses:
'201':
description: 'Email has been set as primary'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalServerError'
/emails/{id}:
delete:
summary: 'Delete an email address'
operationId: deleteEmail
tags:
- Email Management
security:
- CookieAuth: [ ]
- BearerTokenAuth: [ ]
parameters:
- name: id
in: path
description: ID of the email address
required: true
schema:
$ref: '#/components/schemas/UUID4'
responses:
'201':
description: 'Email has been deleted'
'401':
$ref: '#/components/responses/Unauthorized'
'409':
$ref: '#/components/responses/Conflict'
'500':
$ref: '#/components/responses/InternalServerError'
components:
responses:
BadRequest:
description: Bad Request