generated from mintlify/starter
-
Notifications
You must be signed in to change notification settings - Fork 15
/
Copy pathopenapi-flow.yaml
3015 lines (2994 loc) · 96.5 KB
/
openapi-flow.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.3
info:
title: Flow API
description: Flow API
version: 1.2.0
servers:
- url: "https://{tenant_id}.hanko.io"
variables:
tenant_id:
default: "default"
description: "Tenant ID to be provided by the user"
paths:
/registration:
post:
tags:
- flow
description: Initialize or advance a registration flow.
summary: Registration
parameters:
- $ref: "#/components/parameters/ActionParam"
- $ref: "#/components/parameters/LanguageParam"
requestBody:
$ref: "#/components/requestBodies/RegistrationRequestBody"
responses:
200:
$ref: "#/components/responses/RegistrationFlowResponse"
400:
$ref: "#/components/responses/RegistrationFlowResponseBadRequestError"
401:
$ref: "#/components/responses/FlowResponseUnauthorizedError"
403:
$ref: "#/components/responses/FlowResponseForbiddenError"
410:
$ref: "#/components/responses/FlowResponseGoneError"
429:
$ref: "#/components/responses/FlowResponseTooManyRequestsError"
500:
$ref: "#/components/responses/FlowResponseInternalServerError"
/login:
post:
tags:
- flow
description: Initialize or advance a login flow.
summary: Login
parameters:
- $ref: "#/components/parameters/ActionParam"
- $ref: "#/components/parameters/LanguageParam"
requestBody:
$ref: "#/components/requestBodies/LoginRequestBody"
responses:
200:
$ref: "#/components/responses/LoginFlowResponse"
400:
$ref: "#/components/responses/LoginFlowResponseBadRequestError"
401:
$ref: "#/components/responses/FlowResponseUnauthorizedError"
403:
$ref: "#/components/responses/FlowResponseForbiddenError"
410:
$ref: "#/components/responses/FlowResponseGoneError"
429:
$ref: "#/components/responses/FlowResponseTooManyRequestsError"
500:
$ref: "#/components/responses/FlowResponseInternalServerError"
/profile:
post:
tags:
- flow
description: Initialize or advance a profile flow.
summary: Profile
security:
- CookieAuth: []
- BearerTokenAuth: []
parameters:
- $ref: "#/components/parameters/ActionParam"
- $ref: "#/components/parameters/LanguageParam"
requestBody:
$ref: "#/components/requestBodies/ProfileRequestBody"
responses:
200:
$ref: "#/components/responses/ProfileFlowResponse"
400:
$ref: "#/components/responses/ProfileFlowResponseBadRequestError"
401:
$ref: "#/components/responses/FlowResponseUnauthorizedError"
403:
$ref: "#/components/responses/FlowResponseForbiddenError"
404:
$ref: "#/components/responses/FlowResponseNotFoundError"
410:
$ref: "#/components/responses/FlowResponseGoneError"
429:
$ref: "#/components/responses/FlowResponseTooManyRequestsError"
500:
$ref: "#/components/responses/FlowResponseInternalServerError"
components:
securitySchemes:
CookieAuth:
type: apiKey
in: cookie
name: hanko
BearerTokenAuth:
type: http
scheme: bearer
bearerFormat: JWT
parameters:
ActionParam:
in: query
name: action
description: |
String of the format `{action_name}@{flow_id}`. Indicates the action to perform on the flow with the
given `flow_id`. Omitting the query parameter initializes a new flow.
_Note for playground usage_: You can derive the value for this query parameter from the `action`'s `href`
property in a flow state response, e.g. for an `href` value of
`/login?action=register_client_capabilities%4015655672-41ca-48cc-afb1-90be77075764` the (non-URL-encoded) value
would be `register_client_capabilities@15655672-41ca-48cc-afb1-90be77075764`.
schema:
type: string
example: register_client_capabilities@15655672-41ca-48cc-afb1-90be77075764
LanguageParam:
in: header
name: X-Language
schema:
type: string
description: |
Used to internationalize outgoing emails (e.g. for email verification, recovery, etc.).
If email delivery by Hanko is enabled the values for supported languages are:
- "bn" (Bengali/Bangla)
- "de" (German)
- "en" (English)
- "fr" (French)
- "it" (Italian)
- "pt-BR" (Brazilian Portuguese),
- "zh" (Chinese)
If email delivery by Hanko is disabled and a webhook has been configured for the `email.send` event, the
JWT payload of the `token` contained in the response to the webhook endpoint contains a `language` claim that
reflects the value originally passed as the header value.
schemas:
Action:
description: Action
type: object
properties:
action:
description: The name of the action.
type: string
href:
description: The action target as a URL relative to the API tenant base URL.
type: string
description:
description: The description for the action.
type: string
inputs:
description: |
The inputs for the action.
An input indicates that when making a request to perform an action, the `input_data` value of the
request body must contain a key with the given `name` value of the respective input. The corresponding
value for that key is specified by the remaining properties of the input.
type: object
ActionAccountDelete:
description: |
Delete an account.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "account_delete"
ActionBack:
description: Go back to the previous state.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "back"
ActionContinueToLoginOTP:
description: Continue to the `login_otp` state.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "continue_to_login_otp"
ActionContinueToLoginSecurityKey:
description: Continue to the `login_security_key` state.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "continue_to_login_security_key"
ActionContinueToOTPSecretCreation:
description: Continue to the `mfa_otp_secret_creation` state.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "continue_to_otp_secret_creation"
ActionContinueToPasscodeConfirmation:
description: Continue to the `passcode_confirmation` state.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "continue_to_passcode_confirmation"
ActionContinueToPasscodeConfirmationRecovery:
description: Continue to the `passcode_confirmation` state.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "continue_to_passcode_confirmation_recovery"
ActionContinueToPasskeyRegistration:
description: Continue to the `onboarding_create_passkey` state.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "continue_to_passkey_registration"
ActionContinueToPasswordRegistration:
description: Continue to the `password_creation` state.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "continue_to_password_registration"
ActionContinueToPasswordLogin:
description: Continue to the `login_password` state.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "continue_to_password_login"
ActionContinueToSecurityKeyCreation:
description: Continue to the `mfa_security_key_creation` state.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "continue_to_security_key_creation"
ActionContinueWithLoginIdentifier:
description: Provide a login identifier (email or username).
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "continue_with_login_identifier"
inputs:
$ref: "#/components/schemas/InputsContinueWithLoginIdentifier"
ActionEmailAddressSet:
description: Set an email address.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "email_address_set"
inputs:
$ref: "#/components/schemas/InputsEmailAddressSet"
ActionEmailCreate:
description: Add an email.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "email_create"
inputs:
$ref: "#/components/schemas/InputsEmailCreate"
ActionEmailDelete:
description: Delete an email.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "email_delete"
inputs:
$ref: "#/components/schemas/InputsEmailDelete"
ActionEmailSetPrimary:
description: Set an email as the primary email.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "email_set_primary"
inputs:
$ref: "#/components/schemas/InputsEmailSetPrimary"
ActionEmailVerify:
description: Verify an email.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "email_verify"
inputs:
$ref: "#/components/schemas/InputsEmailVerify"
ActionExchangeToken:
description: Exchange a one time token after a third party authentication for a session token.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "exchange_token"
inputs:
$ref: "#/components/schemas/InputsExchangeToken"
ActionRegisterClientCapabilities:
description: Provide information about whether the client is capable of using passkeys (a.k.a. the Webauthn API).
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "register_client_capabilities"
inputs:
$ref: "#/components/schemas/InputsRegisterClientCapabilities"
ActionRegisterLoginIdentifier:
description: Register an email or username.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "register_login_identifier"
inputs:
$ref: "#/components/schemas/InputsRegisterLoginIdentifier"
ActionRegisterPassword:
description: Register a password.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "register_password"
inputs:
$ref: "#/components/schemas/InputsRegisterPassword"
ActionResendPasscode:
description: Resend a passcode.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "resend_passcode"
ActionOTPCodeVerify:
description: Verify an OTP code to set up (T)OTP MFA.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "otp_code_verify"
inputs:
$ref: "#/components/schemas/InputsOTPCodeVerify"
ActionOTPCodeValidate:
description: Validate an OTP code for use as a second factor.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "otp_code_validate"
inputs:
$ref: "#/components/schemas/InputsOTPCodeVerify"
ActionPasswordCreate:
description: Create a password.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "password_create"
inputs:
$ref: "#/components/schemas/InputsPasswordCreate"
ActionOTPSecretDelete:
description: Delete an OTP secret.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "otp_secret_delete"
ActionPasswordDelete:
description: Delete a password.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "password_delete"
ActionPasswordUpdate:
description: Update a password.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "password_update"
inputs:
$ref: "#/components/schemas/InputsPasswordUpdate"
ActionPasswordLogin:
description: Authenticate with a password.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "password_login"
inputs:
$ref: "#/components/schemas/InputsPasswordLogin"
ActionPasswordRecovery:
description: Set up a new password as part of a recovery process.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "password_recovery"
inputs:
$ref: "#/components/schemas/InputsPasswordRecovery"
ActionRememberMe:
description: |
This action determines whether a session cookie or a persistent cookie is issued on flow success.
- If the `remember_me` input is set to `true`, the flow response on flow success contains a `Set-Cookie` header
with a persistent cookie and an `X-Session-Retention` header with a `persistent` value.
- If the `remember_me` input is set to `false`, the flow response on flow success contains a `Set-Cookie` header
with a session cookie and an `X-Session-Retention` header with a `session` value.
The action is only present if the tenant's cookie retention type is set to 'prompt'.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "remember_me"
inputs:
$ref: "#/components/schemas/InputsRememberMe"
ActionThirdPartyOauth:
description: |
Initialize a third party sign-up/sign-in by specifying the `provider` (it must be enabled and configured at the
tenant) to use and the URL to redirect to (`redirect_to`) after successful authentication with the provider.
A `redirect_url` to the selected provider is placed in the `payload` of the next state (`thirdparty`).
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "thirdparty_oauth"
inputs:
$ref: "#/components/schemas/InputsThirdPartyOauth"
ActionUsernameDelete:
description: Delete a username.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "username_create"
ActionUsernameSet:
description: Set a username.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "username_set"
inputs:
$ref: "#/components/schemas/InputsUsernameSet"
ActionSecurityKeyCreate:
description: Create a security key.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "security_key_create"
ActionSecurityKeyDelete:
description: Delete a security key.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "security_key_delete"
inputs:
$ref: "#/components/schemas/InputsSecurityKeyDelete"
ActionSessionDelete:
description: Revoke a session.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "session_delete"
inputs:
$ref: "#/components/schemas/InputsSessionDelete"
ActionSkip:
description: Skip to the next state.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "skip"
ActionTrustDevice:
description: |
Execution of this action indicates that a user considers the device or browser used as trusted. As a
result, MFA (if it is enabled and the user has registered an MFA credential) is skipped for subsequent logins.
Trust persists until it explicitly expires and its expiry is not
extended on subsequent logins. Users must provide MFA again after expiry.
Generates a random device token that is returned to the client in a `Set-Cookie` header on flow success.
The action is only present in the flow response if this Cookie is not set, i.e. if no trust has been granted
or if the cookie has expired.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "trust_device"
ActionVerifyPasscode:
description: Verify a passcode.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "verify_passcode"
inputs:
$ref: "#/components/schemas/InputsVerifyPasscode"
ActionWebauthnCredentialCreate:
description: Generate passkey creation options for registering a passkey.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "webauthn_credential_create"
ActionWebauthnCredentialDelete:
description: Delete a passkey.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "webauthn_credential_delete"
inputs:
$ref: "#/components/schemas/InputsWebauthnCredentialDelete"
ActionWebauthnCredentialRename:
description: Rename a passkey.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "webauthn_credential_rename"
inputs:
$ref: "#/components/schemas/InputsWebauthnCredentialRename"
ActionWebauthnGenerateCreationOptions:
description: Generate passkey creation options for registering a passkey.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "webauthn_generate_creation_options"
ActionWebauthnGenerateRequestOptions:
description: Generate passkey request options for authenticating with a passkey.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "webauthn_generate_request_options"
ActionWebauthnVerifyAssertionResponse:
description: Verify an assertion response to complete a passkey authentication.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "webauthn_verify_assertion_response"
inputs:
$ref: "#/components/schemas/InputsWebauthnVerifyAssertionResponse"
ActionWebauthnVerifyAttestationResponse:
description: Verify an attestation response to complete a passkey registration.
allOf:
- $ref: "#/components/schemas/Action"
- type: object
properties:
action:
enum:
- "webauthn_verify_assertion_response"
inputs:
$ref: "#/components/schemas/InputsWebauthnVerifyAttestationResponse"
Actions:
description: List of actions that can be performed in the current flow state in order to advance the flow to the next state.
type: object
additionalProperties:
$ref: "#/components/schemas/Action"
ActionsDeviceTrust:
type: object
properties:
trust_device:
$ref: "#/components/schemas/ActionTrustDevice"
skip:
$ref: "#/components/schemas/ActionSkip"
back:
$ref: "#/components/schemas/ActionBack"
ActionsCredentialOnboardingChooser:
type: object
properties:
continue_to_passkey_registration:
$ref: "#/components/schemas/ActionContinueToPasskeyRegistration"
continue_to_password_registration:
$ref: "#/components/schemas/ActionContinueToPasswordRegistration"
skip:
$ref: "#/components/schemas/ActionSkip"
back:
$ref: "#/components/schemas/ActionBack"
ActionsLoginInit:
type: object
properties:
continue_with_login_identifier:
$ref: "#/components/schemas/ActionContinueWithLoginIdentifier"
webauthn_generate_request_options:
$ref: "#/components/schemas/ActionWebauthnGenerateRequestOptions"
webauthn_verify_assertion_response:
$ref: "#/components/schemas/ActionWebauthnVerifyAssertionResponse"
thirdparty_oauth:
$ref: "#/components/schemas/ActionThirdPartyOauth"
remember_me:
$ref: "#/components/schemas/ActionRememberMe"
ActionsLoginMethodChooser:
type: object
properties:
continue_to_password_login:
$ref: "#/components/schemas/ActionContinueToPasswordLogin"
continue_to_passcode_confirmation:
$ref: "#/components/schemas/ActionContinueToPasscodeConfirmation"
ActionsLoginPasskey:
type: object
properties:
webauthn_verify_assertion_response:
$ref: "#/components/schemas/ActionWebauthnVerifyAssertionResponse"
back:
$ref: "#/components/schemas/ActionBack"
ActionsLoginPassword:
type: object
properties:
password_login:
$ref: "#/components/schemas/ActionPasswordLogin"
continue_to_passcode_confirmation_recovery:
$ref: "#/components/schemas/ActionContinueToPasscodeConfirmationRecovery"
back:
$ref: "#/components/schemas/ActionBack"
ActionsLoginOTP:
type: object
properties:
otp_code_validate:
$ref: "#/components/schemas/ActionOTPCodeValidate"
continue_to_login_security_key:
$ref: "#/components/schemas/ActionContinueToLoginSecurityKey"
ActionsLoginSecurityKey:
type: object
properties:
webauthn_generate_request_options:
$ref: "#/components/schemas/ActionWebauthnGenerateRequestOptions"
continue_to_login_otp:
$ref: "#/components/schemas/ActionContinueToLoginOTP"
ActionsLoginPasswordRecovery:
type: object
properties:
password_recovery:
$ref: "#/components/schemas/ActionPasswordRecovery"
ActionsMFAMethodChooser:
type: object
properties:
back:
$ref: "#/components/schemas/ActionBack"
continue_to_otp_secret_creation:
$ref: "#/components/schemas/ActionContinueToOTPSecretCreation"
continue_to_security_key_creation:
$ref: "#/components/schemas/ActionContinueToSecurityKeyCreation"
skip:
$ref: "#/components/schemas/ActionSkip"
ActionsMFAOTPSecretCreation:
type: object
properties:
otp_code_verify:
$ref: "#/components/schemas/ActionOTPCodeVerify"
back:
$ref: "#/components/schemas/ActionBack"
ActionsMFASecurityKeyCreation:
type: object
properties:
webauthn_generate_creation_options:
$ref: "#/components/schemas/ActionWebauthnGenerateCreationOptions"
back:
$ref: "#/components/schemas/ActionBack"
ActionsOnboardingCreatePasskey:
type: object
properties:
webauthn_generate_creation_options:
$ref: "#/components/schemas/ActionWebauthnGenerateCreationOptions"
skip:
$ref: "#/components/schemas/ActionSkip"
back:
$ref: "#/components/schemas/ActionBack"
ActionsOnboardingEmail:
type: object
properties:
email_address_set:
$ref: "#/components/schemas/ActionEmailAddressSet"
skip:
$ref: "#/components/schemas/ActionSkip"
ActionsOnboardingUsername:
type: object
properties:
username_set:
type: object
properties:
action:
enum:
- "username_set"
inputs:
$ref: "#/components/schemas/InputsUsernameSet"
skip:
$ref: "#/components/schemas/ActionSkip"
ActionsOnboardingVerifyPasskeyAttestation:
type: object
properties:
webauthn_verify_attestation_response:
type: object
properties:
action:
enum:
- "webauthn_verify_attestation_response"
inputs:
$ref: "#/components/schemas/InputsWebauthnVerifyAttestationResponse"
back:
$ref: "#/components/schemas/ActionBack"
ActionsPasscodeConfirmation:
type: object
properties:
verify_passcode:
$ref: "#/components/schemas/ActionVerifyPasscode"
resend_passcode:
$ref: "#/components/schemas/ActionResendPasscode"
back:
$ref: "#/components/schemas/ActionBack"
ActionsPasswordCreation:
type: object
properties:
register_password:
$ref: "#/components/schemas/ActionRegisterPassword"
skip:
$ref: "#/components/schemas/ActionSkip"
back:
$ref: "#/components/schemas/ActionBack"
ActionsPreflight:
type: object
properties:
register_client_capabilities:
$ref: "#/components/schemas/ActionRegisterClientCapabilities"
ActionsProfileInit:
type: object
properties:
account_delete:
$ref: "#/components/schemas/ActionAccountDelete"
continue_to_otp_secret_creation:
$ref: "#/components/schemas/ActionContinueToOTPSecretCreation"
email_create:
$ref: "#/components/schemas/ActionEmailCreate"
email_delete:
$ref: "#/components/schemas/ActionEmailDelete"
email_set_primary:
$ref: "#/components/schemas/ActionEmailSetPrimary"
email_verify:
$ref: "#/components/schemas/ActionEmailVerify"
otp_secret_delete:
$ref: "#/components/schemas/ActionOTPSecretDelete"
password_create:
$ref: "#/components/schemas/ActionPasswordCreate"
password_update:
$ref: "#/components/schemas/ActionPasswordUpdate"
password_delete:
$ref: "#/components/schemas/ActionPasswordDelete"
security_key_create:
$ref: "#/components/schemas/ActionSecurityKeyCreate"
security_key_delete:
$ref: "#/components/schemas/ActionSecurityKeyDelete"
session_delete:
$ref: "#/components/schemas/ActionSessionDelete"
username_set:
$ref: "#/components/schemas/ActionUsernameSet"
username_delete:
$ref: "#/components/schemas/ActionUsernameDelete"
webauthn_credential_rename:
$ref: "#/components/schemas/ActionWebauthnCredentialRename"
webauthn_credential_create:
$ref: "#/components/schemas/ActionWebauthnCredentialCreate"
webauthn_credential_delete:
$ref: "#/components/schemas/ActionWebauthnCredentialDelete"
ActionsRegistrationInit:
type: object
properties:
register_login_identifier:
$ref: "#/components/schemas/ActionRegisterLoginIdentifier"
thirdparty_oauth:
$ref: "#/components/schemas/ActionThirdPartyOauth"
remember_me:
$ref: "#/components/schemas/ActionRememberMe"
ActionsThirdParty:
type: object
properties:
exchange_token:
$ref: "#/components/schemas/ActionExchangeToken"
ActionsWebauthnVerifyAttestationResponse:
description: ActionsWebauthnVerifyAttestationResponse
type: object
properties:
webauthn_verify_attestation_response:
$ref: "#/components/schemas/ActionWebauthnVerifyAttestationResponse"
back:
$ref: "#/components/schemas/ActionBack"
AnyValue:
description: Can be any value - string, number, boolean, array or object.
CSRFToken:
description: |
Not required on flow initialization, i.e. on requests without an `action`
query parameter.
Required on all other requests performing an action, i.e. on requests that use an `action`
query parameter. Should be the `csrf_token` value from the most recent flow state response.
type: string
example: qvcZt29spXYO77Y9IaxxN4MzLnmbjozl
Error:
type: object
properties:
code:
type: string
message:
type: string
cause:
type: string
Input:
type: object
properties:
name:
type: string
type:
type: string
required:
type: boolean
min_length:
type: integer
max_length:
type: integer
hidden:
type: boolean
value:
type: string
allowed_values:
type: array
items:
type: object
properties:
name:
type: string
value:
$ref: "#/components/schemas/AnyValue"
InputAssertionResponse:
allOf:
- $ref: "#/components/schemas/Input"
- type: object
properties:
name:
enum:
- "assertion_response"
type:
enum:
- "json"
InputCode:
allOf:
- $ref: "#/components/schemas/Input"
- type: object
properties:
name:
enum:
- "code"
type:
enum:
- "string"
min_length:
default: 6
max_length:
default: 6
required:
default: true
hidden:
default: false
InputEmail:
title: Email
allOf:
- $ref: "#/components/schemas/Input"
- type: object
properties:
name:
type: string
enum:
- "email"
type:
type: string
enum:
- "email"
max_length:
default: 120
required:
default: true
hidden:
default: false
InputEmailId:
allOf:
- $ref: "#/components/schemas/Input"
- type: object
properties:
name:
type: string
enum:
- "email_id"
type:
type: string
enum:
- "string"
required:
default: true