-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathspec_v2.yaml
More file actions
2396 lines (2243 loc) · 61.4 KB
/
spec_v2.yaml
File metadata and controls
2396 lines (2243 loc) · 61.4 KB
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
# Todos
#
# - Add examples
openapi: 3.0.3
###################################################################
# General #
###################################################################
info:
version: 2.0.4
title: Corbado Frontend API
description: Overview of all Corbado Frontend API calls to implement passwordless authentication.
contact:
name: Corbado team
email: support@corbado.com
url: https://www.corbado.com
servers:
- url: https://{projectId}.frontendapi.corbado.io
variables:
projectId:
description: Your Corbado project ID
default: pro-000000
tags:
- name: Auth
description: All API calls that are related to an authentication process.
- name: Configs
description: All API calls to manage configurations
- name: Users
description: All API calls to manage users
- name: CorbadoConnect
description: All API calls that are related to a connect process
- name: OIDC
description: All API calls that are related to OpenID Connect
paths:
/v2/process-config:
get:
summary: Retrieve process configuration
description: Retrieves the process configuration settings.
operationId: GetProcessConfig
tags:
- Configs
responses:
"200":
description: Process configuration settings.
content:
application/json:
schema:
$ref: "#/components/schemas/processConfigRsp"
/v2/session-config:
get:
summary: Retrieve session configuration
description: Retrieves the session configuration settings.
operationId: GetSessionConfig
tags:
- Configs
responses:
"200":
description: Session configuration settings.
content:
application/json:
schema:
$ref: "#/components/schemas/sessionConfigRsp"
/v2/user-details-config:
get:
summary: Retrieve user details configuration
description: Retrieves user details configuration needed by the UserDetails component.
operationId: GetUserDetailsConfig
tags:
- Configs
responses:
"200":
description: User details configuration.
content:
application/json:
schema:
$ref: "#/components/schemas/userDetailsConfigRsp"
/v2/me:
get:
summary: Retrieve current user
description: |
Retrieves data of currently logged in user including their [login identifiers](/api-reference/backend-api/loginidentifiers/create-a-login-identifier-for-a-user) and [social logins](/api-reference/backend-api/users/create-a-social-login-for-a-user).
operationId: CurrentUserGet
tags:
- Users
responses:
"200":
description: tbd
content:
application/json:
schema:
$ref: "#/components/schemas/meRsp"
patch:
summary: Update current User
description: |
Updates data of currently logged in user.
operationId: CurrentUserUpdate
tags:
- Users
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/meUpdateReq"
responses:
"200":
$ref: "#/components/responses/200"
delete:
summary: Delete current user
description: |
Deletes currently logged in user.
operationId: CurrentUserDelete
tags:
- Users
responses:
"200":
$ref: "#/components/responses/200"
/v2/me/passkeys:
get:
summary: List all user passkeys
description: |
Returns a list of passkeys for the currently logged in user.
operationId: CurrentUserPasskeyGet
tags:
- Users
responses:
"200":
description: tbd
content:
application/json:
schema:
$ref: "#/components/schemas/mePasskeyRsp"
/v2/me/passkeys/append/start:
post:
summary: Start passkey append
description: |
Starts passkey append for currently logged in user.
operationId: CurrentUserPasskeyAppendStart
tags:
- Users
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/mePasskeysAppendStartReq"
responses:
"200":
description: tbd
content:
application/json:
schema:
$ref: "#/components/schemas/mePasskeysAppendStartRsp"
/v2/me/passkeys/append/finish:
post:
summary: Finish passkey append
description: |
Finishes passkey append for currently logged in user.
operationId: CurrentUserPasskeyAppendFinish
tags:
- Users
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/mePasskeysAppendFinishReq"
responses:
"200":
description: tbd
/v2/me/passkeys/{credentialID}:
delete:
summary: Delete user passkey
description: |
Deletes a passkey for the currently logged in user.
operationId: CurrentUserPasskeyDelete
tags:
- Users
parameters:
- in: path
required: true
name: credentialID
schema:
type: string
description: Unique identifier of the passkey.
example: "cre-940364795071150919"
responses:
"200":
description: tbs
content:
application/json:
schema:
$ref: "#/components/schemas/mePasskeyDeleteRsp"
/v2/me/refresh:
post:
summary: Refresh user session
description: |
Performs session refresh of currently logged in user. Issues a new session-token if session is still valid.
Manage users sessions in the [Developer Panel](https://app.corbado.com/users/sessions) or consult the [Documentation](https://docs.corbado.com/corbado-complete/sessions/overview) for more details.
operationId: CurrentUserSessionRefresh
tags:
- Users
responses:
"200":
description: tbd
content:
application/json:
schema:
$ref: "#/components/schemas/meRefreshRsp"
/v2/me/logout:
post:
summary: Logout user
description: |
Performs session logout of currently logged in user.
Manage users sessions in the [Developer Panel](https://app.corbado.com/users/sessions) or consult the [Documentation](https://docs.corbado.com/corbado-complete/sessions/overview) for more details.
operationId: CurrentUserSessionLogout
tags:
- Users
responses:
"204":
description: tbd
/v2/me/identifier:
post:
summary: Create login identifier
description: |
Creates a login identifier for the currently logged in user.
operationId: CurrentUserIdentifierCreate
tags:
- Users
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/meIdentifierCreateReq"
responses:
"200":
$ref: "#/components/responses/200"
delete:
summary: Delete login identifier
description: |
Deletes a login identifier for the currently logged in user.
operationId: CurrentUserIdentifierDelete
tags:
- Users
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/meIdentifierDeleteReq"
responses:
"200":
$ref: "#/components/responses/200"
patch:
summary: Update login identifier
description: |
Updates a login identifier for the currently logged in user.
operationId: CurrentUserIdentifierUpdate
tags:
- Users
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/meIdentifierUpdateReq"
responses:
"200":
$ref: "#/components/responses/200"
/v2/me/identifier/verify/start:
post:
summary: Start login identifier verification
description: |
Starts login identifer verification of currently logged in user.
operationId: CurrentUserIdentifierVerifyStart
tags:
- Users
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/meIdentifierVerifyStartReq"
responses:
"200":
$ref: "#/components/responses/200"
/v2/me/identifier/verify/finish:
post:
summary: Finish login identifier verification
description: |
Finishes login identifer verification of currently logged in user.
operationId: CurrentUserIdentifierVerifyFinish
tags:
- Users
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/meIdentifierVerifyFinishReq"
responses:
"200":
$ref: "#/components/responses/200"
/v2/auth/process/init:
post:
summary: Initialize authentication process
description: Initializes a new authentication process.
operationId: ProcessInit
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/processInitReq"
responses:
"200":
description: tbd
content:
application/json:
schema:
$ref: "#/components/schemas/processInitRsp"
/v2/auth/process:
get:
summary: Retrieve authentication process
description: Retrieves the current authentication process state.
operationId: ProcessGet
tags:
- Auth
parameters:
- in: query
required: false
name: preferredBlock
schema:
$ref: "#/components/schemas/blockType"
responses:
"200":
description: tbd
content:
application/json:
schema:
$ref: "#/components/schemas/processResponse"
/v2/auth/process/complete:
post:
summary: Complete authentication process
description: Completes the current authentication process.
operationId: ProcessComplete
tags:
- Auth
responses:
"200":
description: tbd
content:
application/json:
schema:
$ref: "#/components/schemas/processResponse"
/v2/auth/process/reset:
post:
summary: Reset authentication process
description: Resets the current authentication process.
operationId: ProcessReset
tags:
- Auth
responses:
"200":
description: tbd
content:
application/json:
schema:
$ref: "#/components/schemas/processResponse"
/v2/auth/signup/init:
post:
summary: Initialize signup
description: Initializes a new user signup process.
operationId: SignupInit
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/signupInitReq"
responses:
"200":
description: tbd
content:
application/json:
schema:
$ref: "#/components/schemas/processResponse"
/v2/auth/login/init:
post:
summary: Initialize login
description: Initializes a new login process.
operationId: LoginInit
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/loginInitReq"
responses:
"200":
description: tbd
content:
application/json:
schema:
$ref: "#/components/schemas/processResponse"
/v2/auth/block/skip:
post:
summary: Skip authentication block
description: Skips the current authentication block.
operationId: BlockSkip
tags:
- Auth
responses:
"200":
description: tbd
content:
application/json:
schema:
$ref: "#/components/schemas/processResponse"
/v2/auth/passkey/append/start:
post:
summary: Start passkey append
description: Starts the process of appending a new passkey.
operationId: PasskeyAppendStart
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/passkeyAppendStartReq"
responses:
"200":
description: tbd
content:
application/json:
schema:
$ref: "#/components/schemas/processResponse"
/v2/auth/passkey/append/finish:
post:
summary: Finish passkey append
description: Completes the process of appending a new passkey.
operationId: PasskeyAppendFinish
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/passkeyAppendFinishReq"
responses:
"200":
description: tbd
content:
application/json:
schema:
$ref: "#/components/schemas/processResponse"
/v2/auth/passkey/login/start:
post:
summary: Start passkey login
description: Initiates the passkey login process.
operationId: PasskeyLoginStart
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/passkeyLoginStartReq"
responses:
"200":
description: tbd
content:
application/json:
schema:
$ref: "#/components/schemas/processResponse"
/v2/auth/passkey/login/finish:
post:
summary: Finish passkey login
description: Completes the passkey login process.
operationId: PasskeyLoginFinish
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/passkeyLoginFinishReq"
responses:
"200":
description: tbd
content:
application/json:
schema:
$ref: "#/components/schemas/processResponse"
/v2/auth/passkey/mediation/finish:
post:
summary: Finish passkey mediation
description: Completes the passkey mediation process.
operationId: PasskeyMediationFinish
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/passkeyMediationFinishReq"
responses:
"200":
description: tbd
content:
application/json:
schema:
$ref: "#/components/schemas/processResponse"
/v2/auth/identifier/verify/start:
post:
summary: Start identifier verification
description: Initiates the identifier verification process.
operationId: IdentifierVerifyStart
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/identifierVerifyStartReq"
responses:
"200":
description: tbd
content:
application/json:
schema:
$ref: "#/components/schemas/processResponse"
/v2/auth/identifier/verify/finish:
post:
summary: Finish identifier verification
description: Completes the identifier verification process.
operationId: IdentifierVerifyFinish
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/identifierVerifyFinishReq"
responses:
"200":
description: tbd
content:
application/json:
schema:
$ref: "#/components/schemas/processResponse"
/v2/auth/identifier/verify/status:
get:
summary: Retrieve identifier verification status
description: Retrieves the current status of identifier verification.
operationId: IdentifierVerifyStatus
tags:
- Auth
responses:
"200":
description: tbd
content:
application/json:
schema:
$ref: "#/components/schemas/processResponse"
/v2/auth/identifier/update:
post:
summary: Update identifier
description: Updates the user's identifier information.
operationId: IdentifierUpdate
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/identifierUpdateReq"
responses:
"200":
description: tbd
content:
application/json:
schema:
$ref: "#/components/schemas/processResponse"
/v2/auth/social/verify/start:
post:
summary: Start social verification
description: Initiates the social authentication verification process.
operationId: SocialVerifyStart
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/socialVerifyStartReq"
responses:
"200":
description: tbd
content:
application/json:
schema:
$ref: "#/components/schemas/processResponse"
/v2/auth/social/verify/callback:
get:
summary: Social verification callback
description: Handles the callback from social authentication providers.
operationId: SocialVerifyCallback
tags:
- Auth
responses:
"200":
description: tbd
/v2/auth/social/verify/finish:
post:
summary: Finish social verification
description: Completes the social authentication verification process.
operationId: SocialVerifyFinish
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/socialVerifyFinishReq"
responses:
"200":
description: tbd
content:
application/json:
schema:
$ref: "#/components/schemas/processResponse"
/v2/auth/events:
post:
summary: Create authentication event
description: Creates a new user generated complete event.
operationId: EventCreate
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/eventCreateReq"
responses:
"204":
description: tbd
/v2/connect/login/init:
post:
summary: Initialize connect login
description: Initializes a [Corbado Connect](https://docs.corbado.com/corbado-connect) process for login.
operationId: ConnectLoginInit
tags:
- CorbadoConnect
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/connectLoginInitReq"
responses:
"200":
description: Contains information about if and how a passkey login can be started.
content:
application/json:
schema:
$ref: "#/components/schemas/connectLoginInitRsp"
/v2/connect/login/start:
post:
summary: Start connect login
description: Starts an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) login process.
operationId: ConnectLoginStart
tags:
- CorbadoConnect
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/connectLoginStartReq"
responses:
"200":
description: Contains the challenge for the passkey login.
content:
application/json:
schema:
$ref: "#/components/schemas/connectLoginStartRsp"
"404":
description: No user was found for the identifier
/v2/connect/login/finish:
post:
summary: Finish connect login
description: Finishes an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) login process.
operationId: ConnectLoginFinish
tags:
- CorbadoConnect
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/connectLoginFinishReq"
responses:
"200":
description: Data about the passkey login and the session.
content:
application/json:
schema:
$ref: "#/components/schemas/connectLoginFinishRsp"
"404":
description: No credential was found for the identifier
/v2/connect/append/init:
post:
summary: Initialize connect append
description: Initializes a [Corbado Connect](https://docs.corbado.com/corbado-connect) process for passkey append.
operationId: ConnectAppendInit
tags:
- CorbadoConnect
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/connectAppendInitReq"
responses:
"200":
description: Contains information about if and how a passkey append can be started.
content:
application/json:
schema:
$ref: "#/components/schemas/connectAppendInitRsp"
/v2/connect/append/start:
post:
summary: Start connect append
description: Starts an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) passkey append process.
operationId: ConnectAppendStart
tags:
- CorbadoConnect
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/connectAppendStartReq"
responses:
"200":
description: Contains the challenge for the passkey append.
content:
application/json:
schema:
$ref: "#/components/schemas/connectAppendStartRsp"
/v2/connect/append/finish:
post:
summary: Finish connect append
description: Finishes an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) passkey append process.
operationId: ConnectAppendFinish
tags:
- CorbadoConnect
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/connectAppendFinishReq"
responses:
"200":
description: Data about the new passkey.
content:
application/json:
schema:
$ref: "#/components/schemas/connectAppendFinishRsp"
/v2/connect/manage/init:
post:
summary: Initialize connect management
description: Initializes a [Corbado Connect](https://docs.corbado.com/corbado-connect) process for passkey management.
operationId: ConnectManageInit
tags:
- CorbadoConnect
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/connectManageInitReq"
responses:
"200":
description: Contains information about if and how passkey management can be started.
content:
application/json:
schema:
$ref: "#/components/schemas/connectManageInitRsp"
/v2/connect/manage/delete:
post:
summary: Delete connect passkey
description: Deletes a passkey for a user identified by a [Corbado Connect](https://docs.corbado.com/corbado-connect) token.
operationId: ConnectManageDelete
tags:
- CorbadoConnect
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/connectManageDeleteReq"
responses:
"200":
description: Contains the ID of the deleted passkey.
content:
application/json:
schema:
$ref: "#/components/schemas/connectManageDeleteRsp"
/v2/connect/manage/list:
post:
summary: List connect passkeys
description: Lists all passkeys for a user identifier by a [Corbado Connect](https://docs.corbado.com/corbado-connect) token.
operationId: ConnectManageList
tags:
- CorbadoConnect
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/connectManageListReq"
responses:
"200":
description: Contains all passkeys for a user.
content:
application/json:
schema:
$ref: "#/components/schemas/connectManageListRsp"
/v2/connect/events:
post:
summary: Create connect event
description: Creates a new user generated [Corbado Connect](https://docs.corbado.com/corbado-connect) event.
operationId: ConnectEventCreate
tags:
- CorbadoConnect
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/connectEventCreateReq"
responses:
"204":
description: tbd
/v2/connect/process/clear:
post:
summary: Clear connect process
description: Remove process state for a [Corbado Connect](https://docs.corbado.com/corbado-connect) process.
operationId: ConnectProcessClear
tags:
- CorbadoConnect
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/connectProcessClearReq"
responses:
"200":
description: Contains information about the process state.
content:
application/json:
schema:
$ref: "#/components/schemas/connectProcessClearRsp"
"404":
description: No process was found for the token
/v2/oidc/userInfo:
get:
summary: OIDC user info
description: Retrieves user information in accordance with the OpenID Connect (OIDC) standard.
operationId: OIDCUserInfoGet
tags:
- OIDC
responses:
"200":
description: User information as per OIDC standard.
content:
application/json:
schema:
$ref: "#/components/schemas/oidcUserInfoRsp"
"401":
description: Unauthorized - Invalid or missing token
components:
###################################################################
# Security schemes #
###################################################################
securitySchemes:
basicAuth:
type: http
scheme: basic
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: |
After a user logs in successfully, a session is created and a JWT token is returned.
This token represents the user's authenticated session.
It must be included in the `Authorization` header as a Bearer token for all protected endpoints:
`Authorization: Bearer <your-token>`
The server will validate this token to authorize access.
projectID:
type: apiKey
in: header
name: X-Corbado-ProjectID
description: |
Identifies your project context for Corbado.
Include this in the request headers as:
`X-Corbado-ProjectID: <your-project-id>`
schemas:
processInitReq:
type: object
description: tbd.
required:
- clientInformation
properties:
clientInformation:
$ref: "#/components/schemas/clientInformation"
passkeyAppendShown:
type: integer
format: int64
optOutOfPasskeyAppendAfterHybrid:
type: boolean
description: deprecated
preferredBlock: