Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update email link custom flow guide #1433

Open
wants to merge 25 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
e57c59d
add info about email links to /sign-up-sign-in-options doc
alexisintech Aug 13, 2024
a507caf
update copy and organization of custom flow doc
alexisintech Aug 13, 2024
2d8a0ea
Merge branch 'main' into aa/DOCS-5240
alexisintech Aug 13, 2024
dc00bec
Update docs/authentication/configuration/sign-up-sign-in-options.mdx
alexisintech Dec 3, 2024
d1b8420
Apply suggestions from code review
alexisintech Dec 3, 2024
95d5710
Merge branch 'main' into aa/DOCS-5240
alexisintech Dec 3, 2024
bd2cbf0
feat: Updated email link code for Core 2
royanger Dec 3, 2024
58b4f1d
update email verification reference doc
alexisintech Dec 3, 2024
e2b82f1
add partial; fix format of doc
alexisintech Dec 3, 2024
4862483
add broken sign-up code
alexisintech Dec 3, 2024
8862863
update headings
alexisintech Jan 17, 2025
1cda334
Merge branch 'main' into aa/DOCS-5240
alexisintech Jan 17, 2025
54e8f0a
update Enable email link authentication section
alexisintech Jan 17, 2025
ee2b209
fix headings again
alexisintech Jan 17, 2025
e211848
fix sign-up flow
alexisintech Jan 17, 2025
4f92818
add placeholder for inputs; align code comments; emailcodefactor --> …
alexisintech Jan 17, 2025
f9a6594
Merge branch 'main' into aa/DOCS-5240
alexisintech Jan 31, 2025
257b102
update explanation of require same device and browser
alexisintech Jan 31, 2025
395f939
working code
alexisintech Jan 31, 2025
70f2780
lint
alexisintech Feb 3, 2025
f5ff890
fix type errors in examples
alexisintech Feb 3, 2025
95920fd
finish
alexisintech Feb 3, 2025
6c81b06
fix link
alexisintech Feb 3, 2025
7f1c1b0
code review suggestions
alexisintech Feb 7, 2025
d861092
Merge branch 'main' into aa/DOCS-5240
alexisintech Feb 11, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion docs/authentication/configuration/sign-up-sign-in-options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,20 @@ If a country is disabled, then phone numbers starting with the corresponding cou

### Email link

When the **Email verification link** option is selected as an authentication strategy, users will receive an email message with a link that can be visited in order to complete the authentication process. Email links can be used to sign up new users, sign in existing ones, or allow existing users to verify newly entered email addresses to their profile. Email links work on any device. There's no constraint on where the link will be opened. For example, a user might try to sign in from their desktop browser, but open the link from their mobile phone.
When the **Email verification link** option is selected as an authentication strategy, users will receive an email message with a link that can be visited in order to complete the authentication process. Email links can be used to sign up new users, sign in existing ones, or allow existing users to verify newly entered email addresses to their profile.
alexisintech marked this conversation as resolved.
Show resolved Hide resolved

As a security measure, email links expire after 10 minutes to prevent the use of potentially compromised stale links.
alexisintech marked this conversation as resolved.
Show resolved Hide resolved

#### Require the same device and browser

By default, email links can work on any device. There's no constraint on where the link can be opened. For example, a user could try to sign in from their desktop browser, but open the link from their mobile phone. In this scenario, _the user's sign in would be completed on the desktop browser from which it was initiated, not the mobile phone where it was verified_. As a result, the user would be signed in on their desktop, not their phone.
alexisintech marked this conversation as resolved.
Show resolved Hide resolved

To configure this setting:

1. Navigate to the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=user-authentication/email-phone-username).
1. In the navigation sidebar, select **User & Authentication > Email, Phone, and Username**.
1. In the **Authentication strategies** section, next to **Email verification link**, select the settings cog icon.
1. Enable or disable the **Require the same device and browser** setting.
alexisintech marked this conversation as resolved.
Show resolved Hide resolved

## Verification methods

Expand Down
Loading
Loading