跳到主要内容

user_info 用户信息

POST /api/v1/users/user_info

描述

获取用户信息接口,用于获取用户的基本信息 这个在登录首页的时候,需要获取用户的基本信息,用于展示用户的基本信息。

访问权限

需要登录,只能获取自己的信息。 具备以下权限:

users:user_info

JSON参数

请求参数如下:

{
"username": "require",
}

请求示例:

{
"username": "huhulala"
}

响应结果

请求返回的HTTP状态码为200

返回结果为JSON格式的数据,您可以通过解析JSON数据来获取API调用的结果信息。结构如下:

{
"success": true|false,
"data"?: {
"username": string,
"role": "Root" | "Admin" | "Guest",
"avatar": string,
"introduction": string,
"permissions": {
"resource1": ["permission1", "permission2", "permission3", ...],
"resource2": ["permission1", "permission2", "permission3", ...],
...
}
},
"errorCode"?: "option string",
"errorMessage"?: "option string",
"showType"?: 0|1|2|4|9,
"traceId"?: "option string"
}
提示
  • username: 用户名
  • role: 用户角色
  • avatar: 用户头像, 是系统预设的头像,/images/avatar1.png ~ /images/avatar6.png
  • introduction: 用户简介
  • permissions: 用户权限, key为资源名称, value为权限列表, 如["read", "write", "delete"]

正确结果示例:

{
"success": true,
"data": {
"username": "wang",
"role": "Root",
"avatar": "/images/avatar1.png",
"introduction": "I am a super administrator",
"permissions": {
"users": ["read", "write", "delete"],
"gnss": ["read", "write", "delete"]
}
}
}

错误结果示例:

{
"success": false,
"errorCode": "40004",
"errorMessage": "username.not.exist",
"showType": 4,
"traceId": "55"
}

错误码

错误码说明错误信息显示类型
50000许可没有初始化license.not.initialized2
40005用户名不合法username.illegal4
40004用户名不存在username.not.exist1
50000文件打开错误open.user.file.error2
50000加载用户文件错误load.user.file.error2
50000缺少默认权限no.permission.data2
50000服务器错误server.error2
40006配置文件加载失败protocol.json.invalid0
提示

4 表示错误, 弹出错误提示框