用户管理接口
管理本方用户的新增、删除、绑定
获取用户账号信息
请求方式:
GET
请求参数:
Name |
Documentation |
TypeName |
|
access_token |
全局access_token |
string |
|
userId |
第三方用户ID |
string |
|
返回值
Name |
Annotations |
Documentation |
TypeName |
|
Mobile |
[] |
手机号 |
string |
|
OrgId |
[] |
组织机构ID |
integer |
|
OrgName |
[] |
组织机构名 |
string |
|
userId |
[] |
用户ID |
string |
|
userName |
[] |
用户名 |
string |
|
email |
[] |
Email |
string |
|
返回示例
{
"mobile": null,
"org_id": 0,
"org_name": null,
"userid": "xxxx@xx.com",
"username": null,
"email": null
}
创建账号
创建用户(系统生成密码)
请求方式:
GET
请求参数:
Name |
Documentation |
TypeName |
|
access_token |
全局access_token |
string |
|
mobile |
手机号 |
string |
|
vericode |
验证码 |
string |
|
返回值
Name |
Annotations |
Documentation |
TypeName |
|
password |
[] |
用户密码 |
string |
|
返回示例
{
"password": "sample string 1"
}
创建用户(第三方设置密码)
请求方式:
GET
请求参数:
Name |
Documentation |
TypeName |
|
access_token |
全局access_token |
string |
|
Body参数
Name |
Documentation |
typeName |
|
mobile |
手机号 |
string |
|
orgId |
组织机构ID |
integer |
|
password |
用户密码 |
string |
|
vericode |
手机验证码 |
string |
|
userId |
用户ID |
string |
|
userName |
用户名 |
string |
|
email |
Email |
string |
|
返回值
Name |
Annotations |
Documentation |
TypeName |
|
result |
[] |
结果字符串 |
string |
|
返回示例
{
"result": "succeeded"
}
更新用户信息
请求方式:
PUT
请求参数:
Name |
Documentation |
TypeName |
|
access_token |
全局access_token |
string |
|
Body参数
Name |
Documentation |
typeName |
|
userId |
用户ID |
string |
|
userName |
用户名 |
string |
|
email |
Email |
string |
|
返回值
Name |
Annotations |
Documentation |
TypeName |
|
result |
[] |
结果字符串 |
string |
|
返回示例
{
"result": "succeeded"
}
删除用户
请求方式:
DELETE
Query Parameters:
Name |
Documentation |
TypeName |
|
access_token |
全局access_token |
string |
|
userId |
第三方用户ID |
string |
|
返回值
Name |
Annotations |
Documentation |
TypeName |
|
result |
[] |
结果字符串 |
string |
|
返回示例
{
"result": "succeeded"
}