查询指定用户组及其父组、子组和成员的详细信息。
接口说明
请求说明
该接口用于获取指定用户组的详细信息，包括用户组的基本信息、父用户组信息、直接子用户组列表以及直接成员列表。
userGroupId是必填参数，需要在请求体中提供。tenantId是可选参数，可以通过查询字符串传递。接口支持多种认证方式，包括 AK、BearerToken 和 APP 认证。
请求和响应的内容类型均为
application/json。请确保具有相应的权限（如
winnexo:GetUserGroup）才能成功调用此接口。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
winnexo:GetUserGroup |
none |
*全部资源
|
无 | 无 |
请求语法
POST /openapi/getUserGroup HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| tenantId |
string |
否 |
租户 ID，公共参数；winnexo-cli 通过 |
10000 |
| userGroupId |
string |
是 |
目标用户组 ID |
7ea8973f-7a5c-4e8a-956b-4fe0e7e2eb11 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
查询用户组详情 |
||
| childGroups |
array |
直接子用户组列表 |
|
|
any |
直接子用户组信息。 |
{"userGroupId":"7ea8973f-7a5c-4e8a-956b-4fe0e7e2eb11","userGroupName":"华南销售","parentId":"b07fb0a4-0b7d-44a7-a3d5-a43a5964c8f0","level":2,"description":"华南销售组织","childGroupCount":0,"directMemberCount":2,"sourceType":"internal","externalSyncStatus":null,"gmtCreate":"2026-08-27T09:00:00Z","gmtModified":"2026-08-27T10:00:00Z"} |
|
| code |
string |
状态码。 |
200 |
| members |
array |
当前用户组直接成员列表 |
|
|
any |
用户组直接成员信息。 |
{"userId":1000001,"userName":"张三","userCode":"zhangsan","gmtCreate":"2026-08-27T09:30:00Z"} |
|
| message |
string |
状态码描述。 |
success |
| parentGroup |
any |
父用户组信息；根节点为空 |
{"userGroupId":"b07fb0a4-0b7d-44a7-a3d5-a43a5964c8f0","userGroupName":"销售中心","parentId":null,"level":1,"description":"销售组织","childGroupCount":1,"directMemberCount":0,"sourceType":"internal","externalSyncStatus":null,"gmtCreate":"2026-08-27T08:00:00Z","gmtModified":"2026-08-27T08:00:00Z"} |
| requestId |
string |
请求 ID。 |
019FF406-1B10-0065-A97D-2D1920C2A03D |
| userGroup |
any |
目标用户组信息 |
{"userGroupId":"7ea8973f-7a5c-4e8a-956b-4fe0e7e2eb11","userGroupName":"华南销售","parentId":"b07fb0a4-0b7d-44a7-a3d5-a43a5964c8f0","level":2,"description":"华南销售组织","childGroupCount":0,"directMemberCount":2,"sourceType":"internal","externalSyncStatus":null,"gmtCreate":"2026-08-27T09:00:00Z","gmtModified":"2026-08-27T10:00:00Z"} |
示例
正常返回示例
JSON格式
{
"childGroups": [
"{\"userGroupId\":\"7ea8973f-7a5c-4e8a-956b-4fe0e7e2eb11\",\"userGroupName\":\"华南销售\",\"parentId\":\"b07fb0a4-0b7d-44a7-a3d5-a43a5964c8f0\",\"level\":2,\"description\":\"华南销售组织\",\"childGroupCount\":0,\"directMemberCount\":2,\"sourceType\":\"internal\",\"externalSyncStatus\":null,\"gmtCreate\":\"2026-08-27T09:00:00Z\",\"gmtModified\":\"2026-08-27T10:00:00Z\"}"
],
"code": "200",
"members": [
"{\"userId\":1000001,\"userName\":\"张三\",\"userCode\":\"zhangsan\",\"gmtCreate\":\"2026-08-27T09:30:00Z\"}"
],
"message": "success",
"parentGroup": "{\"userGroupId\":\"b07fb0a4-0b7d-44a7-a3d5-a43a5964c8f0\",\"userGroupName\":\"销售中心\",\"parentId\":null,\"level\":1,\"description\":\"销售组织\",\"childGroupCount\":1,\"directMemberCount\":0,\"sourceType\":\"internal\",\"externalSyncStatus\":null,\"gmtCreate\":\"2026-08-27T08:00:00Z\",\"gmtModified\":\"2026-08-27T08:00:00Z\"}",
"requestId": "019FF406-1B10-0065-A97D-2D1920C2A03D",
"userGroup": "{\"userGroupId\":\"7ea8973f-7a5c-4e8a-956b-4fe0e7e2eb11\",\"userGroupName\":\"华南销售\",\"parentId\":\"b07fb0a4-0b7d-44a7-a3d5-a43a5964c8f0\",\"level\":2,\"description\":\"华南销售组织\",\"childGroupCount\":0,\"directMemberCount\":2,\"sourceType\":\"internal\",\"externalSyncStatus\":null,\"gmtCreate\":\"2026-08-27T09:00:00Z\",\"gmtModified\":\"2026-08-27T10:00:00Z\"}"
}