列举用户组接口 - GetUserGroupList

功能介绍

查询某个用户所加入的群组列表。

授权信息

当前API调用无需身份策略权限。

URI

GET /koodrive/ose/v1/usergroups

表1 Query参数
参数	是否必选	参数类型	描述
pageSize	是	Integer	每个返回的个数，默认是100，可接受值最大值是100。注意在到达最后的列表之前，实际有可能返回部分或者空结果
pageCursor	是	String	当前页游标，由前一个响应的nextCursor获取
groupName	否	String	用户组名
sourceType	是	Integer	用户组类型 0 群组 1 用户组

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
Authorization	是	String	该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token}
X-Traceid	否	String	消息日志跟踪标识（必须58位）
language	否	String	国际化语言标识，符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语，不传默认美式英语
X-User-Id	是	String	用户id，用于app鉴权
X-Date	是	String	日期，用于app鉴权
Host	是	String	地址，用于app鉴权

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
code	Integer	响应码
msg	String	响应信息
nextCursor	String	分页游标，如果不存在，代表已返回最后一个
userGroupList	Array of UserGroupInfo objects	用户组信息
total	Integer	总数

表4 UserGroupInfo
参数	参数类型	描述
id	String	用户组id
groupName	String	用户组名称
ownerId	String	创建者用户ID
createdTime	String	创建时间
updatedTime	String	更新时间

请求示例

查询用户的群组列表信息。

GET /koodrive/ose/v1/usergroups

Authorization:Bearer+c69b0f40334782d560bb154032cf22ef43d671843c4ffbad

响应示例

状态码：200

群组列表信息。

{
  "total" : 2,
  "userGroupList" : [ {
    "id" : "1407237551361847809",
    "groupName" : "7",
    "ownerId" : "1395476983395324033",
    "createdTime" : "2024-04-25T06:49:49.000Z",
    "updatedTime" : "2024-04-25T06:49:49.000Z"
  }, {
    "id" : "1404926806536180481",
    "groupName" : "111",
    "ownerId" : "1395476983395324033",
    "createdTime" : "2024-04-22T02:18:46.000Z",
    "updatedTime" : "2024-04-22T02:18:46.000Z"
  } ],
  "code" : 0,
  "msg" : "成功"
}