通过 Account API 进行账户设置

什么是 Logto Account API

Logto Account API 是一套全面的 API，允许终端用户直接通过 API 访问，无需经过 Management API。主要亮点如下：

直接访问：Account API 让终端用户可以直接访问和管理自己的账户资料，无需通过 Management API 中转。
用户资料和身份管理：用户可以完全管理自己的资料和安全设置，包括更新邮箱、手机号、密码等身份信息，以及管理社交连接。MFA 和 SSO 支持即将上线。
全局访问控制：管理员可以对访问设置进行全局控制，并自定义每个字段。
无缝授权 (Authorization)：授权 (Authorization) 变得前所未有的简单！只需使用 client.getAccessToken() 获取 OP (Logto) 的不透明令牌 (Opaque token)，并将其作为 Bearer <access_token> 附加到 Authorization 头部即可。

备注:

为了确保访问令牌 (Access token) 具有相应权限，请确保你已在 Logto 配置中正确配置了对应的权限 (Scopes)。

例如，对于 POST /api/my-account/primary-email API，你需要配置 email 权限 (Scope)；对于 POST /api/my-account/primary-phone API，你需要配置 phone 权限 (Scope)。

import { type LogtoConfig, UserScope } from '@logto/js';

const config: LogtoConfig = {
  // ...其他选项
  // 添加适合你用例的权限 (Scopes)。
  scopes: [
    UserScope.Email, // 用于 `{POST,DELETE} /api/my-account/primary-email` API
    UserScope.Phone, // 用于 `{POST,DELETE} /api/my-account/primary-phone` API
    UserScope.CustomData, // 管理自定义数据
    UserScope.Address, // 管理地址
    UserScope.Identities, // 用于身份和 MFA 相关 API
    UserScope.Profile, // 管理用户资料
  ],
};

通过 Logto Account API，你可以构建一个与 Logto 完全集成的自定义账户管理系统，比如个人资料页面。

常见用例如下：

获取用户资料
更新用户资料
更新用户密码
更新用户身份信息，包括邮箱、手机号和社交连接
管理 MFA 因子（验证）

想了解更多可用 API，请访问 Logto Account API 参考文档和 Logto Verification API 参考文档。

备注:

SSO 账户查看和账户删除功能目前通过 Logto Management API 提供。具体实现请参见通过 Management API 进行账户设置。

如何启用 Account API

默认情况下，Account API 是关闭的。要启用它，你需要使用 Management API 更新全局设置。

API 端点 /api/account-center 可用于获取和更新账户中心设置。你可以用它来启用或禁用 Account API，并自定义字段。

请求示例：

curl -X PATCH https://[tenant-id].logto.app/api/account-center \
  -H 'authorization: Bearer <access_token for Logto Management API>' \
  -H 'content-type: application/json' \
  --data-raw '{"enabled":true,"fields":{"username":"Edit"}}'

enabled 字段用于启用或禁用 Account API，fields 字段用于自定义字段，值可以为 Off、Edit、ReadOnly。默认值为 Off。字段列表如下：

name：姓名字段。
avatar：头像字段。
profile：资料字段，包括其子字段。
username：用户名字段。
email：邮箱字段。
phone：手机号字段。
password：密码字段，获取时如果用户已设置密码则返回 true，否则为 false。
social：社交连接。
mfa：MFA 因子。

更多 API 详情请参见 Logto Management API 参考文档。

如何访问 Account API

获取访问令牌 (Access token)

在你的应用中设置好 SDK 后，可以使用 client.getAccessToken() 方法获取访问令牌 (Access token)。该令牌是不透明令牌 (Opaque token)，可用于访问 Account API。

如果你没有使用官方 SDK，则在向 /oidc/token 发起访问令牌 (Access token) 授权请求时，应将 resource 设为空。

使用访问令牌 (Access token) 访问 Account API

与 Account API 交互时，应在 HTTP 头部的 Authorization 字段中以 Bearer 格式（Bearer YOUR_TOKEN）包含访问令牌 (Access token)。

以下是获取用户账户信息的示例：

curl https://[tenant-id].logto.app/api/my-account \
  -H 'authorization: Bearer <access_token>'

管理基础账户信息

获取用户账户信息

要获取用户数据，可以使用 GET /api/my-account 端点。

curl https://[tenant-id].logto.app/api/my-account \
  -H 'authorization: Bearer <access_token>'

响应体示例：

{
  "id": "...",
  "username": "...",
  "name": "...",
  "avatar": "..."
}

响应字段可能会根据账户中心设置有所不同。

更新基础账户信息

基础账户信息包括用户名、姓名、头像、自定义数据及其他资料信息。

要更新 username、name、avatar 和 customData，可以使用 PATCH /api/my-account 端点。

curl -X PATCH https://[tenant-id].logto.app/api/my-account \
  -H 'authorization: Bearer <access_token>' \
  -H 'content-type: application/json' \
  --data-raw '{"username":"...","name":"...","avatar":"..."}'

要更新其他资料信息，包括 familyName、givenName、middleName、nickname、profile（个人主页 URL）、website、gender、birthdate、zoneinfo、locale 和 address，可以使用 PATCH /api/my-account/profile 端点。

curl -X PATCH https://[tenant-id].logto.app/api/my-account/profile \
  -H 'authorization: Bearer <access_token>' \
  -H 'content-type: application/json' \
  --data-raw '{"familyName":"...","givenName":"..."}'

管理标识符和其他敏感信息

出于安全考虑，Account API 对涉及标识符和其他敏感信息的操作要求额外的授权 (Authorization) 层。

获取验证记录 ID

首先，你需要获取一个 验证记录 ID，有效期为 10 分钟（TTL）。这可用于在更新敏感信息前验证用户身份。也就是说，一旦用户通过密码、邮箱验证码或短信验证码成功验证身份后，有 10 分钟时间可以更新认证 (Authentication) 相关数据，包括标识符、凭证、社交账号绑定和 MFA。

要获取验证记录 ID，可以验证用户密码或向用户邮箱或手机发送验证码。

验证用户密码

curl -X POST https://[tenant-id].logto.app/api/verifications/password \
  -H 'authorization: Bearer <access_token>' \
  -H 'content-type: application/json' \
  --data-raw '{"password":"..."}'

响应体示例：

{
  "verificationRecordId": "...",
  "expiresAt": "..."
}

通过向用户邮箱或手机发送验证码进行验证

备注:

要使用此方法，你需要配置邮箱连接器或配置短信连接器，并确保已配置 UserPermissionValidation 模板。

以邮箱为例，请求新的验证码并获取验证记录 ID：

curl -X POST https://[tenant-id].logto.app/api/verifications/verification-code \
  -H 'authorization: Bearer <access_token>' \
  -H 'content-type: application/json' \
  --data-raw '{"identifier":{"type":"email","value":"..."}}'

响应体示例：

{
  "verificationRecordId": "...",
  "expiresAt": "..."
}

收到验证码后，可以用它来更新验证记录的验证状态。

curl -X POST https://[tenant-id].logto.app/api/verifications/verification-code/verify \
  -H 'authorization: Bearer <access_token>' \
  -H 'content-type: application/json' \
  --data-raw '{"identifier":{"type":"email","value":"..."},"verificationId":"...","code":"123456"}'

验证码验证通过后，你就可以使用验证记录 ID 更新用户标识符。

想了解更多验证相关内容，请参见通过 Account API 进行安全验证。

携带验证记录 ID 发送请求

在发送更新用户标识符的请求时，需要在请求头中通过 logto-verification-id 字段携带验证记录 ID。

更新用户密码

要更新用户密码，可以使用 POST /api/my-account/password 端点。

curl -X POST https://[tenant-id].logto.app/api/my-account/password \
  -H 'authorization: Bearer <access_token>' \
  -H 'logto-verification-id: <verification_record_id>' \
  -H 'content-type: application/json' \
  --data-raw '{"password":"..."}'

更新或绑定新邮箱

备注:

要使用此方法，你需要配置邮箱连接器，并确保已配置 BindNewIdentifier 模板。

要更新或绑定新邮箱，首先需要证明邮箱的所有权。

调用 POST /api/verifications/verification-code 端点请求验证码。

curl -X POST https://[tenant-id].logto.app/api/verifications/verification-code \
  -H 'authorization: Bearer <access_token>' \
  -H 'content-type: application/json' \
  --data-raw '{"identifier":{"type":"email","value":"..."}}'

你会在响应中获得 verificationId，并在邮箱中收到验证码，使用它验证邮箱。

curl -X POST https://[tenant-id].logto.app/api/verifications/verification-code/verify \
  -H 'authorization: Bearer <access_token>' \
  -H 'content-type: application/json' \
  --data-raw '{"identifier":{"type":"email","value":"..."},"verificationId":"...","code":"..."}'

验证码验证通过后，可以调用 PATCH /api/my-account/primary-email 更新用户邮箱，将 verificationId 作为 newIdentifierVerificationRecordId 放入请求体。

curl -X POST https://[tenant-id].logto.app/api/my-account/primary-email \
  -H 'authorization: Bearer <access_token>' \
  -H 'logto-verification-id: <verification_record_id>' \
  -H 'content-type: application/json' \
  --data-raw '{"email":"...","newIdentifierVerificationRecordId":"..."}'

移除用户邮箱

要移除用户邮箱，可以使用 DELETE /api/my-account/primary-email 端点。

curl -X DELETE https://[tenant-id].logto.app/api/my-account/primary-email \
  -H 'authorization: Bearer <access_token>' \
  -H 'logto-verification-id: <verification_record_id>'

管理手机号

备注:

要使用此方法，你需要配置短信连接器，并确保已配置 BindNewIdentifier 模板。

与更新邮箱类似，可以使用 PATCH /api/my-account/primary-phone 端点更新或绑定新手机号。使用 DELETE /api/my-account/primary-phone 端点移除用户手机号。

要绑定新的社交连接，首先需通过 POST /api/verifications/social 请求授权 (Authorization) URL。

curl -X POST https://[tenant-id].logto.app/api/verifications/social \
  -H 'authorization: Bearer <access_token>' \
  -H 'content-type: application/json' \
  --data-raw '{"connectorId":"...","redirectUri":"...","state":"..."}'

connectorId：社交连接器的 ID。
redirectUri：用户授权应用后跳转的 URI，你需要在此 URL 上托管网页并捕获回调。
state：用户授权应用后返回的 state，用于防止 CSRF 攻击的随机字符串。

响应中会有 verificationRecordId，请妥善保存以备后用。

用户授权应用后，你会在 redirectUri 收到带有 state 参数的回调。然后可使用 POST /api/verifications/social/verify 端点验证社交连接。

curl -X POST https://[tenant-id].logto.app/api/verifications/social/verify \
  -H 'authorization: Bearer <access_token>' \
  -H 'content-type: application/json' \
  --data-raw '{"connectorData":"...","verificationRecordId":"..."}'

connectorData 是用户授权应用后社交连接器返回的数据，你需要在回调页面解析并获取 redirectUri 的查询参数，并将其封装为 JSON 作为 connectorData 字段的值。

最后，可以使用 POST /api/my-account/identities 端点绑定社交连接。

curl -X POST https://[tenant-id].logto.app/api/my-account/identities \
  -H 'authorization: Bearer <access_token>' \
  -H 'logto-verification-id: <verification_record_id>' \
  -H 'content-type: application/json' \
  --data-raw '{"newIdentifierVerificationRecordId":"..."}'

要移除社交连接，可以使用 DELETE /api/my-account/identities 端点。

curl -X DELETE https://[tenant-id].logto.app/api/my-account/identities/[connector_target_id] \
  -H 'authorization: Bearer <access_token>' \
  -H 'logto-verification-id: <verification_record_id>'

绑定新的 WebAuthn 密钥

备注:

请先启用 MFA 和 WebAuthn。

备注:

要使用此方法，你需要在账户中心设置中启用 mfa 字段。

步骤 1：将前端应用的 origin 添加到相关 origin 列表

WebAuthn 密钥绑定到一个特定主机名，称为 Relying Party ID (RP ID)。只有托管在 RP ID origin 上的应用才能注册或认证 (Authentication) 这些密钥。

由于你的前端应用与 Logto 认证 (Authentication) 页面不在同一域名下调用 Account API，需要配置 相关 origin 以允许跨域密钥操作。

Logto 如何确定 RP ID：

默认设置：如果你只使用 Logto 默认域名 https://[tenant-id].logto.app，RP ID 为 [tenant-id].logto.app
自定义域名：如果你配置了自定义域名如 https://auth.example.com，RP ID 则为 auth.example.com

配置相关 origin：

使用 PATCH /api/account-center 端点添加前端应用的 origin。例如，若你的账户中心运行在 https://account.example.com：

curl -X PATCH https://[tenant-id].logto.app/api/account-center \
  -H 'authorization: Bearer <access_token>' \
  -H 'content-type: application/json' \
  --data-raw '{"webauthnRelatedOrigins":["https://account.example.com"]}'

更多相关 origin 说明请参见 Related Origin Requests 文档。

步骤 2：请求新的注册选项

使用 POST /api/verifications/web-authn/registration 端点请求注册新密钥。Logto 允许每个用户账户注册多个密钥。

curl -X POST https://[tenant-id].logto.app/api/verifications/web-authn/registration \
  -H 'authorization: Bearer <access_token>' \
  -H 'content-type: application/json'

你会收到如下响应：

{
  "registrationOptions": "...",
  "verificationRecordId": "...",
  "expiresAt": "..."
}

步骤 3：在本地浏览器注册密钥

以 @simplewebauthn/browser 为例，可以用 startRegistration 方法在本地浏览器注册密钥。

import { startRegistration } from '@simplewebauthn/browser';

// ...
const response = await startRegistration({
  optionsJSON: registrationOptions, // 第 1 步服务器返回的数据
});
// 保存 response 以备后用

步骤 4：验证密钥注册

使用 POST /api/verifications/web-authn/registration/verify 端点验证密钥注册。

此步骤会验证认证器生成的加密签名，以确保密钥合法创建且传输过程中未被篡改。

curl -X POST https://[tenant-id].logto.app/api/verifications/web-authn/registration/verify \
  -H 'authorization: Bearer <access_token>' \
  -H 'content-type: application/json' \
  --data-raw '{"payload":"...","verificationRecordId":"..."}'

payload：第 2 步本地浏览器返回的响应。
verificationRecordId：第 1 步服务器返回的验证记录 ID。

步骤 5：绑定密钥

最后，可以通过 POST /api/my-account/mfa-verifications 端点将密钥绑定到用户账户。

curl -X POST https://[tenant-id].logto.app/api/my-account/mfa-verifications \
  -H 'authorization: Bearer <access_token>' \
  -H 'logto-verification-id: <verification_record_id>' \
  -H 'content-type: application/json' \
  --data-raw '{"type":"WebAuthn","newIdentifierVerificationRecordId":"..."}'

verification_record_id：有效的验证记录 ID，通过验证用户现有因子获得，详见获取验证记录 ID。
type：MFA 因子类型，目前仅支持 WebAuthn。
newIdentifierVerificationRecordId：第 1 步服务器返回的验证记录 ID。

管理已有 WebAuthn 密钥

要管理已有 WebAuthn 密钥，可以使用 GET /api/my-account/mfa-verifications 端点获取当前密钥和其他 MFA 验证因子。

curl https://[tenant-id].logto.app/api/my-account/mfa-verifications \
  -H 'authorization: Bearer <access_token>'

响应体示例：

[
  {
    "id": "...",
    "type": "WebAuthn",
    "name": "...",
    "agent": "...",
    "createdAt": "...",
    "updatedAt": "..."
  }
]

id：验证因子的 ID。
type：验证因子类型，WebAuthn 密钥为 WebAuthn。
name：密钥名称，可选字段。
agent：密钥的 user agent。

使用 PATCH /api/my-account/mfa-verifications/{verificationId}/name 端点更新密钥名称：

curl -X PATCH https://[tenant-id].logto.app/api/my-account/mfa-verifications/{verificationId}/name \
  -H 'authorization: Bearer <access_token>' \
  -H 'logto-verification-id: <verification_record_id>' \
  -H 'content-type: application/json' \
  --data-raw '{"name":"..."}'

使用 DELETE /api/my-account/mfa-verifications/{verificationId} 端点删除密钥：

curl -X DELETE https://[tenant-id].logto.app/api/my-account/mfa-verifications/{verificationId} \
  -H 'authorization: Bearer <access_token>' \
  -H 'logto-verification-id: <verification_record_id>'

绑定新的 TOTP

备注:

请先启用 MFA 和 TOTP。

备注:

要使用此方法，你需要在账户中心设置中启用 mfa 字段。

步骤 1：生成 TOTP 密钥

使用 POST /api/my-account/mfa-verifications/totp-secret/generate 端点生成 TOTP 密钥。

curl -X POST https://[tenant-id].logto.app/api/my-account/mfa-verifications/totp-secret/generate \
  -H 'authorization: Bearer <access_token>' \
  -H 'content-type: application/json'

响应体示例：

{
  "secret": "..."
}

步骤 2：向用户展示 TOTP 密钥

使用该密钥生成二维码或直接展示给用户。用户应将其添加到自己的认证器应用（如 Google Authenticator、Microsoft Authenticator 或 Authy）。

二维码的 URI 格式如下：

otpauth://totp/[Issuer]:[Account]?secret=[Secret]&issuer=[Issuer]

示例：

otpauth://totp/YourApp:[email protected]?secret=JBSWY3DPEHPK3PXP&issuer=YourApp

步骤 3：绑定 TOTP 因子

用户将密钥添加到认证器应用后，需要验证并绑定到账户。使用 POST /api/my-account/mfa-verifications 端点绑定 TOTP 因子。

curl -X POST https://[tenant-id].logto.app/api/my-account/mfa-verifications \
  -H 'authorization: Bearer <access_token>' \
  -H 'logto-verification-id: <verification_record_id>' \
  -H 'content-type: application/json' \
  --data-raw '{"type":"Totp","secret":"..."}'

verification_record_id：有效的验证记录 ID，通过验证用户现有因子获得，详见获取验证记录 ID。
type：必须为 Totp。
secret：第 1 步生成的 TOTP 密钥。

备注:

一个用户同一时间只能有一个 TOTP 因子。如果用户已存在 TOTP 因子，再次添加会返回 422 错误。

管理备份码

备注:

请先启用 MFA 和备份码。

备注:

要使用此方法，你需要在账户中心设置中启用 mfa 字段。

步骤 1：生成新的备份码

使用 POST /api/my-account/mfa-verifications/backup-codes/generate 端点生成一组新的 10 个备份码。

curl -X POST https://[tenant-id].logto.app/api/my-account/mfa-verifications/backup-codes/generate \
  -H 'authorization: Bearer <access_token>' \
  -H 'content-type: application/json'

响应体示例：

{
  "codes": ["...", "...", "..."]
}

步骤 2：向用户展示备份码

在将备份码绑定到用户账户前，必须将其展示给用户，并提醒：

立即下载或抄写这些备份码
妥善保存在安全位置
每个备份码只能使用一次
这些备份码是丢失主 MFA 方法后的最后救命稻草

你应以清晰、易复制的格式展示备份码，并考虑提供下载选项（如文本文件或 PDF）。

步骤 3：将备份码绑定到用户账户

使用 POST /api/my-account/mfa-verifications 端点将备份码绑定到用户账户。

curl -X POST https://[tenant-id].logto.app/api/my-account/mfa-verifications \
  -H 'authorization: Bearer <access_token>' \
  -H 'logto-verification-id: <verification_record_id>' \
  -H 'content-type: application/json' \
  --data-raw '{"type":"BackupCode","codes":["...","...","..."]}'

verification_record_id：有效的验证记录 ID，通过验证用户现有因子获得，详见获取验证记录 ID。
type：必须为 BackupCode。
codes：上一步生成的备份码数组。

备注:

一个用户同一时间只能有一组备份码。如果所有备份码都已用完，用户需重新生成并绑定新备份码。
备份码不能作为唯一的 MFA 因子。用户必须至少启用一个其他 MFA 因子（如 WebAuthn 或 TOTP）。
每个备份码只能使用一次。

查看已有备份码

要查看已有备份码及其使用状态，可使用 GET /api/my-account/mfa-verifications/backup-codes 端点：

curl https://[tenant-id].logto.app/api/my-account/mfa-verifications/backup-codes \
  -H 'authorization: Bearer <access_token>'

响应体示例：

{
  "codes": [
    {
      "code": "...",
      "usedAt": null
    },
    {
      "code": "...",
      "usedAt": "2024-01-15T10:30:00.000Z"
    }
  ]
}

code：备份码。
usedAt：该备份码被使用的时间戳，未使用时为 null。

什么是 Logto Account API​

如何启用 Account API​

如何访问 Account API​

获取访问令牌 (Access token)​

使用访问令牌 (Access token) 访问 Account API​

管理基础账户信息​

获取用户账户信息​

更新基础账户信息​

管理标识符和其他敏感信息​

获取验证记录 ID​

验证用户密码​

通过向用户邮箱或手机发送验证码进行验证​

携带验证记录 ID 发送请求​

更新用户密码​

更新或绑定新邮箱​

移除用户邮箱​

管理手机号​

绑定新的社交连接​

移除社交连接​

绑定新的 WebAuthn 密钥​

管理已有 WebAuthn 密钥​

绑定新的 TOTP​

管理备份码​

什么是 Logto Account API

如何启用 Account API

如何访问 Account API

获取访问令牌 (Access token)

使用访问令牌 (Access token) 访问 Account API

管理基础账户信息

获取用户账户信息

更新基础账户信息

管理标识符和其他敏感信息

获取验证记录 ID

验证用户密码

通过向用户邮箱或手机发送验证码进行验证

携带验证记录 ID 发送请求

更新用户密码

更新或绑定新邮箱

移除用户邮箱

管理手机号

绑定新的社交连接

移除社交连接

绑定新的 WebAuthn 密钥

管理已有 WebAuthn 密钥

绑定新的 TOTP

管理备份码