> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# 品牌化登录页、登录邮件与自定义认证域名

> 让 Didit 托管登录页和登录邮件呈现您的品牌：自有品牌标识、五种语言的页面文案、条款与隐私链接，以及您自己的登录域名。

Didit Authentication 的托管登录页面和登录邮件使用您的品牌，与您的验证流程使用的是同一品牌。
您可以为 Authentication 设置页面文本和法律链接，也可以将登录移至您自己的域名，例如 `auth.example.com`。

请在控制台的 **Authentication > Branding and emails** 中进行管理。该页面会以浅色和深色两种模式实时预览托管登录页面。

![Didit 商业控制台中沙盒应用的 Branding and emails 页面，显示来自 Customization 的品牌、页面文本以及托管登录页面的预览](https://mintcdn.com/didit-0f962782/RpqZjIB1GnUPdMTN/images/authentication/console-branding.png?fit=max\&auto=format\&n=RpqZjIB1GnUPdMTN\&q=85\&s=9653e0d5b5556cec809139cfa6eaf055)

Authentication > Branding and emails，附托管页面预览。

## 您的品牌

品牌标志、品牌色、背景、圆角和字体均来自您在控制台中的应用 **Customization** 设置，托管页面和邮件会随之呈现相同样式。
如需修改，请选择 **Edit in Customization**。一次修改即可同时更新验证流程和登录页面。

* 页面会跟随用户设备的浅色或深色模式显示，品牌色会针对深色背景进行调整。
* 页面会显示您应用的名称。
* 在 Free 套餐中，托管页面会显示 **Secured by Didit** 标识。

![Didit 为沙盒应用提供的托管登录页面，同时展示浅色和深色模式，包含通行密钥按钮以及邮箱和密码字段](https://mintcdn.com/didit-0f962782/RpqZjIB1GnUPdMTN/images/authentication/hosted-sign-in-light-dark.png?fit=max\&auto=format\&n=RpqZjIB1GnUPdMTN\&q=85\&s=835219dfc253b7bfcb830255aff8ff93)

托管登录页面会跟随用户设备的浅色或深色模式显示。

## 页面文案和法律链接

| 字段 | 限制 | 显示位置 |
| - | - | - |
| **登录标题** | 120 个字符 | 登录页面的标题。 |
| **副标题** | 160 个字符 | 标题下方的副标题行。 |
| **注册标题** | 120 个字符 | 注册页面的标题。 |
| **服务条款 URL** | 500 个字符 | 页面上的一个链接。设置后，注册表单会要求用户接受您的服务条款。 |
| **隐私政策 URL** | 500 个字符 | 页面上的一个链接，位于服务条款链接旁边。 |

托管页面提供英语、西班牙语、法语、德语和日语版本。页面会根据用户浏览器的语言选择显示语言，也可以通过登录 URL 中的 `ui_locales` 参数指定。

您可以为每种语言分别设置自定义文案：未设置文案的语言将保留 Didit 提供的翻译默认文案。

通过 API 调用 [认证管理 API](https://docs.didit.me/zh/authentication/set-up-by-api.md) 中的 `PATCH branding/` 可以设置相同的字段：

```bash theme={null}
curl --fail-with-body --request PATCH "${MANAGEMENT_BASE}branding/" \
  -H "x-api-key: $DIDIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "texts": {
      "en": {"sign_in_title": "Welcome back", "subtitle": "Sign in to manage your account.", "sign_up_title": "Open your account"},
      "es": {"sign_in_title": "Hola de nuevo"}
    },
    "terms_url": "https://example.com/legal/terms",
    "privacy_url": "https://example.com/legal/privacy"
  }'
```

如果提交的文本为空，则会恢复为默认文案。

## 登录邮件

**Branding and emails** 中的邮件视图列出了您应用的登录邮件，并提供每封邮件的预览和 **Send a test** 按钮：

| 邮件 | 发送时机 |
| - | - |
| 邮箱验证码 | 用户使用邮箱验证码登录或注册时。 |
| 魔法链接 | 用户请求登录链接时。 |
| 密码重置 | 用户发起[忘记密码](https://docs.didit.me/zh/authentication/sign-in-methods.md#忘记和重置密码)时。 |
| 新设备登录 | 用户从新设备登录时。 |
| 邀请 | 您使用 `invited` 注册策略邀请用户注册时。 |
| 组织邀请 | 您邀请用户加入您的某个[组织](https://docs.didit.me/zh/authentication/organizations.md#邀请)时。 |
| 智能体已获批准，智能体访问权限已结束 | 用户的 [AI 智能体](https://docs.didit.me/zh/authentication/agent-access.md) 获得或失去访问权限时。 |

每封邮件在您的应用中均标记为 **On** 或 **Off**。
如果您已在自定义中设置已验证的邮箱域名，邮件将从该域名发出；否则，邮件将从 `Didit <no-reply@didit.me>` 发出。

## 自定义域名

默认情况下，您的应用在 `https://<slug>.auth.didit.me` 上为用户提供登录服务。自定义域名会将托管页面、运行时 API 和令牌签发方迁移到您自己的子域名，例如 `auth.example.com`。自定义域名仅适用于生产应用：沙盒应用始终在 Didit 域名上为用户提供登录服务。

> [!WARNING]
>
> 通行密钥归属于用户登录所用的域名。
> 启用自定义域名后，现有通行密钥必须重新注册，因此请在用户开始添加通行密钥之前先添加您的域名。

### 设置方法

1. 在 **Custom domain** 下，输入 **Your domain**（例如 `auth.example.com`），然后选择 **Add domain**。请使用子域名：CNAME 记录无法设置在域名的根级别。
2. 创建控制台显示的 DNS 记录：从您的域名指向应用 Didit 主机的 `CNAME` 记录。
3. 选择 **Check DNS now**。新记录最多可能需要一小时才能显示。Didit 找到该记录后，会为您的域名签发证书，证书会自动续期。
4. 当域名显示 **Verified** 后，选择 **Use this domain**，将其设为应用的登录源。

| 状态 | 含义 |
| - | - |
| Waiting for DNS | Didit 尚未找到 `CNAME` 记录。 |
| Issuing certificate | 记录已存在，正在签发证书。 |
| Verified | 您的域名已可提供托管页面。在您激活之前，它不是您的登录源。 |
| Active | 您的域名已是登录源和令牌签发方。 |
| Not found | 检查失败。请修正记录后重新检查。 |

通过 API 操作时，`PUT domain/` 并附带 `{"domain": "auth.example.com"}` 可添加域名，`POST domain/verify/` 用于检查域名，`POST domain/activate/` 用于激活域名，`DELETE domain/` 用于删除域名。

### 激活后会发生哪些变化

* **签发方。** 新令牌的 `iss` 将包含您的域名，发现文档和 JWKS 也会迁移到该域名。请更新后端校验的签发方，或在旧令牌过期前同时接受两个签发方。参见 [令牌与 JWKS](https://docs.didit.me/zh/authentication/tokens-and-jwks.md)。
* **可发布密钥。** 该密钥编码了签发方，因此会发生变化：请从 **Authentication > Developers** 复制新密钥并更新到您的应用中。
* **旧域名下的会话和令牌** 将在 5 分钟内失效。
* **通行密钥** 必须在新域名上重新注册。
* **重定向 URL、设置以及已注册的用户** 保持不变。

请将可发布密钥保存在应用的单一配置项中，这样切换时只需修改一处。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.