@authara/react-native 0.0.0-stage → 0.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,1128 @@
1
+ // Code generated from authara-core/contract/openapi.yaml; DO NOT EDIT.
2
+ export const autharaGeneratedOperations = [
3
+ {
4
+ id: "getCurrentAccount",
5
+ method: "GET",
6
+ path: "/auth/api/v1/account",
7
+ summary: "Get the authenticated user's account",
8
+ tag: "Users",
9
+ access: "user",
10
+ hasOptions: true,
11
+ optionsRequired: false,
12
+ optionsType: "{ sessions_cursor?: string; sessions_limit?: number; passkeys_cursor?: string; passkeys_limit?: number }",
13
+ exampleOptions: {
14
+ sessions_limit: 20,
15
+ passkeys_limit: 20,
16
+ },
17
+ mutates: false,
18
+ },
19
+ {
20
+ id: "linkCurrentUserApple",
21
+ method: "POST",
22
+ path: "/auth/api/v1/account/auth-methods/apple",
23
+ summary: "Link Apple to the authenticated user's account",
24
+ tag: "Users",
25
+ access: "user",
26
+ hasOptions: true,
27
+ optionsRequired: true,
28
+ optionsType: "{ body: API.AppleAuthorizationRequest }",
29
+ exampleOptions: {
30
+ body: {
31
+ code: "000000",
32
+ state: "<state>",
33
+ },
34
+ },
35
+ mutates: true,
36
+ },
37
+ {
38
+ id: "linkCurrentUserGoogle",
39
+ method: "POST",
40
+ path: "/auth/api/v1/account/auth-methods/google",
41
+ summary: "Link Google to the authenticated user's account",
42
+ tag: "Users",
43
+ access: "user",
44
+ hasOptions: true,
45
+ optionsRequired: true,
46
+ optionsType: "{ body: API.GoogleLoginRequest }",
47
+ exampleOptions: {
48
+ body: {},
49
+ },
50
+ mutates: true,
51
+ },
52
+ {
53
+ id: "linkCurrentUserMicrosoft",
54
+ method: "POST",
55
+ path: "/auth/api/v1/account/auth-methods/microsoft",
56
+ summary: "Link Microsoft to the authenticated user's account",
57
+ tag: "Users",
58
+ access: "user",
59
+ hasOptions: true,
60
+ optionsRequired: true,
61
+ optionsType: "{ body: API.MicrosoftLoginRequest }",
62
+ exampleOptions: {
63
+ body: {
64
+ credential: "<token>",
65
+ nonce: "<nonce>",
66
+ },
67
+ },
68
+ mutates: true,
69
+ },
70
+ {
71
+ id: "unlinkCurrentUserAuthMethod",
72
+ method: "DELETE",
73
+ path: "/auth/api/v1/account/auth-methods/{provider}",
74
+ summary: "Unlink an authentication method from the authenticated user's account",
75
+ tag: "Users",
76
+ access: "user",
77
+ hasOptions: true,
78
+ optionsRequired: true,
79
+ optionsType: '{ provider: "password" | "google" | "apple" | "microsoft" }',
80
+ exampleOptions: {
81
+ provider: "password",
82
+ },
83
+ mutates: true,
84
+ },
85
+ {
86
+ id: "startCurrentUserEmailChange",
87
+ method: "POST",
88
+ path: "/auth/api/v1/account/email-change/challenges",
89
+ summary: "Start an email change challenge",
90
+ tag: "Users",
91
+ access: "user",
92
+ hasOptions: true,
93
+ optionsRequired: true,
94
+ optionsType: "{ body: API.EmailChangeRequest }",
95
+ exampleOptions: {
96
+ body: {
97
+ new_email: "mobile@example.com",
98
+ },
99
+ },
100
+ mutates: true,
101
+ },
102
+ {
103
+ id: "verifyCurrentUserEmailChange",
104
+ method: "POST",
105
+ path: "/auth/api/v1/account/email-change/challenges/verify",
106
+ summary: "Verify an email change challenge",
107
+ tag: "Users",
108
+ access: "user",
109
+ hasOptions: true,
110
+ optionsRequired: true,
111
+ optionsType: "{ body: API.ChallengeVerification }",
112
+ exampleOptions: {
113
+ body: {
114
+ challenge_id: "00000000-0000-0000-0000-000000000000",
115
+ code: "000000",
116
+ },
117
+ },
118
+ mutates: true,
119
+ },
120
+ {
121
+ id: "deleteCurrentUserPasskey",
122
+ method: "DELETE",
123
+ path: "/auth/api/v1/account/passkeys/{passkeyID}",
124
+ summary: "Delete a passkey from the authenticated user's account",
125
+ tag: "Passkeys",
126
+ access: "user",
127
+ hasOptions: true,
128
+ optionsRequired: true,
129
+ optionsType: "{ passkeyID: string }",
130
+ exampleOptions: {
131
+ passkeyID: "00000000-0000-0000-0000-000000000000",
132
+ },
133
+ mutates: true,
134
+ },
135
+ {
136
+ id: "addCurrentUserPassword",
137
+ method: "POST",
138
+ path: "/auth/api/v1/account/password",
139
+ summary: "Add password authentication to the authenticated user's account",
140
+ tag: "Users",
141
+ access: "user",
142
+ hasOptions: true,
143
+ optionsRequired: true,
144
+ optionsType: "{ body: API.SetPasswordRequest }",
145
+ exampleOptions: {
146
+ body: {
147
+ password: "change-me-123456",
148
+ },
149
+ },
150
+ mutates: true,
151
+ },
152
+ {
153
+ id: "changeCurrentUserPassword",
154
+ method: "PUT",
155
+ path: "/auth/api/v1/account/password",
156
+ summary: "Change the authenticated user's password",
157
+ tag: "Users",
158
+ access: "user",
159
+ hasOptions: true,
160
+ optionsRequired: true,
161
+ optionsType: "{ body: API.ChangePasswordRequest }",
162
+ exampleOptions: {
163
+ body: {
164
+ current_password: "change-me-123456",
165
+ new_password: "change-me-123456",
166
+ },
167
+ },
168
+ mutates: true,
169
+ },
170
+ {
171
+ id: "revokeCurrentUserOtherSessions",
172
+ method: "DELETE",
173
+ path: "/auth/api/v1/account/sessions/others",
174
+ summary: "Revoke all sessions except the current session",
175
+ tag: "Sessions",
176
+ access: "user",
177
+ hasOptions: false,
178
+ optionsRequired: false,
179
+ optionsType: "No options",
180
+ exampleOptions: {},
181
+ mutates: true,
182
+ },
183
+ {
184
+ id: "revokeCurrentUserSession",
185
+ method: "DELETE",
186
+ path: "/auth/api/v1/account/sessions/{sessionID}",
187
+ summary: "Revoke one of the authenticated user's sessions",
188
+ tag: "Sessions",
189
+ access: "user",
190
+ hasOptions: true,
191
+ optionsRequired: true,
192
+ optionsType: "{ sessionID: string }",
193
+ exampleOptions: {
194
+ sessionID: "00000000-0000-0000-0000-000000000000",
195
+ },
196
+ mutates: true,
197
+ },
198
+ {
199
+ id: "changeCurrentUsername",
200
+ method: "PATCH",
201
+ path: "/auth/api/v1/account/username",
202
+ summary: "Change the authenticated user's username",
203
+ tag: "Users",
204
+ access: "user",
205
+ hasOptions: true,
206
+ optionsRequired: true,
207
+ optionsType: "{ body: API.ChangeUsernameRequest }",
208
+ exampleOptions: {
209
+ body: {
210
+ username: "mobile-tester",
211
+ },
212
+ },
213
+ mutates: true,
214
+ },
215
+ {
216
+ id: "getPublicCapabilities",
217
+ method: "GET",
218
+ path: "/auth/api/v1/capabilities",
219
+ summary: "Get organization capabilities",
220
+ tag: "Organizations",
221
+ access: "user",
222
+ hasOptions: false,
223
+ optionsRequired: false,
224
+ optionsType: "No options",
225
+ exampleOptions: {},
226
+ mutates: false,
227
+ },
228
+ {
229
+ id: "resendChallenge",
230
+ method: "POST",
231
+ path: "/auth/api/v1/challenges/resend",
232
+ summary: "Request another challenge verification code",
233
+ tag: "Authentication",
234
+ access: "public",
235
+ hasOptions: true,
236
+ optionsRequired: true,
237
+ optionsType: '{ session_transport?: "cookie" | "token"; body: API.ChallengeReference }',
238
+ exampleOptions: {
239
+ session_transport: "token",
240
+ body: {
241
+ challenge_id: "00000000-0000-0000-0000-000000000000",
242
+ },
243
+ },
244
+ mutates: true,
245
+ },
246
+ {
247
+ id: "getCsrfToken",
248
+ method: "GET",
249
+ path: "/auth/api/v1/csrf",
250
+ summary: "Get a CSRF token",
251
+ tag: "Authentication",
252
+ access: "public",
253
+ hasOptions: false,
254
+ optionsRequired: false,
255
+ optionsType: "No options",
256
+ exampleOptions: {},
257
+ mutates: false,
258
+ },
259
+ {
260
+ id: "acceptInvitation",
261
+ method: "POST",
262
+ path: "/auth/api/v1/invitations/accept",
263
+ summary: "Accept an invitation and switch the current session to its organization",
264
+ tag: "Organizations",
265
+ access: "user",
266
+ hasOptions: true,
267
+ optionsRequired: true,
268
+ optionsType: '{ audience?: "app"; body: API.InvitationTokenRequest }',
269
+ exampleOptions: {
270
+ audience: "app",
271
+ body: {
272
+ token: "<token>",
273
+ },
274
+ },
275
+ mutates: true,
276
+ },
277
+ {
278
+ id: "authenticateAndAcceptInvitationWithGoogle",
279
+ method: "POST",
280
+ path: "/auth/api/v1/invitations/google",
281
+ summary: "Sign up or log in with Google, accept an invitation, and switch organizations",
282
+ tag: "Authentication",
283
+ access: "public",
284
+ hasOptions: true,
285
+ optionsRequired: true,
286
+ optionsType: '{ audience?: "app"; body: API.InvitationGoogleRequest }',
287
+ exampleOptions: {
288
+ audience: "app",
289
+ body: {
290
+ token: "<token>",
291
+ flow: "signup",
292
+ },
293
+ },
294
+ mutates: true,
295
+ },
296
+ {
297
+ id: "loginAndAcceptInvitation",
298
+ method: "POST",
299
+ path: "/auth/api/v1/invitations/login",
300
+ summary: "Log in with a password, accept an invitation, and switch organizations",
301
+ tag: "Authentication",
302
+ access: "public",
303
+ hasOptions: true,
304
+ optionsRequired: true,
305
+ optionsType: '{ audience?: "app"; body: API.InvitationPasswordLoginRequest }',
306
+ exampleOptions: {
307
+ audience: "app",
308
+ body: {
309
+ token: "<token>",
310
+ password: "change-me-123456",
311
+ },
312
+ },
313
+ mutates: true,
314
+ },
315
+ {
316
+ id: "previewInvitation",
317
+ method: "GET",
318
+ path: "/auth/api/v1/invitations/preview",
319
+ summary: "Preview an organization invitation",
320
+ tag: "Organizations",
321
+ access: "public",
322
+ hasOptions: true,
323
+ optionsRequired: true,
324
+ optionsType: "{ token: string }",
325
+ exampleOptions: {
326
+ token: "<token>",
327
+ },
328
+ mutates: false,
329
+ },
330
+ {
331
+ id: "loginWithPassword",
332
+ method: "POST",
333
+ path: "/auth/api/v1/login",
334
+ summary: "Log in with a password",
335
+ tag: "Authentication",
336
+ access: "public",
337
+ hasOptions: true,
338
+ optionsRequired: true,
339
+ optionsType: '{ audience?: "app" | "admin" | "operator"; session_transport?: "cookie" | "token"; body: API.PasswordLoginRequest }',
340
+ exampleOptions: {
341
+ audience: "app",
342
+ session_transport: "token",
343
+ body: {
344
+ identifier: "mobile@example.com",
345
+ password: "change-me-123456",
346
+ },
347
+ },
348
+ mutates: true,
349
+ },
350
+ {
351
+ id: "loginWithApple",
352
+ method: "POST",
353
+ path: "/auth/api/v1/oauth/apple",
354
+ summary: "Log in with an Apple authorization code",
355
+ tag: "Authentication",
356
+ access: "public",
357
+ hasOptions: true,
358
+ optionsRequired: true,
359
+ optionsType: '{ audience?: "app" | "admin" | "operator"; session_transport?: "cookie" | "token"; body: API.AppleAuthorizationRequest }',
360
+ exampleOptions: {
361
+ audience: "app",
362
+ session_transport: "token",
363
+ body: {
364
+ code: "000000",
365
+ state: "<state>",
366
+ },
367
+ },
368
+ mutates: true,
369
+ },
370
+ {
371
+ id: "getAppleLoginOptions",
372
+ method: "GET",
373
+ path: "/auth/api/v1/oauth/apple/options",
374
+ summary: "Get Apple login options",
375
+ tag: "Authentication",
376
+ access: "public",
377
+ hasOptions: true,
378
+ optionsRequired: false,
379
+ optionsType: '{ session_transport?: "cookie" | "token" }',
380
+ exampleOptions: {
381
+ session_transport: "token",
382
+ },
383
+ mutates: false,
384
+ },
385
+ {
386
+ id: "loginWithGoogle",
387
+ method: "POST",
388
+ path: "/auth/api/v1/oauth/google",
389
+ summary: "Log in with Google",
390
+ tag: "Authentication",
391
+ access: "public",
392
+ hasOptions: true,
393
+ optionsRequired: true,
394
+ optionsType: '{ audience?: "app" | "admin" | "operator"; session_transport?: "cookie" | "token"; body: API.GoogleLoginRequest }',
395
+ exampleOptions: {
396
+ audience: "app",
397
+ session_transport: "token",
398
+ body: {},
399
+ },
400
+ mutates: true,
401
+ },
402
+ {
403
+ id: "getGoogleLoginOptions",
404
+ method: "GET",
405
+ path: "/auth/api/v1/oauth/google/options",
406
+ summary: "Get Google login options",
407
+ tag: "Authentication",
408
+ access: "public",
409
+ hasOptions: true,
410
+ optionsRequired: false,
411
+ optionsType: '{ session_transport?: "cookie" | "token" }',
412
+ exampleOptions: {
413
+ session_transport: "token",
414
+ },
415
+ mutates: false,
416
+ },
417
+ {
418
+ id: "loginWithMicrosoft",
419
+ method: "POST",
420
+ path: "/auth/api/v1/oauth/microsoft",
421
+ summary: "Log in with Microsoft",
422
+ tag: "Authentication",
423
+ access: "public",
424
+ hasOptions: true,
425
+ optionsRequired: true,
426
+ optionsType: '{ audience?: "app" | "admin" | "operator"; session_transport?: "cookie" | "token"; body: API.MicrosoftLoginRequest }',
427
+ exampleOptions: {
428
+ audience: "app",
429
+ session_transport: "token",
430
+ body: {
431
+ credential: "<token>",
432
+ nonce: "<nonce>",
433
+ },
434
+ },
435
+ mutates: true,
436
+ },
437
+ {
438
+ id: "getMicrosoftLoginOptions",
439
+ method: "GET",
440
+ path: "/auth/api/v1/oauth/microsoft/options",
441
+ summary: "Get Microsoft login options",
442
+ tag: "Authentication",
443
+ access: "public",
444
+ hasOptions: true,
445
+ optionsRequired: false,
446
+ optionsType: '{ session_transport?: "cookie" | "token" }',
447
+ exampleOptions: {
448
+ session_transport: "token",
449
+ },
450
+ mutates: false,
451
+ },
452
+ {
453
+ id: "listCurrentUserOrganizations",
454
+ method: "GET",
455
+ path: "/auth/api/v1/organizations",
456
+ summary: "List organizations for the authenticated user",
457
+ tag: "Organizations",
458
+ access: "user",
459
+ hasOptions: true,
460
+ optionsRequired: false,
461
+ optionsType: "{ cursor?: string; limit?: number }",
462
+ exampleOptions: {
463
+ limit: 20,
464
+ },
465
+ mutates: false,
466
+ },
467
+ {
468
+ id: "getCurrentOrganization",
469
+ method: "GET",
470
+ path: "/auth/api/v1/organizations/current",
471
+ summary: "Get the organization in the current access token",
472
+ tag: "Organizations",
473
+ access: "user",
474
+ hasOptions: false,
475
+ optionsRequired: false,
476
+ optionsType: "No options",
477
+ exampleOptions: {},
478
+ mutates: false,
479
+ },
480
+ {
481
+ id: "listCurrentOrganizationMembers",
482
+ method: "GET",
483
+ path: "/auth/api/v1/organizations/current/members",
484
+ summary: "List members of the current organization",
485
+ tag: "Organizations",
486
+ access: "user",
487
+ hasOptions: true,
488
+ optionsRequired: false,
489
+ optionsType: "{ cursor?: string; limit?: number }",
490
+ exampleOptions: {
491
+ limit: 20,
492
+ },
493
+ mutates: false,
494
+ },
495
+ {
496
+ id: "getPublicOrganization",
497
+ method: "GET",
498
+ path: "/auth/api/v1/organizations/{organizationID}",
499
+ summary: "Get an organization",
500
+ tag: "Organizations",
501
+ access: "user",
502
+ hasOptions: true,
503
+ optionsRequired: true,
504
+ optionsType: "{ organizationID: string }",
505
+ exampleOptions: {
506
+ organizationID: "00000000-0000-0000-0000-000000000000",
507
+ },
508
+ mutates: false,
509
+ },
510
+ {
511
+ id: "updatePublicOrganization",
512
+ method: "PATCH",
513
+ path: "/auth/api/v1/organizations/{organizationID}",
514
+ summary: "Update an organization",
515
+ tag: "Organizations",
516
+ access: "user",
517
+ hasOptions: true,
518
+ optionsRequired: true,
519
+ optionsType: "{ organizationID: string; body: API.UpdateOrganizationRequest }",
520
+ exampleOptions: {
521
+ organizationID: "00000000-0000-0000-0000-000000000000",
522
+ body: {
523
+ name: "Mobile test",
524
+ },
525
+ },
526
+ mutates: true,
527
+ },
528
+ {
529
+ id: "listPublicOrganizationInvitations",
530
+ method: "GET",
531
+ path: "/auth/api/v1/organizations/{organizationID}/invitations",
532
+ summary: "List organization invitations",
533
+ tag: "Organizations",
534
+ access: "user",
535
+ hasOptions: true,
536
+ optionsRequired: true,
537
+ optionsType: "{ organizationID: string; cursor?: string; limit?: number }",
538
+ exampleOptions: {
539
+ organizationID: "00000000-0000-0000-0000-000000000000",
540
+ limit: 20,
541
+ },
542
+ mutates: false,
543
+ },
544
+ {
545
+ id: "getPublicOrganizationInvitation",
546
+ method: "GET",
547
+ path: "/auth/api/v1/organizations/{organizationID}/invitations/{invitationID}",
548
+ summary: "Get an organization invitation",
549
+ tag: "Organizations",
550
+ access: "user",
551
+ hasOptions: true,
552
+ optionsRequired: true,
553
+ optionsType: "{ organizationID: string; invitationID: string }",
554
+ exampleOptions: {
555
+ organizationID: "00000000-0000-0000-0000-000000000000",
556
+ invitationID: "00000000-0000-0000-0000-000000000000",
557
+ },
558
+ mutates: false,
559
+ },
560
+ {
561
+ id: "revokePublicOrganizationInvitation",
562
+ method: "POST",
563
+ path: "/auth/api/v1/organizations/{organizationID}/invitations/{invitationID}/revoke",
564
+ summary: "Revoke an organization invitation",
565
+ tag: "Organizations",
566
+ access: "user",
567
+ hasOptions: true,
568
+ optionsRequired: true,
569
+ optionsType: "{ organizationID: string; invitationID: string }",
570
+ exampleOptions: {
571
+ organizationID: "00000000-0000-0000-0000-000000000000",
572
+ invitationID: "00000000-0000-0000-0000-000000000000",
573
+ },
574
+ mutates: true,
575
+ },
576
+ {
577
+ id: "listPublicOrganizationMembers",
578
+ method: "GET",
579
+ path: "/auth/api/v1/organizations/{organizationID}/members",
580
+ summary: "List organization members",
581
+ tag: "Organizations",
582
+ access: "user",
583
+ hasOptions: true,
584
+ optionsRequired: true,
585
+ optionsType: "{ organizationID: string; cursor?: string; limit?: number }",
586
+ exampleOptions: {
587
+ organizationID: "00000000-0000-0000-0000-000000000000",
588
+ limit: 20,
589
+ },
590
+ mutates: false,
591
+ },
592
+ {
593
+ id: "getPublicOrganizationMember",
594
+ method: "GET",
595
+ path: "/auth/api/v1/organizations/{organizationID}/members/{userID}",
596
+ summary: "Get an organization member",
597
+ tag: "Organizations",
598
+ access: "user",
599
+ hasOptions: true,
600
+ optionsRequired: true,
601
+ optionsType: "{ organizationID: string; userID: string }",
602
+ exampleOptions: {
603
+ organizationID: "00000000-0000-0000-0000-000000000000",
604
+ userID: "00000000-0000-0000-0000-000000000000",
605
+ },
606
+ mutates: false,
607
+ },
608
+ {
609
+ id: "updatePublicOrganizationMember",
610
+ method: "PATCH",
611
+ path: "/auth/api/v1/organizations/{organizationID}/members/{userID}",
612
+ summary: "Update an organization member role",
613
+ tag: "Organizations",
614
+ access: "user",
615
+ hasOptions: true,
616
+ optionsRequired: true,
617
+ optionsType: "{ organizationID: string; userID: string; body: API.UpdateOrganizationMemberRequest }",
618
+ exampleOptions: {
619
+ organizationID: "00000000-0000-0000-0000-000000000000",
620
+ userID: "00000000-0000-0000-0000-000000000000",
621
+ body: {
622
+ role: "admin",
623
+ },
624
+ },
625
+ mutates: true,
626
+ },
627
+ {
628
+ id: "switchOrganization",
629
+ method: "POST",
630
+ path: "/auth/api/v1/organizations/{organizationID}/switch",
631
+ summary: "Switch the current session to another organization",
632
+ tag: "Organizations",
633
+ access: "user",
634
+ hasOptions: true,
635
+ optionsRequired: true,
636
+ optionsType: '{ organizationID: string; audience?: "app" | "admin" | "operator" }',
637
+ exampleOptions: {
638
+ organizationID: "00000000-0000-0000-0000-000000000000",
639
+ audience: "app",
640
+ },
641
+ mutates: true,
642
+ },
643
+ {
644
+ id: "finishPasskeyAuthentication",
645
+ method: "POST",
646
+ path: "/auth/api/v1/passkeys/authenticate/finish",
647
+ summary: "Finish passkey authentication",
648
+ tag: "Passkeys",
649
+ access: "public",
650
+ hasOptions: true,
651
+ optionsRequired: true,
652
+ optionsType: '{ audience?: "app" | "admin" | "operator"; session_transport?: "cookie" | "token"; body: API.PasskeyAuthenticationFinishRequest }',
653
+ exampleOptions: {
654
+ audience: "app",
655
+ session_transport: "token",
656
+ body: {
657
+ challenge_id: "00000000-0000-0000-0000-000000000000",
658
+ credential: {},
659
+ },
660
+ },
661
+ mutates: true,
662
+ },
663
+ {
664
+ id: "beginPasskeyAuthentication",
665
+ method: "POST",
666
+ path: "/auth/api/v1/passkeys/authenticate/options",
667
+ summary: "Start passkey authentication",
668
+ tag: "Passkeys",
669
+ access: "public",
670
+ hasOptions: true,
671
+ optionsRequired: false,
672
+ optionsType: '{ session_transport?: "cookie" | "token" }',
673
+ exampleOptions: {
674
+ session_transport: "token",
675
+ },
676
+ mutates: true,
677
+ },
678
+ {
679
+ id: "finishPasskeyRegistration",
680
+ method: "POST",
681
+ path: "/auth/api/v1/passkeys/register/finish",
682
+ summary: "Finish passkey registration",
683
+ tag: "Passkeys",
684
+ access: "user",
685
+ hasOptions: true,
686
+ optionsRequired: true,
687
+ optionsType: "{ body: API.PasskeyRegistrationFinishRequest }",
688
+ exampleOptions: {
689
+ body: {
690
+ challenge_id: "00000000-0000-0000-0000-000000000000",
691
+ credential: {},
692
+ },
693
+ },
694
+ mutates: true,
695
+ },
696
+ {
697
+ id: "beginPasskeyRegistration",
698
+ method: "POST",
699
+ path: "/auth/api/v1/passkeys/register/options",
700
+ summary: "Start passkey registration",
701
+ tag: "Passkeys",
702
+ access: "user",
703
+ hasOptions: false,
704
+ optionsRequired: false,
705
+ optionsType: "No options",
706
+ exampleOptions: {},
707
+ mutates: true,
708
+ },
709
+ {
710
+ id: "startPasswordResetChallenge",
711
+ method: "POST",
712
+ path: "/auth/api/v1/password-reset/challenges",
713
+ summary: "Start a password reset challenge",
714
+ tag: "Authentication",
715
+ access: "public",
716
+ hasOptions: true,
717
+ optionsRequired: true,
718
+ optionsType: '{ session_transport?: "cookie" | "token"; body: API.PasswordResetRequest }',
719
+ exampleOptions: {
720
+ session_transport: "token",
721
+ body: {
722
+ email: "mobile@example.com",
723
+ new_password: "change-me-123456",
724
+ },
725
+ },
726
+ mutates: true,
727
+ },
728
+ {
729
+ id: "verifyPasswordResetChallenge",
730
+ method: "POST",
731
+ path: "/auth/api/v1/password-reset/challenges/verify",
732
+ summary: "Verify a password reset challenge",
733
+ tag: "Authentication",
734
+ access: "public",
735
+ hasOptions: true,
736
+ optionsRequired: true,
737
+ optionsType: '{ session_transport?: "cookie" | "token"; body: API.PasswordResetChallengeVerification }',
738
+ exampleOptions: {
739
+ session_transport: "token",
740
+ body: {
741
+ challenge_id: "00000000-0000-0000-0000-000000000000",
742
+ code: "000000",
743
+ },
744
+ },
745
+ mutates: true,
746
+ },
747
+ {
748
+ id: "startGoogleAccountRecoveryLink",
749
+ method: "POST",
750
+ path: "/auth/api/v1/provider-links/recovery/google",
751
+ summary: "Start linking Google to an existing account with the same email",
752
+ tag: "Authentication",
753
+ access: "public",
754
+ hasOptions: true,
755
+ optionsRequired: true,
756
+ optionsType: "{ body: API.GoogleLoginRequest }",
757
+ exampleOptions: {
758
+ body: {},
759
+ },
760
+ mutates: true,
761
+ },
762
+ {
763
+ id: "completeAccountRecoveryLinkWithApple",
764
+ method: "POST",
765
+ path: "/auth/api/v1/provider-links/recovery/{linkID}/apple",
766
+ summary: "Prove ownership with an existing Apple login and finish linking",
767
+ tag: "Authentication",
768
+ access: "public",
769
+ hasOptions: true,
770
+ optionsRequired: true,
771
+ optionsType: '{ linkID: string; audience?: "app"; body: API.AccountRecoveryAppleProofRequest }',
772
+ exampleOptions: {
773
+ linkID: "00000000-0000-0000-0000-000000000000",
774
+ audience: "app",
775
+ body: {
776
+ code: "000000",
777
+ state: "<state>",
778
+ },
779
+ },
780
+ mutates: true,
781
+ },
782
+ {
783
+ id: "completeAccountRecoveryLinkWithGoogle",
784
+ method: "POST",
785
+ path: "/auth/api/v1/provider-links/recovery/{linkID}/google",
786
+ summary: "Prove ownership with an existing Google login and finish linking",
787
+ tag: "Authentication",
788
+ access: "public",
789
+ hasOptions: true,
790
+ optionsRequired: true,
791
+ optionsType: '{ linkID: string; audience?: "app"; body: API.AccountRecoveryGoogleProofRequest }',
792
+ exampleOptions: {
793
+ linkID: "00000000-0000-0000-0000-000000000000",
794
+ audience: "app",
795
+ body: {},
796
+ },
797
+ mutates: true,
798
+ },
799
+ {
800
+ id: "completeAccountRecoveryLinkWithMicrosoft",
801
+ method: "POST",
802
+ path: "/auth/api/v1/provider-links/recovery/{linkID}/microsoft",
803
+ summary: "Prove ownership with an existing Microsoft login and finish linking",
804
+ tag: "Authentication",
805
+ access: "public",
806
+ hasOptions: true,
807
+ optionsRequired: true,
808
+ optionsType: '{ linkID: string; audience?: "app"; body: API.AccountRecoveryMicrosoftProofRequest }',
809
+ exampleOptions: {
810
+ linkID: "00000000-0000-0000-0000-000000000000",
811
+ audience: "app",
812
+ body: {
813
+ credential: "<token>",
814
+ nonce: "<nonce>",
815
+ },
816
+ },
817
+ mutates: true,
818
+ },
819
+ {
820
+ id: "completeAccountRecoveryLinkWithPassword",
821
+ method: "POST",
822
+ path: "/auth/api/v1/provider-links/recovery/{linkID}/password",
823
+ summary: "Prove ownership with the existing account password and finish linking",
824
+ tag: "Authentication",
825
+ access: "public",
826
+ hasOptions: true,
827
+ optionsRequired: true,
828
+ optionsType: '{ linkID: string; audience?: "app"; body: API.AccountRecoveryPasswordProofRequest }',
829
+ exampleOptions: {
830
+ linkID: "00000000-0000-0000-0000-000000000000",
831
+ audience: "app",
832
+ body: {
833
+ password: "change-me-123456",
834
+ },
835
+ },
836
+ mutates: true,
837
+ },
838
+ {
839
+ id: "reauthenticateWithApple",
840
+ method: "POST",
841
+ path: "/auth/api/v1/reauthenticate/apple",
842
+ summary: "Reauthenticate the current session with a linked Apple identity",
843
+ tag: "Sessions",
844
+ access: "user",
845
+ hasOptions: true,
846
+ optionsRequired: true,
847
+ optionsType: "{ body: API.AppleReauthenticationRequest }",
848
+ exampleOptions: {
849
+ body: {
850
+ authentication_challenge_id: "00000000-0000-0000-0000-000000000000",
851
+ code: "000000",
852
+ state: "<state>",
853
+ },
854
+ },
855
+ mutates: true,
856
+ },
857
+ {
858
+ id: "checkRecentAuthentication",
859
+ method: "POST",
860
+ path: "/auth/api/v1/reauthenticate/check",
861
+ summary: "Require recent authentication for an application action",
862
+ tag: "Sessions",
863
+ access: "user",
864
+ hasOptions: false,
865
+ optionsRequired: false,
866
+ optionsType: "No options",
867
+ exampleOptions: {},
868
+ mutates: true,
869
+ },
870
+ {
871
+ id: "reauthenticateWithGoogle",
872
+ method: "POST",
873
+ path: "/auth/api/v1/reauthenticate/google",
874
+ summary: "Reauthenticate the current session with a linked Google identity",
875
+ tag: "Sessions",
876
+ access: "user",
877
+ hasOptions: true,
878
+ optionsRequired: true,
879
+ optionsType: "{ body: API.GoogleReauthenticationRequest }",
880
+ exampleOptions: {
881
+ body: {
882
+ authentication_challenge_id: "00000000-0000-0000-0000-000000000000",
883
+ },
884
+ },
885
+ mutates: true,
886
+ },
887
+ {
888
+ id: "reauthenticateWithMicrosoft",
889
+ method: "POST",
890
+ path: "/auth/api/v1/reauthenticate/microsoft",
891
+ summary: "Reauthenticate the current session with a linked Microsoft identity",
892
+ tag: "Sessions",
893
+ access: "user",
894
+ hasOptions: true,
895
+ optionsRequired: true,
896
+ optionsType: "{ body: API.MicrosoftReauthenticationRequest }",
897
+ exampleOptions: {
898
+ body: {
899
+ authentication_challenge_id: "00000000-0000-0000-0000-000000000000",
900
+ credential: "<token>",
901
+ nonce: "<nonce>",
902
+ },
903
+ },
904
+ mutates: true,
905
+ },
906
+ {
907
+ id: "finishPasskeyReauthentication",
908
+ method: "POST",
909
+ path: "/auth/api/v1/reauthenticate/passkeys/finish",
910
+ summary: "Finish passkey reauthentication for the current session",
911
+ tag: "Passkeys",
912
+ access: "user",
913
+ hasOptions: true,
914
+ optionsRequired: true,
915
+ optionsType: "{ body: API.PasskeyReauthenticationFinishRequest }",
916
+ exampleOptions: {
917
+ body: {
918
+ authentication_challenge_id: "00000000-0000-0000-0000-000000000000",
919
+ challenge_id: "00000000-0000-0000-0000-000000000000",
920
+ credential: {},
921
+ },
922
+ },
923
+ mutates: true,
924
+ },
925
+ {
926
+ id: "beginPasskeyReauthentication",
927
+ method: "POST",
928
+ path: "/auth/api/v1/reauthenticate/passkeys/options",
929
+ summary: "Start passkey reauthentication for the current session",
930
+ tag: "Passkeys",
931
+ access: "user",
932
+ hasOptions: true,
933
+ optionsRequired: true,
934
+ optionsType: "{ body: API.AuthenticationChallengeReference }",
935
+ exampleOptions: {
936
+ body: {
937
+ authentication_challenge_id: "00000000-0000-0000-0000-000000000000",
938
+ },
939
+ },
940
+ mutates: true,
941
+ },
942
+ {
943
+ id: "reauthenticateWithPassword",
944
+ method: "POST",
945
+ path: "/auth/api/v1/reauthenticate/password",
946
+ summary: "Reauthenticate the current session with a password",
947
+ tag: "Sessions",
948
+ access: "user",
949
+ hasOptions: true,
950
+ optionsRequired: true,
951
+ optionsType: "{ body: API.PasswordReauthenticationRequest }",
952
+ exampleOptions: {
953
+ body: {
954
+ authentication_challenge_id: "00000000-0000-0000-0000-000000000000",
955
+ password: "change-me-123456",
956
+ },
957
+ },
958
+ mutates: true,
959
+ },
960
+ {
961
+ id: "logout",
962
+ method: "POST",
963
+ path: "/auth/api/v1/sessions/logout",
964
+ summary: "Log out the current session",
965
+ tag: "Sessions",
966
+ access: "public",
967
+ hasOptions: false,
968
+ optionsRequired: false,
969
+ optionsType: "No options",
970
+ exampleOptions: {},
971
+ mutates: true,
972
+ },
973
+ {
974
+ id: "refreshSession",
975
+ method: "POST",
976
+ path: "/auth/api/v1/sessions/refresh",
977
+ summary: "Refresh a cookie-backed session",
978
+ tag: "Sessions",
979
+ access: "public",
980
+ hasOptions: true,
981
+ optionsRequired: false,
982
+ optionsType: '{ audience?: "app" | "admin" | "operator" }',
983
+ exampleOptions: {
984
+ audience: "app",
985
+ },
986
+ mutates: true,
987
+ },
988
+ {
989
+ id: "startSignupChallenge",
990
+ method: "POST",
991
+ path: "/auth/api/v1/signup/challenges",
992
+ summary: "Start challenge-based signup",
993
+ tag: "Authentication",
994
+ access: "public",
995
+ hasOptions: true,
996
+ optionsRequired: true,
997
+ optionsType: '{ audience?: "app"; session_transport?: "cookie" | "token"; body: API.SignupRequest }',
998
+ exampleOptions: {
999
+ audience: "app",
1000
+ session_transport: "token",
1001
+ body: {
1002
+ email: "mobile@example.com",
1003
+ password: "change-me-123456",
1004
+ },
1005
+ },
1006
+ mutates: true,
1007
+ },
1008
+ {
1009
+ id: "verifySignupChallenge",
1010
+ method: "POST",
1011
+ path: "/auth/api/v1/signup/challenges/verify",
1012
+ summary: "Verify a signup challenge and create the account",
1013
+ tag: "Authentication",
1014
+ access: "public",
1015
+ hasOptions: true,
1016
+ optionsRequired: true,
1017
+ optionsType: '{ audience?: "app"; session_transport?: "cookie" | "token"; body: API.SignupChallengeVerification }',
1018
+ exampleOptions: {
1019
+ audience: "app",
1020
+ session_transport: "token",
1021
+ body: {
1022
+ challenge_id: "00000000-0000-0000-0000-000000000000",
1023
+ code: "000000",
1024
+ },
1025
+ },
1026
+ mutates: true,
1027
+ },
1028
+ {
1029
+ id: "signupDirect",
1030
+ method: "POST",
1031
+ path: "/auth/api/v1/signup/direct",
1032
+ summary: "Create an account without a signup challenge",
1033
+ tag: "Authentication",
1034
+ access: "public",
1035
+ hasOptions: true,
1036
+ optionsRequired: true,
1037
+ optionsType: '{ audience?: "app"; session_transport?: "cookie" | "token"; body: API.SignupRequest }',
1038
+ exampleOptions: {
1039
+ audience: "app",
1040
+ session_transport: "token",
1041
+ body: {
1042
+ email: "mobile@example.com",
1043
+ password: "change-me-123456",
1044
+ },
1045
+ },
1046
+ mutates: true,
1047
+ },
1048
+ {
1049
+ id: "refreshTokens",
1050
+ method: "POST",
1051
+ path: "/auth/api/v1/tokens/refresh",
1052
+ summary: "Refresh tokens supplied in JSON",
1053
+ tag: "Sessions",
1054
+ access: "public",
1055
+ hasOptions: true,
1056
+ optionsRequired: true,
1057
+ optionsType: "{ body: API.TokenRefreshRequest }",
1058
+ exampleOptions: {
1059
+ body: {
1060
+ refresh_token: "<token>",
1061
+ },
1062
+ },
1063
+ mutates: true,
1064
+ },
1065
+ {
1066
+ id: "revokeTokens",
1067
+ method: "POST",
1068
+ path: "/auth/api/v1/tokens/revoke",
1069
+ summary: "Revoke a token-backed session",
1070
+ tag: "Sessions",
1071
+ access: "public",
1072
+ hasOptions: true,
1073
+ optionsRequired: true,
1074
+ optionsType: "{ body: API.TokenRevocationRequest }",
1075
+ exampleOptions: {
1076
+ body: {
1077
+ refresh_token: "<token>",
1078
+ },
1079
+ },
1080
+ mutates: true,
1081
+ },
1082
+ {
1083
+ id: "getCurrentUser",
1084
+ method: "GET",
1085
+ path: "/auth/api/v1/user",
1086
+ summary: "Get the authenticated user",
1087
+ tag: "Users",
1088
+ access: "user",
1089
+ hasOptions: false,
1090
+ optionsRequired: false,
1091
+ optionsType: "No options",
1092
+ exampleOptions: {},
1093
+ mutates: false,
1094
+ },
1095
+ {
1096
+ id: "setCurrentUserPassword",
1097
+ method: "PUT",
1098
+ path: "/auth/api/v1/users/password",
1099
+ summary: "Set the authenticated user's password",
1100
+ tag: "Users",
1101
+ access: "user",
1102
+ hasOptions: true,
1103
+ optionsRequired: true,
1104
+ optionsType: "{ body: API.SetPasswordRequest }",
1105
+ exampleOptions: {
1106
+ body: {
1107
+ password: "change-me-123456",
1108
+ },
1109
+ },
1110
+ mutates: true,
1111
+ },
1112
+ {
1113
+ id: "listPublicUserMemberships",
1114
+ method: "GET",
1115
+ path: "/auth/api/v1/users/{userID}/memberships",
1116
+ summary: "List memberships for the authenticated user",
1117
+ tag: "Organizations",
1118
+ access: "user",
1119
+ hasOptions: true,
1120
+ optionsRequired: true,
1121
+ optionsType: "{ userID: string; cursor?: string; limit?: number }",
1122
+ exampleOptions: {
1123
+ userID: "00000000-0000-0000-0000-000000000000",
1124
+ limit: 20,
1125
+ },
1126
+ mutates: false,
1127
+ },
1128
+ ];