文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ RepoMember/ 获取仓库所有成员记录
更新时间:2024-09-02 GMT+08:00
分享

获取仓库所有成员记录

功能介绍

获取仓库成员列表,可通过关键字搜索某成员。

调试

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

URI

GET /v1/repositories/{repository_uuid}/members

表1 路径参数

参数

是否必选

参数类型

描述

repository_uuid

String

参数解释:

仓库UUID(由CreateRepository接口返回)

约束限制:

必传。

取值范围:

可包含数字、字母,长度32位。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

page_index

Integer

参数解释:

第几页。

约束限制:

不涉及。

取值范围:

数字。

默认取值:

不涉及。

page_size

Integer

参数解释:

每页显示size。

约束限制:

不涉及。

取值范围:

数字。

默认取值:

不涉及。

subject

String

参数解释:

搜索关键字,模糊匹配用户名称、用户昵称、租户名称。

约束限制:

不涉及。

取值范围:

长度限制128个字符。

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

error

Error object

响应错误

result

RepositoryMemberList object

响应结果

status

String

响应状态

表5 Error

参数

参数类型

描述

code

String

错误码

message

String

错误信息

表6 RepositoryMemberList

参数

参数类型

描述

total

Integer

仓库成员总数

users

Array of RepositoryMember objects

仓库成员列表

表7 RepositoryMember

参数

参数类型

描述

description

String

仓库成员描述

domain_id

String

租户id

最小长度:8

最大长度:32

domain_name

String

租户名

email

String

邮箱地址

enabled

String

成员是否可用

name

String

用户名

role

Integer

仓库用户权限,取值范围:30->普通成员,40->管理员

user_id

String

用户id

最小长度:4

最大长度:32

请求示例

GET https://{endpoint}/v1/repositories/{repository_uuid}/members

响应示例

状态码: 200

OK

{
  "result" : {
    "total" : 2,
    "users" : [ {
      "user_id" : "5836",
      "name" : "repo",
      "domain_name" : "repo",
      "description" : null,
      "enabled" : null,
      "role" : 40,
      "domain_id" : "159b65b41ead484d8ddff250a4731781",
      "email" : null
    }, {
      "user_id" : "6057",
      "name" : "repo",
      "domain_name" : "repo",
      "description" : null,
      "enabled" : null,
      "role" : 30,
      "domain_id" : "159b65b41ead484d8ddff250a4731781",
      "email" : null
    } ]
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档