1. 应用管理员创建用户
应用管理员创建用户。
请求方式:POST
请求地址:/bospersonnelservice/{appKey}/users/createUser
1.1. 请求参数:
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
appKey | string | xb05cd3a35614caa85c0f8f86c58fcc1 | 是 | 应用Key |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
NULL | NULL | NULL | NULL | NULL |
Body:
application/json:
{
"name": "xxx", //用户名
"password": "xxx", //密码
"fullName": "xxx", //姓名,可选
"email": "xxx@xx.com", //邮箱,可选
"telephone": "xxx", //电话号码
"userType": "0", //用户类型,可选
"noticeType": "0", //通知类型,可选
"xxx": "xxx", //应用库users表中定义的用户扩展属性
"language":"en"//界面中英文类别,目前只支持参数cn和en
}
1.2. 参数说明:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
name | string | NULL | 是 | 用户名 |
password | string | NULL | 是 | 密码 |
fullName | string | NULL | 否 | 姓名,可选 |
string | NULL | 否 | 邮箱,可选 | |
telephone | string | NULL | 是 | 电话号码 |
userType | string | NULL | 否 | 用户类型,可选 |
noticeType | string | NULL | 否 | 通知类型,可选 |
1.3. 正确返回:
Http Status Code:200
{
"code": " SUCCESS",
"message": "请求处理成功",
"data": "a824c7db3eae49d0a0c05dd29d8d6864" //用户key
}
1.4. 状态码:
状态码 | code | message | data | 原因 |
---|---|---|---|---|
200 | ADMIN_AUTH_ERROR | 没有管理员权限 | NULL | 如果不是应用管理员账户 |
200 | PARAMETER_VALID_ERROR | xxx不能为空 | NULL | 如果name、telephone以及users表必填的扩展属性为空 |
200 | TELEPHONE_FORMAT_ERROR | 手机号格式错误 | NULL | 如果telephone不是手机号格式 |
200 | TELEPHONE_OCCUPIED | 手机号已被占用 | NULL | 如果telephone已被占用 |
200 | NAME_OCCUPIED | 用户名已被占用 | NULL | 如果name已被占用 |
200 | EMAIL_OCCUPIED | 邮箱已被占用 | NULL | 如果输入email,并且email已被占用 |
200 | EMAIL _FORMAT_ERROR | 邮箱格式错误 | NULL | 如果输入email,并且email不是邮箱格式 |
200 | PARAMETER_VALID_ERROR | email不能为空 | NULL | 如果noticeType为"email",并且email为空 |
1.5. 注意事项:
- 仅应用管理有权限创建用户。
- name、telephone不能为空。
- 如果password为空,随机建立密码。
- 用户类型可以不填,默认为0(目前有4种类型,分别是0为普通用户,1为管理员用户,2为代表企业用户,3为内部用户)。
1.6. 请求示例
请求URL
http://bosgw.bimwinner.com/bospersonnelservice/w8486e2a067e4bdab7630546ad01751a/users/createUser
Headers
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyS2V5IjoiMTUyN2ZmYWRhZjhhNGY0YWJhZTk4NWM2N2JiZDQ5NmQiLCJ1c2VyTmFtZSI6InJhb2ppYWp1biIsInVzZXJUeXBlIjoiMCIsImFwcEtleSI6Inc4NDg2ZTJhMDY3ZTRiZGFiNzYzMDU0NmFkMDE3NTFhIiwiYXBwTmFtZSI6InRlc3QxMTIzMyIsImFwcERiIjoidzg0ODZlMmEwNjdlNGJkYWI3NjMwNTQ2YWQwMTc1MWEiLCJsb2dpblRpbWUiOiIxNTk3OTk3MjAwOTA2IiwiZXhwIjowfQ.fVC-_XVba6g8yCgcQUQfssG7k4P5zaDlDOYFZ_ffYA4
Body(application/json)
{
"name": "test111", //用户名
"password": "test222", //密码
"fullName": "rerer", //姓名,可选
"email": "12345678@qq.com", //邮箱,可选
"telephone": "12345678910", //电话号码
"userType": "0", //用户类型,可选
"noticeType": "0" //通知类型,可选
}
正常响应 200
{
"message": "请求处理成功",
"code": "SUCCESS",
"data": "40f66f12cb0541668fc75d6cf01f0598"
}