跳到主要内容

users.update

修改用户

  • 请求路由: users.update
  • 交互模型: Request Response
  • 访问限制: 无

仅请求参数中有值的属性会被修改,其他属性保持原有值

请求​

RSocket.rr({
"route" : "users.update",
"data" : {
"username" : "user1@aspiretop",
"fullname" : "用户1",
"userTypes" : [
1,
2
]
}
});

请求参数​

名称类型必须说明
vcodeString否短信验证码, mobile不为空时vcode为必须。
验证码校验失败则用户创建不成功
skipMobileCheckBoolean否为true且请求数据中包含mobile时,跳过短信验证码校验
usernameString否用户标识
accountIdString否用户集成帐户标识
domainString否用户集成域,默认为所属租户标识
fullnameString否用户姓名
passwordString否登录密码
mobileString否手机号码
emailString否邮件地址
genderNumber否用户性别
statusNumber否用户状态
0 - disabled; 1 - enabled
userTypesNumber[]否用户类型,创建用户时指定,具体类型的值由调用方约定
inviteCodeString否邀请码
特定用户类型对应的邀请码为<用户邀请码>-<用户类型标识>
如用户邀请码为HbXm6Ls,则用户类型3对应的邀请码为HbXm6Ls-3
extraObject否
associatedAccountsObject[]否关联帐户信息
associatedAccounts.[].authTypeNumber否账号类型: 1 - 微信; 2 - 微博; 待扩展
associatedAccounts.[].appIdString否集成标识
associatedAccounts.[].accountString否账号
associatedAccounts.[].extraObject否其他扩展信息
anonymousBoolean否是否匿名用户
crDateString否创建时间
tenantIdString否租户ID

返回​

修改后的用户

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

返回属性​

名称类型说明
usernameString用户标识
accountIdString用户集成帐户标识
domainString用户集成域,默认为所属租户标识
fullnameString用户姓名
passwordString登录密码
mobileString手机号码
emailString邮件地址
genderNumber用户性别
statusNumber用户状态
0 - disabled; 1 - enabled
userTypesNumber[]用户类型,创建用户时指定,具体类型的值由调用方约定
inviteCodeString邀请码
特定用户类型对应的邀请码为<用户邀请码>-<用户类型标识>
如用户邀请码为HbXm6Ls,则用户类型3对应的邀请码为HbXm6Ls-3
extraObject
associatedAccountsObject[]关联帐户信息
associatedAccounts.[].authTypeNumber账号类型: 1 - 微信; 2 - 微博; 待扩展
associatedAccounts.[].appIdString集成标识
associatedAccounts.[].accountString账号
associatedAccounts.[].extraObject其他扩展信息
anonymousBoolean是否匿名用户
crDateString创建时间
tenantIdString租户ID

下载结果模型定义