user

Andy HsuAugust 19, 2023GuideADMINAPIGuideAbout 5 min

user

GET 列出所有用户

GET /api/admin/user/list

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	是	none

返回示例

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	integer	true	none	状态码	none
» message	string	true	none	信息	none
» data	object	true	none		none
»» content	[object]	true	none		none
»»» id	integer	true	none	id	none
»»» username	string	true	none	用户名	none
»»» password	string	true	none	密码	none
»»» base_path	string	true	none	基本路径	none
»»» role	integer	true	none	角色	none
»»» disabled	boolean	true	none	是否禁用	none
»»» permission	integer	true	none	权限	none
»»» sso_id	string	true	none	sso id	none
»» total	integer	true	none	总数	none

GET 列出某个用户

GET /api/admin/user/get

请求参数

名称	位置	类型	必选	说明
id	query	string	是	none
Authorization	header	string	是	none

返回示例

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	integer	true	none		none
» message	string	true	none		none
» data	object	true	none		none
»» id	integer	true	none	id	none
»» username	string	true	none	用户名	none
»» password	string	true	none	密码	none
»» base_path	string	true	none	基本路径	none
»» role	integer	true	none	角色	none
»» disabled	boolean	true	none	是否禁用	none
»» permission	integer	true	none	权限	none
»» sso_id	string	true	none	sso id	none

POST 新建用户

POST /api/admin/user/create

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

请求参数

名称	位置	类型	必选	中文名	说明
Authorization	header	string	是		none
body	body	object	否		none
» id	body	integer	否	id	none
» username	body	string	是	用户名	none
» password	body	string	否	密码	none
» base_path	body	string	否	基本路径	none
» role	body	integer	否	角色	none
» permission	body	integer	否	权限	none
» disabled	body	boolean	否	是否禁用	none
» sso_id	body	string	否	sso id	none

返回示例

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	integer	true	none	状态码	none
» message	string	true	none	信息	none
» data	null	true	none		none

POST 更新用户信息

POST /api/admin/user/update

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

请求参数

名称	位置	类型	必选	中文名	说明
Authorization	header	string	是		none
body	body	object	否		none
» id	body	integer	是	id	none
» username	body	string	是	用户名	none
» password	body	string	否	密码	none
» base_path	body	string	否	基本路径	none
» role	body	integer	否	角色	none
» permission	body	integer	否	权限	none
» disabled	body	boolean	否	是否禁用	none
» sso_id	body	string	否	sso id	none

返回示例

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	integer	true	none	状态码	none
» message	string	true	none	信息	none
» data	null	true	none		none

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

POST /api/admin/user/cancel_2fa

请求参数

名称	位置	类型	必选	中文名	说明
id	query	string	是		none
Authorization	header	string	是		none

返回示例

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	integer	true	none	状态码	none
» message	string	true	none	信息	none
» data	null	true	none		none

POST 删除用户

POST /api/admin/user/delete

请求参数

名称	位置	类型	必选	中文名	说明
id	query	string	是		none
Authorization	header	string	否		none

返回示例

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	integer	true	none	状态码	none
» message	string	true	none	信息	none
» data	null	true	none		none

POST 删除用户缓存

POST /api/admin/user/del_cache

请求参数

名称	位置	类型	必选	中文名	说明
username	query	string	是		none
Authorization	header	string	否		none

返回示例

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	integer	true	none	状态码	none
» message	string	true	none	信息	none
» data	null	true	none		none

GET 列出用户的 SFTP 公钥

GET /api/admin/user/sshkey/list

请求参数

名称	位置	类型	必选	中文名	说明
Authorization	header	string	是		none
uid	query	string	是	用户id	none

返回示例

{
  "code": 200,
  "message": "success",
  "data": {
    "content": [
      {
        "id": 1,
        "title": "Test-SSH-Key",
        "fingerprint": "SHA256:aAFI5C******************************KD6hYhs",
        "added_time": "2024-12-15T20:09:28.1777368+08:00",
        "last_used_time": "2024-12-15T20:10:07.7846528+08:00"
      },
      {
        "id": 2,
        "title": "Test-SSH-Key-2",
        "fingerprint": "SHA256:P2zrSs******************************h0Q5BOQ",
        "added_time": "2024-12-20T20:09:28.1777368+08:00",
        "last_used_time": "2024-12-25T20:10:07.7846528+08:00"
      },
    ],
    "total": 2
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	integer	true	none	状态码	none
» message	string	true	none	信息	none
» data	object	true	none	数据	none
»» content	[object]	true	none		none
»»» id	integer	true	none	公钥主键	none
»»» title	string	true	none	公钥名称	none
»»» fingerprint	string	true	none	公钥指纹	none
»»» added_time	string	true	none	添加时间	none
»»» last_used_time	string	true	none	上次认证时间	none
»» total	integer	true	none	总数	none

POST 删除用户的 SFTP 公钥

POST /api/admin/user/sshkey/delete

请求参数

名称	位置	类型	必选	中文名	说明
Authorization	header	string	是		none
id	query	integer	是	公钥主键	none

返回示例

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