接口参考登录与会话
用户登录
POST /api/auth/v1/login,login 的请求参数和响应结构。
POST /api/auth/v1/login
| 项目 | 内容 |
|---|---|
| 操作标识 | login |
| 认证 | 预认证 Cookie |
真实 PostgreSQL 会话认证;需配置 DATABASE_URL 和 PUBLIC_ORIGIN。当前不实现 MFA 和第三方 API 客户端认证。
会话写请求需要合法的 Origin 和与当前 Cookie 绑定的 X-CSRF-Token。登录成功后应重新获取 CSRF 令牌。具体权限由目标资源归属和当前授权决定,见认证约定。
请求参数
| 名称 | 位置 | 必填 | 类型 | 说明与约束 |
|---|---|---|---|---|
| X-CSRF-Token | header | 是 | string | 先 GET /api/auth/v1/csrf 获取,与当前 Cookie 会话绑定;写请求同时要求 Origin 等于配置的 PUBLIC_ORIGIN。;最短 1 |
请求体
请求体必填。
内容类型:application/json。
| 字段 | 类型 | 必填 | 说明与约束 |
|---|---|---|---|
| username | string | 是 | 最短 1;最长 128 |
| password | string | 是 | 最短 1;最长 1024;只写字段 |
完整请求结构(含引用定义)
{
"$ref": "#/$defs/LoginRequest",
"$defs": {
"LoginRequest": {
"type": "object",
"additionalProperties": false,
"properties": {
"username": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"password": {
"type": "string",
"minLength": 1,
"maxLength": 1024,
"writeOnly": true
}
},
"required": [
"username",
"password"
]
}
}
}响应
| HTTP 状态 | 含义 |
|---|---|
| 200 | 成功 |
| 400 | 参数校验失败 |
| 401 | 身份无效 |
| 403 | 无权访问 |
| 404 | 资源不存在 |
| 409 | 状态或幂等冲突 |
| 429 | 请求过于频繁 |
| 500 | 内部错误 |
| 503 | 依赖不可用 |
200 · application/json 响应结构
| 字段 | 类型 | 必填 | 说明与约束 |
|---|---|---|---|
| data | UserIdentity | 是 | — |
| request_id | string | 是 | — |
{
"$ref": "#/$defs/UserIdentityResponse",
"$defs": {
"UserIdentityResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"$ref": "#/$defs/UserIdentity"
},
"request_id": {
"type": "string"
}
},
"required": [
"data",
"request_id"
]
},
"UserIdentity": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"display_name": {
"type": "string"
},
"platform_permissions": {
"type": "array",
"items": {
"type": "string"
}
},
"tenants": {
"type": "array",
"items": {
"$ref": "#/$defs/TenantMembership"
}
},
"active_tenant_id": {
"type": "string",
"nullable": true
}
},
"required": [
"id",
"display_name",
"platform_permissions",
"tenants",
"active_tenant_id"
]
},
"TenantMembership": {
"type": "object",
"additionalProperties": false,
"properties": {
"tenant_id": {
"type": "string"
},
"name": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"permissions": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"tenant_id",
"name",
"roles",
"permissions"
]
}
}
}400 / 401 / 403 / 404 / 409 / 429 / 500 / 503 · application/json 响应结构
{
"$ref": "#/$defs/ErrorResponse",
"$defs": {
"ErrorResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"error": {
"$ref": "#/$defs/ErrorDetail"
},
"request_id": {
"type": "string"
}
},
"required": [
"error",
"request_id"
]
},
"ErrorDetail": {
"type": "object",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"enum": [
"NOT_IMPLEMENTED",
"NOT_FOUND",
"AUTH_REQUIRED",
"FORBIDDEN",
"VALIDATION_FAILED",
"CONFLICT",
"SERVICE_UNAVAILABLE",
"INTERNAL_ERROR",
"RATE_LIMITED"
]
},
"message": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": [
"code",
"message",
"retryable"
]
}
}
}响应中的 request_id 用于排查请求;异步操作以任务最终状态为准。参阅调用约定、异步任务和错误处理。
本页由版本化 OpenAPI 契约生成。通用资源响应允许的任意字段以运行服务为准,不据此推断尚未定义的字段。
