文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ Repository/ 获取CR仓库用户分支或标签级权限
更新时间：2025-08-20 GMT+08:00
查看PDF
分享

获取CR仓库用户分支或标签级权限

功能介绍

获取CR仓库用户分支或标签级权限

调试

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

URI

GET /v4/repositories/{repository_id}/user-ref-permission

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

是

Integer

参数解释：

仓库的ID，通过查询用户所有仓库接口查询项目列表获取。

约束限制：

不涉及。

取值范围：

1-2147483647
表2 Query参数

参数

是否必选

参数类型

描述

target_ref

是

String

参数解释：

分支或者标签名称。

约束限制：

不支持空格 [ \ < ~ ^ : ? * ! ( ) ' " | 等特殊字符，不支持以. / .lock结尾，分支以refs/head/开头，标签以refs/tag/开头

取值范围：

字符串长度不少于1，不超过210。

默认取值：

不涉及。

action

否

String

参数解释：

动作类型，可用于查询指定动作的权限

  • read，查看

  • review，检视

  • approval, 审核

  • create-change，创建变更请求

  • merge，合并变更请求

  • create-delete，创建/删除分支

  • push, 推送

枚举值：

  • read

  • review

  • approval

  • create-change

  • merge

  • create-delete

  • push

change_request_iid

否

Integer

参数解释：

变更请求在仓库内部的ID。

取值范围：

1-2147483647

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

read

UserRefPermissionBasicDto object

参数解释：

查看权限。

review

UserRefPermissionBasicDto object

参数解释：

检视权限。

approval

UserRefPermissionBasicDto object

参数解释：

审核权限。

create_change

UserRefPermissionBasicDto object

参数解释：

创建变更请求权限。

merge

UserRefPermissionBasicDto object

参数解释：

合并变更请求权限。

create_delete

UserRefPermissionBasicDto object

参数解释：

创建和删除分支权限。

push

UserRefPermissionBasicDto object

参数解释：

推送权限。
表5 UserRefPermissionBasicDto

参数

参数类型

描述

has_permission

Boolean

参数解释：

是否有权限。

取值范围：

true：有权限，false：没权限

is_protect

Boolean

参数解释：

是否保护分支。

取值范围：

true：是保护分支，false：非保护分支

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：403

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

请求示例

GET https://{endpoint}/v4/repositories/1/user-ref-permission?target_ref=refs/head/master

响应示例

状态码：200

OK

{
  "read" : {
    "has_permission" : true,
    "is_protect" : false
  },
  "review" : {
    "has_permission" : true,
    "is_protect" : false
  },
  "approval" : {
    "has_permission" : true,
    "is_protect" : false
  },
  "create_change" : {
    "has_permission" : true,
    "is_protect" : false
  },
  "merge" : {
    "has_permission" : true,
    "is_protect" : false
  },
  "create_delete" : {
    "has_permission" : true,
    "is_protect" : false
  },
  "push" : {
    "has_permission" : true,
    "is_protect" : false
  }
}

状态码：401

Unauthorized

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

状态码：403

Bad Request

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

状态码

状态码

描述

200

OK

401

Unauthorized

403

Bad Request

错误码

请参见错误码。

父主题： Repository

相关文档