Skip to content

认证接口

认证接口用于登录、注册、Passkey 和 OIDC。登录成功后返回 JWT,后续用户接口和管理接口使用:

text
Authorization: Bearer <jwt>

密码认证

方法路径参数请求体返回值
POST/auth/password/loginidentifierpasswordcaptcha_tokenagreement_accepted{ "token": "...", "user": { ... } }
POST/auth/password/register可通过 cookie 或请求体传 referral。usernameemailpasswordemail_codecaptcha_tokenreferral_codeagreement_accepted{ "token": "...", "user": { ... } }
POST/auth/password/email-codeemailcaptcha_token{ "message": "Verification code sent" }

登录请求:

json
{
  "identifier": "alice@example.com",
  "password": "change-me",
  "captcha_token": "",
  "agreement_accepted": true
}

注册请求:

json
{
  "username": "alice",
  "email": "alice@example.com",
  "password": "change-me",
  "email_code": "123456",
  "captcha_token": "",
  "referral_code": "",
  "agreement_accepted": true
}

Passkey 登录

方法路径参数请求体返回值
POST/auth/passkey/login/optionsPasskey 登录标识,如用户名或邮箱。WebAuthn 登录挑战。
POST/auth/passkey/loginWebAuthn 登录响应。{ "token": "...", "user": { ... } }

OIDC

方法路径参数请求体返回值
GET/auth/loginQuery: refagreement_accepted重定向到 OIDC Provider。
GET/auth/callbackQuery: codestate重定向回前端并携带登录 token。

错误

状态码说明
400参数不合法、未同意协议、验证码错误。
401凭据无效。
409需要初始化或初始化状态冲突。
503OIDC 未配置或不可用。

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