보호된 브랜치 API

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-Managed, GitLab Dedicated

유효한 액세스 수준

액세스 수준은 ProtectedRefAccess.allowed_access_levels 메서드에서 정의됩니다. 현재 인식되는 이러한 수준은 다음과 같습니다: 

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

보호된 브랜치 디렉터리

  • GitLab 16.0에서 소개된 배포 키 정보.

프로젝트에서 UI에 정의된대로 가져온 보호된 브랜치 디렉터리을 가져옵니다. 와일드카드가 설정된 경우, 해당 와일드카드와 일치하는 브랜치의 정확한 이름 대신 반환됩니다. 

GET /projects/:id/protected_branches
속성 유형 필수 여부 설명
id 정수/문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL-encoded path
search 문자열 아니오 검색할 보호된 브랜치의 이름 또는 일부분 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches"

예시 응답: 

[
  {
    "id": 1,
    "name": "main",
    "push_access_levels": [
      {
        "id":  1,
        "access_level": 40,
        "access_level_description": "관리자"
      },
      {
        "id": 2,
        "access_level": 40,
        "access_level_description": "배포 키",
        "deploy_key_id": 1
      }
    ],
    "merge_access_levels": [
      {
        "id":  1,
        "access_level": 40,
        "access_level_description": "관리자"
      }
    ],
    "allow_force_push":false,
    "code_owner_approval_required": false
  },
  {
    "id": 1,
    "name": "release/*",
    "push_access_levels": [
      {
        "id":  1,
        "access_level": 40,
        "access_level_description": "관리자"
      }
    ],
    "merge_access_levels": [
      {
        "id":  1,
        "access_level": 40,
        "access_level_description": "관리자"
      }
    ],
    "allow_force_push":false,
    "code_owner_approval_required": false
  },
  ...
]

GitLab Premium 또는 Ultimate 사용자는 또한 user_id, group_id, inherited 매개변수를 볼 수 있습니다. inherited 매개변수가 있는 경우 해당 설정이 프로젝트 그룹에서 상속되었음을 나타냅니다.

예시 응답: 

[
  {
    "id": 1,
    "name": "main",
    "push_access_levels": [
      {
        "id":  1,
        "access_level": 40,
        "user_id": null,
        "group_id": null,
        "access_level_description": "관리자"
      },
      {
        "id": 2,
        "access_level": 40,
        "access_level_description": "배포 키",
        "deploy_key_id": 1,
        "user_id": null,
        "group_id": null
      }
    ],
    "merge_access_levels": [
      {
        "id":  1,
        "access_level": null,
        "user_id": null,
        "group_id": 1234,
        "access_level_description": "예시 Merge 그룹"
      }
    ],
    "allow_force_push":false,
    "code_owner_approval_required": false,
    "inherited": true
  },
  ...
]

단일 보호된 브랜치 또는 와일드카드 보호된 브랜치 가져오기

단일 보호된 브랜치 또는 와일드카드 보호된 브랜치를 가져옵니다. 

GET /projects/:id/protected_branches/:name
속성 유형 필수 여부 설명
id 정수/문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL-encoded path
name 문자열 예 브랜치 또는 와일드카드의 이름 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches/main"

예시 응답: 

{
  "id": 1,
  "name": "main",
  "push_access_levels": [
    {
      "id":  1,
      "access_level": 40,
      "access_level_description": "관리자"
    }
  ],
  "merge_access_levels": [
    {
      "id":  1,
      "access_level": 40,
      "access_level_description": "관리자"
    }
  ],
  "allow_force_push":false,
  "code_owner_approval_required": false
}

GitLab Premium 또는 Ultimate 사용자는 또한 user_id 및 group_id 매개변수를 볼 수 있습니다:

예시 응답: 

{
  "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": 40,
      "user_id": null,
      "group_id": null,
      "access_level_description": "관리자"
    }
  ],
  "allow_force_push":false,
  "code_owner_approval_required": false
}

원격 리포지터리 브랜치 보호

단일 리포지터리 브랜치 또는 와일드카드 보호된 브랜치를 보호합니다. 

POST /projects/:id/protected_branches

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches?name=*-stable&push_access_level=30&merge_access_level=30&unprotect_access_level=40"
속성 유형 필수 여부 설명
id 정수/문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL-encoded path
name 문자열 예 브랜치 또는 와일드카드의 이름
allow_force_push 부울 아니오 활성화되면, 이 브랜치로 푸시할 수있는 멤버들은 강제 푸시도 할 수 있습니다. (기본값: false)
allowed_to_merge 배열 아니오 각각 {user_id: integer}, {group_id: integer}, 또는 {access_level: integer} 형태의 해시로 설명된 Merge 액세스 수준의 배열. Premium 및 Ultimate 전용.
allowed_to_push 배열 아니오 각각 {user_id: integer}, {group_id: integer}, 또는 {access_level: integer} 형태의 해시로 설명된 푸시 액세스 수준의 배열. Premium 및 Ultimate 전용.
allowed_to_unprotect 배열 아니오 각각 {user_id: integer}, {group_id: integer}, 또는 {access_level: integer} 형태의 해시로 설명된 언프로텍트 액세스 수준의 배열. 이 필드에는 No access 액세스 수준은 사용할 수 없습니다. Premium 및 Ultimate 전용.
code_owner_approval_required 부울 아니오 브랜치에 푸시를 하려면 이것이 CODEOWNERS 파일의 항목과 일치하는 경우 푸시를 방지합니다. (기본값: false) Premium 및 Ultimate 전용.
merge_access_level 정수 아니오 Merge을 허용하는 액세스 수준. (기본값: 40, 관리자 역할)
push_access_level 정수 아니오 푸시를 허용하는 액세스 수준. (기본값: 40, 관리자 역할)
unprotect_access_level 정수 아니오 언프로텍트를 허용하는 액세스 수준. (기본값: 40, 관리자 역할)

예시 응답: 

{
  "id": 1,
  "name": "*-stable",
  "push_access_levels": [
    {
      "id":  1,
      "access_level": 30,
      "access_level_description": "개발자 + 관리자"
    }
  ],
  "merge_access_levels": [
    {
      "id":  1,
      "access_level": 30,
      "access_level_description": "개발자 + 관리자"
    }
  ],
  "unprotect_access_levels": [
    {
      "id":  1,
      "access_level": 40,
      "access_level_description": "관리자"
    }
  ],
  "allow_force_push":false,
  "code_owner_approval_required": false
}

GitLab Premium 또는 Ultimate 사용자는 또한 user_id 및 group_id 매개변수를 볼 수 있습니다:

예시 응답: 

{
  "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
}

사용자/그룹 레벨 액세스의 예시

Tier: Premium, Ultimate Offering: GitLab.com, Self-Managed, GitLab Dedicated

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/projects/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
}

푸시 및 Merge 액세스 예시

Tier: Premium, Ultimate Offering: GitLab.com, Self-Managed, GitLab Dedicated
  • 13.9에서 GitLab Premium로 이전되었습니다.

예시 요청: 

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/projects/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 /projects/:id/protected_branches/:name

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches/*-stable"
속성 유형 필수 설명
id 정수/문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로
name 문자열 예 브랜치의 이름

보호된 브랜치 업데이트

보호된 브랜치를 업데이트합니다. 

PATCH /projects/:id/protected_branches/:name

curl --request PATCH --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches/feature-branch?allow_force_push=true&code_owner_approval_required=true"
속성 유형 필수 설명
id 정수/문자열 예 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로
name 문자열 예 브랜치 또는 와일드 카드의 이름
allow_force_push 부울 아니오 활성화되면, 이 브랜치로 푸시할 수 있는 멤버는 강제 푸시도 할 수 있습니다.
allowed_to_merge 배열 아니오 Merge 액세스 레벨의 배열로, 각각 {user_id: integer}, {group_id: integer}, 또는 {access_level: integer} 형식의 해시로 설명됩니다. Premium 및 Ultimate 전용.
allowed_to_push 배열 아니오 푸시 액세스 레벨의 배열로, 각각 {user_id: integer}, {group_id: integer}, 또는 {access_level: integer} 형식의 해시로 설명됩니다. Premium 및 Ultimate 전용.
allowed_to_unprotect 배열 아니오 해제 액세스 레벨의 배열로, 각각 {user_id: integer}, {group_id: integer}, {access_level: integer}, 또는 {id: integer, _destroy: true} 형식의 해시로 설명됩니다. 액세스 레벨 액세스 거부는 이 필드에서 사용할 수 없습니다. Premium 및 Ultimate 전용.
code_owner_approval_required 부울 아니오 CODEOWNERS 파일 항목과 일치하면 이 브랜치로의 푸시를 방지합니다. Premium 및 Ultimate 전용.

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: 업데이트된 사용자가 프로젝트에 액세스하는지 확인합니다. 또한 해당 해시에서 access_level의 id를 전달해야 합니다.
  • group_id: 업데이트된 그룹이 이 프로젝트를 공유하는지 확인합니다. 또한 해당 해시에서 access_level의 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/projects/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/projects/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/projects/22034114/protected_branches/main"

예시 응답: 

{
   "name": "main",
   "push_access_levels": []
}

관련 주제