Skip to content

启用用户

接口信息

接口地址:/api/v1/system/user/{id}/enable

请求方式:POST

请求数据类型:

响应数据类型:*/*

接口描述:

通过用户ID启用用户,启用后用户状态变为 Enabled

请求示例:

POST /api/v1/system/user/1776073061/enable

请求参数

请求头

参数名类型必填描述示例值
AuthorizationstringAPI KeyBearer ak-xxxxeyJhbGciOiJIUzI1NiJ9

路径参数:

参数名称参数说明是否必须数据类型
id用户IDinteger(int64)

响应参数:

参数名称参数说明类型schema
code业务状态码,0000 表示成功,其余失败string
displayCode源系统状态码,用于问题跟踪string
message错误描述信息string
data返回的具体业务数据object
tid跟踪唯一标识string
successboolean

响应示例:

javascript
{
	"code": "0000",
	"displayCode": "0000",
	"message": "成功",
	"data": null,
	"tid": "4477891776078779982",
	"success": true
}

CURL示例

shell
curl 'http://127.0.0.1:8081/api/v1/system/user/1776073061/enable' \
  -X POST \
  -H 'Authorization: Bearer ak-d1f2129c4ba24629b8448af3354f9dd0'

{"code":"0000","displayCode":"0000","message":"成功","data":null,"tid":"4477891776078779982","success":true}

测试用例

#场景状态码结果
1启用已禁用的用户0000成功,用户状态变为 Enabled
2启用不存在的用户0000成功(幂等)
3重复启用已启用的用户0000成功(幂等)

验证用户状态

shell
curl 'http://127.0.0.1:8081/api/v1/system/user/detail?id=1776073061' \
  -H 'Authorization: Bearer ak-d1f2129c4ba24629b8448af3354f9dd0'

{"status":"Enabled","id":1776073061,"userName":"更新后的用户名"}

TS模板示例

ts
// 响应接口
export interface EnableUserRes {
  code: string;
  displayCode: string;
  message: string;
  data: object | null;
  tid: string;
  success: boolean;
}

/** 
 * 启用用户
 * @param {number} id - 用户ID
 * @returns
 */
export function enableUser(id: number): Promise<EnableUserRes> {
  return request.post(`/api/v1/system/user/${id}/enable`);
}