Skip to content

认证控制台接口 ​

认证接口用于登录页、注册页、Passkey 登录和 OIDC 跳转。

POST /auth/password/login ​

参数位置类型必填说明
identifierBodystring是用户名或邮箱。
passwordBodystring是密码。
captcha_tokenBodystring否验证码 token。
agreement_acceptedBodyboolean视设置而定是否同意协议。

返回:

json
{
  "token": "jwt-token",
  "user": {}
}

POST /auth/password/register ​

参数位置类型必填说明
usernameBodystring是用户名。
emailBodystring是邮箱。
passwordBodystring是密码。
email_codeBodystring视设置而定邮箱验证码。
captcha_tokenBodystring否验证码 token。
referral_codeBodystring否邀请码;为空时后端会读取邀请 cookie。
agreement_acceptedBodyboolean视设置而定是否同意协议。

返回同登录接口。

POST /auth/password/email-code ​

参数位置类型必填说明
emailBodystring是注册邮箱。
captcha_tokenBodystring否验证码 token。

返回:

json
{
  "message": "Verification code sent"
}

POST /auth/passkey/login/options ​

创建 Passkey 登录挑战。

参数位置类型必填说明
identifierBodystring否用户名或邮箱,具体取决于前端登录流程。

返回 WebAuthn 登录挑战对象。

POST /auth/passkey/login ​

完成 Passkey 登录。

参数位置类型必填说明
WebAuthn 响应Bodyobject是浏览器 navigator.credentials.get() 返回值序列化结果。

返回同登录接口。

GET /auth/login ​

发起 OIDC 登录。

参数位置类型必填说明
refQuerystring否邀请码,会写入 cookie。
agreement_acceptedQueryboolean/string视设置而定是否同意协议。

返回:重定向到 OIDC Provider。

GET /auth/callback ​

OIDC 回调。

参数位置类型必填说明
codeQuerystring是OIDC authorization code。
stateQuerystring是OIDC state,必须匹配 cookie。

返回:重定向回前端并在 URL fragment 中携带 token。

基于 MIT 协议发布(社区版)