users

获取用户列表

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

请求

RSocket.rs({
  "route" : "users",
  "args" : {
    "search" : {
      "keyword" : "135"
    }
  }
});

请求参数

名称	类型	必须	说明
search	Object	否	查询参数
search.username	String	否	用户名
search.fullname	String	否	用户姓名
search.mobile	String	否	手机号码
search.email	String	否	邮件地址
search.userTypes	String	否	逗号分隔的用户类型, 如: 1,2,3 请求参数中携带kind时，忽略userTypes
search.kind	String	否	按类型获取用户 all - 所有用户; console - 后台用户; inet - 互联网用户 请求参数中携带kind时，忽略userTypes
search.status	Number	否	用户状态
search.extra	Object	否	extra查询参数键值对
search.keyword	String	否	模糊匹配关键字
search.from	String	否	查询起始时间，时间样式为RFC3339格式，如：2019-04-18T00:13:39.649Z
search.to	String	否	查询终止时间，时间样式为RFC3339格式，如：2019-04-19T00:13:39.649Z
pg	Object	否	分页参数
pg.page	Number	否	页码，首页从0开始
pg.size	Number	否	每页记录，默认为10
pg.sort	String[]	否	排序字段清单，默认为升序，需要指定降序时在字段名后面添加desc并用分号隔开。 例如：["id", "crDate;desc"]

返回

用户列表

[
  {
    "crDate" : "2023-04-09T12:42:17.099Z",
    "tenantId" : "mzd",
    "username" : "13500010001@mzd",
    "accountId" : "13500010001",
    "domain" : "mzd",
    "fullname" : "13500010001",
    "mobile" : "13500010001",
    "gender" : 1,
    "genderText" : "男",
    "status" : 1,
    "userTypes" : [ ],
    "inviteCode" : "HbXm6Ls",
    "extra" : { },
    "associatedAccounts" : [ ]
  },
  {
    "crDate" : "2023-02-09T03:20:36.044Z",
    "tenantId" : "mzd",
    "username" : "oKQgr46obJ_hpT867BJxzqNjt2MA@mzd",
    "accountId" : "oKQgr46obJ_hpT867BJxzqNjt2MA",
    "domain" : "mzd",
    "fullname" : "张",
    "mobile" : "13500020002",
    "email" : "",
    "gender" : 1,
    "genderText" : "男",
    "status" : 1,
    "userTypes" : [
      1,
      3
    ],
    "inviteCode" : "HbXm6Lt",
    "extra" : { },
    "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

下载结果模型定义