github-starred/better-auth
2
0
Fork 0
mirror of https://github.com/better-auth/better-auth.git synced 2026-10-18 11:32:15 -05:00
Code Issues 2.5k Packages Projects Releases 112 Wiki Activity

docs(magic-link): correct APIMethod contract and document rateLimit (#11497)

Browse Source 
Co-authored-by: Taesu <bytaesu@gmail.com>
This commit is contained in:
Md Sufiyan
2026-10-01 15:53:51 +09:00
committed by GitHub
co-authored by Taesu
parent db02f23391
commit 55b67da016
1 changed files with 16 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/docs/plugins/magic-link.mdx
+16 -4
View File
@@ -55,7 +55,7 @@ Magic link or email link is a way to authenticate users without a password. When
To sign in with a magic link, you need to call `signIn.magicLink` with the user's email address. The `sendMagicLink` function is called to send the magic link to the user's email.
<APIMethod path="/sign-in/magic-link" method="POST" requireSession>
<APIMethod path="/sign-in/magic-link" method="POST" requireHeaders>
```ts
type signInMagicLink = {
/**
@@ -71,11 +71,11 @@ To sign in with a magic link, you need to call `signIn.magicLink` with the user'
*/
callbackURL?: string = "/dashboard"
/**
* URL to redirect after new user signup
* URL to redirect after new user signup.
*/
newUserCallbackURL?: string = "/welcome"
/**
* URL to redirect if an error happen on verification
* URL to redirect if an error happens on verification
* If only callbackURL is provided but without an `errorCallbackURL` then they will be
* redirected to the callbackURL with an `error` query parameter.
*/
@@ -106,7 +106,7 @@ When you send the URL generated by the `sendMagicLink` function to a user, click
If you want to handle the verification manually, (e.g, if you send the user a different URL), you can use the `verify` function.
<APIMethod path="/magic-link/verify" method="GET" requireSession>
<APIMethod path="/magic-link/verify" method="GET" requireHeaders>
```ts
type magicLinkVerify = {
/**
@@ -117,6 +117,16 @@ If you want to handle the verification manually, (e.g, if you send the user a di
* URL to redirect after magic link verification, if not provided will return the session.
*/
callbackURL?: string = "/dashboard"
/**
* URL to redirect after new user signup.
*/
newUserCallbackURL?: string = "/welcome"
/**
* URL to redirect if an error happens on verification.
* If only callbackURL is provided but without an `errorCallbackURL` then they will be
* redirected to the callbackURL with an `error` query parameter.
*/
errorCallbackURL?: string = "/error"
}
```
</APIMethod>
@@ -138,6 +148,8 @@ and a `ctx` context object as the second parameter.
**disableSignUp**: If set to `true`, the user will not be able to sign up using the magic link. The default value is `false`.
**rateLimit**: Rate limit for the `/sign-in/magic-link` and `/magic-link/verify` endpoints. The default value is `{ window: 60, max: 5 }`. See [Rate Limit](/docs/concepts/rate-limit) for details.
**generateToken**: The `generateToken` function is called to generate a token which is used to uniquely identify the user. The default value is a random string. There is one parameter:
* `email`: The email address of the user.