Skip to content

Commit

Permalink
Merge pull request appwrite#1519 from appwrite/docs-memberships-privacy
Browse files Browse the repository at this point in the history
docs: memberships privacy
  • Loading branch information
eldadfux authored Dec 2, 2024
2 parents 2f13cbd + 169b980 commit 4456360
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 1 deletion.
10 changes: 10 additions & 0 deletions src/partials/auth-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,13 @@ Enable email alerts for your users so that whenever another session is created f
You won't receive notifications when logging in using [Magic URL](/docs/products/auth/magic-url), [Email OTP](/docs/products/auth/email-otp), or [OAuth2](/docs/products/auth/oauth2) since these authentication methods already verify user access to their systems, establishing the authentication's legitimacy.

To toggle session alerts, navigate to **Auth** > **Security** > **Session alerts**.

# Memberships privacy {% #memberships-privacy %}

In certain use cases, your app may not need to share members’ personal information with others. You can safeguard privacy by marking specific membership details as private. To configure this setting, navigate to **Auth** > **Security** > **Memberships privacy**

These details can be made private:

- `userName` - The member's name
- `userEmail` - The member's email address
- `mfa` - Whether the member has enabled multi-factor authentication
11 changes: 11 additions & 0 deletions src/routes/docs/products/auth/security/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,14 @@ These permissions are enforced for client SDKs and server SDKs when using JWT, b
Creating and using mock phone numbers allows users to test SMS authentication without needing an actual phone number. This can be useful for testing edge cases where a user doesn't have a phone number but needs to sign in to your application using SMS.

To create a mock phone number, navigate to **Auth** > **Security** > Mock Phone Numbers. After defining a mock phone number, you need to define a specific OTP code that will be used for SMS sign-in instead of the SMS secret code sent to a real phone number.

# Memberships privacy {% #memberships-privacy %}

In certain use cases, your app may not need to share members’ personal information with others. You can safeguard privacy by marking specific membership details as private. To configure this setting, navigate to **Auth** > **Security** > **Memberships privacy**

These details can be made private:

- `userName` - The member's name
- `userEmail` - The member's email address
- `mfa` - Whether the member has enabled multi-factor authentication

13 changes: 12 additions & 1 deletion src/routes/docs/products/auth/teams/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -215,4 +215,15 @@ individual roles in the team using the `Role.team(<TEAM_ID>, [<ROLE_1>, <ROLE_2>

{% arrow_link href="/docs/advanced/platform/permissions" %}
Learn more about permissions
{% /arrow_link %}
{% /arrow_link %}

# Memberships privacy {% #memberships-privacy %}

In certain use cases, your app may not need to share members’ personal information with others. You can safeguard privacy by marking specific membership details as private. To configure this setting, navigate to **Auth** > **Security** > **Memberships privacy**

These details can be made private:

- `userName` - The member's name
- `userEmail` - The member's email address
- `mfa` - Whether the member has enabled multi-factor authentication

0 comments on commit 4456360

Please sign in to comment.