Add user verification journey to auth docs #1548
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add new verification journey page - Add verification to auth journeys navigation
|
The preview deployment is ready. 🟢 Open Preview | Open Build Logs Last updated at: 2024-12-13 20:32:19 CET |
|
@ebenezerdon we should also add examples for client SDKs other than web |
divanov11
approved these changes
Dec 18, 2024
stnguyen90
requested changes
Dec 19, 2024
Comment on lines
+97
to
+98
| label: 'User verification', | ||
| href: '/docs/products/auth/verification' |
There was a problem hiding this comment.
We should stick to simple verbs
Suggested change
| label: 'User verification', | |
| href: '/docs/products/auth/verification' | |
| label: 'Verify user', | |
| href: '/docs/products/auth/verify-user' |
| @@ -0,0 +1,282 @@ | |||
| --- | |||
| layout: article | |||
| title: User verification | |||
|
|
||
| User verification in Appwrite allows you to verify user email addresses and phone numbers. Users don't need to be verified to log in, but you can restrict resource access to verified users only using permissions. | ||
|
|
||
| # Email verification {% #email-verification %} |
There was a problem hiding this comment.
Suggested change
| # Email verification {% #email-verification %} | |
| # Verify email {% #verify-email %} |
|
|
||
| # Email verification {% #email-verification %} | ||
|
|
||
| To verify a user's email, first send a verification email with a redirect URL. The verification secrets will be appended as query parameters to the redirect URL: |
There was a problem hiding this comment.
We should clarify the user needs to log in first before they can call account.createVerification().
Also, let's not use colons before the code samples as we don't do that elsewhere.
| ``` | ||
| {% /multicode %} | ||
|
|
||
| # Role-based access {% #role-based-access %} |
There was a problem hiding this comment.
Suggested change
| # Role-based access {% #role-based-access %} | |
| # Restrict access {% #restrict-access %} |
| ``` | ||
| {% /multicode %} | ||
|
|
||
| # Phone verification {% #phone-verification %} |
There was a problem hiding this comment.
Suggested change
| # Phone verification {% #phone-verification %} | |
| # Verify phone {% #verify-phone %} |
|
|
||
| # Role-based access {% #role-based-access %} | ||
|
|
||
| You can restrict resource access to verified users only using permissions through the `user([USER_ID], "verified")` role. This role is automatically assigned after successful verification. |
There was a problem hiding this comment.
This would restrict for a single user. Let's also mention users('verified') to restrict access to all/any verified user.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Adds user verification as a new journey in the auth documentation.
Test Plan
/docs/products/auth/verificationRelated PRs and Issues
DRL-1115