Skip to main content

auth

Andy HsuGuideAPIGuideAbout 3 min

auth

POST token获取

POST /api/auth/login

获取某个用户的临时JWt token

Body 请求参数

{
  "username": "{{alist_username}}",
  "password": "{{alist_password}}"
}

请求参数

名称位置类型必选中文名说明
bodybodyobjectnone
» usernamebodystring用户名用户名
» passwordbodystring密码密码
» otp_codebodystring二步验证码二步验证码

返回示例

成功

{
  "code": 200,
  "message": "success",
  "data": {
    "token": "abcd"
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码
» messagestringtruenone信息
» dataobjecttruenonedata
»» tokenstringtruenonetoken

POST token获取hash

POST /api/auth/login/hash

获取某个用户的临时JWt token,传入的密码需要在添加-https://github.com/alist-org/alist后缀后再进行sha256open in new window

Body 请求参数

{
  "username": "{{alist_username}}",
  "password": "{{alist_password}}"
}

请求参数

名称位置类型必选中文名说明
bodybodyobjectnone
» usernamebodystring用户名用户名
» passwordbodystring密码hash后密码,获取方式为sha256(密码-https://github.com/alist-org/alist)
» otp_codebodystring二步验证码二步验证码

返回示例

成功

{
  "code": 200,
  "message": "success",
  "data": {
    "token": "abcd"
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码
» messagestringtruenone信息
» dataobjecttruenonedata
»» tokenstringtruenonetoken

POST 生成2FA密钥

POST /api/auth/2fa/generate

请求参数

名称位置类型必选中文名说明
Authorizationheaderstringnone

返回示例

成功

{
  "code": 200,
  "message": "success",
  "data": {
    "qr": "data:image/png;base64,iVBORw0KGgoAAAANSUhE",
    "secret": "RPQZG4MDS3"
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» dataobjecttruenone数据none
»» qrstringtruenone二维码二维码图片的data url
»» secretstringtruenone密钥none

POST 验证2FA code

POST /api/auth/2fa/verify

Body 请求参数

{
  "code": "string",
  "secret": "string"
}

请求参数

名称位置类型必选中文名说明
Authorizationheaderstringnone
bodybodyobjectnone
» codebodystring2FA验证码none
» secretbodystring2FA密钥none

返回示例

成功

{
  "code": 200,
  "message": "success",
  "data": null
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» datanulltruenonenone

GET 获取当前用户信息

GET /api/me

请求参数

名称位置类型必选中文名说明
Authorizationheaderstringnone

返回示例

成功

{
  "code": 200,
  "message": "success",
  "data": {
    "id": 1,
    "username": "admin",
    "Salt": "EV1R",
    "password": "",
    "base_path": "/",
    "role": 2,
    "disabled": false,
    "permission": 0,
    "sso_id": "",
    "otp": true
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» dataobjecttruenone数据none
»» idintegertruenoneidnone
»» usernamestringtruenone用户名none
»» Saltstringtruenonesaltnone
»» passwordstringtruenone密码none
»» base_pathstringtruenone根目录none
»» roleintegertruenone角色none
»» disabledbooleantruenone是否禁用none
»» permissionintegertruenone权限none
»» sso_idstringtruenonesso idnone
»» otpbooleantruenone是否开启二步验证none