Skip to content

Commit 3ce119e

Browse files
authored
Merge pull request #477 from kinde-oss/Feat/Twilio-for-MFA
Update to incorporate SMS MFA
2 parents 1248191 + fbfe60e commit 3ce119e

File tree

1 file changed

+34
-40
lines changed

1 file changed

+34
-40
lines changed

src/content/docs/authenticate/authentication-methods/phone-authentication.mdx

Lines changed: 34 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,26 @@ relatedArticles:
88
- 90f45d2e-cf59-4b5e-a26b-6dafd772e893
99
---
1010

11-
You can allow users to use their phone number as their primary identity for authentication. This is a passwordless method, where the user is sent a code via an SMS to verify them on sign in.
11+
You can allow users to use their phone as a primary method for authentication. This is a passwordless method, where the user is sent a verification code via SMS. SMS can also be included as a secondary factor if you have [multi-factor authentication](/authenticate/multi-factor-auth/about-multi-factor-authentication/) set up.
1212

1313
<Aside>
1414

1515
This feature requires paid third-party services to use. Rates and limitations apply.
1616

1717
</Aside>
1818

19+
## (Existing phone auth Twilio users only) Switch on SMS for MFA
20+
21+
1. In Kinde, go to **Settings > Environment > SMS**.
22+
2. Scroll to the bottom and switch on the **Use this service for SMS MFA** option.
23+
3. Select **Save**.
24+
25+
## Benefits of using a third-party SMS service instead of Kinde
26+
27+
- Gives you full control over the SMS delivery nuances, such as SenderID, country registrations, and detailed delivery metrics.
28+
- You can register dedicated short codes or sender IDs in countries that have strict SMS sending regulations like Ireland, NZ and Canada, which will greatly improve deliverability.
29+
- Access to delivery logs and other service quality details for troubleshooting.
30+
1931
## SMS provider requirements (Twilio)
2032

2133
SMS authentication requires the services of a messaging provider, in this case, [Twilio](https://www.twilio.com/en-us).
@@ -40,73 +52,55 @@ You’ll need the following details that are in the dashboard of your [Twilio ac
4052
- The Auth Token for your Twilio account
4153
- Your Twilio phone number or the Messaging Service SID (if you set one up)
4254

43-
<img
44-
src="https://imagedelivery.net/skPPZTHzSlcslvHjesZQcQ/1da93a0a-9fd3-437f-5357-be90f3f3c200/public"
45-
alt=""
46-
width="672px"
47-
height="auto"
48-
fetchpriority="low"
49-
loading="lazy"
50-
decoding="async"
51-
/>
55+
![Twilio account info](https://imagedelivery.net/skPPZTHzSlcslvHjesZQcQ/1da93a0a-9fd3-437f-5357-be90f3f3c200/public)
5256

5357
Refer to the [Twilio documentation](https://www.twilio.com/docs/messaging/services/tutorials/send-messages-with-messaging-services) for assistance setting up.
5458

5559
## Configure phone SMS auth in Kinde
5660

5761
After you set this up, you can use SMS for both phone authentication and SMS MFA.
5862

59-
1. In Kinde, go to **Authentication**.
60-
2. In the **Passwordless** section, select **Configure** on the **Phone** tile.
61-
3. Select the **Default country** that you want to show on the authentication screen when users sign in.
62-
4. Enter the Twilio details from your Twilio account (see above) in the relevant fields.
63+
1. In Kinde, go to **Settings > Environment > SMS**.
64+
2. Select the **Default country** that you want to show on the authentication screen when users sign in.
65+
3. Enter the Twilio details from your Twilio account (see above) in the relevant fields.
6366

64-
<img
65-
src="https://imagedelivery.net/skPPZTHzSlcslvHjesZQcQ/4c857ff9-ff87-44ea-a488-3e2b511caf00/public"
66-
alt=""
67-
width="672px"
68-
height="auto"
69-
fetchpriority="low"
70-
loading="lazy"
71-
decoding="async"
72-
/>
73-
74-
5. In the **SMS source** field, select either the **Use** **Messaging service** or **Use phone number**. Verification codes will be sent from whichever you choose.
67+
![twilio details](https://imagedelivery.net/skPPZTHzSlcslvHjesZQcQ/4c857ff9-ff87-44ea-a488-3e2b511caf00/public)
68+
69+
4. In the **SMS source** field, select either the **Use** **Messaging service** or **Use phone number**. Verification codes will be sent from whichever you choose.
7570

7671
<Aside>
7772

7873
Note that the Twilio messaging service is more suitable for global applications as it detects where the sign in comes from and sends from an appropriate number.
7974

8075
</Aside>
8176

82-
6. Depending on your selection in the previous step, enter either the **Messaging service SID** or Twilio **Phone number** in the relevant field.
77+
5. Depending on your selection in the previous step, enter either the **Messaging service SID** or Twilio **Phone number** in the relevant field.
8378

84-
<img
85-
src="https://imagedelivery.net/skPPZTHzSlcslvHjesZQcQ/749a80bc-d6b7-40b0-950a-650c7775b900/public"
86-
alt=""
87-
width="672px"
88-
height="auto"
89-
fetchpriority="low"
90-
loading="lazy"
91-
decoding="async"
92-
/>
79+
![Twilio config](https://imagedelivery.net/skPPZTHzSlcslvHjesZQcQ/749a80bc-d6b7-40b0-950a-650c7775b900/public)
9380

94-
7. Select if you want to use a fallback service if the provider service is interrupted.
81+
6. Select if you want to use a fallback service if the provider service is interrupted.
9582

96-
![option to use kinde sms as fallback](https://imagedelivery.net/skPPZTHzSlcslvHjesZQcQ/9bdd2ef1-c308-4307-c84e-bc8ffdbfe200/public)
83+
![option to use kinde sms as fallback](https://imagedelivery.net/skPPZTHzSlcslvHjesZQcQ/9bdd2ef1-c308-4307-c84e-bc8ffdbfe200/public)
9784

98-
8. Select which applications you want to switch phone auth on for. Only do this if you want users to be able to sign in with their phone number.
99-
9. Select **Save**.
85+
7. Select **Save**.
10086

10187
## Switch on phone authentication for an application
10288

10389
After you have set up Twilio details, you’re ready to switch on phone or SMS auth for your applications.
10490

105-
1. Go to **Settings > Authentication**.
91+
1. Go to **Settings > Environment > Authentication**.
10692
2. In the **Passwordless** section, select **Configure** on the **Phone** tile.
10793
3. Switch on the auth method for the applications you want.
10894
4. Select **Save**.
10995

96+
## Switch on SMS as a factor in MFA
97+
98+
If MFA is required or optional for your users, you may want to use the Twilio service for SMS MFA.
99+
100+
1. Go to **Settings > Environment > Multi-factor auth**.
101+
2. Under **Additional authentication methods**, switch on **SMS**.
102+
3. Select **Save**.
103+
110104
## SMS message format
111105

112106
You can’t customize the code message that user’s receive. We use a standard format as follows, to allow for easier translation.

0 commit comments

Comments
 (0)