users.reg

新用户注册

请求路由: users.reg

交互模型: Request Response

访问限制: 无

新用户注册后的生效机制一般有两种，一种是所有新用户注册后直接生效，可立刻访问系统功能；一种是注册后，手工进行激活处理或根据特定逻辑激活。

可通过系统属性iap.user.default-status控制这一过程：

iap.user.default-status=1时，注册后自动激活；

关于用户帐户标识username

注册时，accountId和tenantId共同组成用户唯一标识username。如accountId为user1，tenantId为aspiretop，则最终的用户唯一标识username为user1@aspiretop 其中：

accountId中包含@时，会被转义为\\40。例如accountId为user1@gmail.com，tenantId为aspiretop, 则username为user1\\40gmail.com@aspiretop

由于.为route的分隔符，当使用包含.字符的username作为route发送请求时，.需要被转义为%2E

例如： route: users.{username}，当username为user1\\40gmail.com@aspiretop时，按下面所示进行转义后发送请求：
RSocket.rr({
  route: 'users.user1\\40gmail%2Ecom@aspiretop'
})

请求

RSocket.rr({
  "route" : "users.reg",
  "data" : {
    "accountId" : "user1",
    "tenantId" : "aspiretop",
    "fullname" : "用户1",
    "captchaKey" : "151cc16bc46141108b2d53ff2362ac9a",
    "captchaCode" : "ybg3d",
    "scope" : "shop",
    "password" : "*******",
    "extra" : {
      "abc" : 123
    }
  }
});

请求参数

名称	类型	必须	说明
`captchaKey`	String	否	图形验证码标识
`captchaCode`	String	否	图形验证码
`scope`	String	是	应用scope标识
`vcode`	String	否	短信验证码, mobile不为空时vcode为必须。验证码校验失败则用户创建不成功
`accountId`	String	是	用户集成帐户标识
`fullname`	String	否	用户姓名
`password`	String	否	登录密码
`mobile`	String	否	手机号码
`email`	String	否	邮件地址
`gender`	Number	否	用户性别
`status`	Number	否	用户状态 0 - disabled; 1 - enabled
`userTypes`	Number[]	否	用户类型，创建用户时指定，具体类型的值由调用方约定
`inviteCode`	String	否	邀请码特定用户类型对应的邀请码为`<用户邀请码>-<用户类型标识>` 如用户邀请码为`HbXm6Ls`，则用户类型3对应的邀请码为`HbXm6Ls-3`
`extra`	Object	否
`associatedAccounts`	Object[]	否	关联帐户信息
`associatedAccounts.[].authType`	Number	否	账号类型： 1 - 微信； 2 - 微博；待扩展
`associatedAccounts.[].appId`	String	否	集成标识
`associatedAccounts.[].account`	String	否	账号
`associatedAccounts.[].extra`	Object	否	其他扩展信息
`anonymous`	Boolean	否	是否匿名用户
`tenantId`	String	是	租户ID

成功注册的用户

{
  "tenantId" : "aspiretop",
  "username" : "user1@aspiretop",
  "accountId" : "user1",
  "domain" : "aspiretop",
  "fullname" : "用户1",
  "status" : 1,
  "userTypes" : [ ],
  "inviteCode" : "HbXm6Ls",
  "extra" : {
    "abc" : 123
  },
  "associatedAccounts" : [ ]
}

返回属性

名称	类型	说明
`username`	String	用户标识
`accountId`	String	用户集成帐户标识
`domain`	String	用户集成域，默认为所属租户标识
`fullname`	String	用户姓名
`password`	String	登录密码
`mobile`	String	手机号码
`email`	String	邮件地址
`gender`	Number	用户性别
`status`	Number	用户状态 0 - disabled; 1 - enabled
`userTypes`	Number[]	用户类型，创建用户时指定，具体类型的值由调用方约定
`inviteCode`	String	邀请码特定用户类型对应的邀请码为`<用户邀请码>-<用户类型标识>` 如用户邀请码为`HbXm6Ls`，则用户类型3对应的邀请码为`HbXm6Ls-3`
`extra`	Object
`associatedAccounts`	Object[]	关联帐户信息
`associatedAccounts.[].authType`	Number	账号类型： 1 - 微信； 2 - 微博；待扩展
`associatedAccounts.[].appId`	String	集成标识
`associatedAccounts.[].account`	String	账号
`associatedAccounts.[].extra`	Object	其他扩展信息
`anonymous`	Boolean	是否匿名用户
`crDate`	String	创建时间
`tenantId`	String	租户ID

下载结果模型定义

关于用户帐户标识username​

请求​

请求参数​

返回​

返回属性​

关于用户帐户标识username

请求

请求参数

返回

返回属性