Skip to content

Commit 9b82e06

Browse files
committed
docs: document email allowlist behavior
1 parent 9569bf3 commit 9b82e06

2 files changed

Lines changed: 19 additions & 4 deletions

File tree

docs/security/README.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Logto delivers robust secure access management designed to counter these risks h
4343
label: 'Blocklist',
4444
href: '/security/blocklist',
4545
description:
46-
'Take control of your user base by blocking disposable or unwanted email domains or addresses.',
46+
'Control new sign-ups and newly linked emails with an allowlist and block disposable or unwanted addresses.',
4747
customProps: {
4848
icon: <BlockUserIcon />,
4949
},

docs/security/blocklist.mdx

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,24 @@ sidebar_position: 3
88

99
## Email blocklist \{#email-blocklist}
1010

11-
The email blocklist policy allows customization of email blocklist settings to prevent account sign-up abuse. It monitors email addresses used for sign-up and account settings. If a user attempts to sign up or link an email address that violates any blocklist rules, the system will reject the request, helping to mitigate spam accounts and enhance overall account security.
11+
Use the email allowlist and blocklist settings to control which email addresses can be used for new account registrations and account linking. Logto rejects email addresses that do not satisfy every enabled rule, helping to mitigate spam accounts and enhance overall account security.
1212

13-
Visit the <CloudLink to="/security/blocklist"> Console > Security > Blocklist</CloudLink> to configure the email blocklist settings.
13+
Visit the <CloudLink to="/security/blocklist"> Console > Security > Blocklist</CloudLink> to configure the email allowlist and blocklist settings.
14+
15+
### Custom email allowlist \{#custom-email-allowlist}
16+
17+
Use the custom email allowlist to restrict new sign-ups and newly linked emails to approved addresses. The allowlist is disabled when it has no entries. When it contains one or more entries, an email address must match at least one entry:
18+
19+
| Entry type | Example | Matches |
20+
| ----------- | ------------------ | ----------------------------------------------------------- |
21+
| Exact email | `foo@example.com` | Only `foo@example.com` |
22+
| Domain | `@example.com` | Any email address whose domain is exactly `example.com` |
23+
| Wildcard | `foo*@example.com` | Emails such as `foo1@example.com` and `foo.bar@example.com` |
24+
| Wildcard | `@*.example.com` | Emails from subdomains, such as `user@team.example.com` |
25+
26+
Matching is case-insensitive. A wildcard subdomain entry such as `@*.example.com` does not match the root domain `example.com`; add both `@example.com` and `@*.example.com` to allow the root domain and its subdomains.
27+
28+
The allowlist is not an exception list for the blocklist. An email that matches the allowlist must still pass all enabled blocklist checks, including disposable email, subaddressing, and custom blocklist rules.
1429

1530
### Block disposable email addresses \{#block-disposable-email-addresses}
1631

@@ -30,7 +45,7 @@ You can also use `*` as a wildcard in the local part or domain. For example, `fo
3045

3146
:::note
3247

33-
Disposable emails, subaddressing, and custom email are restricted during [new-user registration](/end-user-flows/sign-up-and-sign-in/sign-up), [linking email during social sign-in](/end-user-flows/sign-up-and-sign-in/social-sign-in#collect-sign-up-identifiers), and updating emails via [Account API](/end-user-flows/account-settings/by-account-api#update-or-link-new-email). Existing users with these email addresses can still sign in.
48+
Email allowlist and blocklist rules apply during [new-user registration](/end-user-flows/sign-up-and-sign-in/sign-up), [linking email during social sign-in](/end-user-flows/sign-up-and-sign-in/social-sign-in#collect-sign-up-identifiers), and linking or updating emails via [Account API](/end-user-flows/account-settings/by-account-api#update-or-link-new-email). Existing users can still sign in with email addresses that are already linked to their accounts.
3449

3550
- Admins can "bypass restrictions" by manually adding users in <CloudLink to="/users">Console > User management</CloudLink>, or via [Management API](https://openapi.logto.io/operation/operation-createuser). E.g., Create an user with a subaddress email when subaddressing is blocked.
3651
- Block existing accounts by deleting or suspending them in <CloudLink to="/users">Console > User management</CloudLink>.

0 commit comments

Comments
 (0)