新增用户 API

注册新用户，使用 POST 发起请求，请求地址为 /api/v1/users。

POST /api/v1/users

请求 URI

参数名	位置	类型	必填	说明
apiKey	query	字符串	否	API 密钥，请参考身份认证

请求 Body

参数名	类型	必填	说明
userName	字符串	是	用户账号
password	字符串	是	用户密码
passwordFormat	字符串	否	密码加密格式，有`Clear`及`Encrypt`两种，分别代表不加密以及可逆加密。
groupId	整数	否	用户组 Id
checked	字符串	否	是否已审核
locked	字符串	否	是否被锁定
displayName	字符串	否	用户姓名
mobile	字符串	否	手机号
email	字符串	否	邮箱
avatarUrl	字符串	否	头像图片路径
openId	字符串	否	微信用户的标识，对当前公众号唯一

名称	类型	说明
200 OK	User	用户
401 Unauthorized	Error	认证错误
400 BadRequest	Error	参数错误

示例

请求示例

POST /api/v1/users
Content-Type: application/json
X-SS-API-KEY: 7cd22002-27a7-4c5d-ba4d-a1c108a20eaf

{
  "userName": "demo",
  "password": "demo888",
  "displayName": "演示",
  "email": "demo@sample.com",
  "mobile": "13888888888"
}

返回示例

{
  "id": 1,
  "userName": "demo",
  "password": "3CPlhZ8UAus=",
  "passwordFormat": "Encrypted",
  "createDate": "2018-06-17 14:18:45",
  "lastResetPasswordDate": "2018-06-17 14:18:45",
  "lastActivityDate": "2018-06-17 14:18:45",
  "countOfLogin": 0,
  "countOfFailedLogin": 0,
  "countOfWriting": 0,
  "checked": true,
  "locked": false,
  "displayName": "演示",
  "email": "demo@sample.com",
  "mobile": "13888888888",
  "avatarUrl": "",
  "openId": ""
}