成员管理


POST /api/v2/department/{ dept_no }/member_list -(递归)获取部门成员

能够(递归)获取指定部门编号下的所有成员。

请求参数:

参数 必需 类型 说明
has_child boolean 是否递归获取所有成员。默认为false,即只获取当前部门下的成员,而不获取其子部门的成员

请求数据样例:

{
    "has_child": true
}

响应内容:

参数 含义
users 当前指定部门下的成员列表

单个成员的返回数据结构:

参数 含义
name 昵称
username 用户名
departments 用户所属的部门编号列表

响应数据样例:

{
    users: [
        {
            username: "aubrey",
            name: "aubrey",
            departments: [1]
        }
    ]
}

POST /api/v2/user/{ username }/user_retrieve - 获取成员信息

请求参数:

响应内容:

参数 含义
user 成员信息,同单个成员的返回数据结构

响应数据样例:

{
    user: {
        username: "aubrey",
        name: "aubrey",
        departments: [2, 3]
    }
}

POST /api/v2/user/create - 添加成员

在指定部门下添加一位成员,该成员用户自动激活(可直接通过单点登录进行访问,并且会占用1个用户数),但是没有手机、邮箱和密码等个人注册信息。

请求参数:

参数 必需 类型 说明
name string 昵称
departments numer[] 用户所属部门列表
username string 成员编号

请求数据样例:

{
    "username": "jiandaoyun",
    "name": "小云",
    "departments": [1, 3]
}

响应内容:

参数 类型 说明
user json 新添加的该成员信息,同单个成员的返回数据结构

响应数据样例:

{
    user: {
        username: "jiandaoyun",
        name: "小云",
        departments: [1, 3]
    }
}

POST /api/v2/user/{ username }/update - 修改成员

修改指定成员的信息,比如部门、昵称。

注意:成员编号不允许修改。

请求参数:

参数 必需 类型 说明
name string 昵称
departments numer[] 用户所属部门列表

请求数据样例:

{
    "name": "jiandaoyun",
    "departments": [4]
}

响应内容:

参数 类型 说明
user json 修改后的该成员信息,同单个成员的返回数据结构

响应数据样例:

{
    user: {
        username: "jiandaoyun",
        name: "小云",
        departments: [4]
    }
}

POST /api/v2/user/{ username }/delete - 删除成员

从通讯录中删除指定成员编号的用户。

请求参数:

响应参数:

参数 类型 说明
status string 返回请求结果

响应数据样例:

{
    "status": "success"
}

POST /api/v2/user/batch_delete - 批量删除成员

请求参数:

参数 必需 类型 说明
usernames array 用户编号列表

请求数据样例:

{
    "usernames": ["tester", "developer"]
}

响应内容:

参数 类型 说明
status string 返回请求结果

响应数据样例:

{
    "status": "success"
}
本文是否对您有帮助?
 有帮助
 没帮助
您是否遇到了以下问题?
如需获取即时帮助,请联系技术支持