그룹 수준 보호 브랜치 API
유효한 액세스 수준
액세스 수준은 ProtectedRefAccess.allowed_access_levels
메서드에서 정의됩니다.
다음 수준이 인식됩니다:
0 => 액세스 없음
30 => 개발자 액세스
40 => 유지자 액세스
60 => 관리자 액세스
보호된 브랜치 목록
그룹에서 보호된 브랜치 목록을 가져옵니다. 와일드 카드가 설정된 경우 해당 와일드 카드와 일치하는 브랜치의 정확한 이름 대신 반환됩니다.
GET /groups/:id/protected_branches
속성 | 유형 | 필수 | 설명 |
---|---|---|---|
id
| 정수 또는 문자열 | 예 | 인증 된 사용자가 소유 한 URL 인코딩 된 경로의 ID 또는 |
search
| 문자열 | 아니요 | 검색 할 보호된 브랜치의 이름 또는 이름 일부입니다. |
curl --header "PRIVATE-TOKEN: <your_access_token>" \
"https://gitlab.example.com/api/v4/groups/5/protected_branches"
예시 응답:
[
{
"id": 1,
"name": "main",
"push_access_levels": [
{
"id": 1,
"access_level": 40,
"user_id": null,
"group_id": 1234,
"access_level_description": "유지자"
}
],
"merge_access_levels": [
{
"id": 1,
"access_level": 40,
"user_id": null,
"group_id": 1234,
"access_level_description": "유지자"
}
],
"allow_force_push":false,
"code_owner_approval_required": false
},
{
"id": 1,
"name": "release/*",
"push_access_levels": [
{
"id": 1,
"access_level": 40,
"user_id": null,
"group_id": null,
"access_level_description": "유지자"
}
],
"merge_access_levels": [
{
"id": 1,
"access_level": 40,
"user_id": null,
"group_id": 1234,
"access_level_description": "유지자"
}
],
"allow_force_push":false,
"code_owner_approval_required": false
},
...
]
단일 보호된 브랜치 또는 와일드 카드 보호된 브랜치 가져오기
단일 보호된 브랜치 또는 와일드 카드 보호된 브랜치를 가져옵니다.
GET /groups/:id/protected_branches/:name
속성 | 유형 | 필수 | 설명 |
---|---|---|---|
id
| 정수 또는 문자열 | 예 | 인증 된 사용자가 소유 한 URL 인코딩 된 경로의 ID 또는 |
name
| 문자열 | 예 | 분기 또는 와일드 카드의 이름입니다. |
curl --header "PRIVATE-TOKEN: <your_access_token>" \
"https://gitlab.example.com/api/v4/groups/5/protected_branches/main"
예시 응답:
{
"id": 1,
"name": "main",
"push_access_levels": [
{
"id": 1,
"access_level": 40,
"user_id": null,
"group_id": null,
"access_level_description": "유지자"
}
],
"merge_access_levels": [
{
"id": 1,
"access_level": null,
"user_id": null,
"group_id": 1234,
"access_level_description": "예시 병합 그룹"
}
],
"allow_force_push":false,
"code_owner_approval_required": false
}
저장소 브랜치 보호
와일드 카드 보호된 브랜치를 사용하여 단일 저장소 브랜치를 보호합니다.
POST /groups/:id/protected_branches
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
"https://gitlab.example.com/api/v4/groups/5/protected_branches?name=*-stable&push_access_level=30&merge_access_level=30&unprotect_access_level=40"
속성 | 유형 | 필수 | 설명 |
---|---|---|---|
id
| 정수 또는 문자열 | 예 | 인증 된 사용자가 소유 한 URL 인코딩 된 경로의 ID 또는 |
name
| 문자열 | 예 | 브랜치 또는 와일드 카드의 이름입니다. |
allow_force_push
| 불리언 | 아니요 | 푸시 액세스를 가진 모든 사용자가 강제 푸시를 할 수 있도록 허용합니다. 기본값: false .
|
allowed_to_merge
| 배열 | 아니요 | 병합을 허용하는 액세스 수준 배열입니다. 각각 {user_id: integer} , {group_id: integer} , 또는 {access_level: integer} 형의 해시로 설명됩니다.
|
allowed_to_push
| 배열 | 아니요 | 푸시를 허용하는 액세스 수준 배열입니다. 각각 {user_id: integer} , {group_id: integer} , 또는 {access_level: integer} 형의 해시로 설명됩니다.
|
allowed_to_unprotect
| 배열 | 아니요 | 언프로텍트를 허용하는 액세스 수준 배열입니다. 각각 {user_id: integer} , {group_id: integer} , 또는 {access_level: integer} 형의 해시로 설명됩니다.
|
code_owner_approval_required
| 불리언 | 아니요 |
CODEOWNERS 파일의 항목과 일치하는 경우이 브랜치에 푸시하는 것을 방지합니다. 기본값: false .
|
merge_access_level
| 정수 | 아니요 | 병합을 허용하는 액세스 수준입니다. 기본값: 40 , 유지자 역할.
|
push_access_level
| 정수 | 아니요 | 푸시를 허용하는 액세스 수준입니다. 기본값: 40 , 유지자 역할.
|
unprotect_access_level
| 정수 | 아니요 | 언프로텍트를 허용하는 액세스 수준입니다. 기본값: 40 , 유지자 역할.
|
예시 응답:
{
"id": 1,
"name": "*-stable",
"push_access_levels": [
{
"id": 1,
"access_level": 30,
"user_id": null,
"group_id": null,
"access_level_description": "개발자 + 유지자"
}
],
"merge_access_levels": [
{
"id": 1,
"access_level": 30,
"user_id": null,
"group_id": null,
"access_level_description": "개발자 + 유지자"
}
],
"unprotect_access_levels": [
{
"id": 1,
"access_level": 40,
"user_id": null,
"group_id": null,
"access_level_description": "유지자"
}
],
"allow_force_push":false,
"code_owner_approval_required": false
}
사용자 및 그룹 수준 액세스 예제
allowed_to_push
/ allowed_to_merge
/ allowed_to_unprotect
배열의 요소는 {user_id: integer}
, {group_id: integer}
, 또는 {access_level: integer}
형식을 취해야합니다. 각 사용자는 프로젝트에 액세스해야하고 각 그룹은 이 프로젝트를 공유해야합니다. 이러한 액세스 수준은 보호된 브랜치 액세스에 대해 더욱 세분화된 제어를 허용합니다.
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
"https://gitlab.example.com/api/v4/groups/5/protected_branches?name=*-stable&allowed_to_push%5B%5D%5Buser_id%5D=1"
예시 응답:
{
"id": 1,
"name": "*-stable",
"push_access_levels": [
{
"id": 1,
"access_level": null,
"user_id": 1,
"group_id": null,
"access_level_description": "관리자"
}
],
"merge_access_levels": [
{
"id": 1,
"access_level": 40,
"user_id": null,
"group_id": null,
"access_level_description": "관리자"
}
],
"unprotect_access_levels": [
{
"id": 1,
"access_level": 40,
"user_id": null,
"group_id": null,
"access_level_description": "관리자"
}
],
"allow_force_push": false,
"code_owner_approval_required": false
}
푸시 허용 및 병합 허용이 있는 예시
예시 요청:
curl --request POST \
--header "PRIVATE-TOKEN: <your_access_token>" \
--header "Content-Type: application/json" \
--data '{
"name": "main",
"allowed_to_push": [{"access_level": 30}],
"allowed_to_merge": [{
"access_level": 30
},{
"access_level": 40
}
]}'
"https://gitlab.example.com/api/v4/groups/5/protected_branches"
예시 응답:
{
"id": 5,
"name": "main",
"push_access_levels": [
{
"id": 1,
"access_level": 30,
"access_level_description": "개발자 + 유지보수자",
"user_id": null,
"group_id": null
}
],
"merge_access_levels": [
{
"id": 1,
"access_level": 30,
"access_level_description": "개발자 + 유지보수자",
"user_id": null,
"group_id": null
},
{
"id": 2,
"access_level": 40,
"access_level_description": "유지보수자",
"user_id": null,
"group_id": null
}
],
"unprotect_access_levels": [
{
"id": 1,
"access_level": 40,
"access_level_description": "유지보수자",
"user_id": null,
"group_id": null
}
],
"allow_force_push": false,
"code_owner_approval_required": false
}
보호 해제된 저장소 브랜치
지정된 보호된 브랜치 또는 와일드카드 보호된 브랜치의 보호를 해제합니다.
DELETE /groups/:id/protected_branches/:name
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
"https://gitlab.example.com/api/v4/groups/5/protected_branches/*-stable"
속성 | 유형 | 필수 | 설명 |
---|---|---|---|
id
| 정수 또는 문자열 | 예 | 인증된 사용자가 소유한 그룹의 ID 또는 URL-encoded path |
name
| 문자열 | 예 | 브랜치의 이름 |
예시 응답:
{
"name": "main",
"push_access_levels": [
{
"id": 12,
"access_level": 40,
"access_level_description": "유지보수자",
"user_id": null,
"group_id": null
}
]
}
보호된 브랜치 업데이트
보호된 브랜치를 업데이트합니다.
PATCH /groups/:id/protected_branches/:name
curl --request PATCH --header "PRIVATE-TOKEN: <your_access_token>" \
"https://gitlab.example.com/api/v4/groups/5/protected_branches/feature-branch?allow_force_push=true&code_owner_approval_required=true"
속성 | 유형 | 필수 | 설명 |
---|---|---|---|
id
| 정수 또는 문자열 | 예 | 인증된 사용자가 소유한 그룹의 ID 또는 URL-encoded path |
name
| 문자열 | 예 | 브랜치의 이름 |
allow_force_push
| 부울 | 아니오 | 활성화되면이 브랜치로 푸시 할 수있는 멤버는 강제 푸시도 수행할 수 있습니다. |
allowed_to_push
| 배열 | 아니오 | 각각 해시로 설명된 push 액세스 수준의 배열 |
allowed_to_merge
| 배열 | 아니오 | 각각 해시로 설명된 병합 액세스 수준의 배열 |
allowed_to_unprotect
| 배열 | 아니오 | 각각 해시로 설명된 unprotect 액세스 수준의 배열. |
code_owner_approval_required
| 부울 | 아니오 | 이 브랜치로의 푸시를 방지하십시오. 이것이 CODEOWNERS 파일의 항목과 일치하면 기본값은 false 입니다.
|
allowed_to_push
, allowed_to_merge
및 allowed_to_unprotect
배열의 요소는 다음을 해야합니다:
-
user_id
,group_id
, 또는access_level
중 하나여야합니다. -
{user_id: integer}
,{group_id: integer}
, 또는{access_level: integer}
형식을 취해야합니다.
업데이트하려면:
-
user_id
: 업데이트 된 사용자가 프로젝트에 액세스 할 수 있도록합니다. 또한 해당 해시의id
를 전달해야합니다. -
group_id
: 업데이트 된 그룹이 이 프로젝트를 공유해야합니다. 또한 해당 해시의id
를 전달해야합니다.
삭제하려면:
-
true
로 설정된_destroy
를 전달해야합니다. 다음 예를 참조하십시오.
예시: push_access_level
레코드 만들기
curl --header 'Content-Type: application/json' --request PATCH \
--data '{"allowed_to_push": [{access_level: 40}]}' \
--header "PRIVATE-TOKEN: <your_access_token>" \
"https://gitlab.example.com/api/v4/groups/22034114/protected_branches/main"
예시 응답:
{
"name": "main",
"push_access_levels": [
{
"id": 12,
"access_level": 40,
"access_level_description": "Maintainers",
"user_id": null,
"group_id": null
}
]
}
예시: push_access_level
레코드 업데이트
curl --header 'Content-Type: application/json' --request PATCH \
--data '{"allowed_to_push": [{"id": 12, "access_level": 0}]' \
--header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/22034114/protected_branches/main"
예시 응답:
{
"name": "main",
"push_access_levels": [
{
"id": 12,
"access_level": 0,
"access_level_description": "No One",
"user_id": null,
"group_id": null
}
]
}
예시: push_access_level
레코드 삭제
curl --header 'Content-Type: application/json' --request PATCH \
--data '{"allowed_to_push": [{"id": 12, "_destroy": true}]}' \
--header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/22034114/protected_branches/main"
예시 응답:
{
"name": "main",
"push_access_levels": []
}