# 登录

# 描述

你可以使用此 API 获取一个 token,把它放到自定义 HTTP 头部 edge-token 中可以调用其他登录后才能调用的接口。 edge-token 的有效期默认是 8 小时;最长有效期是 31 天。

# URI
POST /admin-api/user/login
# JSON Body 参数
{
    "username":"username",
    "password":"password",
    "remember": false,      # 当 remember 参数为 true 时, edge-token 有效期为 31 天。
    "plugin":"Builtin"
}
# 请求示例
# Shell
curl  http://{admin-site}/admin-api/user/login -X 'POST' -d '{"username":"username","password":"password","plugin":"Builtin"}'
# 响应示例
Status: 200 OK
{
    "status": 0,
    "msg": "login successful.",
    "data": {
        "_created_unix": "2021-07-26 00:44:40.097306",
        "username": "edge-admin",
        "edge-token": "6332de49089ec6a24567b3efcabb1012139947b0c232a52e85b88cdcb02bd530",
        "id": 1,
        "_modified_unix": "2021-07-26 00:44:40.097306",
        "role": "master",
        "login_2fa": {}
    },
    "time": 1627290462
}
# edge-token 的用法

调用其他 API 时把 edge-token 设置为 HTTP 头部,示例:

curl http://{admin-site}/admin-api/user/logout \
-H "edge-token: 2aeac420361ba6c202887452f0ffab8fffc619731cc3daffc6bc7a4707756abf",