用户接口

class dingtalk.client.api.User(client=None)

auth_scopes()

获取CorpSecret授权范围

返回:

batchdelete(user_ids)

批量删除成员

参数:user_ids – 员工UserID列表。列表长度在1到20之间 返回:

can_access_microapp(app_id, user_id)

获取管理员的微应用管理权限

参数:

• app_id – 微应用id
• user_id – 员工唯一标识ID

返回:

是否能管理该微应用

create(user_data)

创建成员

参数:user_data – 用户信息 返回:userid

delete(userid)

删除成员

参数:userid – 员工在企业内的UserID，企业用来唯一标识用户的字段 返回:

get(userid, lang='zh_CN')

获取成员详情

参数:

• userid – 员工在企业内的UserID，企业用来唯一标识用户的字段
• lang – 通讯录语言(默认zh_CN，未来会支持en_US)

返回:

get_admin()

获取管理员列表

返回:sys_level 管理员角色 1:主管理员,2:子管理员

get_admin_scope(userid)

查询管理员通讯录权限范围

参数:userid – 用户id

get_dept_member(dept_id)

获取部门用户userid列表

参数:dept_id – 用户在当前钉钉开放平台账号范围内的唯一标识 Return 部门userid列表:  

get_org_user_count(only_active)

获取企业员工人数

参数:only_active – 是否包含未激活钉钉的人员数量 返回:企业员工数量

get_userid_by_unionid(unionid)

根据unionid获取成员的userid

参数:unionid – 用户在当前钉钉开放平台账号范围内的唯一标识 返回:

getuserinfo(code)

通过CODE换取用户身份

参数:code – requestAuthCode接口中获取的CODE 返回:

list(department_id, offset=0, size=100, order='custom', lang='zh_CN')

获取部门成员（详情）

参数:

• department_id – 获取的部门id
• offset – 偏移量
• size – 表分页大小，最大100
• order – 排序规则 entry_asc 代表按照进入部门的时间升序 entry_desc 代表按照进入部门的时间降序 modify_asc 代表按照部门信息修改时间升序 modify_desc 代表按照部门信息修改时间降序 custom 代表用户定义排序
• lang – 通讯录语言(默认zh_CN另外支持en_US)

返回:

listbypage(department_id, offset=0, size=100, order='custom', lang='zh_CN')

获取部门用户

参数:

• department_id – 获取的部门id
• offset – 偏移量
• size – 表分页大小，最大100
• order – 排序规则 entry_asc 代表按照进入部门的时间升序 entry_desc 代表按照进入部门的时间降序 modify_asc 代表按照部门信息修改时间升序 modify_desc 代表按照部门信息修改时间降序 custom 代表用户定义排序
• lang – 通讯录语言(默认zh_CN另外支持en_US)

返回:

simple_list(department_id, offset=0, size=100, order='custom', lang='zh_CN')

获取部门成员

参数:

• department_id – 获取的部门id
• offset – 偏移量
• size – 表分页大小，最大100
• order – 排序规则 entry_asc 代表按照进入部门的时间升序 entry_desc 代表按照进入部门的时间降序 modify_asc 代表按照部门信息修改时间升序 modify_desc 代表按照部门信息修改时间降序 custom 代表用户定义排序
• lang – 通讯录语言(默认zh_CN另外支持en_US)

返回:

update(user_data)

更新成员

参数:user_data – 用户信息 返回: