Mud Tools

Appearance

租户V3用户组管理 - FeishuTenantV3UserGroup ​

接口名称 ​

租户V3用户组管理 - (IFeishuTenantV3UserGroup)

功能描述 ​

本接口提供飞书用户组（User Group）的管理功能，适用于租户应用场景。支持用户组的创建、更新、查询和删除等操作。

用户组是飞书通讯录中基础实体之一，在用户组内可添加用户或部门资源。各类业务权限管控可以与用户组关联，从而实现高效便捷的成员权限管控。

参考文档 ​

函数列表 ​

函数名称功能描述认证方式HTTP 方法
CreateUserGroupAsync创建用户组租户令牌POST
UpdateUserGroupAsync更新用户组租户令牌PATCH
GetUserGroupInfoByIdAsync获取用户组详情租户令牌GET
GetUserGroupsAsync获取用户组列表租户令牌GET
GetUserBelongGroupsAsync获取成员所属用户组租户令牌GET
DeleteUserGroupByIdAsync删除用户组租户令牌DELETE

函数详细内容 ​

创建用户组 ​

函数名称：创建用户组

函数签名：

csharp
Task<FeishuApiResult<UserGroupCreateResult>?> CreateUserGroupAsync(
    [Body] UserGroupInfoRequest groupInfoRequest,
    [Query("user_id_type")] string? user_id_type = null,
    [Query("department_id_type")] string? department_id_type = Consts.Department_Id_Type,
    CancellationToken cancellationToken = default);

认证：租户令牌

参数：

参数名类型必填说明
groupInfoRequestUserGroupInfoRequest✅创建用户组请求体
user_id_typestring⚪用户ID类型
department_id_typestring⚪部门ID类型，默认 open_department_id
cancellationTokenCancellationToken⚪取消操作令牌

响应：

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "group": {
      "group_id": "xxx",
      "name": "项目A成员",
      "member_count": 0,
      "type": 1
    }
  }
}

说明：创建用户组。用户组是飞书通讯录中基础实体之一，在用户组内可添加用户或部门资源。各类业务权限管控可以与用户组关联，从而实现高效便捷的成员权限管控。

代码示例：

csharp
public class UserGroupService
{
    private readonly IFeishuTenantV3UserGroup _userGroupClient;

    public UserGroupService(IFeishuTenantV3UserGroup userGroupClient)
    {
        _userGroupClient = userGroupClient;
    }

    public async Task CreateProjectGroupAsync()
    {
        var request = new UserGroupInfoRequest
        {
            Name = "项目A成员",
            Description = "负责项目A的所有成员"
        };

        var result = await _userGroupClient.CreateUserGroupAsync(request);
        if (result?.Code == 0)
        {
            Console.WriteLine($"用户组创建成功，ID: {result.Data?.Group?.GroupId}");
        }
    }
}

更新用户组 ​

函数名称：更新用户组

函数签名：

csharp
Task<FeishuNullDataApiResult?> UpdateUserGroupAsync(
    [Path] string group_id,
    [Body] UserGroupUpdateRequest groupUpdateRequest,
    [Query("user_id_type")] string? user_id_type = null,
    [Query("department_id_type")] string? department_id_type = Consts.Department_Id_Type,
    CancellationToken cancellationToken = default);

认证：租户令牌

参数：

参数名类型必填说明
group_idstring✅用户组ID
groupUpdateRequestUserGroupUpdateRequest✅更新用户组请求体
user_id_typestring⚪用户ID类型
department_id_typestring⚪部门ID类型
cancellationTokenCancellationToken⚪取消操作令牌

响应：

json
{
  "code": 0,
  "msg": "success"
}

说明：更新用户组。

获取用户组详情 ​

函数名称：获取用户组详情

函数签名：

csharp
Task<FeishuApiResult<UserGroupQueryResult>?> GetUserGroupInfoByIdAsync(
    [Path] string group_id,
    [Query("user_id_type")] string? user_id_type = Consts.User_Id_Type,
    [Query("department_id_type")] string? department_id_type = Consts.Department_Id_Type,
    CancellationToken cancellationToken = default);

认证：租户令牌

参数：

参数名类型必填说明
group_idstring✅用户组ID
user_id_typestring⚪用户ID类型
department_id_typestring⚪部门ID类型
cancellationTokenCancellationToken⚪取消操作令牌

响应：

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "group": {
      "group_id": "xxx",
      "name": "项目A成员",
      "member_count": 10,
      "type": 1
    }
  }
}

说明：通过用户组ID查询指定用户组的基本信息，包括用户组名称、成员数量和类型等。

获取用户组列表 ​

函数名称：获取用户组列表

函数签名：

csharp
Task<FeishuApiResult<UserGroupListResult>?> GetUserGroupsAsync(
    [Query("page_size")] int? page_size = Consts.PageSize,
    [Query("page_token")] string? page_token = null,
    [Query("type")] int? type = 1,
    CancellationToken cancellationToken = default);

认证：租户令牌

参数：

参数名类型必填说明
page_sizeint⚪分页大小，默认10
page_tokenstring⚪分页标记
typeint⚪用户组类型，1：普通用户组，2：动态用户组，默认1
cancellationTokenCancellationToken⚪取消操作令牌

响应：

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "grouplist": [
      {
        "group_id": "xxx",
        "name": "项目A成员",
        "member_count": 10,
        "type": 1
      }
    ],
    "page_token": "xxx",
    "has_more": false
  }
}

说明：查询当前租户下的用户组列表，列表内包含用户组的ID、名字、成员数量和类型等信息。

获取成员所属用户组 ​

函数名称：获取成员所属用户组

函数签名：

csharp
Task<FeishuApiResult<UserBelongGroupListResult>?> GetUserBelongGroupsAsync(
    [Query("member_id")] string member_id,
    [Query("member_id_type")] string? member_id_type = null,
    [Query("group_type")] int? group_type = null,
    [Query("page_size")] int? page_size = Consts.PageSize,
    [Query("page_token")] string? page_token = null,
    [Query("type")] int? type = 1,
    CancellationToken cancellationToken = default);

认证：租户令牌

参数：

参数名类型必填说明
member_idstring✅成员ID
member_id_typestring⚪成员ID类型
group_typeint⚪用户组类型，1：普通用户组，2：动态用户组
page_sizeint⚪分页大小，默认10
page_tokenstring⚪分页标记
typeint⚪类型
cancellationTokenCancellationToken⚪取消操作令牌

响应：

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "grouplist": [
      {
        "group_id": "xxx",
        "name": "项目A成员"
      }
    ]
  }
}

说明：查询指定用户所属的用户组列表。

删除用户组 ​

函数名称：删除用户组

函数签名：

csharp
Task<FeishuNullDataApiResult?> DeleteUserGroupByIdAsync(
    [Path] string group_id,
    CancellationToken cancellationToken = default);

认证：租户令牌

参数：

参数名类型必填说明
group_idstring✅需删除的用户组ID
cancellationTokenCancellationToken⚪取消操作令牌

响应：

json
{
  "code": 0,
  "msg": "success"
}

说明：删除指定用户组。