修改用户基础信息
POST/auth/v1/user/basic/edit
接口说明
修改用户基础信息,支持修改昵称、用户名、手机号、邮箱、头像、性别、描述等基本信息
入参要求:
Authorization: 当前登录用户的access_token(必填,请求头中传入,格式为Bearer xxx)client_id: 应用对应的客户端id(可选,默认为环境id)x-device-id: 设备id(可选,当前登录设备的id)- 请求体参数:
user_id: 用户id(可选,修改其他用户信息时需要管理员权限)nickname: 昵称(可选,2-48位)username: 用户名(可选,2-48位,支持英文大小写、数字、特殊字符)phone: 手机号(可选,格式:+86 13000000000)description: 描述(可选,用户个人简介)avatar_url: 头像URL(可选)gender: 性别(可选,MALE-男,FEMALE-女)email: 邮箱(可选,有效的邮箱格式)
前置条件:
- 需要有效的access_token
- 只能修改自己的信息,除非有管理员权限
- 用户名修改需要验证唯一性
- 手机号、邮箱修改可能需要验证码验证
出参:
- 返回空对象表示修改成功
- 错误时返回错误信息
修改用户信息请求示例
POST /auth/v1/user/basic/edit
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5leGFtcGxlLmNvbSIsInN1YiI6Ijk4NzY1NDMyMTAxMjM0NTY3ODkiLCJhdWQiOiJkZW1vLWFwcC0yZjhhOWMzZTFiNGQiLCJleHAiOjE3MzQ2NzU4ODksImlhdCI6MTczNDY2ODY4OSwic2NvcGUiOiJ1c2VyIn0.dGhpc19pc19hX2Zha2Vfc2lnbmF0dXJlX2Zvcl9leGFtcGxlX3B1cnBvc2VzX29ubHlfZG9fbm90X3VzZV9pbl9wcm9kdWN0aW9uX2Vudmlyb25tZW50X3RoaXNfaXNfbm90X3JlYWxfdG9rZW5fZGF0YQ
x-device-id: device_123456
Content-Type: application/json
{
"nickname": "张三",
"username": "zhangsan",
"phone": "+86 13000000000",
"description": "这是一位热爱技术的开发者",
"avatar_url": "https://example/avatar.jpg",
"gender": "MALE",
"email": "zhangsan@example"
}
修改用户信息响应示例(成功)
{}
修改用户信息响应示例(失败)
{
"error": "username_already_exists",
"error_code": 409,
"error_description": "用户名已存在"
}
使用场景:
- 用户修改个人资料
- 管理员修改用户信息
- 用户绑定或更换手机号、邮箱
- 更新用户头像和基本信息
注意事项:
- 用户名修改需要验证唯一性
- 手机号、邮箱修改需要发送验证码
- 敏感信息修改可能需要二次验证
- 管理员可以修改其他用户信息,普通用户只能修改自己的信息
Request
Query Parameters
client_id string
应用对应的客户端id,可从云开发平台-->身份认证-->开发设置获取。默认为环境id,可以不传
Header Parameters
x-device-id string
设备id,当前登录设备的id。客户端应随机生成,并缓存到客户端。此参数与登录账号数有关
Authorization stringrequired
当前登录用户的access_token, 值的格式为Bearer xxx
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5leGFtcGxlLmNvbSIsInN1YiI6Ijk4NzY1NDMyMTAxMjM0NTY3ODkiLCJhdWQiOiJkZW1vLWFwcC0yZjhhOWMzZTFiNGQiLCJleHAiOjE3MzQ2NzU4ODksImlhdCI6MTczNDY2ODY4OSwic2NvcGUiOiJ1c2VyIn0.dGhpc19pc19hX2Zha2Vfc2lnbmF0dXJlX2Zvcl9leGFtcGxlX3B1cnBvc2VzX29ubHlfZG9fbm90X3VzZV9pbl9wcm9kdWN0aW9uX2Vudmlyb25tZW50X3RoaXNfaXNfbm90X3JlYWxfdG9rZW5fZGF0YQ
- application/json
Body
user_id string
用户id
nickname string
昵称
username string
用户名
phone string
手机号
description string
描述
avatar_url string
头像
gender string
性别, MALE-男, FEMALE-女
email string
邮箱
Responses
- 200
- 500
A successful response.
Response Headers
- application/json
- Schema
Schema
- any
An unexpected error response.
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
error 错误信息 (string)
error_code int32
error_description 错误描述 (string)
{
"error": "string",
"error_code": 0,
"error_description": "string"
}
Loading...