组织架构 SDK 接口文档
概述
组织架构 SDK 提供了飞书通讯录的完整 API 封装,支持部门管理、用户管理、角色管理、用户组管理等功能,帮助开发者构建企业级组织管理应用。
主要功能:
- 部门创建、更新、删除、查询
- 用户创建、更新、离职、恢复
- 角色与角色成员管理
- 用户组与成员管理
- 职级、职务、序列管理
- 单位与人员类型管理
适用场景:
- 企业组织架构同步
- 员工入离职自动化
- 权限管理系统集成
- 组织数据分析与报表
文档使用指引:
本索引文档提供了所有组织架构相关 API 的导航入口。每个 API 文档包含接口名称、功能描述、函数签名、参数说明及请求示例。点击各 API 链接可查看详细文档。
快速开始
安装
bash
dotnet add package Mud.Feishu配置文件
在 appsettings.json 中添加飞书应用配置:
json
{
"FeishuApps": [
{
"AppKey": "default",
"AppId": "cli_xxx",
"AppSecret": "your_app_secret",
"BaseUrl": "https://open.feishu.cn",
"IsDefault": true
}
]
}注册服务
在 Program.cs 中注册飞书服务:
csharp
// 添加飞书服务
builder.Services.AddFeishuApp(builder.Configuration, "FeishuApps");
// 注册 API 服务
builder.Services.CreateFeishuServicesBuilder()
.AddModules(FeishuModule.All)
.Build();依赖注入使用
在 Controller 或服务中通过构造函数注入接口:
csharp
using Mud.Feishu;
public class UserController : ControllerBase
{
private readonly IFeishuTenantV3User _userApi;
public UserController(IFeishuTenantV3User userApi)
{
_userApi = userApi;
}
[HttpGet("{userId}")]
public async Task<IActionResult> GetUser(string userId)
{
var result = await _userApi.GetUserInfoByIdAsync(userId);
return Ok(result.Data);
}
}API 接口导航
部门管理
- 租户V1部门管理 — 部门创建、更新、删除、批量查询与搜索
- 租户V3部门管理 — 部门信息获取、子部门列表、部门ID变更、部门群解绑
- 用户V1部门管理 — 用户权限的部门管理(V1版本)
- 用户V3部门管理 — 用户权限的部门查询(V3版本)
用户管理
- 租户V1员工管理 — 员工创建、更新、离职、恢复、批量查询
- 租户V3用户管理 — 用户创建、更新、删除、恢复、JSAPI票据获取
- 用户V1员工管理 — 用户权限的员工管理(V1版本)
- 用户V3用户管理 — 用户权限的用户查询与搜索(V3版本)
角色与用户组
- 租户V3角色管理 — 角色创建、更新、删除
- 租户V3角色成员管理 — 角色成员添加、管理范围设置、成员查询
- 租户V3用户组管理 — 用户组创建、更新、查询、删除
- 租户V3用户组成员管理 — 用户组成员添加、查询、移除
职级职务序列
单位与人员类型
- 租户V3单位管理 — 单位创建、更新、部门绑定、查询
- 租户V3人员类型管理 — 人员类型创建、更新、查询、删除
命名空间与版本信息
- 根命名空间:
Mud.Feishu - 当前版本:2.0.5
- 目标框架:.NET Standard 2.0 / .NET 6+ / .NET 8+