用户管理
主动调用通用参数请参阅全局说明
SDK示例:https://github.com/youduim/youdu-sdk-java
创建用户
请求说明
POST方式请求URL: http://[SERVER:7080]/cgi/user/create?accessToken=$access_token
请求结构体
{
"userId": "$user_id",
"name": "$user_name",
"gender": 1,
"mobile": "$user_mobile",
"phone": "$user_phone",
"email": "$user_email",
"dept": [1,5],
"enableState": 0
}
参数说明
参数 | 必须 | 说明 |
---|---|---|
userId | 是 | 用户id(帐号),企业内必须唯一。长度为1~64个字符(包括汉字和英文字母) |
name | 是 | 用户名称。长度为0~64个字符(包括汉字和英文字母,可为空) |
gender | 是 | 性别,整型。0表示男性,1表示女性 |
mobile | 否 | 手机号码。企业内必须唯一 |
phone | 否 | 电话号码 |
否 | 邮箱。长度为0~64个字符 | |
dept | 是 | 所属部门列表,不超过20个 |
enableState | 否 | 用户状态(-1:禁用,1:已授权,0:未激活) |
返回结果
全局状态码
更新用户
请求说明
POST方式请求URL: http://[SERVER:7080]/cgi/user/update?accessToken=$access_token
请求结构体
{
"userId": "$user_id",
"name": "$user_name",
"gender": 1,
"mobile": "$user_mobile",
"phone": "$user_phone",
"email": "$user_email",
"dept": [3,5]
}
参数说明
参数 | 必须 | 说明 |
---|---|---|
userId | 是 | 用户id(帐号),企业内必须唯一。长度为1~64个字符(包括汉字和英文字母) |
name | 否 | 用户名称。长度为0~64个字符(包括汉字和英文字母,可为空) |
gender | 否 | 性别,整型。0表示男性,1表示女性 |
mobile | 否 | 手机号码。企业内必须唯一 |
phone | 否 | 电话号码 |
否 | 邮箱。长度为0~64个字符 | |
dept | 否 | 所属部门列表,不超过20个 |
返回结果
全局状态码
更新用户部门职务信息
请求说明
POST方式请求URL: http://[SERVER:7080]/cgi/user/positionupdate?accessToken=$access_token
请求结构体
{
"userId": "$user_id",
"deptId":4,
"position":"工程师",
"weight":2,
"sortId":7
}
参数说明
参数 | 必须 | 说明 |
---|---|---|
userId | 是 | 用户id(帐号),企业内必须唯一。长度为1~64个字符(包括汉字和英文字母) |
deptId | 是 | 部门Id。用户必须在该部门内 |
position | 否 | 职务 |
weight | 否 | 职务权重。用户拥有多个职务时,权重值越大的职务排序越靠前 |
sortId | 否 | 用户在部门中的排序,值越大排序越靠前 |
返回结果
全局状态码
删除用户
请求说明
GET方式请求URL: http://[SERVER:7080]/cgi/user/delete?accessToken=$access_token&userId=$user_id
参数说明
参数 | 必须 | 说明 |
---|---|---|
userId | 是 | 需要删除的帐号 |
返回结果
全局状态码
批量删除用户
请求说明
POST方式请求URL: http://[SERVER:7080]/cgi/user/batchdelete?accessToken=$access_token
请求结构体
{
"delList":["$userid_1", "$userid_2", "$userid_3"]
}
参数说明
参数 | 必须 | 说明 |
---|---|---|
delList | 是 | 删除的帐号列表。最多支持200个 |
返回结果
全局状态码
获取用户信息
请求说明
GET方式请求URL: http://[SERVER:7080]/cgi/user/get?accessToken=$access_token&userId=$user_id
参数说明
参数 | 必须 | 说明 |
---|---|---|
userId | 是 | 用户id |
返回结果
{
"userId": "$user_id",
"name": "$user_name",
"gender": $user_gender,
"mobile": "$user_mobile",
"phone": "$user_phone",
"email": "$user_email",
"dept": [1,2],
"deptDetail": [
{
"deptId": 1,
"position":"$position_1",
"weight":3,
"sortId":4
},
{
"deptId": 2,
"position":"$position_2",
"weight":4,
"sortId":2
}
]
}
参数 | 说明 |
---|---|
userId | 用户id |
name | 用户名称 |
gender | 性别。0表示男性,1表示女性 |
mobile | 手机号码 |
phone | 电话号码 |
邮箱 | |
dept | 所属部门列表 |
deptDetail | 所在部门内的详细信息 |
deptDetail说明:
参数 | 说明 |
---|---|
deptId | 部门id |
position | 职务名称 |
weight | 职务权重。用户拥有多个职务时,权重值越大的职务排序越靠前 |
sortId | 用户在部门中的排序,值越大排序越靠前 |
获取部门用户详细信息
请求说明
GET方式请求URL: http://[SERVER:7080]/cgi/user/list?accessToken=$access_token&deptId=$dept_id
参数说明
参数 | 必须 | 说明 |
---|---|---|
deptId | 是 | 部门id |
返回结果
{
"userList":[
{
"userId": "$user_id",
"name": "$user_name",
"gender": $user_gender,
"mobile": "$user_mobile",
"phone": "$user_phone",
"email": "$user_email",
"dept": [1,2],
"deptDetail": [
{
"deptId": 1,
"position":"$position_1",
"weight":3,
"sortId":2
},
{
"deptId": 2,
"position":"$position_2",
"weight":4,
"sortId":5
}
]
}
]
}
参数 | 说明 |
---|---|
userList | 用户列表 |
userId | 用户id |
name | 用户名称 |
gender | 性别。0表示男性,1表示女性 |
mobile | 手机号码 |
phone | 电话号码 |
邮箱 | |
dept | 所属部门列表 |
deptDetail | 所在部门内的详细信息 |
deptDetail说明:
参数 | 说明 |
---|---|
deptId | 部门id |
position | 职务名称 |
weight | 职务权重。用户拥有多个职务时,权重值越大的职务排序越靠前 |
sortId | 用户在部门中的排序,值越大排序越靠前 |
获取部门用户
请求说明
GET方式请求URL: http://[SERVER:7080]/cgi/user/simplelist?accessToken=$access_token&deptId=$dept_id
参数说明
参数 | 必须 | 说明 |
---|---|---|
deptId | 是 | 部门id |
返回结果
{
"userList": [
{
"userId": "$user_id_1",
"name": "$user_name_1",
"gender": 0,
"dept": [1, 2]
}
]
}
参数 | 说明 |
---|---|
userList | 用户列表 |
userId | 用户id |
name | 用户名称 |
gender | 性别,整型。0表示男性,1表示女性 |
dept | 所属部门列表 |
设置用户头像
请求说明
POST方式请求URL: http://[SERVER:7080]/cgi/avatar/set?accessToken=$access_token&userId=$user_id
参数说明
参数 | 必须 | 说明 |
---|---|---|
userId | 是 | 用户id |
file | 是 | 头像文件。采用multipart-form方式上传,以file作为表单名,加密后上传,加密方式详见加解密说明 |
返回结果
全局状态码
获取用户头像
请求说明
GET方式请求URL: http://[SERVER:7080]/cgi/avatar/get?accessToken=$access_token&userId=$user_id&size=$avatar_size
参数说明
参数 | 必须 | 说明 |
---|---|---|
userId | 是 | 用户id |
size | 否 | 头像大小:0-大头像;1-小头像; 不设置默认返回小头像 |
返回结果
成功时返回:
HTTP/1.1 200 OK
Connection: close
Content-Type: image/png
Content-disposition: attachment;
Date: Mon, 26 Feb 2018 17:20:18 GMT
Cache-Control: no-cache, must-revalidate
Content-Length: 339721
//自定义encrypt参数,在header中返回
encrypt: "$encrypt"
//以下为http body,是加密后的头像二进制数据
$avatar_bytes
encrypt 解密后数据格式为:
{
"size": $media_size
}
错误时返回:
全局状态码
更新用户拓展属性字段
请求说明
POST方式请求URL: http://[SERVER:7080]/cgi/user/extend/update?accessToken=$access_token
请求结构体
{
"userId": "$user_id",
"key" : "needchangepwd",
"value": "1",
}
参数说明
参数 | 必须 | 说明 |
---|---|---|
userId | 是 | 用户id |
key | 是 | 用户拓展属性关键字,目前支持:"needchangepwd"(用于设置账号下次登录必须修改密码) |
value | 是 | 下次登录修改密码开关:"0"-关闭;"1"-开启 |
返回结果
全局状态码
查询用户激活状态
请求说明
GET方式请求URL: http://[SERVER:7080]/cgi/user/enable/state?accessToken=$access_token&userId=$userId
参数说明
参数 | 必须 | 说明 |
---|---|---|
userId | 是 | 用户id |
返回结果
成功时返回:
{
"enableState": 0
}
参数 | 说明 |
---|---|
enableState | 用户状态(-1:禁用,1:已授权,0:未激活) |
错误时返回:
全局状态码
修改用户激活状态
请求说明
GET方式请求URL: http://[SERVER:7080]/cgi/user/enable/stateupdate?accessToken=$access_token
参数说明
参数 | 必须 | 说明 |
---|---|---|
userIdList | 是 | 用户id列表 |
enableState | 是 | 用户状态(-1:禁用,1:已授权,0:未激活) |
返回结果
全局状态码
用户离职
服务端版本要求 >22.1.9
请求说明
POST方式请求URL: http://[SERVER:7080]/cgi/user.quit?accessToken=$access_token&accList=user accs &buin=
参数说明
参数 | 必须 | 说明 |
---|---|---|
accList | 是 | 接收成员账号列表。多个接收者用竖线分隔,最多支持1000个 |
buin | 是 | 主机号 |
返回结果
参数 | 说明 |
---|---|
errcode | 错误码 0=修改成功,其他修改异常 |
errmsg | 具体错误描述 |
返回结果示例
{"errcode":0,"errmsg":"ok"}
用户离职恢复
服务端版本要求 >22.1.9
请求说明
POST方式请求URL: http://[SERVER:7080]/cgi/user.restore?accessToken=$access_token&gid=user id
参数说明
参数 | 必须 | 说明 |
---|---|---|
gid | 是 | 成员Gid |
返回结果
参数 | 说明 |
---|---|
errcode | 错误码 0=修改成功,其他修改异常 |
errmsg | 具体错误描述 |
返回结果示例
{"errcode":0,"errmsg":"ok"}