用户登录

POST

/api/v1/auth/login

错误码：

401 invalid_credentials / invalid_factor：口令或 TOTP 验证码错误，或已被限流。

503 factor_key_unavailable：请求带 totp_code 且该账号的 TOTP 种子由已退役的
加密 kid 保护，服务端无法解密。重试无效，需要管理员重置因子。该结果不消耗
认证失败额度。

请求参数

Header 参数

Body 参数application/json必填

示例

{
    "identifier": "string",
    "password": "pa$$word_q",
    "totp_code": "string"
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/api/v1/auth/login' \
--header 'X-Chenxing-Session-Mode;' \
--header 'Content-Type: application/json' \
--data '{
    "identifier": "string",
    "password": "pa$$word_q",
    "totp_code": "string"
}'

返回响应

🟢200成功

application/json

登录成功，同时设置 Session 和 CSRF Cookie

Headers

Bodyapplication/json

示例

{
    "session_id": "string",
    "expires_at": "2019-08-24T14:15:22.123Z"
}

🟢202成功

🟠401没有权限

🟠413服务器故障

🟠415

🟠422参数错误

🔴503服务器故障

修改于 2026-10-01 05:59:34

注册用户

查询当前登录状态