Repository navigation
Expand file tree
/
Copy pathopenapi.yaml
More file actions
10905 lines (10598 loc) · 371 KB
/
Copy pathopenapi.yaml
File metadata and controls
10905 lines (10598 loc) · 371 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
openapi: 3.1.0
info:
title: OpenRisk API
version: 1.0.0
description: |
Modern, intelligent risk management platform API.
Part of the OpenDefender suite with AI-driven risk assessment, mitigation tracking, and security integration.
**Authentication**: All protected endpoints require a Bearer JWT token in the `Authorization` header.
**Base URL**: `/api/v1`
**Request bodies are never compressed**: any request whose `Content-Encoding` is
not absent or `identity` is refused with 415 before it reaches a route (see
`#/components/responses/UnsupportedContentEncoding`). This applies to every
operation below, authenticated or not.
contact:
name: OpenDefender Team
license:
name: GNU Affero General Public License v3.0 only (AGPL-3.0-only)
url: https://www.gnu.org/licenses/agpl-3.0.html
servers:
- url: /api/v1
description: Production API
tags:
- name: Health
description: Health check and status
- name: Authentication
description: Login and user management
- name: Risks
description: Risk management - create, read, update, delete risks
- name: Mitigations
description: Mitigation planning and tracking
- name: Compliance
description: Compliance frameworks, controls, and evidence (M1)
- name: Assets
description: Asset management
- name: Statistics
description: Dashboard and analytics
- name: Export
description: Data export
- name: Gamification
description: Gamification and user profiles
- name: Saved Views
description: Named filter/sort/column views of a register (#580)
- name: Scanner
description: Scan configurations and scan jobs (cloud, API and on-prem agent scans)
paths:
/health:
get:
tags:
- Health
summary: Health check
operationId: healthCheck
description: Check API health status
security: []
responses:
'200':
description: API is healthy
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: UP
version:
type: string
example: 1.0.0
db:
type: string
example: CONNECTED
'503':
description: API is running but its database is unreachable
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: DOWN
version:
type: string
example: 1.0.0
db:
type: string
example: DISCONNECTED
# ==================== AUTHENTICATION ====================
/auth/login:
post:
tags:
- Authentication
summary: Login with email and password
operationId: login
security: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LoginInput'
responses:
'200':
description: Login successful
content:
application/json:
schema:
$ref: '#/components/schemas/AuthResponse'
'400':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Invalid credentials
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: "`RATE_LIMITED` (15 per 5 minutes per IP, or the API-wide quota) or `LOGIN_LOCKED` (too many failed sign-ins for this address); both set Retry-After"
headers:
Retry-After:
schema: { type: integer }
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/RateLimitedError'
- $ref: '#/components/schemas/AuthError'
# OR26-03 — deferrable MFA enrolment. The organization-wide grace window
# after which a privileged account (admin/root, or the RSSI business role)
# must hold a second factor. Reading is open to any authenticated member —
# everyone subject to a deadline deserves to see what it is. Writing is
# admin-only and lands in the governance audit trail.
/security/mfa-policy:
get:
tags:
- Authentication
summary: Read the organization's MFA grace policy
operationId: getMfaPolicy
security:
- bearerAuth: []
responses:
'200':
description: The tenant's policy, or the shipped default when unset
content:
application/json:
schema:
$ref: '#/components/schemas/MFAPolicy'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
put:
tags:
- Authentication
summary: Set the organization's MFA grace policy
operationId: updateMfaPolicy
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMFAPolicyInput'
responses:
'200':
description: The saved policy
content:
application/json:
schema:
$ref: '#/components/schemas/MFAPolicy'
'400':
description: grace_days missing or out of the 0..90 range
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Not an administrator of this organization
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/users/me:
get:
tags:
- Profile
summary: Get the caller's own profile and effective preferences
operationId: getMyProfile
security:
- bearerAuth: []
responses:
'200':
description: Own profile. `effective` resolves each preference as own choice, else the organization default.
content:
application/json:
schema:
$ref: '#/components/schemas/MyProfile'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
patch:
tags:
- Profile
summary: Update the caller's own profile and preferences
description: >
Partial update of the session's own user; no field selects another
account. An omitted field is unchanged, an empty string clears it
(full_name cannot be cleared). Email, username, role and status are
not writable here.
operationId: updateMyProfile
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UserProfilePatch'
responses:
'200':
description: Updated profile
content:
application/json:
schema:
$ref: '#/components/schemas/MyProfile'
'400':
description: Invalid field; the message names it
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/users/me/avatar:
put:
tags:
- Profile
summary: Upload the caller's avatar
description: PNG, JPEG or WebP, at most 1 MB, decided by the file's bytes. Replaces and deletes any previous avatar.
operationId: uploadMyAvatar
security:
- bearerAuth: []
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
required: [file]
properties:
file:
type: string
format: binary
responses:
'200':
description: Updated profile
content:
application/json:
schema:
$ref: '#/components/schemas/MyProfile'
'400':
description: Not an accepted image, or larger than 1 MB
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- Profile
summary: Remove the caller's avatar
operationId: deleteMyAvatar
security:
- bearerAuth: []
responses:
'200':
description: Updated profile
content:
application/json:
schema:
$ref: '#/components/schemas/MyProfile'
/users/{id}/avatar:
get:
tags:
- Profile
summary: Read a user's avatar
description: Served only when the user is an active member of the caller's organization; otherwise 404, exactly as for a user that does not exist.
operationId: getUserAvatar
security:
- bearerAuth: []
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: The image
content:
image/png: { schema: { type: string, format: binary } }
image/jpeg: { schema: { type: string, format: binary } }
image/webp: { schema: { type: string, format: binary } }
'404':
description: No avatar visible to the caller
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/auth/password/change:
post:
tags:
- Authentication
summary: Change the signed-in user's own password
description: >
Requires the current password; the new one must pass the password policy.
On success every session of the user ends and the calling device is
given a fresh one (new session cookies, and the pair in the body), and a
notice is emailed. If no new session can be minted, `reauthenticate` is
true. Rate limited with the other authentication routes. No password is
ever logged or echoed.
operationId: changePassword
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [current_password, new_password]
properties:
current_password: { type: string, format: password }
new_password: { type: string, format: password }
locale: { type: string, enum: [fr, en] }
responses:
'200':
description: Password changed
content:
application/json:
schema:
type: object
properties:
message: { type: string }
reauthenticate: { type: boolean }
token_pair:
type: object
properties:
access_token: { type: string }
refresh_token: { type: string }
expires_in: { type: integer }
csrf_token: { type: string }
'400':
description: "`weak_password` (with `assessment`) or `same_password`"
'401':
description: No session
'403':
description: "Called with a personal access token, which cannot change the password and is given no session; `wrong_current_password`; or, from the middleware, `CSRF_FAILED` or `MFA_ENROLLMENT_REQUIRED`"
'409':
description: "`no_local_password`: the account signs in through an identity provider"
'429':
description: Rate limited
'503':
$ref: '#/components/responses/MFAStatusUnavailable'
/auth/me:
get:
tags:
- Authentication
summary: The signed-in user, their MFA state and how they can prove who they are
description: >
Re-read on every call, never taken from the token alone. `mfa` is
omitted when the server cannot resolve it (read that as unknown, not as
"fine"). `has_password` is false for an account that signs in through
an identity provider; such an account confirms sensitive changes, like
turning MFA off, with an authenticator code instead (#754, D-061). It is
a boolean, never the hash.
operationId: getMe
security:
- bearerAuth: []
responses:
'200':
description: The current session's user
content:
application/json:
schema:
$ref: '#/components/schemas/MeResponse'
'401':
description: No session
'404':
description: The session's user no longer exists
'429':
$ref: '#/components/responses/QuotaExceeded'
/auth/mfa/disable:
post:
tags:
- Authentication
summary: Turn off two-factor authentication for the signed-in user
description: >
An open session is not enough (#754). The body carries the current
`password`, or, when `/auth/me` says `has_password: false`, a current
six-digit `code` from the authenticator app; backup codes are not
accepted, and a code never replaces the password of an account that has
one. Refused for roles the deployment requires MFA for. Each attempt
counts against a per-account budget of 5 per 15 minutes (on top of the
per-IP limit). On success the TOTP secret and every backup code are
deleted in one transaction, the attempt is audited, and the owner is
notified by email and in-app. Neither the password nor the code is ever
logged or echoed. Errors carry a stable `code` (see DisableMFAError).
operationId: disableMfa
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DisableMFAInput'
responses:
'200':
description: MFA is off
content:
application/json:
schema:
type: object
required: [message]
properties:
message: { type: string }
'400':
description: The body is not JSON
'401':
description: "`wrong_password` or `wrong_code`. Not a session error: the session stays valid."
content:
application/json:
schema:
$ref: '#/components/schemas/DisableMFAError'
'403':
description: "`mfa_required_by_role`; or, from the middleware, `CSRF_FAILED` or `MFA_ENROLLMENT_REQUIRED`"
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/DisableMFAError'
- $ref: '#/components/schemas/GuardError'
'404':
description: "`not_enrolled`"
content:
application/json:
schema:
$ref: '#/components/schemas/DisableMFAError'
'409':
description: "`no_local_password`: no password and no way to check a code on this deployment"
content:
application/json:
schema:
$ref: '#/components/schemas/DisableMFAError'
'429':
description: "`too_many_attempts`, or the per-IP limit"
content:
application/json:
schema:
$ref: '#/components/schemas/DisableMFAError'
'503':
$ref: '#/components/responses/MFAStatusUnavailable'
/auth/mfa/backup-codes/regenerate:
post:
tags:
- Authentication
summary: Replace the signed-in user's MFA backup codes
description: >
New codes stand in for the second factor, so issuing them takes that
factor (#1032): a current six-digit `code` from the authenticator app,
always, plus the current `password` when `/auth/me` says
`has_password: true`. An existing backup code is not accepted. Allowed
for every role, including those that may not turn MFA off. Attempts
share the per-account budget of `/auth/mfa/disable` (5 per 15 minutes,
on top of the per-IP limit). On success the old codes are deleted and 8
new ones stored hashed in one transaction; they are returned once, with
`Cache-Control: no-store`. On any failure the old codes stay. Success
and failure are written to the auth audit log, and success mails the
owner. Refused to personal access tokens. Neither proof is ever logged
or echoed. Errors carry a stable `code` (see RegenerateBackupCodesError).
operationId: regenerateMfaBackupCodes
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RegenerateBackupCodesInput'
responses:
'200':
description: The new codes, shown once
content:
application/json:
schema:
type: object
required: [backup_codes]
properties:
backup_codes:
type: array
minItems: 8
maxItems: 8
items: { type: string }
'400':
description: The body is not JSON
'401':
description: "`wrong_password` or `wrong_code` (wrong, missing or already used). Not a session error: the session stays valid."
content:
application/json:
schema:
$ref: '#/components/schemas/RegenerateBackupCodesError'
'403':
description: "`personal_access_token`: a personal access token cannot mint backup codes; or, from the middleware, `CSRF_FAILED` or `MFA_ENROLLMENT_REQUIRED`"
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/RegenerateBackupCodesError'
- $ref: '#/components/schemas/GuardError'
'404':
description: "`not_enrolled`: no verified authenticator on this account"
content:
application/json:
schema:
$ref: '#/components/schemas/RegenerateBackupCodesError'
'429':
description: "`too_many_attempts`, or the per-IP limit"
content:
application/json:
schema:
$ref: '#/components/schemas/RegenerateBackupCodesError'
'503':
$ref: '#/components/responses/MFAStatusUnavailable'
# ==================== AUTHENTICATION (#1120) ====================
/auth/register:
post:
tags:
- Authentication
summary: Create an account and its organization
description: >-
Creates the user, a new organization they own and their root membership in one transaction.
No session is issued: the client signs in with /auth/login afterwards. Rate limited
per IP (10 per 15 minutes) and, for an address that already has an account, per address
(`REGISTER_RATE_LIMITED`). `EMAIL_ALREADY_REGISTERED` and `REGISTER_RATE_LIMITED` confirm
that an address has an account; the owner accepted that in D-073. A taken username is
checked before the address is looked up, so `USERNAME_TAKEN` says nothing about the
address.
operationId: register
security: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterInput'
responses:
'201':
description: Account and organization created
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterResponse'
'400':
description: Malformed body, a missing field, or a password the policy refuses
content:
application/json:
schema:
$ref: '#/components/schemas/AuthError'
'409':
description: '`EMAIL_ALREADY_REGISTERED` or `USERNAME_TAKEN`'
content:
application/json:
schema:
$ref: '#/components/schemas/AuthError'
'429':
description: >-
`RATE_LIMITED` (per IP) or `REGISTER_RATE_LIMITED` (per address); both set Retry-After
headers:
Retry-After:
schema:
type: integer
description: Seconds to wait
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/RateLimitedError'
- $ref: '#/components/schemas/AuthError'
'500':
description: Registration failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthError'
/auth/refresh:
post:
tags:
- Authentication
summary: Rotate the session's token pair
description: >-
Takes the refresh token from the body or, for a browser client that sends no body, from
the session cookie. Rotation is single-use: the presented token is destroyed and new
session cookies are set with a fresh CSRF token. Presenting a token that was already
rotated revokes the whole session family, clears the cookies and answers `REFRESH_REUSE_DETECTED`.
A concurrent refresh inside the grace window gets the same successor instead (D-048).
The device fingerprint may also come from the X-Device-Fingerprint header.
operationId: refreshToken
security: []
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
refresh_token:
type: string
device_fingerprint:
type: string
responses:
'200':
description: New token pair; session cookies re-issued
content:
application/json:
schema:
type: object
required:
- token_pair
properties:
token_pair:
$ref: '#/components/schemas/TokenPair'
csrf_token:
type: string
description: Mirrors the refreshed or_csrf cookie
'400':
description: No refresh token anywhere and an unparseable body
content:
application/json:
schema:
$ref: '#/components/schemas/AuthError'
'401':
description: >-
Refresh failed, or `REFRESH_REUSE_DETECTED` (the session family is revoked)
content:
application/json:
schema:
$ref: '#/components/schemas/AuthError'
'429':
$ref: '#/components/responses/QuotaExceeded'
'500':
description: The session cookies could not be issued
content:
application/json:
schema:
$ref: '#/components/schemas/AuthError'
/auth/logout:
post:
tags:
- Authentication
summary: End the current session
description: >-
Clears the session cookies first, whatever happens next. Then revokes the refresh token
(from the body or the cookie) and, when a validly signed access token is presented (Authorization
header or cookie), blacklists its JTI and ends the session it names. With nothing to
revoke it still answers 200 "Logged out". A missing or forged access token is not an
error; there is just nothing to revoke.
operationId: logout
security: []
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
refresh_token:
type: string
responses:
'200':
description: Logged out
content:
application/json:
schema:
type: object
properties:
message:
type: string
'401':
description: Revocation failed (the cookies are cleared anyway)
content:
application/json:
schema:
$ref: '#/components/schemas/AuthError'
'429':
$ref: '#/components/responses/QuotaExceeded'
/auth/password/forgot:
post:
tags:
- Authentication
summary: Request a password reset link
description: >-
The answer is identical, in status and body, whether or not the address has an account,
and the mail is sent asynchronously so latency does not tell either. Limited per address
(counted for unknown addresses too, so the 429 reveals nothing) and per IP (15 per 5
minutes, shared with /auth/password/reset). The link expires in 30 minutes. Messages
follow `locale`, then Accept-Language, then French.
operationId: forgotPassword
security: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- email
properties:
email:
type: string
format: email
locale:
type: string
enum:
- fr
- en
responses:
'200':
description: The uniform acknowledgement
content:
application/json:
schema:
type: object
properties:
message:
type: string
'400':
description: Malformed body or no email
content:
application/json:
schema:
$ref: '#/components/schemas/AuthError'
'429':
description: >-
Too many requests for this address (`retry_after` in seconds), or the per-IP limit
(`RATE_LIMITED`)
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/RateLimitedError'
- type: object
properties:
error:
type: string
retry_after:
type: integer
'500':
description: Generic failure
content:
application/json:
schema:
$ref: '#/components/schemas/AuthError'
/auth/password/reset:
post:
tags:
- Authentication
summary: Set a new password from a reset link
description: >-
One answer (`invalid_token`) covers an unknown, expired or already-used token, so a
response never confirms that a token existed. A password the policy refuses answers
422 `weak_password` with the full assessment. On success every active session of the
account is signed out.
operationId: resetPassword
security: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- token
- new_password
properties:
token:
type: string
new_password:
type: string
format: password
locale:
type: string
enum:
- fr
- en
responses:
'200':
description: Password changed
content:
application/json:
schema:
type: object
properties:
message:
type: string
sessions_revoked:
type: boolean
description: True once every session of the account was signed out
'400':
description: Malformed body, or `invalid_token`
content:
application/json:
schema:
$ref: '#/components/schemas/AuthError'
'422':
description: '`weak_password`'
content:
application/json:
schema:
type: object
properties:
error:
type: string
code:
type: string
enum:
- weak_password
assessment:
$ref: '#/components/schemas/PasswordAssessment'
'429':
description: '`RATE_LIMITED` (per IP, shared with /auth/password/forgot)'
content:
application/json:
schema:
$ref: '#/components/schemas/RateLimitedError'
'500':
description: Generic failure
content:
application/json:
schema:
$ref: '#/components/schemas/AuthError'
/auth/password/check:
post:
tags:
- Authentication
summary: Score a candidate password against the policy
description: >-
The same policy the write paths enforce, so the strength meter cannot disagree with
the server. Public because the registration and reset screens have no session; it discloses
nothing the caller did not type. `email` and `name` let it judge the password against
the identity it will belong to. Limited to 120 per 5 minutes per IP.
operationId: checkPassword
security: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
password:
type: string
format: password
email:
type: string
format: email
name:
type: string
responses:
'200':
description: The assessment
content:
application/json:
schema:
$ref: '#/components/schemas/PasswordAssessment'
'400':
description: Malformed body
content:
application/json:
schema:
$ref: '#/components/schemas/AuthError'
'429':
description: '`RATE_LIMITED`'
content:
application/json:
schema:
$ref: '#/components/schemas/RateLimitedError'
/auth/oauth2/login/{provider}:
get:
tags:
- Authentication
summary: Start an OAuth2 sign-in
description: >-
A browser navigation, not an API call: it answers 302 to the provider with `state` and
a PKCE challenge, and sets a cookie that binds the callback to this browser. Every failure
is a 302 to the SPA's /login with an `error` code (`unsupported_provider`, `provider_not_configured`,
`internal`) that the login screen renders. `return_to` is kept only when it is a root-relative
path on this site.
operationId: oauth2Login
security: []
parameters:
- name: provider
in: path
required: true
schema:
type: string
enum:
- google
- github
- azure
- name: return_to
in: query
required: false
schema:
type: string
description: Root-relative path to land on after sign-in
- name: lang
in: query
required: false
schema:
type: string
enum:
- fr
- en
responses:
'302':
description: To the provider, or to /login?error=... on failure
headers:
Location:
schema:
type: string
'429':
$ref: '#/components/responses/QuotaExceeded'
/auth/oauth2/callback/{provider}:
get:
tags:
- Authentication
summary: Finish an OAuth2 sign-in
description: >-
The provider's redirect back. The state cookie is checked and cleared first, so a flow
gets one try. On success the session cookies are set and the browser is sent to the
SPA's SSO completion page (with `next` when a safe `return_to` was given). When the
account owes a second factor (an enrolled authenticator, or a role whose MFA grace is
over) no session is set: the MFA step goes into an HttpOnly cookie for POST /auth/sso/mfa
and the completion page gets `mfa=1`. Every failure
is a 302 to /login with an `error` code: `access_denied`, `consent_required`, `provider_error`,
`state_missing`, `state_invalid`, `code_missing`, `unsupported_provider`, `exchange_failed`,
`userinfo_failed`, `email_unverified`, `no_email`, `account_disabled`, `no_account`,
`password_account`, `internal`, or `provider_conflict` with `existing_provider` naming the provider that
already owns the address.
operationId: oauth2Callback
security: []
parameters:
- name: provider
in: path
required: true
schema:
type: string
enum:
- google
- github
- azure
- name: state
in: query
required: false
schema:
type: string
- name: code
in: query
required: false
schema:
type: string