그룹 수준 보호된 브랜치 API

Tier: Premium, Ultimate Offering: Self-Managed
History
  • Introduced in GitLab 15.9 with a flag named 그룹 보호 브랜치. 기본적으로 비활성화됨.
  • Flag 그룹 보호 브랜치 다시 정의됨 flag to 그룹에 보호 브랜치 허용 GitLab 15.11.
자체 관리 GitLab의 경우, 기본적으로이 기능을 사용할 수 없습니다. 사용하려면 관리자가 그룹에 보호 브랜치 허용라는 기능 플래그를 활성화 할 수 있습니다. GitLab.com 및 GitLab Dedicated의 경우,이 기능은 사용할 수 없습니다.

그룹 수준 보호된 브랜치 API를 사용하여 보호된 브랜치 규칙을 관리합니다. 그룹 내 프로젝트에 적용되는 보호된 브랜치 규칙을 나열, 생성, 업데이트, 삭제하는 데 사용됩니다.

경고: 그룹 수준의 보호된 브랜치 설정은 최상위 그룹에만 제한됩니다.

유효한 액세스 레벨

액세스 레벨은 ProtectedRefAccess.allowed_access_levels 메서드에 정의됩니다. 이러한 레벨이 인식됩니다: 

0  => 액세스 권한 없음
30 => 개발자 액세스
40 => 유지 관리자 액세스
60 => 관리자 액세스

보호된 브랜치 목록

그룹에서 보호된 브랜치 목록을 가져옵니다. 와일드카드가 설정되어 있으면 해당 와일드카드와 일치하는 브랜치의 정확한 이름 대신 반환됩니다. 

GET /groups/:id/protected_branches
속성 유형 필수 설명
id 정수 또는 문자열 예 그룹의 ID 또는 URL-인코딩 된 경로.
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 정수 또는 문자열 예 그룹의 ID 또는 URL-인코딩 된 경로.
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 정수 또는 문자열 예 그룹의 ID 또는 URL-인코딩 된 경로.
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: 정수}, {group_id: 정수}, 또는 {access_level: 정수} 형식이어야 합니다. 각 사용자는 프로젝트에 액세스해야 하며, 각 그룹은 이 프로젝트를 공유해야 합니다. 이러한 액세스 수준은 보호된 브랜치 액세스에 대해 보다 세분화된 제어를 허용합니다. 

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": "Administrator"
    }
  ],
  "merge_access_levels": [
    {
      "id": 1,
      "access_level": 40,
      "user_id": null,
      "group_id": null,
      "access_level_description": "Maintainers"
    }
  ],
  "unprotect_access_levels": [
    {
      "id": 1,
      "access_level": 40,
      "user_id": null,
      "group_id": null,
      "access_level_description": "Maintainers"
    }
  ],
  "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": "Developers + Maintainers",
      "user_id": null,
      "group_id": null
    }
  ],
  "merge_access_levels": [
    {
      "id": 1,
      "access_level": 30,
      "access_level_description": "Developers + Maintainers",
      "user_id": null,
      "group_id": null
    },
    {
      "id": 2,
      "access_level": 40,
      "access_level_description": "Maintainers",
      "user_id": null,
      "group_id": null
    }
  ],
  "unprotect_access_levels": [
    {
      "id": 1,
      "access_level": 40,
      "access_level_description": "Maintainers",
      "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 integer or string yes 그룹의 ID 또는 URL 인코딩된 경로.
name string yes 브랜치의 이름.

예제 응답: 

{
  "name": "main",
  "push_access_levels": [
    {
      "id": 12,
      "access_level": 40,
      "access_level_description": "Maintainers",
      "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 integer or string yes 그룹의 ID 또는 URL 인코딩된 경로.
name string yes 브랜치 이름.
allow_force_push boolean no 활성화되면 이 브랜치로 푸시할 수있는 멤버는 강제 푸시도 할 수 있습니다.
allowed_to_push 배열 no 해시로 설명된 푸시 액세스 레벨의 배열.
allowed_to_merge 배열 no 해시로 설명된 머지 액세스 레벨의 배열.
allowed_to_unprotect 배열 no 해시로 설명된 보호 해제 액세스 레벨의 배열.
code_owner_approval_required boolean no CODEOWNERS 파일에서 항목과 일치하는 경우 이 브랜치로 푸시되는 것을 방지합니다. 기본값: false.

allowed_to_push, allowed_to_merge 및 allowed_to_unprotect 배열의 요소는 다음 사항을 준수해야 합니다:

  • user_id, group_id, 또는 access_level 중 하나여야 합니다.
  • {user_id: 정수}, {group_id: 정수}, 또는 {access_level: 정수} 형식이어야 합니다.

업데이트할 때:

  • user_id: 업데이트된 사용자가 프로젝트에 액세스하도록 합니다. 또한 해당 해시 내에서 id를 전달해야 합니다.
  • group_id: 업데이트된 그룹이 이 프로젝트를 공유하도록 합니다. 또한 해당 해시 내에서 id를 전달해야 합니다.

삭제할 때:

  • _destroy를 true로 설정해야 합니다. 다음 예제를 참조하세요.

예시: 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": []
}