获取用户组成员列表
适用版本>=v7.0.2505a.20250515
接口说明:获取用户组成员列表
请求说明
| 请求地址 | 配置域名+/openapi+/v7/groups/{group_id}/members |
|---|---|
| 请求方法 | GET |
| 签名方式 | KSO-1(配置域名+/openapi不参与签名) |
| 权限要求 | 查询和管理用户组(应用授权) kso.group.readwrite 查询用户组(应用授权) kso.group.read 查询和管理用户组(用户授权) kso.group.readwrite 查询用户组(用户授权) kso.group.read |
请求头(Header)
| Header | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
| X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
| Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
路径参数(Path)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| group_id | string | 是 | 用户组id |
查询参数(Query)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| page_size | int | 否 | 分页大小,默认20[ 1 … 200 ] |
| page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回next_page_token作为新的page_token,下次遍历可采用该page_token获取查询结果 |
| with_total | boolean | 否 | true:返回用户组成员数量 false:不返回用户组成员数量 默认为:false |
响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| code | integer | code |
| detail | string | detail |
| msg | string | msg |
| data | object | null |
| ∟ items | object[] | <= 1024 items |
| ∟ ∟ ctime | int64 | 创建时间,时间戳,单位为秒 |
| ∟ ∟ group_id | string | 用户组ID |
| ∟ ∟ item_id | string | 用户组成员ID |
| ∟ ∟ item_type | string | 成员类型,可选值normal:普通成员;dept:部门成员 |
| ∟ ∟ mtime | int64 | 更新时间,时间戳,单位为秒 |
| ∟ ∟ nickname | string | 成员昵称 |
| ∟ ∟ role | string | 成员角色,owner:拥有者,admin:管理员,normal:普通成员 |
| ∟ next_page_token | string | 下一页分页标记;当查询结果中next_page_token为空或无该返回值时,代表无下一页 |
| ∟ total | int64 | 总数 |
响应体示例
json
{
"data": {
"items": [
{
"ctime": 1,
"group_id": "string",
"item_id": "string",
"item_type": "string",
"mtime": 1,
"nickname": "string",
"role": "string"
}
],
"next_page_token": "string",
"total": 0
},
"code": 0,
"detail": "string",
"msg": "string"
}