Skip to content

Commit 4138c52

Browse files
Merge branch 'master' into sfa-mobile-guides
2 parents 25f967d + fe528a7 commit 4138c52

8 files changed

Lines changed: 131 additions & 11 deletions

File tree

docs/sdk/pnp/android/mfa.mdx

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ You can configure the order of MFA or enable/disable MFA type by passing the `mf
192192
// highlight-start
193193
mfaSettings = MfaSettings(
194194
deviceShareFactor = MfaSetting(true, 1, true),
195-
socialBackupFactor = MfaSetting(true, 2, false),
195+
socialBackupFactor = MfaSetting(true, 2, true),
196196
passwordFactor = MfaSetting(true, 3, false),
197197
backUpShareFactor = MfaSetting(true, 4, false),
198198
)
@@ -202,6 +202,21 @@ You can configure the order of MFA or enable/disable MFA type by passing the `mf
202202
)
203203
```
204204

205+
:::note Note
206+
207+
- At least two factors are mandatory when setting up the mfaSettings.
208+
- If you set `mandatory: true` for all factors, the user must set up all four factors.
209+
- If you set `mandatory: false` for all factors, the user can skip setting up MFA. But at least two
210+
factors are mandatory.
211+
- If you set `mandatory: true` for some factors and `mandatory: false` for others, the user must set
212+
up the mandatory factors and can skip the optional factors. But, the user must set up at least two
213+
factors.
214+
- The `priority` field is used to set the order of the factors. The factor with the lowest priority
215+
will be the first factor to be set up. The factor with the highest priority will be the last
216+
factor to be set up.
217+
218+
:::
219+
205220
## Using `enableMFA` method to trigger MFA setup flow for users
206221

207222
<EnableMFAMethod />

docs/sdk/pnp/flutter/mfa.mdx

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ Future<void> initWeb3Auth() async {
209209
deviceShareFactor: MfaSetting(
210210
enable: true,
211211
priority: 4,
212-
mandatory: false,
212+
mandatory: true,
213213
),
214214
backUpShareFactor: MfaSetting(
215215
enable: true,
@@ -234,6 +234,21 @@ Future<void> initWeb3Auth() async {
234234
}
235235
```
236236

237+
:::note Note
238+
239+
- At least two factors are mandatory when setting up the mfaSettings.
240+
- If you set `mandatory: true` for all factors, the user must set up all four factors.
241+
- If you set `mandatory: false` for all factors, the user can skip setting up MFA. But at least two
242+
factors are mandatory.
243+
- If you set `mandatory: true` for some factors and `mandatory: false` for others, the user must set
244+
up the mandatory factors and can skip the optional factors. But, the user must set up at least two
245+
factors.
246+
- The `priority` field is used to set the order of the factors. The factor with the lowest priority
247+
will be the first factor to be set up. The factor with the highest priority will be the last
248+
factor to be set up.
249+
250+
:::
251+
237252
## Using `enableMFA` method to trigger MFA setup flow for users
238253

239254
<EnableMFAMethod />

docs/sdk/pnp/ios/mfa.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,21 @@ let result = try await Web3Auth(
230230
))
231231
```
232232

233+
:::note Note
234+
235+
- At least two factors are mandatory when setting up the mfaSettings.
236+
- If you set `mandatory: true` for all factors, the user must set up all four factors.
237+
- If you set `mandatory: false` for all factors, the user can skip setting up MFA. But at least two
238+
factors are mandatory.
239+
- If you set `mandatory: true` for some factors and `mandatory: false` for others, the user must set
240+
up the mandatory factors and can skip the optional factors. But, the user must set up at least two
241+
factors.
242+
- The `priority` field is used to set the order of the factors. The factor with the lowest priority
243+
will be the first factor to be set up. The factor with the highest priority will be the last
244+
factor to be set up.
245+
246+
:::
247+
233248
## Using `enableMFA` method to trigger MFA setup flow for users
234249

235250
<EnableMFAMethod />

docs/sdk/pnp/react-native/mfa.mdx

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,23 +90,38 @@ const state = await web3auth.login({
9090
deviceShareFactor: {
9191
enable: true,
9292
priority: 1,
93-
mandatory: true,
93+
mandatory: true, // at least two factors are mandatory
9494
},
9595
backUpShareFactor: {
9696
enable: true,
9797
priority: 2,
98-
mandatory: true,
98+
mandatory: true, // at least two factors are mandatory
9999
},
100100
socialBackupFactor: {
101101
enable: true,
102102
priority: 3,
103-
mandatory: true,
103+
mandatory: true, // at least two factors are mandatory
104104
},
105105
passwordFactor: {
106106
enable: true,
107107
priority: 4,
108-
mandatory: true,
108+
mandatory: true, // at least two factors are mandatory
109109
},
110110
},
111111
});
112112
```
113+
114+
:::note Note
115+
116+
- At least two factors are mandatory when setting up the mfaSettings.
117+
- If you set `mandatory: true` for all factors, the user must set up all four factors.
118+
- If you set `mandatory: false` for all factors, the user can skip setting up MFA. But at least two
119+
factors are mandatory.
120+
- If you set `mandatory: true` for some factors and `mandatory: false` for others, the user must set
121+
up the mandatory factors and can skip the optional factors. But, the user must set up at least two
122+
factors.
123+
- The `priority` field is used to set the order of the factors. The factor with the lowest priority
124+
will be the first factor to be set up. The factor with the highest priority will be the last
125+
factor to be set up.
126+
127+
:::

docs/sdk/pnp/unity/mfa.mdx

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ public class Web3custom : MonoBehaviour
149149
clientId = "BAwFgL-r7wzQKmtcdiz2uHJKNZdK7gzEf2q-m55xfzSZOw8jLOyIi4AVvvzaEQO5nv2dFLEmf9LBkF8kaq3aErg",
150150
network = Web3Auth.Network.TESTNET,
151151
mfaSettings = new MfaSettings(
152-
new MfaSetting(true, 1, false),
152+
new MfaSetting(true, 1, true),
153153
new MfaSetting(true, 1, true),
154154
new MfaSetting(true, 1, false),
155155
new MfaSetting(true, 1, true)
@@ -165,3 +165,18 @@ public class Web3custom : MonoBehaviour
165165
}
166166

167167
```
168+
169+
:::note Note
170+
171+
- At least two factors are mandatory when setting up the mfaSettings.
172+
- If you set `mandatory: true` for all factors, the user must set up all four factors.
173+
- If you set `mandatory: false` for all factors, the user can skip setting up MFA. But at least two
174+
factors are mandatory.
175+
- If you set `mandatory: true` for some factors and `mandatory: false` for others, the user must set
176+
up the mandatory factors and can skip the optional factors. But, the user must set up at least two
177+
factors.
178+
- The `priority` field is used to set the order of the factors. The factor with the lowest priority
179+
will be the first factor to be set up. The factor with the highest priority will be the last
180+
factor to be set up.
181+
182+
:::

docs/sdk/pnp/unreal/mfa.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,21 @@ struct FMfaSettings
103103
};
104104
```
105105
106+
:::note Note
107+
108+
- At least two factors are mandatory when setting up the mfaSettings.
109+
- If you set `mandatory: true` for all factors, the user must set up all four factors.
110+
- If you set `mandatory: false` for all factors, the user can skip setting up MFA. But at least two
111+
factors are mandatory.
112+
- If you set `mandatory: true` for some factors and `mandatory: false` for others, the user must set
113+
up the mandatory factors and can skip the optional factors. But, the user must set up at least two
114+
factors.
115+
- The `priority` field is used to set the order of the factors. The factor with the lowest priority
116+
will be the first factor to be set up. The factor with the highest priority will be the last
117+
factor to be set up.
118+
119+
:::
120+
106121
### Usage
107122
108123
![Unreal Blueprint MFA Settings Options](/guides/sdk/unreal/unreal-mfa-settings.png)

docs/sdk/pnp/web/modal/mfa.mdx

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,12 +99,12 @@ const openloginAdapter = new OpenloginAdapter({
9999
deviceShareFactor: {
100100
enable: true,
101101
priority: 1,
102-
mandatory: true,
102+
mandatory: true, // at least two factors are mandatory
103103
},
104104
backUpShareFactor: {
105105
enable: true,
106106
priority: 2,
107-
mandatory: false,
107+
mandatory: true, // at least two factors are mandatory
108108
},
109109
socialBackupFactor: {
110110
enable: true,
@@ -120,3 +120,18 @@ const openloginAdapter = new OpenloginAdapter({
120120
},
121121
});
122122
```
123+
124+
:::note Note
125+
126+
- At least two factors are mandatory when setting up the mfaSettings.
127+
- If you set `mandatory: true` for all factors, the user must set up all four factors.
128+
- If you set `mandatory: false` for all factors, the user can skip setting up MFA. But at least two
129+
factors are mandatory.
130+
- If you set `mandatory: true` for some factors and `mandatory: false` for others, the user must set
131+
up the mandatory factors and can skip the optional factors. But, the user must set up at least two
132+
factors.
133+
- The `priority` field is used to set the order of the factors. The factor with the lowest priority
134+
will be the first factor to be set up. The factor with the highest priority will be the last
135+
factor to be set up.
136+
137+
:::

docs/sdk/pnp/web/no-modal/mfa.mdx

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,12 +100,12 @@ const openloginAdapter = new OpenloginAdapter({
100100
deviceShareFactor: {
101101
enable: true,
102102
priority: 1,
103-
mandatory: true,
103+
mandatory: true, // at least two factors are mandatory
104104
},
105105
backUpShareFactor: {
106106
enable: true,
107107
priority: 2,
108-
mandatory: false,
108+
mandatory: true, // at least two factors are mandatory
109109
},
110110
socialBackupFactor: {
111111
enable: true,
@@ -121,3 +121,18 @@ const openloginAdapter = new OpenloginAdapter({
121121
},
122122
});
123123
```
124+
125+
:::note Note
126+
127+
- At least two factors are mandatory when setting up the mfaSettings.
128+
- If you set `mandatory: true` for all factors, the user must set up all four factors.
129+
- If you set `mandatory: false` for all factors, the user can skip setting up MFA. But at least two
130+
factors are mandatory.
131+
- If you set `mandatory: true` for some factors and `mandatory: false` for others, the user must set
132+
up the mandatory factors and can skip the optional factors. But, the user must set up at least two
133+
factors.
134+
- The `priority` field is used to set the order of the factors. The factor with the lowest priority
135+
will be the first factor to be set up. The factor with the highest priority will be the last
136+
factor to be set up.
137+
138+
:::

0 commit comments

Comments
 (0)