用户登录和认证API接口
更新时间：2023-12-13
接口描述
该接口用于用户登录或校验用户是否已经登录。用户登录请求的响应消息中会有用于后续身份校验的token，登录后token有效期默认是36000秒，过期后需要重新登录。同一个用户同一时间段内进行多次登录，会获得不同的token，每个token都生效，拥有各自有效期。比如前端admin登录web后，客户端依然可以调用登录接口获得新的token，不会导致web前端登录失效。
请求结构
POST /console/user/auth
请求头域
无特殊请求头。
请求参数
| 参数 | 类型 | 是否必选 | 描述 | 示例 |
|---|---|---|---|---|
| userName | String | 否 | 登录用户名。如果是登录请求必填，否则忽略该字段 | admin |
| password | String | 否 | 登录密码。如果是登录请求必填，否则忽略该字段 | pwd1 |
| token | String | 否 | 仅当用户登录后，发起后续的其他API请求时需要，登录请求时该字段必须为空 | eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyTmFtZSI6ImFkbWluIiwiZXhwIjoxNjY1NTA3MDUwfQ.-RTto3RhQnY2yjafd-uruXvd9jQlzKV62TFA9kseJ7E |
响应头域
无特殊响应头。
响应参数
| 参数 | 类型 | 描述 |
|---|---|---|
| status | Int32 | 接口返回状态, 0表示成功，其他表示失败。失败时请忽略data字段。 |
| message | String | 成功或错误提示 |
| data | Map | 设备信息 |
| role | String | 该用户角色，当前固定为super |
| userName | String | 当前登录用户的用户名 |
| token | String | 请求token为空时，会返回该字段作为已登录的凭证。用户在调用需要登录认证的API时需要携带该token作为请求头 |
请求示例
1、登录请求示例
POST /console/user/auth
Content-Type: application/json
Content-Length: 1254
{
"userName": "admin",
"password": "pwd1"
}2、认证请求示例
POST /console/user/auth
Content-Type: application/json
Content-Length: 1254
{
"token": "xxxx"
}响应示例
1、登录响应示例
HTTP/1.1 200 OK
cache-control: no-cache
content-length: 484
content-type: application/json; charset=utf-8
date: Thu, 17 Nov 2022 00:45:02 GMT
server: nginx/1.21.6
{
"status":0,
"message": "success",
"data"：{
"role": "super",
"userName": "admin",
"token": "xxxx"
}
}2、认证响应示例
HTTP/1.1 200 OK
cache-control: no-cache
content-length: 484
content-type: application/json; charset=utf-8
date: Thu, 17 Nov 2022 00:45:02 GMT
server: nginx/1.21.6
{
"status":0,
"message": "success",
"data"：{
"role": "super",
"userName": "admin"
}
}