获取代码组下可添加的成员列表
功能介绍
获取代码组下可添加的成员列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/groups/{group_id}/members/list
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
group_id |
是 |
Integer |
参数解释: 代码组id,代码组首页,Group ID后的数字Id 取值范围: 1-2147483647 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口查询项目列表获取。 取值范围: 字符串长度32。 |
query |
否 |
String |
参数解释: 成员搜索字符串 |
join_way |
否 |
String |
参数解释: 成员加入方式 domain 租户 normal 普通 inherit 继承 枚举值:
|
access_level |
否 |
Integer |
参数解释: 过滤成员的access level, 10待审核 20浏览者 30开发者 40管理员 50所有者 取值范围: 1-2147483647 |
offset |
否 |
Integer |
参数解释: 偏移量,从0开始。 取值范围: 0-2147483647 默认取值: 0 |
limit |
否 |
Integer |
参数解释: 返回数量。 取值范围: 1-100 默认取值: 20 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of GroupMemberDetailDto objects |
参数解释: 成员列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
参数解释: 唯一标识id。 取值范围: 1-2147483647 |
source_id |
Integer |
参数解释: 资源id。 取值范围: 1-2147483647 |
user_id |
Integer |
参数解释: 用户id。 取值范围: 1-2147483647 |
user_from |
String |
参数解释: 用户来源。 取值范围: 字符串长度不少于1,不超过1000。 |
role_id |
String |
参数解释: 角色id。 取值范围: 字符串长度不少于1,不超过1000。 |
role_name |
String |
参数解释: 角色名称。 取值范围: 字符串长度不少于1,不超过1000。 |
cn_role_name |
String |
参数解释: 角色中文名称。 取值范围: 字符串长度不少于1,不超过1000。 |
req_role_id |
String |
参数解释: 项目角色id。 取值范围: 字符串长度不少于1,不超过1000。 |
req_role_name |
String |
参数解释: 项目角色名称。 取值范围: 字符串长度不少于1,不超过1000。 |
user_group_id |
String |
参数解释: 成员组id。 取值范围: 字符串长度不少于1,不超过1000。 |
group_name |
String |
参数解释: 代码组名称。 取值范围: 字符串长度不少于1,不超过1000。 |
user_name |
String |
参数解释: 用户名称。 取值范围: 字符串长度不少于1,不超过1000。 |
domain_id |
String |
参数解释: 租户id。 取值范围: 字符串长度不少于1,不超过1000。 |
domain_name |
String |
参数解释: 租户名称。 取值范围: 字符串长度不少于1,不超过1000。 |
nick_name |
String |
参数解释: 用户昵称。 取值范围: 字符串长度不少于1,不超过1000。 |
is_group_creator |
Boolean |
参数解释: 是否为代码组创建者。 |
is_project_admin |
Boolean |
参数解释: 是否为项目管理员。 |
path |
String |
参数解释: 路径。 取值范围: 字符串长度不少于1,不超过1000。 |
role_chinese_name |
String |
参数解释: 角色中文名称。 取值范围: 字符串长度不少于1,不超过1000。 |
can_remove |
Boolean |
参数解释: 是否可移除。 |
access_level |
Integer |
参数解释: 角色。 取值范围: 1-2147483647 |
service_license_status |
Integer |
参数解释: 服务license状态。 取值范围: 1-2147483647 |
iam_id |
String |
参数解释: 用户iam_id。 取值范围: 字符串长度不少于1,不超过1000。 |
current_group_member |
Boolean |
参数解释: 是否为当前代码组成员。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
请求示例
GET https://{endpoint}/v4/groups/{group_id}/members/list
响应示例
状态码:200
获取代码组下可添加的成员列表
[ { "id" : 1067730, "source_id" : 2111919928, "user_id" : 9091, "user_from" : "项目成员", "role_id" : "42501d8587994fb1ace57dc2bd80a51f", "role_name" : "项目经理", "cn_role_name" : "项目经理", "req_role_id" : "42501d8587994fb1ace57dc2bd80a51f", "req_role_name" : "项目经理", "user_group_id" : null, "group_name" : "p_group3", "user_name" : "03e2dc950c7441df8d26972e33cadb15", "domain_id" : "159b65b41ead484d8ddff250a4731781", "domain_name" : "devcloud_codehub_l00314597_01", "nick_name" : null, "is_group_creator" : false, "is_project_admin" : false, "path" : null, "role_chinese_name" : null, "can_remove" : true, "access_level" : 40, "service_license_status" : 1, "iam_id" : "03e2dc950c7441df8d26972e33cadb15", "current_group_member" : true } ]
状态码:401
Unauthorized
{ "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }
状态码:403
Bad Request
{ "error_code" : "CH.004403", "error_msg" : "您没有操作权限,请升级权限后重试。" }
状态码
状态码 |
描述 |
---|---|
200 |
获取代码组下可添加的成员列表 |
401 |
Unauthorized |
403 |
Bad Request |
错误码
请参见错误码。