创建成员
创建成员
权限说明
仅专有轻流支持;
「超管accessToken」和「权限组accessToken」都可以调用,「权限组accessToken」须具有通讯录权限。
请求
**请求方式:**POST
请求地址:https://自有域名/openApi/user
POST https://abcd.qingflow.com/openApi/user
2.1 参数说明(路径参数):
无
2.2 参数说明(查询参数):
无
2.3 请求头(Header)
| 参数 | 必须 | 说明 |
|---|---|---|
| accessToken | 是 | 调用接口凭证。获取方法请查看“文档” |
2.4 请求体(Body)
| 参数 | 必须 | 类型 | 说明 |
|---|---|---|---|
| userId | 是 | string | 用户的userId |
| name | 是 | string | 用户名 |
| areaCode | string | 区号,默认为86 | |
| mobileNum | string | 手机号 | |
| 是 | string | 邮箱(邮箱避免重复) | |
| headImg | string | 头像 | |
| department | [array] | 同步部门id列表 | |
| role | [array] | 同步角色id列表 | |
| customRole | [array] | 成员所属自建角色列表(仅企业微信/钉钉/飞书等特殊工作区适用) | |
| customDepartment | [array] | 成员所在自建部门列表(仅企业微信/钉钉/飞书等特殊工作区的专有轻流工作区适用) | |
| beingDisabled | boolean | 是否禁用成员 | |
| superiorId | string | 直属主管的外部id(仅限专有轻流) |
2.5 请求体示例
{
"userId": "", //必填
"name": "", //必填
"areaCode": "86",
"mobileNum": "手机号",
"email": "邮箱", //必填
"headImg": "头像",
"department":[],
"role": [],
"customRole": [],
"customDepartment": [],
"beingDisabled": "true"
}
返回
3.1 返回体
| 参数 | 必含 | 类型 | 说明 |
|---|---|---|---|
| errCode | 是 | int | 错误码,非0表示失败 |
| errMsg | 是 | string | 错误描述 |
| questionRelations | 关联的设置,这里没用 | ||
| result | 是 | object | 返回结果 |
| userId | string | 用户的userId |
3.2 返回体示例
{
"errCode": 0,
"errMsg": null,
"result": {
"userId": "用户的userId"
}
}
注意事项
创建成员以邮箱为唯一标识位:
- 该邮箱在对应环境中未创建账户——创建用户,在该工作区创建用户,相当于加入工作区; 关于密码:5.3稳定版之后,创建的用户无初始密码;需要code-login登录后进入系统补充密码; 5.3版本之前用该接口创建的用户,初始密码为123456
- 邮箱已存在轻流,但不在当前工作区——在该工作区创建成员,相当于加入工作区。同时如果有传其他信息,进行信息的更新
- 邮箱已存在于轻流,且对应用户在当前工作区时,调用本接口会更新成员信息