用户组搜索

适用版本>=v7.0.2506.20250626
接口说明：按组名筛选符合条件的组

标签：用户组

请求说明

字段	值
请求地址	配置域名+/openapi+`/v7/groups/search`
HTTP 方法	`GET`
接口描述	按组名筛选符合条件的组
签名方式	KSO-1（配置域名+/openapi不参与签名）
限频策略	无
权限要求	查询和管理用户组(用户授权) `kso.group.readwrite` 查询用户组(用户授权) `kso.group.read`

请求头 (Headers)

属性名	类型	是否必填	描述	可选值
X-Kso-Date	`string`	是	RFC1123 格式的日期，例: `Wed, 23 Jan 2013 06:43:08 GMT`	-
X-Kso-Authorization	`string`	是	KSO-1 签名值，详见《签名方法》	-
Authorization	`string`	是	授权凭证，格式为：`Bearer {access_token}`	-

查询参数 (Query)

属性名	类型	是否必填	描述	可选值
keyword	`string`	是	搜索关键字	-
source	`array`	否	用户组的业务方来源，默认为default，不填则搜索所有来源的用户组	-
with_total	`boolean`	否	是否返回搜索到的总条数	-
page_size	`integer`	否	请求大小，默认为20	-
page_token	`string`	否	分页标记，第一次请求不填，表示从头开始遍历	-
with_dept_info	`boolean`	否	私有云适用，是否返回部门信息	-

响应体(Response)

HTTP状态码: 200
响应体格式: application/json

没有可用的数据

响应体示例

json

{
  "data": {
    "items": [
      {
        "dept_path": "string",
        "highlights": {
          "example_key": [
            "string"
          ]
        },
        "avatar": "string",
        "company_id": "string",
        "creator_id": "string",
        "ctime": 0,
        "dept_id": "string",
        "description": "string",
        "id": "string",
        "mail": "string",
        "member_total": 0,
        "mtime": 0,
        "name": "string",
        "owner_id": "string",
        "source": "string",
        "status": "enable",
        "type": "string"
      }
    ],
    "next_page_token": "string",
    "total": 0
  },
  "code": 0,
  "msg": "string"
}