跳到主要内容

delete_user 删除用户

POST /api/v1/users/delete_user

描述

删除用户接口,用于删除用户。

root用户不能被删除。

如果删除的用户不存在,则返回40004错误码.

访问权限

需要登录,具备以下权限:

users:delete_user

JSON参数

请求参数如下:

{
"username": string
}

说明:

  • username: 用户名,必填,长度为5-20个单词字符

请求示例:

{
"username": "huhulala"
}

响应结果

请求返回的HTTP状态码为200

返回结果为JSON格式的数据,您可以通过解析JSON数据来获取API调用的结果信息。结构如下:

{
"success": true|false,
"errorCode"?: "option string",
"errorMessage"?: "option string",
"showType"?: 0|1|2|4|9,
"traceId"?: "option string"
}

正确结果示例:

{
"success": true
}

错误结果示例, 返回false时候需要带上错误码和错误信息:

{
"success": false,
"errorCode": "40004",
"errorMessage": "username.not.exist",
"showType": 9
}

错误码

错误码说明错误信息显示类型
40004用户名不存在username.not.exist4
50000服务器错误server.error2
40006配置文件加载失败protocol.json.invalid1
40007不能删除root用户user.not.delete.root1