Skip to content

创建指定用户的认证ticket

接口信息

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

请求方式:POST

请求数据类型:

响应数据类型:*/*

接口描述:

为指定用户创建认证 ticket,用于用户免登录认证

请求示例:

POST /api/v1/system/user/1776073061/ticket/create

请求参数

请求头

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

路径参数:

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

响应参数:

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

响应示例:

javascript
{
	"code": "0000",
	"displayCode": "0000",
	"message": "success",
	"data": "846f39681cf44166a46ab643a2e0950d",
	"tid": "8659031776079107595",
	"success": true
}

CURL示例

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

{"code":"0000","displayCode":"0000","message":"success","data":"846f39681cf44166a46ab643a2e0950d","tid":"8659031776079107595","success":true}

测试用例

#场景状态码结果
1创建已有用户的 ticket0000成功,返回 ticket 字符串
2创建不存在的用户的 ticket4000失败,返回 Error user id

失败用例

用户ID不存在

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

{"code":"4000","displayCode":"4000","message":"Error user id","data":null,"tid":"3483351776079108404","success":false}

TS模板示例

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

/** 
 * 创建指定用户的认证ticket
 * @param {number} id - 用户ID
 * @returns
 */
export function createTicket(id: number): Promise<CreateTicketRes> {
  return request.post(`/api/v1/system/user/${id}/ticket/create`);
}