文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ Group/ 获取代码组下可添加的成员列表
更新时间:2025-07-15 GMT+08:00
分享

获取代码组下可添加的成员列表

功能介绍

获取代码组下可添加的成员列表

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v4/groups/{group_id}/members/addable-list

表1 路径参数

参数

是否必选

参数类型

描述

group_id

Integer

参数解释:

代码组id,代码组首页,Group ID后的数字Id

取值范围:

1-2147483647

表2 Query参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目的32位uuid,项目唯一标识,通过查询项目列表接口查询项目列表获取。

取值范围:

字符串长度32。

offset

Integer

参数解释:

偏移量,从0开始。

取值范围:

0-2147483647

默认取值:

0

limit

Integer

参数解释:

返回数量。

取值范围:

1-100

默认取值:

20

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of GroupBatchAddMemberDto objects

参数解释:

成员列表。

表5 GroupBatchAddMemberDto

参数

参数类型

描述

iam_id

String

参数解释:

用户iam_id。

取值范围:

字符串长度不少于1,不超过1000。

user_id

String

参数解释:

用户userId。

取值范围:

字符串长度不少于1,不超过1000。

name

String

参数解释:

用户名称。

取值范围:

字符串长度不少于1,不超过1000。

nick_name

String

参数解释:

用户昵称。

取值范围:

字符串长度不少于1,不超过1000。

domain_name

String

参数解释:

租户名称。

取值范围:

字符串长度不少于1,不超过1000。

domain_id

String

参数解释:

租户id。

取值范围:

字符串长度不少于1,不超过1000。

repo_role_id

String

参数解释:

角色id。

取值范围:

字符串长度不少于1,不超过1000。

req_role_id

String

参数解释:

项目角色id。

取值范围:

字符串长度不少于1,不超过1000。

repo_role_name

String

参数解释:

角色名称。

取值范围:

字符串长度不少于1,不超过1000。

req_role_name

String

参数解释:

项目角色名称。

取值范围:

字符串长度不少于1,不超过1000。

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

状态码:403

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

请求示例

GET https://{endpoint}/v4/groups/{group_id}/members/addable-list

响应示例

状态码:200

获取代码组下可添加的成员列表

[ {
  "iam_id" : "7be75ff77809436bb8acb031a7640098",
  "user_id" : null,
  "name" : "7be75ff77809436bb8acb031a7640098",
  "nick_name" : null,
  "domain_name" : "devcloud_codehub_l00314597_01",
  "domain_id" : "159b65b41ead484d8ddff250a4731781",
  "repo_role_id" : "c58e56f8e8684d2e83f48b8674485de7",
  "req_role_id" : "c58e56f8e8684d2e83f48b8674485de7",
  "repo_role_name" : "Committer",
  "req_role_name" : "Committer"
} ]

状态码:401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "认证信息过期"
}

状态码:403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "您没有操作权限,请升级权限后重试。"
}

状态码

状态码

描述

200

获取代码组下可添加的成员列表

401

Unauthorized

403

Bad Request

错误码

请参见错误码

相关文档