You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If you are using the <ahref="#send-passwordless-login">Send Passwordless Login</a> API with the code returned by this call, that API will send a message using a delivery method appropriate for the <code>loginId</code> used here. If you supplied a username or email address <code>loginId</code>, the message will be sent via email. If you supplied a phone number <code>loginId</code> then the message will be delivered via an SMS messenger.
58
+
</span>
59
+
} />
60
+
<LoginIdTypeFieldplural />
57
61
<APIFieldname="state"type="Object"optional>
58
62
An optional object that will be returned un-modified when you complete the passwordless login request. This may be useful to return the user to particular state once they complete login using the passwordless code.
59
63
</APIField>
@@ -77,9 +81,9 @@ _Response Codes_
77
81
78
82
## Send Passwordless Login
79
83
80
-
This API allows you to send an email to a user that will contain a code that can be used to complete login. This API should be used if you want to build your own login page.
84
+
This API allows you to send an email or SMS message to a user that will contain a code that can be used to complete login. This API should be used if you want to build your own login page.
81
85
82
-
If you plan to utilize the FusionAuth login page then you will not need to use this API. Instead, once passwordless authentication is enabled for the FusionAuth Application, a new button will be presented to the user on the login page which will allow them to request an email.
86
+
If you plan to utilize the FusionAuth login page then you will not need to use this API. Instead, once passwordless authentication is enabled for the FusionAuth Application, a new button will be presented to the user on the login page which will allow them to request an email or SMS message.
83
87
84
88
This API does not require authentication.
85
89
@@ -89,15 +93,15 @@ This API does not require authentication.
89
93
Available Since Version 1.11.0.
90
94
</Aside>
91
95
92
-
<APImethod="POST"uri="/api/passwordless/send"authentication={["none"]}title="Send the provided code via email"/>
96
+
<APImethod="POST"uri="/api/passwordless/send"authentication={["none"]}title="Send the provided code via email or SMS"/>
The unique code to send via email, used to complete the login request. This value can be generated with a call to the [Start Passwordless Login](#start-passwordless-login) API.
104
+
The unique code to send via email or SMS, used to complete the login request. This value can be generated with a call to the [Start Passwordless Login](#start-passwordless-login) API.
101
105
</APIField>
102
106
</APIBlock>
103
107
@@ -106,7 +110,8 @@ Available Since Version 1.11.0.
106
110
<APImethod="POST"uri="/api/passwordless/send"authentication={["none"]}title="Generate a code and send a login link via email"/>
107
111
108
112
<Asidetype="caution"title="Deprecated usage">
109
-
This usage of the API may be removed at a later date. Once available prefer the usage outlined above which is available beginning in `1.11.0` which means you will need to use the Start API prior to calling this API.
113
+
* This usage of the API may be removed at a later date. Once available prefer the usage outlined above which is available beginning in `1.11.0` which means you will need to use the Start API prior to calling this API.
114
+
* Passwordless login with phone numbers, introduced in version `1.99.9`, is not supported by this API. Use the [Start Passwordless Login](#start-passwordless-login) API to obtain a code and then provide that code to this API (see above).
0 commit comments