@faable/auth-sdk 2.7.43 → 2.7.45
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.
- package/dist/FaableAuthApi.d.ts +9 -0
- package/dist/api/generated-client.d.ts +23 -0
- package/dist/api/types.d.ts +292 -0
- package/dist/version.js +2 -2
- package/package.json +1 -1
- package/spec/openapi.json +548 -1
package/dist/FaableAuthApi.d.ts
CHANGED
|
@@ -93,6 +93,7 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
|
|
|
93
93
|
} | undefined;
|
|
94
94
|
default_country_iso?: string | null | undefined;
|
|
95
95
|
webauthn_rp_id?: string | null | undefined;
|
|
96
|
+
logout_confirm_required?: boolean | undefined;
|
|
96
97
|
createdAt: string;
|
|
97
98
|
updatedAt?: string | undefined;
|
|
98
99
|
}>;
|
|
@@ -793,6 +794,8 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
|
|
|
793
794
|
software_version?: string | null | undefined;
|
|
794
795
|
frontchannel_logout_uri?: string | null | undefined;
|
|
795
796
|
frontchannel_logout_session_required?: boolean | undefined;
|
|
797
|
+
backchannel_logout_uri?: string | null | undefined;
|
|
798
|
+
backchannel_logout_session_required?: boolean | undefined;
|
|
796
799
|
login_methods?: {
|
|
797
800
|
order?: string[] | undefined;
|
|
798
801
|
disabled_connections?: string[] | undefined;
|
|
@@ -854,6 +857,8 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
|
|
|
854
857
|
software_version?: string | null | undefined;
|
|
855
858
|
frontchannel_logout_uri?: string | null | undefined;
|
|
856
859
|
frontchannel_logout_session_required?: boolean | undefined;
|
|
860
|
+
backchannel_logout_uri?: string | null | undefined;
|
|
861
|
+
backchannel_logout_session_required?: boolean | undefined;
|
|
857
862
|
login_methods?: {
|
|
858
863
|
order?: string[] | undefined;
|
|
859
864
|
disabled_connections?: string[] | undefined;
|
|
@@ -918,6 +923,8 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
|
|
|
918
923
|
software_version?: string | null | undefined;
|
|
919
924
|
frontchannel_logout_uri?: string | null | undefined;
|
|
920
925
|
frontchannel_logout_session_required?: boolean | undefined;
|
|
926
|
+
backchannel_logout_uri?: string | null | undefined;
|
|
927
|
+
backchannel_logout_session_required?: boolean | undefined;
|
|
921
928
|
login_methods?: {
|
|
922
929
|
order?: string[] | undefined;
|
|
923
930
|
disabled_connections?: string[] | undefined;
|
|
@@ -981,6 +988,8 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
|
|
|
981
988
|
software_version?: string | null | undefined;
|
|
982
989
|
frontchannel_logout_uri?: string | null | undefined;
|
|
983
990
|
frontchannel_logout_session_required?: boolean | undefined;
|
|
991
|
+
backchannel_logout_uri?: string | null | undefined;
|
|
992
|
+
backchannel_logout_session_required?: boolean | undefined;
|
|
984
993
|
login_methods?: {
|
|
985
994
|
order?: string[] | undefined;
|
|
986
995
|
disabled_connections?: string[] | undefined;
|
|
@@ -91,6 +91,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
91
91
|
} | undefined;
|
|
92
92
|
default_country_iso?: string | null | undefined;
|
|
93
93
|
webauthn_rp_id?: string | null | undefined;
|
|
94
|
+
logout_confirm_required?: boolean | undefined;
|
|
94
95
|
createdAt: string;
|
|
95
96
|
updatedAt?: string | undefined;
|
|
96
97
|
}>;
|
|
@@ -164,6 +165,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
164
165
|
} | undefined;
|
|
165
166
|
default_country_iso?: string | null | undefined;
|
|
166
167
|
webauthn_rp_id?: string | null | undefined;
|
|
168
|
+
logout_confirm_required?: boolean | undefined;
|
|
167
169
|
createdAt: string;
|
|
168
170
|
updatedAt?: string | undefined;
|
|
169
171
|
}>;
|
|
@@ -259,6 +261,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
259
261
|
} | undefined;
|
|
260
262
|
default_country_iso?: string | null | undefined;
|
|
261
263
|
webauthn_rp_id?: string | null | undefined;
|
|
264
|
+
logout_confirm_required?: boolean | undefined;
|
|
262
265
|
createdAt: string;
|
|
263
266
|
updatedAt?: string | undefined;
|
|
264
267
|
}>;
|
|
@@ -356,6 +359,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
356
359
|
} | undefined;
|
|
357
360
|
default_country_iso?: string | null | undefined;
|
|
358
361
|
webauthn_rp_id?: string | null | undefined;
|
|
362
|
+
logout_confirm_required?: boolean | undefined;
|
|
359
363
|
createdAt: string;
|
|
360
364
|
updatedAt?: string | undefined;
|
|
361
365
|
}[]>;
|
|
@@ -413,6 +417,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
413
417
|
} | undefined;
|
|
414
418
|
default_country_iso?: string | null | undefined;
|
|
415
419
|
webauthn_rp_id?: string | null | undefined;
|
|
420
|
+
logout_confirm_required?: boolean | undefined;
|
|
416
421
|
createdAt: string;
|
|
417
422
|
updatedAt?: string | undefined;
|
|
418
423
|
}>>;
|
|
@@ -473,6 +478,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
473
478
|
} | undefined;
|
|
474
479
|
default_country_iso?: string | null | undefined;
|
|
475
480
|
webauthn_rp_id?: string | null | undefined;
|
|
481
|
+
logout_confirm_required?: boolean | undefined;
|
|
476
482
|
createdAt: string;
|
|
477
483
|
updatedAt?: string | undefined;
|
|
478
484
|
}>>;
|
|
@@ -702,6 +708,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
702
708
|
} | undefined;
|
|
703
709
|
default_country_iso?: string | null | undefined;
|
|
704
710
|
webauthn_rp_id?: string | null | undefined;
|
|
711
|
+
logout_confirm_required?: boolean | undefined;
|
|
705
712
|
createdAt: string;
|
|
706
713
|
updatedAt?: string | undefined;
|
|
707
714
|
}>;
|
|
@@ -1218,6 +1225,8 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1218
1225
|
software_version?: string | null | undefined;
|
|
1219
1226
|
frontchannel_logout_uri?: string | null | undefined;
|
|
1220
1227
|
frontchannel_logout_session_required?: boolean | undefined;
|
|
1228
|
+
backchannel_logout_uri?: string | null | undefined;
|
|
1229
|
+
backchannel_logout_session_required?: boolean | undefined;
|
|
1221
1230
|
login_methods?: {
|
|
1222
1231
|
order?: string[] | undefined;
|
|
1223
1232
|
disabled_connections?: string[] | undefined;
|
|
@@ -1295,6 +1304,8 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1295
1304
|
software_version?: string | null | undefined;
|
|
1296
1305
|
frontchannel_logout_uri?: string | null | undefined;
|
|
1297
1306
|
frontchannel_logout_session_required?: boolean | undefined;
|
|
1307
|
+
backchannel_logout_uri?: string | null | undefined;
|
|
1308
|
+
backchannel_logout_session_required?: boolean | undefined;
|
|
1298
1309
|
login_methods?: {
|
|
1299
1310
|
order?: string[] | undefined;
|
|
1300
1311
|
disabled_connections?: string[] | undefined;
|
|
@@ -1373,6 +1384,8 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1373
1384
|
software_version?: string | null | undefined;
|
|
1374
1385
|
frontchannel_logout_uri?: string | null | undefined;
|
|
1375
1386
|
frontchannel_logout_session_required?: boolean | undefined;
|
|
1387
|
+
backchannel_logout_uri?: string | null | undefined;
|
|
1388
|
+
backchannel_logout_session_required?: boolean | undefined;
|
|
1376
1389
|
login_methods?: {
|
|
1377
1390
|
order?: string[] | undefined;
|
|
1378
1391
|
disabled_connections?: string[] | undefined;
|
|
@@ -1452,6 +1465,8 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1452
1465
|
software_version?: string | null | undefined;
|
|
1453
1466
|
frontchannel_logout_uri?: string | null | undefined;
|
|
1454
1467
|
frontchannel_logout_session_required?: boolean | undefined;
|
|
1468
|
+
backchannel_logout_uri?: string | null | undefined;
|
|
1469
|
+
backchannel_logout_session_required?: boolean | undefined;
|
|
1455
1470
|
login_methods?: {
|
|
1456
1471
|
order?: string[] | undefined;
|
|
1457
1472
|
disabled_connections?: string[] | undefined;
|
|
@@ -1513,6 +1528,8 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1513
1528
|
software_version?: string | null | undefined;
|
|
1514
1529
|
frontchannel_logout_uri?: string | null | undefined;
|
|
1515
1530
|
frontchannel_logout_session_required?: boolean | undefined;
|
|
1531
|
+
backchannel_logout_uri?: string | null | undefined;
|
|
1532
|
+
backchannel_logout_session_required?: boolean | undefined;
|
|
1516
1533
|
login_methods?: {
|
|
1517
1534
|
order?: string[] | undefined;
|
|
1518
1535
|
disabled_connections?: string[] | undefined;
|
|
@@ -1577,6 +1594,8 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1577
1594
|
software_version?: string | null | undefined;
|
|
1578
1595
|
frontchannel_logout_uri?: string | null | undefined;
|
|
1579
1596
|
frontchannel_logout_session_required?: boolean | undefined;
|
|
1597
|
+
backchannel_logout_uri?: string | null | undefined;
|
|
1598
|
+
backchannel_logout_session_required?: boolean | undefined;
|
|
1580
1599
|
login_methods?: {
|
|
1581
1600
|
order?: string[] | undefined;
|
|
1582
1601
|
disabled_connections?: string[] | undefined;
|
|
@@ -1657,6 +1676,8 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1657
1676
|
software_version?: string | null | undefined;
|
|
1658
1677
|
frontchannel_logout_uri?: string | null | undefined;
|
|
1659
1678
|
frontchannel_logout_session_required?: boolean | undefined;
|
|
1679
|
+
backchannel_logout_uri?: string | null | undefined;
|
|
1680
|
+
backchannel_logout_session_required?: boolean | undefined;
|
|
1660
1681
|
login_methods?: {
|
|
1661
1682
|
order?: string[] | undefined;
|
|
1662
1683
|
disabled_connections?: string[] | undefined;
|
|
@@ -1735,6 +1756,8 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1735
1756
|
software_version?: string | null | undefined;
|
|
1736
1757
|
frontchannel_logout_uri?: string | null | undefined;
|
|
1737
1758
|
frontchannel_logout_session_required?: boolean | undefined;
|
|
1759
|
+
backchannel_logout_uri?: string | null | undefined;
|
|
1760
|
+
backchannel_logout_session_required?: boolean | undefined;
|
|
1738
1761
|
login_methods?: {
|
|
1739
1762
|
order?: string[] | undefined;
|
|
1740
1763
|
disabled_connections?: string[] | undefined;
|
package/dist/api/types.d.ts
CHANGED
|
@@ -3916,6 +3916,26 @@ export interface paths {
|
|
|
3916
3916
|
patch?: never;
|
|
3917
3917
|
trace?: never;
|
|
3918
3918
|
};
|
|
3919
|
+
"/logout/confirm": {
|
|
3920
|
+
parameters: {
|
|
3921
|
+
query?: never;
|
|
3922
|
+
header?: never;
|
|
3923
|
+
path?: never;
|
|
3924
|
+
cookie?: never;
|
|
3925
|
+
};
|
|
3926
|
+
get?: never;
|
|
3927
|
+
put?: never;
|
|
3928
|
+
/**
|
|
3929
|
+
* Confirm a parked RP-Initiated Logout
|
|
3930
|
+
* @description Finishes a `/logout` request that was parked pending confirmation (backlog §240) because it carried no verified `id_token_hint`. Single-use: the state cannot be replayed.
|
|
3931
|
+
*/
|
|
3932
|
+
post: operations["session/logoutConfirm"];
|
|
3933
|
+
delete?: never;
|
|
3934
|
+
options?: never;
|
|
3935
|
+
head?: never;
|
|
3936
|
+
patch?: never;
|
|
3937
|
+
trace?: never;
|
|
3938
|
+
};
|
|
3919
3939
|
"/authorize": {
|
|
3920
3940
|
parameters: {
|
|
3921
3941
|
query?: never;
|
|
@@ -3936,6 +3956,26 @@ export interface paths {
|
|
|
3936
3956
|
patch?: never;
|
|
3937
3957
|
trace?: never;
|
|
3938
3958
|
};
|
|
3959
|
+
"/select-account": {
|
|
3960
|
+
parameters: {
|
|
3961
|
+
query?: never;
|
|
3962
|
+
header?: never;
|
|
3963
|
+
path?: never;
|
|
3964
|
+
cookie?: never;
|
|
3965
|
+
};
|
|
3966
|
+
get?: never;
|
|
3967
|
+
put?: never;
|
|
3968
|
+
/**
|
|
3969
|
+
* Answer the account chooser of a prompt=select_account login
|
|
3970
|
+
* @description Resumes an authorization request that `/authorize` parked on the hosted account chooser. Requires the session cookie of the user the chooser was shown to. Returns where the browser goes next: the client callback with a code, or a login screen.
|
|
3971
|
+
*/
|
|
3972
|
+
post: operations["oauth/selectAccount"];
|
|
3973
|
+
delete?: never;
|
|
3974
|
+
options?: never;
|
|
3975
|
+
head?: never;
|
|
3976
|
+
patch?: never;
|
|
3977
|
+
trace?: never;
|
|
3978
|
+
};
|
|
3939
3979
|
"/oauth/link_ticket": {
|
|
3940
3980
|
parameters: {
|
|
3941
3981
|
query?: never;
|
|
@@ -4475,6 +4515,8 @@ export interface components {
|
|
|
4475
4515
|
default_country_iso?: string | null;
|
|
4476
4516
|
/** @description WebAuthn Relying Party ID for this tenant's passkeys. Defaults to the account domain. Set it to a registrable suffix you own (e.g. `acme.com`) when the login screen is served from more than one host — the RP ID is frozen into every credential at registration, so changing it afterwards invalidates every passkey already enrolled. */
|
|
4477
4517
|
webauthn_rp_id?: string | null;
|
|
4518
|
+
/** @description When true, `/logout` asks the End-User to confirm before ending the session unless the request carries a verified `id_token_hint`. Off by default — a plain link to `/logout` is otherwise enough to sign anyone out (logout CSRF). */
|
|
4519
|
+
logout_confirm_required?: boolean;
|
|
4478
4520
|
/** @description AuthAccount creation date */
|
|
4479
4521
|
createdAt: string;
|
|
4480
4522
|
/** @description AuthAccount updated date */
|
|
@@ -4739,6 +4781,8 @@ export interface components {
|
|
|
4739
4781
|
software_version?: string | null;
|
|
4740
4782
|
frontchannel_logout_uri?: string | null;
|
|
4741
4783
|
frontchannel_logout_session_required?: boolean;
|
|
4784
|
+
backchannel_logout_uri?: string | null;
|
|
4785
|
+
backchannel_logout_session_required?: boolean;
|
|
4742
4786
|
/** @description Which login methods the hosted login screen offers and in what order. Set on the Account as the tenant default; the same object on a Client overrides it **field by field**, so a client can flip one flag without restating the rest. Absent everywhere = built-in defaults. */
|
|
4743
4787
|
login_methods?: {
|
|
4744
4788
|
/** @description Order in which the hosted login screen renders the available methods. Entries are Connection resource ids (`connection_xxx`) or the literal `passkey`. Methods not listed keep the built-in order (passwordless, database, social) after the listed ones; ids that no longer resolve are ignored. Listing an `oidc` connection here is also the only way to surface it on the login screen — see resolveLoginMethods(). */
|
|
@@ -4860,6 +4904,8 @@ export interface components {
|
|
|
4860
4904
|
software_version?: string | null;
|
|
4861
4905
|
frontchannel_logout_uri?: string | null;
|
|
4862
4906
|
frontchannel_logout_session_required?: boolean;
|
|
4907
|
+
backchannel_logout_uri?: string | null;
|
|
4908
|
+
backchannel_logout_session_required?: boolean;
|
|
4863
4909
|
login_methods?: {
|
|
4864
4910
|
/** @description Order in which the hosted login screen renders the available methods. Entries are Connection resource ids (`connection_xxx`) or the literal `passkey`. Methods not listed keep the built-in order (passwordless, database, social) after the listed ones; ids that no longer resolve are ignored. Listing an `oidc` connection here is also the only way to surface it on the login screen — see resolveLoginMethods(). */
|
|
4865
4911
|
order?: string[];
|
|
@@ -6280,6 +6326,10 @@ export interface components {
|
|
|
6280
6326
|
frontchannel_logout_uri?: string;
|
|
6281
6327
|
/** @description OIDC Front-Channel Logout 1.0 — when true, the OP MUST include `iss` and `sid` parameters when calling the frontchannel_logout_uri. */
|
|
6282
6328
|
frontchannel_logout_session_required?: boolean;
|
|
6329
|
+
/** @description OIDC Back-Channel Logout 1.0 — URL the OP POSTs a signed `logout_token` to when a session this client took part in ends. */
|
|
6330
|
+
backchannel_logout_uri?: string;
|
|
6331
|
+
/** @description OIDC Back-Channel Logout 1.0 — when true, the `logout_token` MUST include a `sid` claim. */
|
|
6332
|
+
backchannel_logout_session_required?: boolean;
|
|
6283
6333
|
/** @description Non-standard (Auth0-compatible) — origins (scheme://host[:port], no path) allowed to make cross-origin (CORS) requests to the token and passwordless endpoints. Empty allows any origin. */
|
|
6284
6334
|
web_origins?: string[];
|
|
6285
6335
|
} & {
|
|
@@ -6309,6 +6359,8 @@ export interface components {
|
|
|
6309
6359
|
software_version?: string;
|
|
6310
6360
|
frontchannel_logout_uri?: string;
|
|
6311
6361
|
frontchannel_logout_session_required?: boolean;
|
|
6362
|
+
backchannel_logout_uri?: string;
|
|
6363
|
+
backchannel_logout_session_required?: boolean;
|
|
6312
6364
|
web_origins?: string[];
|
|
6313
6365
|
} & {
|
|
6314
6366
|
[key: string]: unknown;
|
|
@@ -6447,6 +6499,7 @@ export interface components {
|
|
|
6447
6499
|
} | null;
|
|
6448
6500
|
default_country_iso?: string | null;
|
|
6449
6501
|
webauthn_rp_id?: string | null;
|
|
6502
|
+
logout_confirm_required?: boolean | null;
|
|
6450
6503
|
login_flow?: string | null;
|
|
6451
6504
|
};
|
|
6452
6505
|
FactorSummary: {
|
|
@@ -6512,6 +6565,14 @@ export interface components {
|
|
|
6512
6565
|
/** @description OIDC §3.1.2.1 — maximum allowable elapsed time in seconds since the last End-User authentication. If exceeded, the OP re-authenticates and `auth_time` is REQUIRED in the resulting id_token. */
|
|
6513
6566
|
max_age?: number;
|
|
6514
6567
|
prompt?: string;
|
|
6568
|
+
/** @description OIDC §3.1.2.1 — hint about the identifier (email, username) the End-User will sign in with. Pre-fills the hosted login screen and is forwarded to upstream identity providers. */
|
|
6569
|
+
login_hint?: string;
|
|
6570
|
+
/** @description OIDC §3.1.2.1 — an id_token this provider issued earlier for the user the client believes is signed in. Verified (signature, not expiry). With `prompt=none`, a session for a different user answers `login_required`; otherwise it forces a fresh sign-in. */
|
|
6571
|
+
id_token_hint?: string;
|
|
6572
|
+
/** @description OIDC §3.1.2.1 — space-separated Authentication Context Class References, in order of preference. `urn:faable:loa:2` asks for a second factor: a session that only has one is challenged (or, with `prompt=none`, answers `interaction_required`). */
|
|
6573
|
+
acr_values?: string;
|
|
6574
|
+
/** @description OIDC §3.1.2.1 — preferred languages for the hosted screens, space-separated BCP47 tags. Forwarded to upstream identity providers. */
|
|
6575
|
+
ui_locales?: string;
|
|
6515
6576
|
/** @description Auth0-compatible alias for `resource` (RFC 8707). When both are sent they must match. Identifier of the Api the client wants to access; persisted in the auth state so the token issued at /oauth/token targets the matching Api resource. */
|
|
6516
6577
|
audience?: string;
|
|
6517
6578
|
/** @description RFC 8707 Resource Indicator. MUST be an absolute URI without fragment. When matched against a registered Api in the tenant the issued access_token gets `aud = <api.identifier>`. */
|
|
@@ -6794,6 +6855,8 @@ export interface operations {
|
|
|
6794
6855
|
default_country_iso?: string | null;
|
|
6795
6856
|
/** @description WebAuthn Relying Party ID for this tenant's passkeys. Defaults to the account domain. Set it to a registrable suffix you own (e.g. `acme.com`) when the login screen is served from more than one host — the RP ID is frozen into every credential at registration, so changing it afterwards invalidates every passkey already enrolled. */
|
|
6796
6857
|
webauthn_rp_id?: string | null;
|
|
6858
|
+
/** @description When true, `/logout` asks the End-User to confirm before ending the session unless the request carries a verified `id_token_hint`. Off by default — a plain link to `/logout` is otherwise enough to sign anyone out (logout CSRF). */
|
|
6859
|
+
logout_confirm_required?: boolean;
|
|
6797
6860
|
/** @description AuthAccount creation date */
|
|
6798
6861
|
createdAt: string;
|
|
6799
6862
|
/** @description AuthAccount updated date */
|
|
@@ -7139,6 +7202,8 @@ export interface operations {
|
|
|
7139
7202
|
default_country_iso?: string | null;
|
|
7140
7203
|
/** @description WebAuthn Relying Party ID for this tenant's passkeys. Defaults to the account domain. Set it to a registrable suffix you own (e.g. `acme.com`) when the login screen is served from more than one host — the RP ID is frozen into every credential at registration, so changing it afterwards invalidates every passkey already enrolled. */
|
|
7141
7204
|
webauthn_rp_id?: string | null;
|
|
7205
|
+
/** @description When true, `/logout` asks the End-User to confirm before ending the session unless the request carries a verified `id_token_hint`. Off by default — a plain link to `/logout` is otherwise enough to sign anyone out (logout CSRF). */
|
|
7206
|
+
logout_confirm_required?: boolean;
|
|
7142
7207
|
/** @description AuthAccount creation date */
|
|
7143
7208
|
createdAt: string;
|
|
7144
7209
|
/** @description AuthAccount updated date */
|
|
@@ -7370,6 +7435,8 @@ export interface operations {
|
|
|
7370
7435
|
default_country_iso?: string | null;
|
|
7371
7436
|
/** @description WebAuthn Relying Party ID for this tenant's passkeys. Defaults to the account domain. Set it to a registrable suffix you own (e.g. `acme.com`) when the login screen is served from more than one host — the RP ID is frozen into every credential at registration, so changing it afterwards invalidates every passkey already enrolled. */
|
|
7372
7437
|
webauthn_rp_id?: string | null;
|
|
7438
|
+
/** @description When true, `/logout` asks the End-User to confirm before ending the session unless the request carries a verified `id_token_hint`. Off by default — a plain link to `/logout` is otherwise enough to sign anyone out (logout CSRF). */
|
|
7439
|
+
logout_confirm_required?: boolean;
|
|
7373
7440
|
/** @description AuthAccount creation date */
|
|
7374
7441
|
createdAt: string;
|
|
7375
7442
|
/** @description AuthAccount updated date */
|
|
@@ -7556,6 +7623,7 @@ export interface operations {
|
|
|
7556
7623
|
} | null;
|
|
7557
7624
|
default_country_iso?: string | null;
|
|
7558
7625
|
webauthn_rp_id?: string | null;
|
|
7626
|
+
logout_confirm_required?: boolean | null;
|
|
7559
7627
|
login_flow?: string | null;
|
|
7560
7628
|
};
|
|
7561
7629
|
};
|
|
@@ -7673,6 +7741,8 @@ export interface operations {
|
|
|
7673
7741
|
default_country_iso?: string | null;
|
|
7674
7742
|
/** @description WebAuthn Relying Party ID for this tenant's passkeys. Defaults to the account domain. Set it to a registrable suffix you own (e.g. `acme.com`) when the login screen is served from more than one host — the RP ID is frozen into every credential at registration, so changing it afterwards invalidates every passkey already enrolled. */
|
|
7675
7743
|
webauthn_rp_id?: string | null;
|
|
7744
|
+
/** @description When true, `/logout` asks the End-User to confirm before ending the session unless the request carries a verified `id_token_hint`. Off by default — a plain link to `/logout` is otherwise enough to sign anyone out (logout CSRF). */
|
|
7745
|
+
logout_confirm_required?: boolean;
|
|
7676
7746
|
/** @description AuthAccount creation date */
|
|
7677
7747
|
createdAt: string;
|
|
7678
7748
|
/** @description AuthAccount updated date */
|
|
@@ -10139,6 +10209,8 @@ export interface operations {
|
|
|
10139
10209
|
software_version?: string | null;
|
|
10140
10210
|
frontchannel_logout_uri?: string | null;
|
|
10141
10211
|
frontchannel_logout_session_required?: boolean;
|
|
10212
|
+
backchannel_logout_uri?: string | null;
|
|
10213
|
+
backchannel_logout_session_required?: boolean;
|
|
10142
10214
|
/** @description Which login methods the hosted login screen offers and in what order. Set on the Account as the tenant default; the same object on a Client overrides it **field by field**, so a client can flip one flag without restating the rest. Absent everywhere = built-in defaults. */
|
|
10143
10215
|
login_methods?: {
|
|
10144
10216
|
/** @description Order in which the hosted login screen renders the available methods. Entries are Connection resource ids (`connection_xxx`) or the literal `passkey`. Methods not listed keep the built-in order (passwordless, database, social) after the listed ones; ids that no longer resolve are ignored. Listing an `oidc` connection here is also the only way to surface it on the login screen — see resolveLoginMethods(). */
|
|
@@ -10335,6 +10407,8 @@ export interface operations {
|
|
|
10335
10407
|
software_version?: string | null;
|
|
10336
10408
|
frontchannel_logout_uri?: string | null;
|
|
10337
10409
|
frontchannel_logout_session_required?: boolean;
|
|
10410
|
+
backchannel_logout_uri?: string | null;
|
|
10411
|
+
backchannel_logout_session_required?: boolean;
|
|
10338
10412
|
/** @description Which login methods the hosted login screen offers and in what order. Set on the Account as the tenant default; the same object on a Client overrides it **field by field**, so a client can flip one flag without restating the rest. Absent everywhere = built-in defaults. */
|
|
10339
10413
|
login_methods?: {
|
|
10340
10414
|
/** @description Order in which the hosted login screen renders the available methods. Entries are Connection resource ids (`connection_xxx`) or the literal `passkey`. Methods not listed keep the built-in order (passwordless, database, social) after the listed ones; ids that no longer resolve are ignored. Listing an `oidc` connection here is also the only way to surface it on the login screen — see resolveLoginMethods(). */
|
|
@@ -10533,6 +10607,8 @@ export interface operations {
|
|
|
10533
10607
|
software_version?: string | null;
|
|
10534
10608
|
frontchannel_logout_uri?: string | null;
|
|
10535
10609
|
frontchannel_logout_session_required?: boolean;
|
|
10610
|
+
backchannel_logout_uri?: string | null;
|
|
10611
|
+
backchannel_logout_session_required?: boolean;
|
|
10536
10612
|
login_methods?: {
|
|
10537
10613
|
/** @description Order in which the hosted login screen renders the available methods. Entries are Connection resource ids (`connection_xxx`) or the literal `passkey`. Methods not listed keep the built-in order (passwordless, database, social) after the listed ones; ids that no longer resolve are ignored. Listing an `oidc` connection here is also the only way to surface it on the login screen — see resolveLoginMethods(). */
|
|
10538
10614
|
order?: string[];
|
|
@@ -10622,6 +10698,8 @@ export interface operations {
|
|
|
10622
10698
|
software_version?: string | null;
|
|
10623
10699
|
frontchannel_logout_uri?: string | null;
|
|
10624
10700
|
frontchannel_logout_session_required?: boolean;
|
|
10701
|
+
backchannel_logout_uri?: string | null;
|
|
10702
|
+
backchannel_logout_session_required?: boolean;
|
|
10625
10703
|
/** @description Which login methods the hosted login screen offers and in what order. Set on the Account as the tenant default; the same object on a Client overrides it **field by field**, so a client can flip one flag without restating the rest. Absent everywhere = built-in defaults. */
|
|
10626
10704
|
login_methods?: {
|
|
10627
10705
|
/** @description Order in which the hosted login screen renders the available methods. Entries are Connection resource ids (`connection_xxx`) or the literal `passkey`. Methods not listed keep the built-in order (passwordless, database, social) after the listed ones; ids that no longer resolve are ignored. Listing an `oidc` connection here is also the only way to surface it on the login screen — see resolveLoginMethods(). */
|
|
@@ -10824,6 +10902,8 @@ export interface operations {
|
|
|
10824
10902
|
software_version?: string | null;
|
|
10825
10903
|
frontchannel_logout_uri?: string | null;
|
|
10826
10904
|
frontchannel_logout_session_required?: boolean;
|
|
10905
|
+
backchannel_logout_uri?: string | null;
|
|
10906
|
+
backchannel_logout_session_required?: boolean;
|
|
10827
10907
|
/** @description Which login methods the hosted login screen offers and in what order. Set on the Account as the tenant default; the same object on a Client overrides it **field by field**, so a client can flip one flag without restating the rest. Absent everywhere = built-in defaults. */
|
|
10828
10908
|
login_methods?: {
|
|
10829
10909
|
/** @description Order in which the hosted login screen renders the available methods. Entries are Connection resource ids (`connection_xxx`) or the literal `passkey`. Methods not listed keep the built-in order (passwordless, database, social) after the listed ones; ids that no longer resolve are ignored. Listing an `oidc` connection here is also the only way to surface it on the login screen — see resolveLoginMethods(). */
|
|
@@ -11024,6 +11104,8 @@ export interface operations {
|
|
|
11024
11104
|
software_version?: string | null;
|
|
11025
11105
|
frontchannel_logout_uri?: string | null;
|
|
11026
11106
|
frontchannel_logout_session_required?: boolean;
|
|
11107
|
+
backchannel_logout_uri?: string | null;
|
|
11108
|
+
backchannel_logout_session_required?: boolean;
|
|
11027
11109
|
/** @description Which login methods the hosted login screen offers and in what order. Set on the Account as the tenant default; the same object on a Client overrides it **field by field**, so a client can flip one flag without restating the rest. Absent everywhere = built-in defaults. */
|
|
11028
11110
|
login_methods?: {
|
|
11029
11111
|
/** @description Order in which the hosted login screen renders the available methods. Entries are Connection resource ids (`connection_xxx`) or the literal `passkey`. Methods not listed keep the built-in order (passwordless, database, social) after the listed ones; ids that no longer resolve are ignored. Listing an `oidc` connection here is also the only way to surface it on the login screen — see resolveLoginMethods(). */
|
|
@@ -26166,6 +26248,95 @@ export interface operations {
|
|
|
26166
26248
|
};
|
|
26167
26249
|
};
|
|
26168
26250
|
};
|
|
26251
|
+
"session/logoutConfirm": {
|
|
26252
|
+
parameters: {
|
|
26253
|
+
query?: never;
|
|
26254
|
+
header?: never;
|
|
26255
|
+
path?: never;
|
|
26256
|
+
cookie?: never;
|
|
26257
|
+
};
|
|
26258
|
+
requestBody: {
|
|
26259
|
+
content: {
|
|
26260
|
+
"application/json": {
|
|
26261
|
+
/** @description The `state` the confirmation screen was opened with. */
|
|
26262
|
+
state: string;
|
|
26263
|
+
};
|
|
26264
|
+
};
|
|
26265
|
+
};
|
|
26266
|
+
responses: {
|
|
26267
|
+
/** @description Default Response */
|
|
26268
|
+
200: {
|
|
26269
|
+
headers: {
|
|
26270
|
+
[name: string]: unknown;
|
|
26271
|
+
};
|
|
26272
|
+
content?: never;
|
|
26273
|
+
};
|
|
26274
|
+
/**
|
|
26275
|
+
* @description `invalid_state` — The `state` is missing, expired, or does not describe a resumable step.
|
|
26276
|
+
*
|
|
26277
|
+
* `validation_error` — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
26278
|
+
*/
|
|
26279
|
+
400: {
|
|
26280
|
+
headers: {
|
|
26281
|
+
[name: string]: unknown;
|
|
26282
|
+
};
|
|
26283
|
+
content: {
|
|
26284
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
26285
|
+
/** @enum {string} */
|
|
26286
|
+
error_code?: "invalid_state" | "validation_error";
|
|
26287
|
+
};
|
|
26288
|
+
};
|
|
26289
|
+
};
|
|
26290
|
+
/** @description `state_mismatch` — The `state` belongs to another account, session, client or ceremony. */
|
|
26291
|
+
401: {
|
|
26292
|
+
headers: {
|
|
26293
|
+
[name: string]: unknown;
|
|
26294
|
+
};
|
|
26295
|
+
content: {
|
|
26296
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
26297
|
+
/** @enum {string} */
|
|
26298
|
+
error_code?: "state_mismatch";
|
|
26299
|
+
};
|
|
26300
|
+
};
|
|
26301
|
+
};
|
|
26302
|
+
/** @description `account_not_found` — No Auth Account matches the request (domain, header or token). */
|
|
26303
|
+
404: {
|
|
26304
|
+
headers: {
|
|
26305
|
+
[name: string]: unknown;
|
|
26306
|
+
};
|
|
26307
|
+
content: {
|
|
26308
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
26309
|
+
/** @enum {string} */
|
|
26310
|
+
error_code?: "account_not_found";
|
|
26311
|
+
};
|
|
26312
|
+
};
|
|
26313
|
+
};
|
|
26314
|
+
/** @description `too_many_requests` — Rate limit exceeded. Honour the `Retry-After` header. */
|
|
26315
|
+
429: {
|
|
26316
|
+
headers: {
|
|
26317
|
+
[name: string]: unknown;
|
|
26318
|
+
};
|
|
26319
|
+
content: {
|
|
26320
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
26321
|
+
/** @enum {string} */
|
|
26322
|
+
error_code?: "too_many_requests";
|
|
26323
|
+
};
|
|
26324
|
+
};
|
|
26325
|
+
};
|
|
26326
|
+
/** @description `internal_error` — Unexpected server error. Retry later; the request id is logged. */
|
|
26327
|
+
500: {
|
|
26328
|
+
headers: {
|
|
26329
|
+
[name: string]: unknown;
|
|
26330
|
+
};
|
|
26331
|
+
content: {
|
|
26332
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
26333
|
+
/** @enum {string} */
|
|
26334
|
+
error_code?: "internal_error";
|
|
26335
|
+
};
|
|
26336
|
+
};
|
|
26337
|
+
};
|
|
26338
|
+
};
|
|
26339
|
+
};
|
|
26169
26340
|
authorize: {
|
|
26170
26341
|
parameters: {
|
|
26171
26342
|
query: {
|
|
@@ -26203,6 +26374,14 @@ export interface operations {
|
|
|
26203
26374
|
/** @description OIDC §3.1.2.1 — maximum allowable elapsed time in seconds since the last End-User authentication. If exceeded, the OP re-authenticates and `auth_time` is REQUIRED in the resulting id_token. */
|
|
26204
26375
|
max_age?: number;
|
|
26205
26376
|
prompt?: string;
|
|
26377
|
+
/** @description OIDC §3.1.2.1 — hint about the identifier (email, username) the End-User will sign in with. Pre-fills the hosted login screen and is forwarded to upstream identity providers. */
|
|
26378
|
+
login_hint?: string;
|
|
26379
|
+
/** @description OIDC §3.1.2.1 — an id_token this provider issued earlier for the user the client believes is signed in. Verified (signature, not expiry). With `prompt=none`, a session for a different user answers `login_required`; otherwise it forces a fresh sign-in. */
|
|
26380
|
+
id_token_hint?: string;
|
|
26381
|
+
/** @description OIDC §3.1.2.1 — space-separated Authentication Context Class References, in order of preference. `urn:faable:loa:2` asks for a second factor: a session that only has one is challenged (or, with `prompt=none`, answers `interaction_required`). */
|
|
26382
|
+
acr_values?: string;
|
|
26383
|
+
/** @description OIDC §3.1.2.1 — preferred languages for the hosted screens, space-separated BCP47 tags. Forwarded to upstream identity providers. */
|
|
26384
|
+
ui_locales?: string;
|
|
26206
26385
|
/** @description Auth0-compatible alias for `resource` (RFC 8707). When both are sent they must match. Identifier of the Api the client wants to access; persisted in the auth state so the token issued at /oauth/token targets the matching Api resource. */
|
|
26207
26386
|
audience?: string;
|
|
26208
26387
|
/** @description RFC 8707 Resource Indicator. MUST be an absolute URI without fragment. When matched against a registered Api in the tenant the issued access_token gets `aud = <api.identifier>`. */
|
|
@@ -26309,6 +26488,105 @@ export interface operations {
|
|
|
26309
26488
|
};
|
|
26310
26489
|
};
|
|
26311
26490
|
};
|
|
26491
|
+
"oauth/selectAccount": {
|
|
26492
|
+
parameters: {
|
|
26493
|
+
query?: never;
|
|
26494
|
+
header?: never;
|
|
26495
|
+
path?: never;
|
|
26496
|
+
cookie?: never;
|
|
26497
|
+
};
|
|
26498
|
+
requestBody: {
|
|
26499
|
+
content: {
|
|
26500
|
+
"application/json": {
|
|
26501
|
+
/** @description The `state` the select-account screen was opened with. */
|
|
26502
|
+
state: string;
|
|
26503
|
+
/** @description `continue`: go on as the signed-in user. `other`: sign this browser out and start a fresh login for the same request. */
|
|
26504
|
+
choice: "continue" | "other";
|
|
26505
|
+
};
|
|
26506
|
+
};
|
|
26507
|
+
};
|
|
26508
|
+
responses: {
|
|
26509
|
+
/** @description Default Response */
|
|
26510
|
+
200: {
|
|
26511
|
+
headers: {
|
|
26512
|
+
[name: string]: unknown;
|
|
26513
|
+
};
|
|
26514
|
+
content: {
|
|
26515
|
+
"application/json": {
|
|
26516
|
+
redirect_url: string;
|
|
26517
|
+
};
|
|
26518
|
+
};
|
|
26519
|
+
};
|
|
26520
|
+
/**
|
|
26521
|
+
* @description `invalid_state` — The `state` is missing, expired, or does not describe a resumable step.
|
|
26522
|
+
*
|
|
26523
|
+
* `validation_error` — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
26524
|
+
*/
|
|
26525
|
+
400: {
|
|
26526
|
+
headers: {
|
|
26527
|
+
[name: string]: unknown;
|
|
26528
|
+
};
|
|
26529
|
+
content: {
|
|
26530
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
26531
|
+
/** @enum {string} */
|
|
26532
|
+
error_code?: "invalid_state" | "validation_error";
|
|
26533
|
+
};
|
|
26534
|
+
};
|
|
26535
|
+
};
|
|
26536
|
+
/**
|
|
26537
|
+
* @description `not_logged_in` — There is no signed-in session for this request.
|
|
26538
|
+
*
|
|
26539
|
+
* `state_mismatch` — The `state` belongs to another account, session, client or ceremony.
|
|
26540
|
+
*/
|
|
26541
|
+
401: {
|
|
26542
|
+
headers: {
|
|
26543
|
+
[name: string]: unknown;
|
|
26544
|
+
};
|
|
26545
|
+
content: {
|
|
26546
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
26547
|
+
/** @enum {string} */
|
|
26548
|
+
error_code?: "not_logged_in" | "state_mismatch";
|
|
26549
|
+
};
|
|
26550
|
+
};
|
|
26551
|
+
};
|
|
26552
|
+
/** @description `account_not_found` — No Auth Account matches the request (domain, header or token). */
|
|
26553
|
+
404: {
|
|
26554
|
+
headers: {
|
|
26555
|
+
[name: string]: unknown;
|
|
26556
|
+
};
|
|
26557
|
+
content: {
|
|
26558
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
26559
|
+
/** @enum {string} */
|
|
26560
|
+
error_code?: "account_not_found";
|
|
26561
|
+
};
|
|
26562
|
+
};
|
|
26563
|
+
};
|
|
26564
|
+
/** @description `too_many_requests` — Rate limit exceeded. Honour the `Retry-After` header. */
|
|
26565
|
+
429: {
|
|
26566
|
+
headers: {
|
|
26567
|
+
[name: string]: unknown;
|
|
26568
|
+
};
|
|
26569
|
+
content: {
|
|
26570
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
26571
|
+
/** @enum {string} */
|
|
26572
|
+
error_code?: "too_many_requests";
|
|
26573
|
+
};
|
|
26574
|
+
};
|
|
26575
|
+
};
|
|
26576
|
+
/** @description `internal_error` — Unexpected server error. Retry later; the request id is logged. */
|
|
26577
|
+
500: {
|
|
26578
|
+
headers: {
|
|
26579
|
+
[name: string]: unknown;
|
|
26580
|
+
};
|
|
26581
|
+
content: {
|
|
26582
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
26583
|
+
/** @enum {string} */
|
|
26584
|
+
error_code?: "internal_error";
|
|
26585
|
+
};
|
|
26586
|
+
};
|
|
26587
|
+
};
|
|
26588
|
+
};
|
|
26589
|
+
};
|
|
26312
26590
|
"oauth/link_ticket": {
|
|
26313
26591
|
parameters: {
|
|
26314
26592
|
query?: never;
|
|
@@ -27528,6 +27806,10 @@ export interface operations {
|
|
|
27528
27806
|
frontchannel_logout_uri?: string;
|
|
27529
27807
|
/** @description OIDC Front-Channel Logout 1.0 — when true, the OP MUST include `iss` and `sid` parameters when calling the frontchannel_logout_uri. */
|
|
27530
27808
|
frontchannel_logout_session_required?: boolean;
|
|
27809
|
+
/** @description OIDC Back-Channel Logout 1.0 — URL the OP POSTs a signed `logout_token` to when a session this client took part in ends. */
|
|
27810
|
+
backchannel_logout_uri?: string;
|
|
27811
|
+
/** @description OIDC Back-Channel Logout 1.0 — when true, the `logout_token` MUST include a `sid` claim. */
|
|
27812
|
+
backchannel_logout_session_required?: boolean;
|
|
27531
27813
|
/** @description Non-standard (Auth0-compatible) — origins (scheme://host[:port], no path) allowed to make cross-origin (CORS) requests to the token and passwordless endpoints. Empty allows any origin. */
|
|
27532
27814
|
web_origins?: string[];
|
|
27533
27815
|
} & {
|
|
@@ -27566,6 +27848,8 @@ export interface operations {
|
|
|
27566
27848
|
software_version?: string;
|
|
27567
27849
|
frontchannel_logout_uri?: string;
|
|
27568
27850
|
frontchannel_logout_session_required?: boolean;
|
|
27851
|
+
backchannel_logout_uri?: string;
|
|
27852
|
+
backchannel_logout_session_required?: boolean;
|
|
27569
27853
|
web_origins?: string[];
|
|
27570
27854
|
} & {
|
|
27571
27855
|
[key: string]: unknown;
|
|
@@ -27659,6 +27943,14 @@ export interface operations {
|
|
|
27659
27943
|
/** @description OIDC §3.1.2.1 — maximum allowable elapsed time in seconds since the last End-User authentication. If exceeded, the OP re-authenticates and `auth_time` is REQUIRED in the resulting id_token. */
|
|
27660
27944
|
max_age?: number;
|
|
27661
27945
|
prompt?: string;
|
|
27946
|
+
/** @description OIDC §3.1.2.1 — hint about the identifier (email, username) the End-User will sign in with. Pre-fills the hosted login screen and is forwarded to upstream identity providers. */
|
|
27947
|
+
login_hint?: string;
|
|
27948
|
+
/** @description OIDC §3.1.2.1 — an id_token this provider issued earlier for the user the client believes is signed in. Verified (signature, not expiry). With `prompt=none`, a session for a different user answers `login_required`; otherwise it forces a fresh sign-in. */
|
|
27949
|
+
id_token_hint?: string;
|
|
27950
|
+
/** @description OIDC §3.1.2.1 — space-separated Authentication Context Class References, in order of preference. `urn:faable:loa:2` asks for a second factor: a session that only has one is challenged (or, with `prompt=none`, answers `interaction_required`). */
|
|
27951
|
+
acr_values?: string;
|
|
27952
|
+
/** @description OIDC §3.1.2.1 — preferred languages for the hosted screens, space-separated BCP47 tags. Forwarded to upstream identity providers. */
|
|
27953
|
+
ui_locales?: string;
|
|
27662
27954
|
/** @description Auth0-compatible alias for `resource` (RFC 8707). When both are sent they must match. Identifier of the Api the client wants to access; persisted in the auth state so the token issued at /oauth/token targets the matching Api resource. */
|
|
27663
27955
|
audience?: string;
|
|
27664
27956
|
/** @description RFC 8707 Resource Indicator. MUST be an absolute URI without fragment. When matched against a registered Api in the tenant the issued access_token gets `aud = <api.identifier>`. */
|
package/dist/version.js
CHANGED
|
@@ -9,13 +9,13 @@
|
|
|
9
9
|
// login pages could not import the SDK at all. Same pattern as auth-js.
|
|
10
10
|
//
|
|
11
11
|
// The sentinels MUST stay byte-identical to the `from` values in `.releaserc`.
|
|
12
|
-
export const version = "2.7.
|
|
12
|
+
export const version = "2.7.45";
|
|
13
13
|
// Short git SHA of the released commit. The version dates a build; this names
|
|
14
14
|
// the exact tree, so a canonical log line or an audit entry leads straight to
|
|
15
15
|
// `git show <sha>`. Deliberately NOT hex: an unreleased build (dev, a local
|
|
16
16
|
// link) cannot be mistaken for a real commit — auth only records values that
|
|
17
17
|
// look like a SHA, and this one never will.
|
|
18
|
-
export const commit = "
|
|
18
|
+
export const commit = "0e88d02";
|
|
19
19
|
// What this SDK writes in `x-faable-client`. Exported for a consumer that
|
|
20
20
|
// builds a strategy on its own (outside `FaableAuthApi`) and still wants the
|
|
21
21
|
// token request attributed — a bare `authClientCredentials` stamps only what
|