@faable/auth-sdk 2.5.78 → 2.5.80
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 +18 -0
- package/dist/api/generated-client.d.ts +86 -0
- package/dist/api/types.d.ts +245 -3
- package/package.json +1 -1
- package/spec/openapi.json +852 -4
package/dist/api/types.d.ts
CHANGED
|
@@ -220,7 +220,7 @@ export interface paths {
|
|
|
220
220
|
patch?: never;
|
|
221
221
|
trace?: never;
|
|
222
222
|
};
|
|
223
|
-
"/
|
|
223
|
+
"/login/identify": {
|
|
224
224
|
parameters: {
|
|
225
225
|
query?: never;
|
|
226
226
|
header?: never;
|
|
@@ -233,7 +233,7 @@ export interface paths {
|
|
|
233
233
|
* Leave the identifier-first screen
|
|
234
234
|
* @description Records the identifier the user typed on the hosted `/flow/identify` screen and advances the login to the method chooser. `state` is the id the screen was opened with; it stays valid, so the chooser is reached with the same `?state=`.
|
|
235
235
|
*/
|
|
236
|
-
post: operations["
|
|
236
|
+
post: operations["login/identify"];
|
|
237
237
|
delete?: never;
|
|
238
238
|
options?: never;
|
|
239
239
|
head?: never;
|
|
@@ -1529,6 +1529,54 @@ export interface paths {
|
|
|
1529
1529
|
patch?: never;
|
|
1530
1530
|
trace?: never;
|
|
1531
1531
|
};
|
|
1532
|
+
"/mfa/challenge/options": {
|
|
1533
|
+
parameters: {
|
|
1534
|
+
query?: never;
|
|
1535
|
+
header?: never;
|
|
1536
|
+
path?: never;
|
|
1537
|
+
cookie?: never;
|
|
1538
|
+
};
|
|
1539
|
+
/**
|
|
1540
|
+
* What the second-factor screen should offer
|
|
1541
|
+
* @description For a login parked on the hosted challenge screen: which factors the user can answer with, in the order and with the default the login flow chose, and whether recovery codes are an option. Reads the state without consuming it.
|
|
1542
|
+
*/
|
|
1543
|
+
get: {
|
|
1544
|
+
parameters: {
|
|
1545
|
+
query: {
|
|
1546
|
+
state: string;
|
|
1547
|
+
};
|
|
1548
|
+
header?: never;
|
|
1549
|
+
path?: never;
|
|
1550
|
+
cookie?: never;
|
|
1551
|
+
};
|
|
1552
|
+
requestBody?: never;
|
|
1553
|
+
responses: {
|
|
1554
|
+
/** @description Default Response */
|
|
1555
|
+
200: {
|
|
1556
|
+
headers: {
|
|
1557
|
+
[name: string]: unknown;
|
|
1558
|
+
};
|
|
1559
|
+
content: {
|
|
1560
|
+
"application/json": {
|
|
1561
|
+
/** @description The ways this user can answer, in the order the screen should offer them. Only factors the user actually has and the policy accepts. */
|
|
1562
|
+
factors: ("totp" | "webauthn")[];
|
|
1563
|
+
/** @description The one to mark as the default, when there are several. */
|
|
1564
|
+
preferred?: "totp" | "webauthn";
|
|
1565
|
+
/** @description Whether to offer the recovery-code way in: the flow allows it and the user has codes. */
|
|
1566
|
+
recovery: boolean;
|
|
1567
|
+
};
|
|
1568
|
+
};
|
|
1569
|
+
};
|
|
1570
|
+
};
|
|
1571
|
+
};
|
|
1572
|
+
put?: never;
|
|
1573
|
+
post?: never;
|
|
1574
|
+
delete?: never;
|
|
1575
|
+
options?: never;
|
|
1576
|
+
head?: never;
|
|
1577
|
+
patch?: never;
|
|
1578
|
+
trace?: never;
|
|
1579
|
+
};
|
|
1532
1580
|
"/mfa/verify": {
|
|
1533
1581
|
parameters: {
|
|
1534
1582
|
query?: never;
|
|
@@ -2123,6 +2171,8 @@ export interface paths {
|
|
|
2123
2171
|
client_id: string;
|
|
2124
2172
|
redirect_to?: string;
|
|
2125
2173
|
state?: string;
|
|
2174
|
+
/** @description The "Remember me on this device" checkbox. Honoured only when the tenant shows one (`login_methods.remember_me: "optional"`). */
|
|
2175
|
+
remember_me?: boolean;
|
|
2126
2176
|
};
|
|
2127
2177
|
};
|
|
2128
2178
|
};
|
|
@@ -2678,6 +2728,21 @@ export interface components {
|
|
|
2678
2728
|
*/
|
|
2679
2729
|
verify_email_auto_send: boolean;
|
|
2680
2730
|
};
|
|
2731
|
+
welcome_email?: {
|
|
2732
|
+
/**
|
|
2733
|
+
* Format: uri
|
|
2734
|
+
* @description Where the welcome button sends the user. Defaults to `https://<first callback hostname>`. Point it at your app (not your marketing site) so a fresh user lands somewhere useful.
|
|
2735
|
+
*/
|
|
2736
|
+
cta_url?: string | null;
|
|
2737
|
+
/** @description Replaces the default one-line body ("Your account on … is ready to go."). Plain text, sent verbatim in every enabled locale. */
|
|
2738
|
+
body?: string | null;
|
|
2739
|
+
/** @description Rendered as a "Follow <account>" block after the button — GitHub, LinkedIn, X, YouTube… Empty or absent hides the block. */
|
|
2740
|
+
social_links?: {
|
|
2741
|
+
label: string;
|
|
2742
|
+
/** Format: uri */
|
|
2743
|
+
url: string;
|
|
2744
|
+
}[] | null;
|
|
2745
|
+
} | null;
|
|
2681
2746
|
/** @description Policy for the user email-change flow. `new_only` (default) sends a single confirmation link to the new email. `old_and_new` requires the user to also click a link sent to the previous email before the swap takes effect — stricter, useful for tenants with higher-risk users. */
|
|
2682
2747
|
email_change_verification_mode?: "new_only" | "old_and_new";
|
|
2683
2748
|
/**
|
|
@@ -2705,6 +2770,10 @@ export interface components {
|
|
|
2705
2770
|
passkey_promotion_snooze_days?: number;
|
|
2706
2771
|
/** @description How many times a user is offered a passkey over their lifetime. `0` switches the offer off for this tenant without changing `passkey_promotion`. Defaults to 3. */
|
|
2707
2772
|
passkey_promotion_max_prompts?: number;
|
|
2773
|
+
/** @description Show a "Remember me on this device" checkbox on the password and email-code forms. `optional`: unchecked, the session ends when the browser closes; checked, it lasts `remember_me_days`. `off` (the default): no checkbox, every session lasts the built-in 30 days. */
|
|
2774
|
+
remember_me?: "off" | "optional";
|
|
2775
|
+
/** @description How long a session lasts when the user ticked "Remember me". Defaults to 30. */
|
|
2776
|
+
remember_me_days?: number;
|
|
2708
2777
|
};
|
|
2709
2778
|
/** @description The login flow bound to this account (`loginflow_xxx`). Absent = the flow compiled from the settings. A Client may bind its own. */
|
|
2710
2779
|
login_flow?: string | null;
|
|
@@ -2993,6 +3062,10 @@ export interface components {
|
|
|
2993
3062
|
passkey_promotion_snooze_days?: number;
|
|
2994
3063
|
/** @description How many times a user is offered a passkey over their lifetime. `0` switches the offer off for this tenant without changing `passkey_promotion`. Defaults to 3. */
|
|
2995
3064
|
passkey_promotion_max_prompts?: number;
|
|
3065
|
+
/** @description Show a "Remember me on this device" checkbox on the password and email-code forms. `optional`: unchecked, the session ends when the browser closes; checked, it lasts `remember_me_days`. `off` (the default): no checkbox, every session lasts the built-in 30 days. */
|
|
3066
|
+
remember_me?: "off" | "optional";
|
|
3067
|
+
/** @description How long a session lasts when the user ticked "Remember me". Defaults to 30. */
|
|
3068
|
+
remember_me_days?: number;
|
|
2996
3069
|
};
|
|
2997
3070
|
/** @description Second-factor policy. Set on the Account as the tenant default; the same object on a Client overrides it **field by field**, so one app can require MFA without changing the rest. */
|
|
2998
3071
|
mfa_policy?: {
|
|
@@ -3094,6 +3167,10 @@ export interface components {
|
|
|
3094
3167
|
passkey_promotion_snooze_days?: number;
|
|
3095
3168
|
/** @description How many times a user is offered a passkey over their lifetime. `0` switches the offer off for this tenant without changing `passkey_promotion`. Defaults to 3. */
|
|
3096
3169
|
passkey_promotion_max_prompts?: number;
|
|
3170
|
+
/** @description Show a "Remember me on this device" checkbox on the password and email-code forms. `optional`: unchecked, the session ends when the browser closes; checked, it lasts `remember_me_days`. `off` (the default): no checkbox, every session lasts the built-in 30 days. */
|
|
3171
|
+
remember_me?: "off" | "optional";
|
|
3172
|
+
/** @description How long a session lasts when the user ticked "Remember me". Defaults to 30. */
|
|
3173
|
+
remember_me_days?: number;
|
|
3097
3174
|
} | null;
|
|
3098
3175
|
mfa_policy?: {
|
|
3099
3176
|
/** @description `off` (default) never challenges. `optional` challenges a user who has enrolled a factor, and lets everyone else in. `required` challenges everyone and sends users with no factor through enrolment during login — it never locks anyone out in place. */
|
|
@@ -4505,6 +4582,21 @@ export interface components {
|
|
|
4505
4582
|
*/
|
|
4506
4583
|
verify_email_auto_send: boolean;
|
|
4507
4584
|
};
|
|
4585
|
+
welcome_email?: {
|
|
4586
|
+
/**
|
|
4587
|
+
* Format: uri
|
|
4588
|
+
* @description Where the welcome button sends the user. Defaults to `https://<first callback hostname>`. Point it at your app (not your marketing site) so a fresh user lands somewhere useful.
|
|
4589
|
+
*/
|
|
4590
|
+
cta_url?: string | null;
|
|
4591
|
+
/** @description Replaces the default one-line body ("Your account on … is ready to go."). Plain text, sent verbatim in every enabled locale. */
|
|
4592
|
+
body?: string | null;
|
|
4593
|
+
/** @description Rendered as a "Follow <account>" block after the button — GitHub, LinkedIn, X, YouTube… Empty or absent hides the block. */
|
|
4594
|
+
social_links?: {
|
|
4595
|
+
label: string;
|
|
4596
|
+
/** Format: uri */
|
|
4597
|
+
url: string;
|
|
4598
|
+
}[] | null;
|
|
4599
|
+
} | null;
|
|
4508
4600
|
login_methods?: {
|
|
4509
4601
|
/** @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(). */
|
|
4510
4602
|
order?: string[];
|
|
@@ -4522,6 +4614,10 @@ export interface components {
|
|
|
4522
4614
|
passkey_promotion_snooze_days?: number;
|
|
4523
4615
|
/** @description How many times a user is offered a passkey over their lifetime. `0` switches the offer off for this tenant without changing `passkey_promotion`. Defaults to 3. */
|
|
4524
4616
|
passkey_promotion_max_prompts?: number;
|
|
4617
|
+
/** @description Show a "Remember me on this device" checkbox on the password and email-code forms. `optional`: unchecked, the session ends when the browser closes; checked, it lasts `remember_me_days`. `off` (the default): no checkbox, every session lasts the built-in 30 days. */
|
|
4618
|
+
remember_me?: "off" | "optional";
|
|
4619
|
+
/** @description How long a session lasts when the user ticked "Remember me". Defaults to 30. */
|
|
4620
|
+
remember_me_days?: number;
|
|
4525
4621
|
} | null;
|
|
4526
4622
|
mfa_policy?: {
|
|
4527
4623
|
/** @description `off` (default) never challenges. `optional` challenges a user who has enrolled a factor, and lets everyone else in. `required` challenges everyone and sends users with no factor through enrolment during login — it never locks anyone out in place. */
|
|
@@ -4579,6 +4675,8 @@ export interface components {
|
|
|
4579
4675
|
response_type?: string;
|
|
4580
4676
|
/** @description Same-origin path to return the user to after authentication, instead of the OAuth client redirect. Used by first-party interactive flows (e.g. device-code confirm). Non same-origin values are ignored. */
|
|
4581
4677
|
redirect_to?: string;
|
|
4678
|
+
/** @description The "Remember me on this device" checkbox. Honoured only when the tenant shows one (`login_methods.remember_me: "optional"`): `true` keeps the session for `remember_me_days`, `false` ends it when the browser closes. */
|
|
4679
|
+
remember_me?: boolean;
|
|
4582
4680
|
client_id: string;
|
|
4583
4681
|
/** @description Deprecated. Use connection_id */
|
|
4584
4682
|
connection?: string;
|
|
@@ -4662,6 +4760,21 @@ export interface operations {
|
|
|
4662
4760
|
*/
|
|
4663
4761
|
verify_email_auto_send: boolean;
|
|
4664
4762
|
};
|
|
4763
|
+
welcome_email?: {
|
|
4764
|
+
/**
|
|
4765
|
+
* Format: uri
|
|
4766
|
+
* @description Where the welcome button sends the user. Defaults to `https://<first callback hostname>`. Point it at your app (not your marketing site) so a fresh user lands somewhere useful.
|
|
4767
|
+
*/
|
|
4768
|
+
cta_url?: string | null;
|
|
4769
|
+
/** @description Replaces the default one-line body ("Your account on … is ready to go."). Plain text, sent verbatim in every enabled locale. */
|
|
4770
|
+
body?: string | null;
|
|
4771
|
+
/** @description Rendered as a "Follow <account>" block after the button — GitHub, LinkedIn, X, YouTube… Empty or absent hides the block. */
|
|
4772
|
+
social_links?: {
|
|
4773
|
+
label: string;
|
|
4774
|
+
/** Format: uri */
|
|
4775
|
+
url: string;
|
|
4776
|
+
}[] | null;
|
|
4777
|
+
} | null;
|
|
4665
4778
|
/** @description Policy for the user email-change flow. `new_only` (default) sends a single confirmation link to the new email. `old_and_new` requires the user to also click a link sent to the previous email before the swap takes effect — stricter, useful for tenants with higher-risk users. */
|
|
4666
4779
|
email_change_verification_mode?: "new_only" | "old_and_new";
|
|
4667
4780
|
/**
|
|
@@ -4689,6 +4802,10 @@ export interface operations {
|
|
|
4689
4802
|
passkey_promotion_snooze_days?: number;
|
|
4690
4803
|
/** @description How many times a user is offered a passkey over their lifetime. `0` switches the offer off for this tenant without changing `passkey_promotion`. Defaults to 3. */
|
|
4691
4804
|
passkey_promotion_max_prompts?: number;
|
|
4805
|
+
/** @description Show a "Remember me on this device" checkbox on the password and email-code forms. `optional`: unchecked, the session ends when the browser closes; checked, it lasts `remember_me_days`. `off` (the default): no checkbox, every session lasts the built-in 30 days. */
|
|
4806
|
+
remember_me?: "off" | "optional";
|
|
4807
|
+
/** @description How long a session lasts when the user ticked "Remember me". Defaults to 30. */
|
|
4808
|
+
remember_me_days?: number;
|
|
4692
4809
|
};
|
|
4693
4810
|
/** @description The login flow bound to this account (`loginflow_xxx`). Absent = the flow compiled from the settings. A Client may bind its own. */
|
|
4694
4811
|
login_flow?: string | null;
|
|
@@ -4808,6 +4925,21 @@ export interface operations {
|
|
|
4808
4925
|
*/
|
|
4809
4926
|
verify_email_auto_send: boolean;
|
|
4810
4927
|
};
|
|
4928
|
+
welcome_email?: {
|
|
4929
|
+
/**
|
|
4930
|
+
* Format: uri
|
|
4931
|
+
* @description Where the welcome button sends the user. Defaults to `https://<first callback hostname>`. Point it at your app (not your marketing site) so a fresh user lands somewhere useful.
|
|
4932
|
+
*/
|
|
4933
|
+
cta_url?: string | null;
|
|
4934
|
+
/** @description Replaces the default one-line body ("Your account on … is ready to go."). Plain text, sent verbatim in every enabled locale. */
|
|
4935
|
+
body?: string | null;
|
|
4936
|
+
/** @description Rendered as a "Follow <account>" block after the button — GitHub, LinkedIn, X, YouTube… Empty or absent hides the block. */
|
|
4937
|
+
social_links?: {
|
|
4938
|
+
label: string;
|
|
4939
|
+
/** Format: uri */
|
|
4940
|
+
url: string;
|
|
4941
|
+
}[] | null;
|
|
4942
|
+
} | null;
|
|
4811
4943
|
/** @description Policy for the user email-change flow. `new_only` (default) sends a single confirmation link to the new email. `old_and_new` requires the user to also click a link sent to the previous email before the swap takes effect — stricter, useful for tenants with higher-risk users. */
|
|
4812
4944
|
email_change_verification_mode?: "new_only" | "old_and_new";
|
|
4813
4945
|
/**
|
|
@@ -4835,6 +4967,10 @@ export interface operations {
|
|
|
4835
4967
|
passkey_promotion_snooze_days?: number;
|
|
4836
4968
|
/** @description How many times a user is offered a passkey over their lifetime. `0` switches the offer off for this tenant without changing `passkey_promotion`. Defaults to 3. */
|
|
4837
4969
|
passkey_promotion_max_prompts?: number;
|
|
4970
|
+
/** @description Show a "Remember me on this device" checkbox on the password and email-code forms. `optional`: unchecked, the session ends when the browser closes; checked, it lasts `remember_me_days`. `off` (the default): no checkbox, every session lasts the built-in 30 days. */
|
|
4971
|
+
remember_me?: "off" | "optional";
|
|
4972
|
+
/** @description How long a session lasts when the user ticked "Remember me". Defaults to 30. */
|
|
4973
|
+
remember_me_days?: number;
|
|
4838
4974
|
};
|
|
4839
4975
|
/** @description The login flow bound to this account (`loginflow_xxx`). Absent = the flow compiled from the settings. A Client may bind its own. */
|
|
4840
4976
|
login_flow?: string | null;
|
|
@@ -4908,6 +5044,21 @@ export interface operations {
|
|
|
4908
5044
|
*/
|
|
4909
5045
|
verify_email_auto_send: boolean;
|
|
4910
5046
|
};
|
|
5047
|
+
welcome_email?: {
|
|
5048
|
+
/**
|
|
5049
|
+
* Format: uri
|
|
5050
|
+
* @description Where the welcome button sends the user. Defaults to `https://<first callback hostname>`. Point it at your app (not your marketing site) so a fresh user lands somewhere useful.
|
|
5051
|
+
*/
|
|
5052
|
+
cta_url?: string | null;
|
|
5053
|
+
/** @description Replaces the default one-line body ("Your account on … is ready to go."). Plain text, sent verbatim in every enabled locale. */
|
|
5054
|
+
body?: string | null;
|
|
5055
|
+
/** @description Rendered as a "Follow <account>" block after the button — GitHub, LinkedIn, X, YouTube… Empty or absent hides the block. */
|
|
5056
|
+
social_links?: {
|
|
5057
|
+
label: string;
|
|
5058
|
+
/** Format: uri */
|
|
5059
|
+
url: string;
|
|
5060
|
+
}[] | null;
|
|
5061
|
+
} | null;
|
|
4911
5062
|
/** @description Policy for the user email-change flow. `new_only` (default) sends a single confirmation link to the new email. `old_and_new` requires the user to also click a link sent to the previous email before the swap takes effect — stricter, useful for tenants with higher-risk users. */
|
|
4912
5063
|
email_change_verification_mode?: "new_only" | "old_and_new";
|
|
4913
5064
|
/**
|
|
@@ -4935,6 +5086,10 @@ export interface operations {
|
|
|
4935
5086
|
passkey_promotion_snooze_days?: number;
|
|
4936
5087
|
/** @description How many times a user is offered a passkey over their lifetime. `0` switches the offer off for this tenant without changing `passkey_promotion`. Defaults to 3. */
|
|
4937
5088
|
passkey_promotion_max_prompts?: number;
|
|
5089
|
+
/** @description Show a "Remember me on this device" checkbox on the password and email-code forms. `optional`: unchecked, the session ends when the browser closes; checked, it lasts `remember_me_days`. `off` (the default): no checkbox, every session lasts the built-in 30 days. */
|
|
5090
|
+
remember_me?: "off" | "optional";
|
|
5091
|
+
/** @description How long a session lasts when the user ticked "Remember me". Defaults to 30. */
|
|
5092
|
+
remember_me_days?: number;
|
|
4938
5093
|
};
|
|
4939
5094
|
/** @description The login flow bound to this account (`loginflow_xxx`). Absent = the flow compiled from the settings. A Client may bind its own. */
|
|
4940
5095
|
login_flow?: string | null;
|
|
@@ -4990,6 +5145,21 @@ export interface operations {
|
|
|
4990
5145
|
*/
|
|
4991
5146
|
verify_email_auto_send?: boolean;
|
|
4992
5147
|
};
|
|
5148
|
+
welcome_email?: {
|
|
5149
|
+
/**
|
|
5150
|
+
* Format: uri
|
|
5151
|
+
* @description Where the welcome button sends the user. Defaults to `https://<first callback hostname>`. Point it at your app (not your marketing site) so a fresh user lands somewhere useful.
|
|
5152
|
+
*/
|
|
5153
|
+
cta_url?: string | null;
|
|
5154
|
+
/** @description Replaces the default one-line body ("Your account on … is ready to go."). Plain text, sent verbatim in every enabled locale. */
|
|
5155
|
+
body?: string | null;
|
|
5156
|
+
/** @description Rendered as a "Follow <account>" block after the button — GitHub, LinkedIn, X, YouTube… Empty or absent hides the block. */
|
|
5157
|
+
social_links?: {
|
|
5158
|
+
label: string;
|
|
5159
|
+
/** Format: uri */
|
|
5160
|
+
url: string;
|
|
5161
|
+
}[] | null;
|
|
5162
|
+
} | null;
|
|
4993
5163
|
login_methods?: {
|
|
4994
5164
|
/** @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(). */
|
|
4995
5165
|
order?: string[];
|
|
@@ -5007,6 +5177,10 @@ export interface operations {
|
|
|
5007
5177
|
passkey_promotion_snooze_days?: number;
|
|
5008
5178
|
/** @description How many times a user is offered a passkey over their lifetime. `0` switches the offer off for this tenant without changing `passkey_promotion`. Defaults to 3. */
|
|
5009
5179
|
passkey_promotion_max_prompts?: number;
|
|
5180
|
+
/** @description Show a "Remember me on this device" checkbox on the password and email-code forms. `optional`: unchecked, the session ends when the browser closes; checked, it lasts `remember_me_days`. `off` (the default): no checkbox, every session lasts the built-in 30 days. */
|
|
5181
|
+
remember_me?: "off" | "optional";
|
|
5182
|
+
/** @description How long a session lasts when the user ticked "Remember me". Defaults to 30. */
|
|
5183
|
+
remember_me_days?: number;
|
|
5010
5184
|
} | null;
|
|
5011
5185
|
mfa_policy?: {
|
|
5012
5186
|
/** @description `off` (default) never challenges. `optional` challenges a user who has enrolled a factor, and lets everyone else in. `required` challenges everyone and sends users with no factor through enrolment during login — it never locks anyone out in place. */
|
|
@@ -5058,6 +5232,21 @@ export interface operations {
|
|
|
5058
5232
|
*/
|
|
5059
5233
|
verify_email_auto_send: boolean;
|
|
5060
5234
|
};
|
|
5235
|
+
welcome_email?: {
|
|
5236
|
+
/**
|
|
5237
|
+
* Format: uri
|
|
5238
|
+
* @description Where the welcome button sends the user. Defaults to `https://<first callback hostname>`. Point it at your app (not your marketing site) so a fresh user lands somewhere useful.
|
|
5239
|
+
*/
|
|
5240
|
+
cta_url?: string | null;
|
|
5241
|
+
/** @description Replaces the default one-line body ("Your account on … is ready to go."). Plain text, sent verbatim in every enabled locale. */
|
|
5242
|
+
body?: string | null;
|
|
5243
|
+
/** @description Rendered as a "Follow <account>" block after the button — GitHub, LinkedIn, X, YouTube… Empty or absent hides the block. */
|
|
5244
|
+
social_links?: {
|
|
5245
|
+
label: string;
|
|
5246
|
+
/** Format: uri */
|
|
5247
|
+
url: string;
|
|
5248
|
+
}[] | null;
|
|
5249
|
+
} | null;
|
|
5061
5250
|
/** @description Policy for the user email-change flow. `new_only` (default) sends a single confirmation link to the new email. `old_and_new` requires the user to also click a link sent to the previous email before the swap takes effect — stricter, useful for tenants with higher-risk users. */
|
|
5062
5251
|
email_change_verification_mode?: "new_only" | "old_and_new";
|
|
5063
5252
|
/**
|
|
@@ -5085,6 +5274,10 @@ export interface operations {
|
|
|
5085
5274
|
passkey_promotion_snooze_days?: number;
|
|
5086
5275
|
/** @description How many times a user is offered a passkey over their lifetime. `0` switches the offer off for this tenant without changing `passkey_promotion`. Defaults to 3. */
|
|
5087
5276
|
passkey_promotion_max_prompts?: number;
|
|
5277
|
+
/** @description Show a "Remember me on this device" checkbox on the password and email-code forms. `optional`: unchecked, the session ends when the browser closes; checked, it lasts `remember_me_days`. `off` (the default): no checkbox, every session lasts the built-in 30 days. */
|
|
5278
|
+
remember_me?: "off" | "optional";
|
|
5279
|
+
/** @description How long a session lasts when the user ticked "Remember me". Defaults to 30. */
|
|
5280
|
+
remember_me_days?: number;
|
|
5088
5281
|
};
|
|
5089
5282
|
/** @description The login flow bound to this account (`loginflow_xxx`). Absent = the flow compiled from the settings. A Client may bind its own. */
|
|
5090
5283
|
login_flow?: string | null;
|
|
@@ -5167,6 +5360,21 @@ export interface operations {
|
|
|
5167
5360
|
*/
|
|
5168
5361
|
verify_email_auto_send: boolean;
|
|
5169
5362
|
};
|
|
5363
|
+
welcome_email?: {
|
|
5364
|
+
/**
|
|
5365
|
+
* Format: uri
|
|
5366
|
+
* @description Where the welcome button sends the user. Defaults to `https://<first callback hostname>`. Point it at your app (not your marketing site) so a fresh user lands somewhere useful.
|
|
5367
|
+
*/
|
|
5368
|
+
cta_url?: string | null;
|
|
5369
|
+
/** @description Replaces the default one-line body ("Your account on … is ready to go."). Plain text, sent verbatim in every enabled locale. */
|
|
5370
|
+
body?: string | null;
|
|
5371
|
+
/** @description Rendered as a "Follow <account>" block after the button — GitHub, LinkedIn, X, YouTube… Empty or absent hides the block. */
|
|
5372
|
+
social_links?: {
|
|
5373
|
+
label: string;
|
|
5374
|
+
/** Format: uri */
|
|
5375
|
+
url: string;
|
|
5376
|
+
}[] | null;
|
|
5377
|
+
} | null;
|
|
5170
5378
|
/** @description Policy for the user email-change flow. `new_only` (default) sends a single confirmation link to the new email. `old_and_new` requires the user to also click a link sent to the previous email before the swap takes effect — stricter, useful for tenants with higher-risk users. */
|
|
5171
5379
|
email_change_verification_mode?: "new_only" | "old_and_new";
|
|
5172
5380
|
/**
|
|
@@ -5194,6 +5402,10 @@ export interface operations {
|
|
|
5194
5402
|
passkey_promotion_snooze_days?: number;
|
|
5195
5403
|
/** @description How many times a user is offered a passkey over their lifetime. `0` switches the offer off for this tenant without changing `passkey_promotion`. Defaults to 3. */
|
|
5196
5404
|
passkey_promotion_max_prompts?: number;
|
|
5405
|
+
/** @description Show a "Remember me on this device" checkbox on the password and email-code forms. `optional`: unchecked, the session ends when the browser closes; checked, it lasts `remember_me_days`. `off` (the default): no checkbox, every session lasts the built-in 30 days. */
|
|
5406
|
+
remember_me?: "off" | "optional";
|
|
5407
|
+
/** @description How long a session lasts when the user ticked "Remember me". Defaults to 30. */
|
|
5408
|
+
remember_me_days?: number;
|
|
5197
5409
|
};
|
|
5198
5410
|
/** @description The login flow bound to this account (`loginflow_xxx`). Absent = the flow compiled from the settings. A Client may bind its own. */
|
|
5199
5411
|
login_flow?: string | null;
|
|
@@ -5744,6 +5956,8 @@ export interface operations {
|
|
|
5744
5956
|
} | null;
|
|
5745
5957
|
identifier_first: boolean;
|
|
5746
5958
|
remember_last_method: boolean;
|
|
5959
|
+
/** @description Render a "Remember me on this device" checkbox on the password and email-code forms, and send its value as `remember_me` when posting the credential. */
|
|
5960
|
+
remember_me: boolean;
|
|
5747
5961
|
/** @description What the user typed on the identifier-first screen, when the flow has one. Prefill the email field with it. */
|
|
5748
5962
|
identifier?: string;
|
|
5749
5963
|
/** @description The method key that was moved first because this browser used it last time (`remember_last_method`). Absent otherwise. */
|
|
@@ -5755,7 +5969,7 @@ export interface operations {
|
|
|
5755
5969
|
};
|
|
5756
5970
|
};
|
|
5757
5971
|
};
|
|
5758
|
-
"
|
|
5972
|
+
"login/identify": {
|
|
5759
5973
|
parameters: {
|
|
5760
5974
|
query?: never;
|
|
5761
5975
|
header?: never;
|
|
@@ -5900,6 +6114,10 @@ export interface operations {
|
|
|
5900
6114
|
passkey_promotion_snooze_days?: number;
|
|
5901
6115
|
/** @description How many times a user is offered a passkey over their lifetime. `0` switches the offer off for this tenant without changing `passkey_promotion`. Defaults to 3. */
|
|
5902
6116
|
passkey_promotion_max_prompts?: number;
|
|
6117
|
+
/** @description Show a "Remember me on this device" checkbox on the password and email-code forms. `optional`: unchecked, the session ends when the browser closes; checked, it lasts `remember_me_days`. `off` (the default): no checkbox, every session lasts the built-in 30 days. */
|
|
6118
|
+
remember_me?: "off" | "optional";
|
|
6119
|
+
/** @description How long a session lasts when the user ticked "Remember me". Defaults to 30. */
|
|
6120
|
+
remember_me_days?: number;
|
|
5903
6121
|
};
|
|
5904
6122
|
/** @description Second-factor policy. Set on the Account as the tenant default; the same object on a Client overrides it **field by field**, so one app can require MFA without changing the rest. */
|
|
5905
6123
|
mfa_policy?: {
|
|
@@ -5999,6 +6217,10 @@ export interface operations {
|
|
|
5999
6217
|
passkey_promotion_snooze_days?: number;
|
|
6000
6218
|
/** @description How many times a user is offered a passkey over their lifetime. `0` switches the offer off for this tenant without changing `passkey_promotion`. Defaults to 3. */
|
|
6001
6219
|
passkey_promotion_max_prompts?: number;
|
|
6220
|
+
/** @description Show a "Remember me on this device" checkbox on the password and email-code forms. `optional`: unchecked, the session ends when the browser closes; checked, it lasts `remember_me_days`. `off` (the default): no checkbox, every session lasts the built-in 30 days. */
|
|
6221
|
+
remember_me?: "off" | "optional";
|
|
6222
|
+
/** @description How long a session lasts when the user ticked "Remember me". Defaults to 30. */
|
|
6223
|
+
remember_me_days?: number;
|
|
6002
6224
|
};
|
|
6003
6225
|
/** @description Second-factor policy. Set on the Account as the tenant default; the same object on a Client overrides it **field by field**, so one app can require MFA without changing the rest. */
|
|
6004
6226
|
mfa_policy?: {
|
|
@@ -6092,6 +6314,10 @@ export interface operations {
|
|
|
6092
6314
|
passkey_promotion_snooze_days?: number;
|
|
6093
6315
|
/** @description How many times a user is offered a passkey over their lifetime. `0` switches the offer off for this tenant without changing `passkey_promotion`. Defaults to 3. */
|
|
6094
6316
|
passkey_promotion_max_prompts?: number;
|
|
6317
|
+
/** @description Show a "Remember me on this device" checkbox on the password and email-code forms. `optional`: unchecked, the session ends when the browser closes; checked, it lasts `remember_me_days`. `off` (the default): no checkbox, every session lasts the built-in 30 days. */
|
|
6318
|
+
remember_me?: "off" | "optional";
|
|
6319
|
+
/** @description How long a session lasts when the user ticked "Remember me". Defaults to 30. */
|
|
6320
|
+
remember_me_days?: number;
|
|
6095
6321
|
} | null;
|
|
6096
6322
|
mfa_policy?: {
|
|
6097
6323
|
/** @description `off` (default) never challenges. `optional` challenges a user who has enrolled a factor, and lets everyone else in. `required` challenges everyone and sends users with no factor through enrolment during login — it never locks anyone out in place. */
|
|
@@ -6171,6 +6397,10 @@ export interface operations {
|
|
|
6171
6397
|
passkey_promotion_snooze_days?: number;
|
|
6172
6398
|
/** @description How many times a user is offered a passkey over their lifetime. `0` switches the offer off for this tenant without changing `passkey_promotion`. Defaults to 3. */
|
|
6173
6399
|
passkey_promotion_max_prompts?: number;
|
|
6400
|
+
/** @description Show a "Remember me on this device" checkbox on the password and email-code forms. `optional`: unchecked, the session ends when the browser closes; checked, it lasts `remember_me_days`. `off` (the default): no checkbox, every session lasts the built-in 30 days. */
|
|
6401
|
+
remember_me?: "off" | "optional";
|
|
6402
|
+
/** @description How long a session lasts when the user ticked "Remember me". Defaults to 30. */
|
|
6403
|
+
remember_me_days?: number;
|
|
6174
6404
|
};
|
|
6175
6405
|
/** @description Second-factor policy. Set on the Account as the tenant default; the same object on a Client overrides it **field by field**, so one app can require MFA without changing the rest. */
|
|
6176
6406
|
mfa_policy?: {
|
|
@@ -6270,6 +6500,10 @@ export interface operations {
|
|
|
6270
6500
|
passkey_promotion_snooze_days?: number;
|
|
6271
6501
|
/** @description How many times a user is offered a passkey over their lifetime. `0` switches the offer off for this tenant without changing `passkey_promotion`. Defaults to 3. */
|
|
6272
6502
|
passkey_promotion_max_prompts?: number;
|
|
6503
|
+
/** @description Show a "Remember me on this device" checkbox on the password and email-code forms. `optional`: unchecked, the session ends when the browser closes; checked, it lasts `remember_me_days`. `off` (the default): no checkbox, every session lasts the built-in 30 days. */
|
|
6504
|
+
remember_me?: "off" | "optional";
|
|
6505
|
+
/** @description How long a session lasts when the user ticked "Remember me". Defaults to 30. */
|
|
6506
|
+
remember_me_days?: number;
|
|
6273
6507
|
};
|
|
6274
6508
|
/** @description Second-factor policy. Set on the Account as the tenant default; the same object on a Client overrides it **field by field**, so one app can require MFA without changing the rest. */
|
|
6275
6509
|
mfa_policy?: {
|
|
@@ -6369,6 +6603,10 @@ export interface operations {
|
|
|
6369
6603
|
passkey_promotion_snooze_days?: number;
|
|
6370
6604
|
/** @description How many times a user is offered a passkey over their lifetime. `0` switches the offer off for this tenant without changing `passkey_promotion`. Defaults to 3. */
|
|
6371
6605
|
passkey_promotion_max_prompts?: number;
|
|
6606
|
+
/** @description Show a "Remember me on this device" checkbox on the password and email-code forms. `optional`: unchecked, the session ends when the browser closes; checked, it lasts `remember_me_days`. `off` (the default): no checkbox, every session lasts the built-in 30 days. */
|
|
6607
|
+
remember_me?: "off" | "optional";
|
|
6608
|
+
/** @description How long a session lasts when the user ticked "Remember me". Defaults to 30. */
|
|
6609
|
+
remember_me_days?: number;
|
|
6372
6610
|
};
|
|
6373
6611
|
/** @description Second-factor policy. Set on the Account as the tenant default; the same object on a Client overrides it **field by field**, so one app can require MFA without changing the rest. */
|
|
6374
6612
|
mfa_policy?: {
|
|
@@ -11652,6 +11890,8 @@ export interface operations {
|
|
|
11652
11890
|
otp: string;
|
|
11653
11891
|
/** @description Same-origin path to return the user to after authentication, instead of the OAuth client redirect. Used by first-party interactive flows (e.g. device-code confirm). Non same-origin values are ignored. */
|
|
11654
11892
|
redirect_to?: string;
|
|
11893
|
+
/** @description The "Remember me on this device" checkbox. Honoured only when the tenant shows one (`login_methods.remember_me: "optional"`). */
|
|
11894
|
+
remember_me?: boolean;
|
|
11655
11895
|
};
|
|
11656
11896
|
};
|
|
11657
11897
|
};
|
|
@@ -12480,6 +12720,8 @@ export interface operations {
|
|
|
12480
12720
|
response_type?: string;
|
|
12481
12721
|
/** @description Same-origin path to return the user to after authentication, instead of the OAuth client redirect. Used by first-party interactive flows (e.g. device-code confirm). Non same-origin values are ignored. */
|
|
12482
12722
|
redirect_to?: string;
|
|
12723
|
+
/** @description The "Remember me on this device" checkbox. Honoured only when the tenant shows one (`login_methods.remember_me: "optional"`): `true` keeps the session for `remember_me_days`, `false` ends it when the browser closes. */
|
|
12724
|
+
remember_me?: boolean;
|
|
12483
12725
|
client_id: string;
|
|
12484
12726
|
/** @description Deprecated. Use connection_id */
|
|
12485
12727
|
connection?: string;
|