Appearance
🚀 SaaS 用户管理 API 文档
所有 API 均需携带有效的
Authorization
签名信息(Bearer Token)进行身份认证。
通用请求 Header
字段 | 类型 | 必选 | 说明 |
---|---|---|---|
Authorization | string | Y | 格式为 Bearer |
获取用户列表
调用此 API 获取当前 SaaS 应用下的全部用户列表。
请求方式 | POST |
---|---|
请求地址 | 授权场景:https://saas.api.yoo-ai.com/saas/user/list |
请求参数
Header
字段 | 类型 | 是否必选 | 说明 |
---|---|---|---|
Authorization | String | ✅ 必选 | 签名信息 |
响应结果
✅ 正常返回(Http Code:
200
)
json
{
"code": 200,
"msg": "成功",
"data": [
{
"nickname": "测试用户",
"mobile": "18688559044",
"uid": "87hhhrio9",
"union_id": "QAXTSb6TaW",
"created_at": "2025-07-05 16:46:00"
},
{
"nickname": "测试用户",
"mobile": "139780977",
"uid": "27hhhrio9",
"union_id": "vB7HqJdPYA",
"created_at": "2025-07-07 15:22:28"
}
],
"request_id": "YOO-saas-api686b77008d63b"
}
添加 SaaS 用户
用于创建属于当前 SaaS 应用的新用户。
请求方式 | POST |
---|---|
请求地址 | 授权场景:https://saas.api.yoo-ai.com/saas/user/create |
请求参数
Header
字段 | 类型 | 必选 | 说明 |
---|---|---|---|
Authorization | string | Y | 签名信息 |
Body
字段 | 类型 | 必选 | 说明 |
---|---|---|---|
uid | string | Y | 用户唯一标识(最大长度 32) |
nickname | string | Y | 用户昵称(最大长度 16) |
mobile | string | Y | 用户手机号 |
响应结果
✅ 正常返回
json
{
"code": 200,
"msg": "添加成功",
"data": {
"union_id":"87hhhrio9",
"uid":"186695"
},
"request_id": "YOO-saas-api686b7678b302c"
}
⚠️ 已存在 uid 的返回
json
{
"code": 2008,
"msg": "用户已存在...",
"data": {},
"request_id": "YOO-saas-api686b7678b302c"
}
禁用 SaaS 用户
用于禁用当前 SaaS 应用下的指定用户。
请求方式 | POST |
---|---|
请求地址 | 授权场景:https://saas.api.yoo-ai.com/saas/user/ban |
请求参数
Header
字段 | 类型 | 必选 | 说明 |
---|---|---|---|
Authorization | string | Y | 签名信息 |
请求 Body
字段 | 类型 | 必选 | 说明 |
---|---|---|---|
union_id | string | Y | 用户 Union ID |
返回结果
✅ 正常返回
json
{
"code": 200,
"msg": "处理成功",
"data": [],
"request_id": "YOO-saas-api686b76ba45139"
}