From 951542ca574075d059c1c0dab4a499df3b909cca Mon Sep 17 00:00:00 2001 From: loks0n <22452787+loks0n@users.noreply.github.com> Date: Tue, 26 Nov 2024 11:54:29 +0000 Subject: [PATCH 1/5] docs: memberships privacy --- src/partials/auth-security.md | 15 +++++++++++++++ .../docs/products/auth/security/+page.markdoc | 15 +++++++++++++++ .../docs/products/auth/teams/+page.markdoc | 17 ++++++++++++++++- 3 files changed, 46 insertions(+), 1 deletion(-) diff --git a/src/partials/auth-security.md b/src/partials/auth-security.md index 2777feeb19..aad0775e53 100644 --- a/src/partials/auth-security.md +++ b/src/partials/auth-security.md @@ -34,3 +34,18 @@ 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 %} + +Hide specific membership details from other users by marking them as private. To set this up, go 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 + +{% info title="Scale plan feature" %} +Memberships privacy is available on the Appwrite Cloud scale plan. +{% /info %} + diff --git a/src/routes/docs/products/auth/security/+page.markdoc b/src/routes/docs/products/auth/security/+page.markdoc index 2725c199c0..cdfe4982d0 100644 --- a/src/routes/docs/products/auth/security/+page.markdoc +++ b/src/routes/docs/products/auth/security/+page.markdoc @@ -40,3 +40,18 @@ 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 %} + +Hide specific membership details from other users by marking them as private. To set this up, go 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 + +{% info title="Scale plan feature" %} +Memberships privacy is available on the Appwrite Cloud scale plan. +{% /info %} + diff --git a/src/routes/docs/products/auth/teams/+page.markdoc b/src/routes/docs/products/auth/teams/+page.markdoc index a2d7a99f0f..787a4e102c 100644 --- a/src/routes/docs/products/auth/teams/+page.markdoc +++ b/src/routes/docs/products/auth/teams/+page.markdoc @@ -215,4 +215,19 @@ individual roles in the team using the `Role.team(, [, {% arrow_link href="/docs/advanced/platform/permissions" %} Learn more about permissions -{% /arrow_link %} \ No newline at end of file +{% /arrow_link %} + +# Memberships privacy {% #memberships-privacy %} + +Hide specific membership details from other users by marking them as private. To set this up, go 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 + +{% info title="Scale plan feature" %} +Memberships privacy is available on the Appwrite Cloud scale plan. +{% /info %} + From e790812a975c8911f544dee3ae80cb544bf89c13 Mon Sep 17 00:00:00 2001 From: "Luke B. Silver" <22452787+loks0n@users.noreply.github.com> Date: Tue, 26 Nov 2024 12:23:51 +0000 Subject: [PATCH 2/5] Update src/partials/auth-security.md Co-authored-by: Eldad A. Fux --- src/partials/auth-security.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/partials/auth-security.md b/src/partials/auth-security.md index aad0775e53..51c059d2eb 100644 --- a/src/partials/auth-security.md +++ b/src/partials/auth-security.md @@ -37,7 +37,7 @@ To toggle session alerts, navigate to **Auth** > **Security** > **Session alerts # Memberships privacy {% #memberships-privacy %} -Hide specific membership details from other users by marking them as private. To set this up, go to **Auth** > **Security** > **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: From 5e92e705c1caa6b7da2ef05d1aa4b2e0e1e469f4 Mon Sep 17 00:00:00 2001 From: "Luke B. Silver" <22452787+loks0n@users.noreply.github.com> Date: Tue, 26 Nov 2024 12:23:56 +0000 Subject: [PATCH 3/5] Update src/routes/docs/products/auth/teams/+page.markdoc Co-authored-by: Eldad A. Fux --- src/routes/docs/products/auth/teams/+page.markdoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/routes/docs/products/auth/teams/+page.markdoc b/src/routes/docs/products/auth/teams/+page.markdoc index 787a4e102c..07d5607a8b 100644 --- a/src/routes/docs/products/auth/teams/+page.markdoc +++ b/src/routes/docs/products/auth/teams/+page.markdoc @@ -219,7 +219,7 @@ Learn more about permissions # Memberships privacy {% #memberships-privacy %} -Hide specific membership details from other users by marking them as private. To set this up, go to **Auth** > **Security** > **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: From 16e014b98059563988a39535b297a81fcb0f5bdc Mon Sep 17 00:00:00 2001 From: "Luke B. Silver" <22452787+loks0n@users.noreply.github.com> Date: Tue, 26 Nov 2024 12:24:02 +0000 Subject: [PATCH 4/5] Update src/routes/docs/products/auth/security/+page.markdoc Co-authored-by: Eldad A. Fux --- src/routes/docs/products/auth/security/+page.markdoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/routes/docs/products/auth/security/+page.markdoc b/src/routes/docs/products/auth/security/+page.markdoc index cdfe4982d0..de4540ce30 100644 --- a/src/routes/docs/products/auth/security/+page.markdoc +++ b/src/routes/docs/products/auth/security/+page.markdoc @@ -43,7 +43,7 @@ To create a mock phone number, navigate to **Auth** > **Security** > Mock Phone # Memberships privacy {% #memberships-privacy %} -Hide specific membership details from other users by marking them as private. To set this up, go to **Auth** > **Security** > **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: From fd0f90640d7195775c2e3b8d175a3b451ce3150c Mon Sep 17 00:00:00 2001 From: loks0n <22452787+loks0n@users.noreply.github.com> Date: Tue, 26 Nov 2024 12:24:40 +0000 Subject: [PATCH 5/5] eldad review --- src/partials/auth-security.md | 5 ----- src/routes/docs/products/auth/security/+page.markdoc | 4 ---- src/routes/docs/products/auth/teams/+page.markdoc | 4 ---- 3 files changed, 13 deletions(-) diff --git a/src/partials/auth-security.md b/src/partials/auth-security.md index aad0775e53..e284fcc4ea 100644 --- a/src/partials/auth-security.md +++ b/src/partials/auth-security.md @@ -44,8 +44,3 @@ 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 - -{% info title="Scale plan feature" %} -Memberships privacy is available on the Appwrite Cloud scale plan. -{% /info %} - diff --git a/src/routes/docs/products/auth/security/+page.markdoc b/src/routes/docs/products/auth/security/+page.markdoc index cdfe4982d0..c2101a0cf0 100644 --- a/src/routes/docs/products/auth/security/+page.markdoc +++ b/src/routes/docs/products/auth/security/+page.markdoc @@ -51,7 +51,3 @@ These details can be made private: - `userEmail` - The member's email address - `mfa` - Whether the member has enabled multi-factor authentication -{% info title="Scale plan feature" %} -Memberships privacy is available on the Appwrite Cloud scale plan. -{% /info %} - diff --git a/src/routes/docs/products/auth/teams/+page.markdoc b/src/routes/docs/products/auth/teams/+page.markdoc index 787a4e102c..9b07be9e56 100644 --- a/src/routes/docs/products/auth/teams/+page.markdoc +++ b/src/routes/docs/products/auth/teams/+page.markdoc @@ -227,7 +227,3 @@ These details can be made private: - `userEmail` - The member's email address - `mfa` - Whether the member has enabled multi-factor authentication -{% info title="Scale plan feature" %} -Memberships privacy is available on the Appwrite Cloud scale plan. -{% /info %} -