添加数字工厂员工账号。注:该API需要数字工厂管理员授权应用权限后才可调用。
路径 | /industry/user/account/add |
版本号 | 1.0.1 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 否 |
超时时间 | 10000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
appId | String | 是 | 应用实例唯一标识 | |
phone | String | 是 | 员工电话号码 | |
String | 否 | email地址 | ||
nickName | String | 是 | 员工名称 | |
organizationIds | List | 否 | 加入的组织列表 | |
roleCodes | List | 否 | 授予角色列表 | |
workNumber | String | 否 | 员工工号 | |
loginName | String | 否 | 员工登录名 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
响应码, 200: 成功 |
|
message | String |
错误消息 |
|
localizedMsg | String |
本地语言错误消息 |
|
data | JSON |
员工信息 |
|
auid | String |
员工ID |
|
orgList | JSON |
组织列表 |
|
organizationId | String |
组织ID |
|
organizationName | String |
组织名称 |
|
roleList | JSON |
角色列表 |
|
roleCode | String |
角色码 |
|
roleName | String |
角色名称 |
|
phone | String |
电话号码 |
|
String |
email地址 |
||
nickName | String |
姓名 |
|
loginName | String |
登录名 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.1"
},
"params":{
"appId": "value0",
"phone": "value1",
"email": "value2",
"nickName": "value3",
"organizationIds": "value4",
"roleCodes": "value5",
"workNumber": "value6",
"loginName": "value7"
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": {
"organizationId": "xxxxxxxx",
"organizationShowName": "研发部",
"roleCode": "ADMINISTRATOR",
"roleName": "系统集成商",
"auid": "505c689bf68dc13e35eee32b00e52d652c283946",
"phone": "13900001111",
"email": "test@taobao.com",
"nickName": "test",
"roleList": [
{
"roleCode": "SI",
"roleName": "系统集成商"
}
],
"orgList": [
{
"organizationId": "xxxxxx",
"organizationName": "研发部"
}
]
}
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | 500 | Internal Error | Internal Error |
503 | 503 | Service Unavailable | Service Unavailable |
403 | 403 | Request Limited | Request Limited |
401 | 401 | Empty Signature | Empty Signature |
400 | 400 | Request Format Error | Request Format Error |
200 | 20003 | Find Backend Error | Find Backend Error |
200 | 20004 | Backend Service Error | Backend Service Error |
200 | 20055 | Backend Service Invalid | Request Format Error |
200 | 20056 | Hsf Invoke Timeout | Hsf Invoke Timeout |
200 | 401 | Request Authorized Error | Request Authorized Error |
200 | 403 | Request Forbidden | Request Forbidden |
200 | 500 | Server Error | Server Error |