103 lines
2.8 KiB
Markdown
103 lines
2.8 KiB
Markdown
|
# API 文档 - 获取用户信息
|
|||
|
|
|
|||
|
|
## 元数据
|
|||
|
|
- 需求编号：001
|
|||
|
|
- 子需求编号：001-01
|
|||
|
|
- 接口编号：002
|
|||
|
|
- 创建时间：2026-02-02
|
|||
|
|
- 创建人：AI Assistant
|
|||
|
|
- 状态：已完成
|
|||
|
|
|
|||
|
|
## 接口概述
|
|||
|
|
获取当前用户的详细信息，包括用户 ID、用户名、邮箱、组织信息、配置文件信息等。
|
|||
|
|
|
|||
|
|
## 基本信息
|
|||
|
|
|
|||
|
|
- **功能描述**：获取当前用户的详细信息
|
|||
|
|
- **请求方式**：GET
|
|||
|
|
- **请求路径**：`/partner/connection/user`
|
|||
|
|
- **权限要求**：`@PreAuthorize("@ss.hasLogin()")`
|
|||
|
|
|
|||
|
|
## 请求参数
|
|||
|
|
|
|||
|
|
无
|
|||
|
|
|
|||
|
|
## 响应参数
|
|||
|
|
|
|||
|
|
| 参数名 | 类型 | 说明 |
|
|||
|
|
|--------|------|------|
|
|||
|
|
| code | Integer | 状态码（200 成功，其他失败） |
|
|||
|
|
| msg | String | 提示信息 |
|
|||
|
|
| data | Object | 响应数据 |
|
|||
|
|
| data.userId | String | 用户 ID |
|
|||
|
|
| data.username | String | 用户名 |
|
|||
|
|
| data.email | String | 邮箱 |
|
|||
|
|
| data.organizationId | String | 组织 ID |
|
|||
|
|
| data.organizationName | String | 组织名称 |
|
|||
|
|
| data.profileId | String | 配置文件 ID |
|
|||
|
|
| data.profileName | String | 配置文件名称 |
|
|||
|
|
| data.userFullName | String | 用户全名 |
|
|||
|
|
| data.userType | String | 用户类型 |
|
|||
|
|
| data.userLanguage | String | 用户语言 |
|
|||
|
|
| data.userLocale | String | 用户区域设置 |
|
|||
|
|
|
|||
|
|
### 成功响应示例
|
|||
|
|
|
|||
|
|
```json
|
|||
|
|
{
|
|||
|
|
"code": 200,
|
|||
|
|
"msg": "操作成功",
|
|||
|
|
"data": {
|
|||
|
|
"userId": "0055w00000AaBCD",
|
|||
|
|
"username": "admin@example.com",
|
|||
|
|
"email": "admin@example.com",
|
|||
|
|
"organizationId": "00D5w00000AaBC",
|
|||
|
|
"organizationName": "Example Company",
|
|||
|
|
"profileId": "00e5w00000AaBCD",
|
|||
|
|
"profileName": "System Administrator",
|
|||
|
|
"userFullName": "John Doe",
|
|||
|
|
"userType": "Standard",
|
|||
|
|
"userLanguage": "en_US",
|
|||
|
|
"userLocale": "en_US"
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 失败响应示例
|
|||
|
|
|
|||
|
|
```json
|
|||
|
|
{
|
|||
|
|
"code": 500,
|
|||
|
|
"msg": "获取用户信息失败: 未找到有效的会话",
|
|||
|
|
"data": null
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 错误码
|
|||
|
|
|
|||
|
|
| 错误码 | 说明 | 处理建议 |
|
|||
|
|
|--------|------|----------|
|
|||
|
|
| 200 | 操作成功 | - |
|
|||
|
|
| 401 | 未登录或登录已过期 | 请重新登录 |
|
|||
|
|
| 500 | 服务器内部错误 | 请联系管理员或稍后重试 |
|
|||
|
|
|
|||
|
|
## 注意事项
|
|||
|
|
|
|||
|
|
1. 此接口返回的是当前登录用户的信息
|
|||
|
|
2. 用户信息包含敏感数据，请妥善保管
|
|||
|
|
3. 用户类型包括：Standard、PowerCustomer、PowerPartner、CSPLitePortal 等
|
|||
|
|
4. 用户语言和区域设置可能影响某些 API 的返回结果
|
|||
|
|
5. 配置文件信息可用于权限控制和功能访问判断
|
|||
|
|
|
|||
|
|
## 使用场景
|
|||
|
|
|
|||
|
|
- 显示当前用户信息
|
|||
|
|
- 根据用户权限控制功能访问
|
|||
|
|
- 根据用户语言和区域设置本地化显示
|
|||
|
|
- 审计和日志记录
|
|||
|
|
|
|||
|
|
## 相关文档
|
|||
|
|
- [需求文档](../../requirements/2026-01-28-001-PartnerAPI源org实现.md)
|
|||
|
|
- [设计文档](../../design/2026-01-29-001-01-认证和会话管理-设计.md)
|
|||
|
|
- [决策记录](../../decisions/2026-01-29-001-01-ADR-认证和会话管理技术选型.md)
|