新增用户API

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

  1. POST /api/v1/users HTTP/1.1

请求 URI

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

请求 Body

参数名 类型 必填 说明
userName 字符串 是 用户账号
password 字符串 是 用户密码
passwordFormat 字符串 否 密码加密格式，有Clear及Encrypt两种，分别代表不加密以及可逆加密。
isChecked 字符串 否 是否已审核用户
isLockedOut 字符串 否 是否被锁定
displayName 字符串 否 用户姓名
email 字符串 否 邮箱
mobile 字符串 否 手机号
avatarUrl 字符串 否 头像图片路径
organization 字符串 否 组织
department 字符串 否 部门
position 字符串 否 职位
gender 字符串 否 性别
birthday 字符串 否 出生日期
education 字符串 否 毕业院校
graduation 字符串 否 学历
address 字符串 否 地址
weiXin 字符串 否 微信
qq 字符串 否 QQ
weiBo 字符串 否 微博
interests 字符串 否 兴趣
signature 字符串 否 签名

返回

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

示例

请求示例

  1. POST /api/v1/users HTTP/1.1
  2. Content-Type: application/json
  3. X-SS-API-KEY: 7cd22002-27a7-4c5d-ba4d-a1c108a20eaf
  5. {
  6.   "userName": "demo",
  7.   "password": "demo888",
  8.   "displayName": "演示",
  9.   "email": "demo@sample.com",
  10.   "mobile": "13888888888"
  11. }

返回示例

  1. {
  2.   "value": {
  3.     "id": 1,
  4.     "userName": "demo",
  5.     "password": "3CPlhZ8UAus=",
  6.     "passwordFormat": "Encrypted",
  7.     "passwordSalt": "VohMFwNz4s006ZytezfUxg==",
  8.     "createDate": "2018-06-17 14:18:45",
  9.     "lastResetPasswordDate": "2018-06-17 14:18:45",
  10.     "lastActivityDate": "2018-06-17 14:18:45",
  11.     "countOfLogin": 0,
  12.     "countOfFailedLogin": 0,
  13.     "countOfWriting": 0,
  14.     "isChecked": true,
  15.     "isLockedOut": false,
  16.     "displayName": "演示",
  17.     "email": "demo@sample.com",
  18.     "mobile": "13888888888",
  19.     "avatarUrl": "",
  20.     "organization": "",
  21.     "department": "",
  22.     "position": "",
  23.     "gender": "",
  24.     "birthday": "",
  25.     "education": "",
  26.     "graduation": "",
  27.     "address": "",
  28.     "weiXin": "",
  29.     "qq": "",
  30.     "weiBo": "",
  31.     "interests": "",
  32.     "signature": ""
  33.   }
  34. }