# 新增用户 API
注册新用户,使用POST
发起请求,请求地址为/api/v1/users
POST /api/v1/users HTTP/1.1
# 请求 URI
参数名 | 位置 | 类型 | 必填 | 说明 |
---|---|---|---|---|
apiKey | query | 字符串 | 否 | API 密钥,请参考身份认证 |
# 请求 Body
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
userName | 字符串 | 是 | 用户账号 |
password | 字符串 | 是 | 用户密码 |
passwordFormat | 字符串 | 否 | 密码加密格式,有Clear 及Encrypt 两种,分别代表不加密以及可逆加密。 |
isChecked | 字符串 | 否 | 是否已审核用户 |
isLockedOut | 字符串 | 否 | 是否被锁定 |
displayName | 字符串 | 否 | 用户姓名 |
字符串 | 否 | 邮箱 | |
mobile | 字符串 | 否 | 手机号 |
avatarUrl | 字符串 | 否 | 头像图片路径 |
organization | 字符串 | 否 | 组织 |
department | 字符串 | 否 | 部门 |
position | 字符串 | 否 | 职位 |
gender | 字符串 | 否 | 性别 |
birthday | 字符串 | 否 | 出生日期 |
education | 字符串 | 否 | 毕业院校 |
graduation | 字符串 | 否 | 学历 |
address | 字符串 | 否 | 地址 |
weiXin | 字符串 | 否 | 微信 |
字符串 | 否 | ||
字符串 | 否 | 微博 | |
interests | 字符串 | 否 | 兴趣 |
signature | 字符串 | 否 | 签名 |
# 返回
名称 | 类型 | 说明 |
---|---|---|
200 OK | User | 用户 |
401 Unauthorized | Error | 认证错误 |
400 BadRequest | Error | 参数错误 |
# 示例
# 请求示例
POST /api/v1/users HTTP/1.1
Content-Type: application/json
X-SS-API-KEY: 7cd22002-27a7-4c5d-ba4d-a1c108a20eaf
{
"userName": "demo",
"password": "demo888",
"displayName": "演示",
"email": "demo@sample.com",
"mobile": "13888888888"
}
# 返回示例
{
"value": {
"id": 1,
"userName": "demo",
"password": "3CPlhZ8UAus=",
"passwordFormat": "Encrypted",
"passwordSalt": "VohMFwNz4s006ZytezfUxg==",
"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,
"isChecked": true,
"isLockedOut": false,
"displayName": "演示",
"email": "demo@sample.com",
"mobile": "13888888888",
"avatarUrl": "",
"organization": "",
"department": "",
"position": "",
"gender": "",
"birthday": "",
"education": "",
"graduation": "",
"address": "",
"weiXin": "",
"qq": "",
"weiBo": "",
"interests": "",
"signature": ""
}
}