登录

OpenAPI 契约

方法
POST
路径
/api/v1/auth/login
认证
None
响应状态
200 400 401 429 500
请求与响应 Schema
JSON
{
  "requestBody": {
    "application/json": {
      "$ref": "#/components/schemas/LoginRequest"
    }
  },
  "responses": {
    "200": {
      "description": "Session created",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/AuthResponse"
        }
      }
    },
    "400": {
      "description": "Invalid request",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/RequestError"
        }
      }
    },
    "401": {
      "description": "Username or password was rejected",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "500": {
      "description": "Unexpected server error",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    }
  }
}

POST /api/v1/auth/login 为公开接口。以 JSON 提交非空的 username 和 password。成功登录会返回访问令牌、刷新令牌、令牌类型以及以秒为单位的访问令牌有效期。

仅通过 HTTPS 使用 Authorization: Bearer <access token> 发送访问令牌。不得将两类令牌放入 URL、日志、浏览器可见配置或错误报告。无效凭据会返回认证错误。

http
POST /api/v1/auth/login
Content-Type: application/json