跳到主要内容

注册新用户

POST 
/auth/v1/signup

注册新用户，支持以下三种注册场景：

1. 手机号+验证码注册​

入参要求：​

  • phone_number: 手机号（必填，格式："+86 13000000000"）
  • verification_token: 验证码token，必填，通过验证短信、邮箱验证码接口获取
  • username: 用户名（可选，2-48位）
  • password: 密码（可选）

出参：​

  • 返回标准的token响应（access_token、refresh_token等）

手机号+验证码注册请求示例​

{
  "phone_number": "+86 13000000000",
  "verification_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5leGFtcGxlLmNvbSIsInN1YiI6Ijk4NzY1NDMyMTAxMjM0NTY3ODkiLCJhdWQiOiJkZW1vLWFwcC0yZjhhOWMzZTFiNGQiLCJleHAiOjE3MzQ2NzU4ODksImlhdCI6MTczNDY2ODY4OSwic2NvcGUiOiJ1c2VyIn0.dGhpc19pc19hX2Zha2Vfc2lnbmF0dXJlX2Zvcl9leGFtcGxlX3B1cnBvc2VzX29ubHlfZG9fbm90X3VzZV9pbl9wcm9kdWN0aW9uX2Vudmlyb25tZW50X3RoaXNfaXNfbm90X3JlYWxfdG9rZW5fZGF0YQ",
  "username": "user123",
  "password": "Password@123"
}

手机号+验证码注册响应示例​

{
  "token_type": "Bearer",
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5leGFtcGxlLmNvbSIsInN1YiI6Ijk4NzY1NDMyMTAxMjM0NTY3ODkiLCJhdWQiOiJkZW1vLWFwcC0yZjhhOWMzZTFiNGQiLCJleHAiOjE3MzQ2NzU4ODksImlhdCI6MTczNDY2ODY4OSwic2NvcGUiOiJ1c2VyIn0.dGhpc19pc19hX2Zha2Vfc2lnbmF0dXJlX2Zvcl9leGFtcGxlX3B1cnBvc2VzX29ubHlfZG9fbm90X3VzZV9pbl9wcm9kdWN0aW9uX2Vudmlyb25tZW50X3RoaXNfaXNfbm90X3JlYWxfdG9rZW5fZGF0YQ",
  "refresh_token": "m.Y7Nk75cRMmeMrwYOqmG0Sju4YjZiiPRO-lE",
  "expires_in": 7200,
  "sub": "9876543210123456789"
}

2. 邮箱+验证码注册​

入参要求：​

  • email: 邮箱地址（必填）
  • verification_token: 验证码token，必填，通过验证短信、邮箱验证码接口获取
  • username: 用户名（可选，5-24位）
  • password: 密码（可选）

出参：​

  • 返回标准的token响应（access_token、refresh_token等）

邮箱+验证码注册请求示例​

{
  "email": "user@example",
  "verification_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5leGFtcGxlLmNvbSIsInN1YiI6Ijk4NzY1NDMyMTAxMjM0NTY3ODkiLCJhdWQiOiJkZW1vLWFwcC0yZjhhOWMzZTFiNGQiLCJleHAiOjE3MzQ2NzU4ODksImlhdCI6MTczNDY2ODY4OSwic2NvcGUiOiJ1c2VyIn0.dGhpc19pc19hX2Zha2Vfc2lnbmF0dXJlX2Zvcl9leGFtcGxlX3B1cnBvc2VzX29ubHlfZG9fbm90X3VzZV9pbl9wcm9kdWN0aW9uX2Vudmlyb25tZW50X3RoaXNfaXNfbm90X3JlYWxfdG9rZW5fZGF0YQ",
  "username": "user456",
  "password": "DemoPass123!@#"
}

邮箱+验证码注册响应示例​

{
  "token_type": "Bearer",
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5leGFtcGxlLmNvbSIsInN1YiI6Ijk4NzY1NDMyMTAxMjM0NTY3ODkiLCJhdWQiOiJkZW1vLWFwcC0yZjhhOWMzZTFiNGQiLCJleHAiOjE3MzQ2NzU4ODksImlhdCI6MTczNDY2ODY4OSwic2NvcGUiOiJ1c2VyIn0.dGhpc19pc19hX2Zha2Vfc2lnbmF0dXJlX2Zvcl9leGFtcGxlX3B1cnBvc2VzX29ubHlfZG9fbm90X3VzZV9pbl9wcm9kdWN0aW9uX2Vudmlyb25tZW50X3RoaXNfaXNfbm90X3JlYWxfdG9rZW5fZGF0YQ",
  "refresh_token": "m.Y7Nk75cRMmeMrwYOqmG0Sju4YjZiiPRO-lE",
  "expires_in": 7200,
  "sub": "9876543210123456789"
}

3. 第三方授权注册​

入参要求：​

  • provider_token: 第三方身份源token（必填）
  • username: 用户名（可选，5-24位）
  • password: 密码（可选）

出参：​

  • 返回标准的token响应（access_token、refresh_token等）

第三方授权注册请求示例​

{
  "provider_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJwcm92aWRlciI6ImdpdGh1YiIsInN1YiI6IjEyMzQ1Njc4OTAiLCJleHAiOjE3MzQ2ODIzNTd9.bVJ0cE1xTnBWc0R5QmhKa0xmR3pYY1ZiTm1Bc1FkRmdIaktsTXBPclN0VXZXeElaQWJDZERlRmZHaEhpSmpLa0xs",
  "username": "github_user",
  "password": "SamplePass456$%^"
}

第三方授权注册响应示例​

{
  "token_type": "Bearer",
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5leGFtcGxlLmNvbSIsInN1YiI6Ijk4NzY1NDMyMTAxMjM0NTY3ODkiLCJhdWQiOiJkZW1vLWFwcC0yZjhhOWMzZTFiNGQiLCJleHAiOjE3MzQ2NzU4ODksImlhdCI6MTczNDY2ODY4OSwic2NvcGUiOiJ1c2VyIn0.dGhpc19pc19hX2Zha2Vfc2lnbmF0dXJlX2Zvcl9leGFtcGxlX3B1cnBvc2VzX29ubHlfZG9fbm90X3VzZV9pbl9wcm9kdWN0aW9uX2Vudmlyb25tZW50X3RoaXNfaXNfbm90X3JlYWxfdG9rZW5fZGF0YQ",
  "refresh_token": "m.Y7Nk75cRMmeMrwYOqmG0Sju4YjZiiPRO-lE",
  "expires_in": 7200,
  "sub": "9876543210123456789"
}

通用说明：​

  • 可在注册时同时设置用户名、密码
  • 验证码注册时，需要通过验证短信、邮箱验证码接口获取verification_token
  • 不支持仅传入用户名、密码注册。用户名密码创建用户，请前往云后台创建

Request​

Query Parameters

    client_id string

    应用对应的客户端id，可从云开发平台-->身份认证-->开发设置获取。默认为环境id，可以不传

Header Parameters

    x-device-id string

    设备id，当前登录设备的id。客户端应随机生成，并缓存到客户端。此参数与登录账号数有关

Body

    email 邮箱 (string)

    邮箱+verification_token注册时必传

    phone_number 手机号 (string)

    手机+verification_token注册时必传，+86不可省略。例如："+86 13000000000"

    username 用户名 (string)

    长度2-48位，支持英文大小写、数字、特殊字符（仅支持-_.:+ @），且只能以字母或数字开头，不支持中文

    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​

A successful response.

Response Headers
    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[]
    Loading...