获取组成员列表
适用版本>=v7.0.2310a.20231019
接口说明:获取组成员列表
请求说明
| 请求地址 | 配置域名+/graph+/v7/groups/{group_id}/members |
|---|---|
| 请求方法 | GET |
| 签名方式 | WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名) |
| 权限要求 | 更新用户组成员(用户授权) kso.group.member.write应用查询用户组(应用授权) kso.appdrive.group.member.read |
请求头(Header)
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考签名说明 |
| Authorization | 是 | 授权凭证,格式为: Bearer {access_token} |
路径参数(Path)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| group_id | string | 是 | 组id,<= 1024 characters |
查询参数(Query)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| page_size | int | 否 | 分页大小,默认20[ 1 … 200 ] |
| page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回next_page_token作为新的page_token,下次遍历可采用该page_token获取查询结果 |
| with_total | bool | 否 | 是否返回total字段 默认不返回 |
响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| code | integer | code |
| detail | string | detail |
| msg | string | msg |
| data | object | 列表信息 |
| ∟ items | object | <= 1024 items |
| ∟ ∟ ctime | integer | >= 1,创建时间,时间戳,单位为秒 |
| ∟ ∟ group_id | string | <= 1024 characters,组ID |
| ∟ ∟ item_id | string | <= 1024 characters,成员ID |
| ∟ ∟ item_type | string | <= 1024 characters,成员类型(normal,dept,group),默认为normal |
| ∟ ∟ mtime | integer | 更新时间,时间戳,单位为秒 |
| ∟ ∟ nickname | string | <= 1024 characters,成员昵称 |
| ∟ ∟ role | string | <= 1024 characters,成员角色,owner拥有者,admin管理员,normal普通成员 |
| ∟ next_page_token | string | <= 1024 characters,下一页分页标记;当查询结果中next_page_token为空或无该返回值时,代表无下一页 |
| ∟ total | integer | 总数 |
响应体示例
{
"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"
}