认证操作

POST

/api/v2/auth

根据 action 执行认证与账号生命周期相关操作：login（用户名或邮箱+密码登录）、register（注册并进入待激活）、verify（发送邮箱验证码）、activate（验证码激活账号）、reset-password（单动作密码重置：仅传 email 发送重置码；传 email+code+newPassword 完成重置）、logout、refresh，以及 Milkloud OIDC 登录与 GitHub OAuth 回调（github-callback）。

请求参数

Query 参数

Body 参数application/json必填

示例

{
    "login": "string",
    "password": "string"
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.xhsr.org.cn/api/v2/auth?action=' \
--header 'Content-Type: application/json' \
--data '{
    "login": "string",
    "password": "string"
}'

返回响应

🟢200

application/json

成功。github-callback：未登录场景返回 { token, refreshToken, user, created }（created 表示是否自动注册）；已登录绑定场景返回 { message, bound: true, user }。

Bodyapplication/json

示例

{
    "token": "jwt-token-string",
    "user": {
        "id": "u123",
        "username": "testuser",
        "email": "user@example.com",
        "avatar_url": "https://xxx.com/avatar.png",
        "role": "user",
        "created_at": "2025-01-01T12:00:00Z"
    },
    "message": "登录成功"
}

🟢201

🟠400

🟠401

🟠403

🟠404

🟠409

🟠429

🔴500

🔴502

修改于 2026-10-07 10:19:10

重定向认证操作 (OIDC / GitHub OAuth 回调)

获取谱面列表或详情