注册新用户
POST/auth/v1/signup
注册新用户,适用场景:
- 手机号+验证码注册新用户
- 邮箱+验证码注册新用户
- 第三方授权后获取provider_token注册新用户。
可在注册时同时设置用户名、密码。不支持仅传入用户名、密码注册。用户名密码创建用户,请前往云后台创建。
Request
Query Parameters
client_id string
应用对应的客户端id,可从云开发平台-->身份认证-->开发设置获取。默认为环境id,可以不传
Header Parameters
x-device-id string
设备id,当前登录设备的id。客户端应随机生成,并缓存到客户端。此参数与登录账号数有关
- application/json
Body
email 邮箱 (string)
邮箱+verification_token注册时必传
phone_number 手机号 (string)
手机+verification_token注册时必传,+86不可省略。例如:"+86 13000000000"
username 用户名 (string)
长度5-24位,支持字符中英文、数字、特殊字符(仅支持_-),不支持中文
verification_token 接收到的验证码Token (string)
手机+verification_token或邮箱+verification_token注册时必传
password optional password 密码 (string)
name optional 昵称, 可选 (string)
gender optional 头像, 符合css编码格式 (string)
picture optional 头像, 符合css编码格式 (string)
locale optional 地区, 可选 (如果地区为空, 则h后端会根据手机号码,ip地址等多种因素, 选择初始化地区)
格式: zh (string)
provider_token 如果之前获取过三方信息, 则可以将三方信息绑定到该账号 (string)
/auth/v1/provider/token等接口返回的provider_token
Responses
- 200
- 400
A successful response.
Response Headers
- application/json
- Schema
- Example (from schema)
- Example
Schema
token_type 访问令牌类型 (string)
统一返回 Bearer
access_token 用户的访问令牌 (string)
用于访问云开发HTTP API的令牌,长度4096位以内
refresh_token 用户的刷新令牌 (string)
access_token过期可通过refresh_token刷新获取新的access_token,过期时间默认为31天。长度128位以内
expires_in int32
access_token的过期时间,单位为秒
scope 授权范围 (string)
sub 用户的唯一id (string)
groups string[]
{
"token_type": "string",
"access_token": "string",
"refresh_token": "string",
"expires_in": 0,
"scope": "string",
"sub": "string",
"groups": [
"string"
]
}
{
"token_type": "Bearer",
"access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjlkMWRjMzFlLWI0ZDAtNDQ4Yi1hNzZmLWIwY2M2M2Q4MTQ5OCJ9.eyJpc3MiOiJodHRwOi8vbG93Y29kZS01ZzlhYzIwdTJhMjdkYTQ2LmFwLXNoYW5naGFpLnRjYi1hcGkudGVuY2VudGNsb3VkYXBpLmNvbSIsInN1YiI6IjE4NzAwMTQxNjE5NTk2MjA2MDgiLCJhdWQiOiJBT0o4eUFBQnpOc01YZjBJY0tjIiwiZXhwIjoxNzM0Njg4Mjk0LCJpYXQiOjE3MzQ2ODEwOTQsImF0X2hhc2giOiJyLlBtazZMemNpUTJ5QktESWFONEFreGciLCJzY29wZSI6InVzZXIgc3NvIiwicHJvamVjdF9pZCI6Imxvd2NvZGUtNWc5YWMyMHUyYTI3ZGE0NiIsIm1ldGEiOnsid3hPcGVuSWQiOiIiLCJ3eFVuaW9uSWQiOiIifSwidXNlcl90eXBlIjoiIn0.lbSQ06kh5pe6PqRbGfm6tHZzj9stKDwYxpWqnjwALDx-DYqU-nOAPWQxXowEZGd-HwwsDbEi_eZfpxds4UO5rdmueMXCUxgMk9wf0fNRZe9KzOgdtmSq0H92pPjKAxskmZvzTLe4ftsAZmWLb-wUjATrk1RsGR4i9INeT9Ydprt-6vOdiJJQkLBDTBuiwdOQxge3md2rcnoM0L0VHwdCAIk1IfNZ4Dih9D77B34HPxdQdeAbppnS2SMFtjGAuvcwUVya3Lp8UFTNMrWO7S3ue4nOd35ns4tUc9cwB2LijNaBj4kYBHIjU8GFZCLuuSfGVj7EFnE2YFvlAU64aqvlYQ",
"refresh_token": "m.Y7Nk75cRMmeMrwYOqmG0Sju4YjZiiPRO-lE",
"expires_in": 7200,
"sub": "1870014161959620608"
}
- you can not signup just by username and password,不允许仅用用户名密码注册,用户身份需经过验证
- phone number login is disabled by admin,手机号登录未开启,需在云开发平台开启
- you can not set phone number and email at same time,手机号、邮箱不可同时设置
Response Headers
- application/json
- Schema
- Example (from schema)
- Example
Schema
error 错误信息 (string)
error_code int32
error_description 错误描述 (string)
{
"error": "string",
"error_code": 0,
"error_description": "string"
}
{
"error": "unimplemented",
"error_code": 12,
"error_description": "you can not signup just by username and password"
}
Loading...