跳至主要內容

user

Andy HsuGuideADMINAPIGuide大约 4 分钟

user

GET 列出所有用户

GET /api/admin/user/list

请求参数

名称位置类型必选说明
Authorizationheaderstringnone

返回示例

成功

{
  "code": 200,
  "message": "success",
  "data": {
    "content": [
      {
        "id": 1,
        "username": "admin",
        "Salt": "W",
        "password": "",
        "base_path": "/",
        "role": 2,
        "disabled": false,
        "permission": 0,
        "sso_id": ""
      },
      {
        "id": 2,
        "username": "guest",
        "Salt": "M",
        "password": "",
        "base_path": "/",
        "role": 1,
        "disabled": true,
        "permission": 0,
        "sso_id": ""
      },
      {
        "id": 3,
        "username": "N",
        "Salt": "L",
        "password": "",
        "base_path": "/",
        "role": 0,
        "disabled": false,
        "permission": 256,
        "sso_id": ""
      }
    ],
    "total": 3
  }
}

返回结果

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

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» dataobjecttruenonenone
»» content[object]truenonenone
»»» idintegertruenoneidnone
»»» usernamestringtruenone用户名none
»»» Saltstringtruenonesaltnone
»»» passwordstringtruenone密码none
»»» base_pathstringtruenone基本路径none
»»» roleintegertruenone角色none
»»» disabledbooleantruenone是否禁用none
»»» permissionintegertruenone权限none
»»» sso_idstringtruenonesso idnone
»» totalintegertruenone总数none

GET 列出某个用户

GET /api/admin/user/get

请求参数

名称位置类型必选说明
idquerystringnone
Authorizationheaderstringnone

返回示例

成功

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

返回结果

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

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone状态码none
» messagestringtruenone信息none
» dataobjecttruenonenone
»» content[object]truenonenone
»»» idintegertruenoneidnone
»»» usernamestringtruenone用户名none
»»» Saltstringtruenonesaltnone
»»» passwordstringtruenone密码none
»»» base_pathstringtruenone基本路径none
»»» roleintegertruenone角色none
»»» disabledbooleantruenone是否禁用none
»»» permissionintegertruenone权限none
»»» sso_idstringtruenonesso idnone
»» totalintegertruenone总数none

POST 新建用户

POST /api/admin/user/create

Body 请求参数

{
  "id": 0,
  "username": "a",
  "password": "123456",
  "base_path": "/",
  "role": 0,
  "permission": 60,
  "disabled": false,
  "sso_id": ""
}

请求参数

名称位置类型必选中文名说明
Authorizationheaderstringnone
bodybodyobjectnone
» idbodyintegeridnone
» usernamebodystring用户名none
» passwordbodystring密码none
» base_pathbodystring基本路径none
» rolebodyinteger角色none
» permissionbodyinteger权限none
» disabledbodyboolean是否禁用none
» sso_idbodystringsso idnone

返回示例

成功

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

返回结果

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

返回数据结构

状态码 200

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

POST 更新用户信息

POST /api/admin/user/update

Body 请求参数

{
  "id": 0,
  "username": "a",
  "password": "123456",
  "base_path": "/",
  "role": 0,
  "permission": 60,
  "disabled": false,
  "sso_id": ""
}

请求参数

名称位置类型必选中文名说明
Authorizationheaderstringnone
bodybodyobjectnone
» idbodyintegeridnone
» usernamebodystring用户名none
» passwordbodystring密码none
» base_pathbodystring基本路径none
» rolebodyinteger角色none
» permissionbodyinteger权限none
» disabledbodyboolean是否禁用none
» sso_idbodystringsso idnone

返回示例

成功

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

返回结果

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

返回数据结构

状态码 200

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

POST 取消某个用户的两步验证

POST /api/admin/user/cancel_2fa

请求参数

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

返回示例

成功

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

返回结果

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

返回数据结构

状态码 200

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

POST 删除用户

POST /api/admin/user/delete

请求参数

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

返回示例

成功

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

返回结果

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

返回数据结构

状态码 200

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

POST 删除用户缓存

POST /api/admin/user/del_cache

请求参数

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

返回示例

成功

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

返回结果

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

返回数据结构

状态码 200

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