보호된 브랜치 API

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

유효한 액세스 레벨

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

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

보호된 브랜치 목록

프로젝트에서 UI에 정의된대로 보호된 브랜치 목록을 가져옵니다. 와일드카드가 설정되면 해당 와일드카드와 일치하는 브랜치의 정확한 이름 대신 반환됩니다. 

GET /projects/:id/protected_branches
속성 유형 필수 설명
id 정수/문자열 예 프로젝트의 ID 또는 URL-encoded 경로
search 문자열 아니요 검색할 보호된 브랜치의 이름 또는 일부 이름

다음 예에서 프로젝트 ID는 5입니다. 

curl --헤더 "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches"

다음 예시 응답은 다음을 포함합니다:

  • ID가 100 및 101인 두 보호된 브랜치.
  • push_access_levels의 ID가 1001, 1002 및 1003. 
[
  {
    "id": 100,
    "name": "main",
    "push_access_levels": [
      {
        "id":  1001,
        "access_level": 40,
        "access_level_description": "관리자"
      },
      {
        "id": 1002,
        "access_level": 40,
        "access_level_description": "배포 키",
        "deploy_key_id": 1
      }
    ],
    "merge_access_levels": [
      {
        "id":  2001,
        "access_level": 40,
        "access_level_description": "관리자"
      }
    ],
    "allow_force_push":false,
    "code_owner_approval_required": false
  },
  {
    "id": 101,
    "name": "release/*",
    "push_access_levels": [
      {
        "id":  1003,
        "access_level": 40,
        "access_level_description": "관리자"
      }
    ],
    "merge_access_levels": [
      {
        "id":  2002,
        "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가 100인 보호된 브랜치 한 개.
  • push_access_levels의 ID가 1001 및 1002. 
[
  {
    "id": 101,
    "name": "main",
    "push_access_levels": [
      {
        "id":  1001,
        "access_level": 40,
        "user_id": null,
        "group_id": null,
        "access_level_description": "관리자"
      },
      {
        "id": 1002,
        "access_level": 40,
        "access_level_description": "배포 키",
        "deploy_key_id": 1,
        "user_id": null,
        "group_id": null
      }
    ],
    "merge_access_levels": [
      {
        "id":  2001,
        "access_level": null,
        "user_id": null,
        "group_id": 1234,
        "access_level_description": "예제 머지 그룹"
      }
    ],
    "allow_force_push":false,
    "code_owner_approval_required": false,
    "inherited": true
  },
  ...
]

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

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

GET /projects/:id/protected_branches/:name
속성 유형 필수 설명
id 정수/문자열 예 프로젝트의 ID 또는 URL-encoded 경로
name 문자열 예 브랜치 또는 와일드카드의 이름

다음 예에서 프로젝트 ID는 5이고 브랜치 이름은 main입니다: 

curl --헤더 "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches/main"

예시 응답: 

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

저장소 브랜치 보호

  • GitLab 17.5에서 deploy_key_id 구성이 도입되었습니다.

단일 저장소 브랜치 또는 여러 프로젝트 저장소 브랜치를 와일드카드 보호 브랜치를 사용하여 보호합니다. 

POST /projects/:id/protected_branches
속성 유형 필요 여부 설명
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}, {deploy_key_id: integer}, 또는 {access_level: integer} 형식의 해시로 설명됩니다. 프리미엄 및 얼티밋 전용.
allowed_to_unprotect 배열 아니요 언프로텍트 액세스 수준의 배열, 각각이 {user_id: integer}, {group_id: integer}, 또는 {access_level: integer} 형식의 해시로 설명됩니다. No access 액세스 수준은 이 필드에 사용할 수 없습니다. 프리미엄 및 얼티밋 전용.
code_owner_approval_required 부울 아니요 이 브랜치에 푸시를 하는 경우 CODEOWNERS 파일에 항목과 일치하는 경우 푸시를 방지합니다. (기본값: false) 프리미엄 및 얼티밋 전용.
merge_access_level 정수 아니요 머지할 수있는 액세스 수준. (기본값: 40, Maintainer 역할).
push_access_level 정수 아니요 푸시할 수있는 액세스 수준. (기본값: 40, Maintainer 역할)
unprotect_access_level 정수 아니요 언프로텍트할 수있는 액세스 수준. (기본값: 40, Maintainer 역할)

다음 예제에서 프로젝트 ID는 5이고 브랜치 이름은 *-stable입니다. 

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가 101인 보호된 브랜치.
  • ID가 1001인 push_access_levels.
  • ID가 2001인 merge_access_levels.
  • ID가 3001인 unprotect_access_levels. 
{
  "id": 101,
  "name": "*-stable",
  "push_access_levels": [
    {
      "id": 1001,
      "access_level": 30,
      "access_level_description": "개발자 + 유지보수자(Developers + Maintainers)"
    }
  ],
  "merge_access_levels": [
    {
      "id": 2001,
      "access_level": 30,
      "access_level_description": "개발자 + 유지보수자(Developers + Maintainers)"
    }
  ],
  "unprotect_access_levels": [
    {
      "id": 3001,
      "access_level": 40,
      "access_level_description": "유지보수자(Maintainers)"
    }
  ],
  "allow_force_push": false,
  "code_owner_approval_required": false
}

GitLab Premium 또는 Ultimate에 로그인한 사용자는 또한 user_id 및 group_id 매개변수를 볼 수 있습니다.

다음 예제 응답에는 다음이 포함됩니다.

  • ID가 101인 보호된 브랜치.
  • ID가 1001인 push_access_levels.
  • ID가 2001인 merge_access_levels.
  • ID가 3001인 unprotect_access_levels. 
{
  "id": 1,
  "name": "*-stable",
  "push_access_levels": [
    {
      "id": 1001,
      "access_level": 30,
      "user_id": null,
      "group_id": null,
      "access_level_description": "개발자 + 유지보수자(Developers + Maintainers)"
    }
  ],
  "merge_access_levels": [
    {
      "id": 2001,
      "access_level": 30,
      "user_id": null,
      "group_id": null,
      "access_level_description": "개발자 + 유지보수자(Developers + Maintainers)"
    }
  ],
  "unprotect_access_levels": [
    {
      "id": 3001,
      "access_level": 40,
      "user_id": null,
      "group_id": null,
      "access_level_description": "유지보수자(Maintainers)"
    }
  ],
  "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가 101인 보호된 브랜치.
  • ID가 1001인 push_access_levels.
  • ID가 2001인 merge_access_levels.
  • ID가 3001인 unprotect_access_levels. 
{
  "id": 101,
  "name": "*-stable",
  "push_access_levels": [
    {
      "id": 1001,
      "access_level": null,
      "user_id": 1,
      "group_id": null,
      "access_level_description": "관리자(Administrator)"
    }
  ],
  "merge_access_levels": [
    {
      "id": 2001,
      "access_level": 40,
      "user_id": null,
      "group_id": null,
      "access_level_description": "유지보수자(Maintainers)"
    }
  ],
  "unprotect_access_levels": [
    {
      "id": 3001,
      "access_level": 40,
      "user_id": null,
      "group_id": null,
      "access_level_description": "유지보수자(Maintainers)"
    }
  ],
  "allow_force_push": false,
  "code_owner_approval_required": false
}

배포 키 액세스 예시

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

allowed_to_push 배열의 요소는 {user_id: integer}, {group_id: integer}, {deploy_key_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[][deploy_key_id]=1"

다음 예시 응답에는 다음이 포함됩니다:

  • ID가 101인 보호된 브랜치.
  • ID가 1001인 push_access_levels.
  • ID가 2001인 merge_access_levels.
  • ID가 3001인 unprotect_access_levels. 
{
  "id": 101,
  "name": "*-stable",
  "push_access_levels": [
    {
      "id": 1001,
      "access_level": null,
      "user_id": null,
      "group_id": null,
      "deploy_key_id": 1,
      "access_level_description": "배포"
    }
  ],
  "merge_access_levels": [
    {
      "id": 2001,
      "access_level": 40,
      "user_id": null,
      "group_id": null,
      "access_level_description": "Maintainers"
    }
  ],
  "unprotect_access_levels": [
    {
      "id": 3001,
      "access_level": 40,
      "user_id": null,
      "group_id": null,
      "access_level_description": "Maintainers"
    }
  ],
  "allow_force_push": false,
  "code_owner_approval_required": false
}

푸시 및 병합 액세스 허용의 예시

Tier: Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated
  • GitLab 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가 105인 보호된 브랜치.
  • ID가 1001인 push_access_levels.
  • ID가 2001 및 2002인 merge_access_levels.
  • ID가 3001인 unprotect_access_levels. 
{
  "id": 105,
  "name": "main",
  "push_access_levels": [
    {
      "id": 1001,
      "access_level": 30,
      "access_level_description": "개발자 + 유지보수 담당자",
      "user_id": null,
      "group_id": null
    }
  ],
  "merge_access_levels": [
    {
      "id": 2001,
      "access_level": 30,
      "access_level_description": "개발자 + 유지보수 담당자",
      "user_id": null,
      "group_id": null
    },
    {
      "id": 2002,
      "access_level": 40,
      "access_level_description": "유지보수 담당자",
      "user_id": null,
      "group_id": null
    }
  ],
  "unprotect_access_levels": [
    {
      "id": 3001,
      "access_level": 40,
      "access_level_description": "유지보수 담당자",
      "user_id": null,
      "group_id": null
    }
  ],
  "allow_force_push": false,
  "code_owner_approval_required": false
}

보호된 저장소 브랜치의 보호 해제

주어진 보호된 브랜치 또는 와일드카드 보호된 브랜치의 보호를 해제합니다. 

DELETE /projects/:id/protected_branches/:name
속성 유형 필수 설명
id integer/string 예 프로젝트의 ID 또는 URL-인코딩된 경로
name string 예 브랜치의 이름

다음 예시에서 프로젝트 ID는 5이고 브랜치 이름은 *-stable입니다. 

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches/*-stable"

보호된 브랜치 업데이트

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

PATCH /projects/:id/protected_branches/:name
속성 유형 필수 설명
id integer/string 예 프로젝트의 ID 또는 URL-인코딩된 경로.
name string 예 브랜치 또는 와일드카드의 이름.
allow_force_push boolean 아니오 활성화되면 이 브랜치로 푸시할 수 있는 멤버는 강제 푸시도 수행할 수 있습니다.
allowed_to_merge 배열 아니오 병합 액세스 수준의 배열로, 각각 {user_id: integer}, {group_id: integer}, 또는 {access_level: integer} 형식의 해시로 설명됩니다. Premium 및 Ultimate 전용.
allowed_to_push 배열 아니오 푸시 액세스 수준의 배열로, 각각 {user_id: integer}, {group_id: integer}, {deploy_key_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 boolean 아니오 이 브랜치로 푸시를 막습니다만, CODEOWNERS 파일 항목과 일치하면 Premium 및 Ultimate 전용.

다음 예시에서 프로젝트 ID는 5이고 브랜치의 이름은 feature-branch입니다. 

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"

allowed_to_push, allowed_to_merge, allowed_to_unprotect 배열의 요소는 user_id, group_id 또는 access_level 중 하나이어야 하며, 각각 {user_id: integer}, {group_id: integer} 또는 {access_level: integer}의 형식을 취해야 합니다.

allowed_to_push은 {deploy_key_id: integer} 형식을 취하는 추가 요소를 포함합니다.

업데이트하기 위해:

  • user_id: 업데이트된 사용자가 프로젝트에 액세스 권한이 있는지 확인합니다. 또한 해당 해시 내의 access_level의 id를 전달해야 합니다.
  • group_id: 업데이트된 그룹이 이 프로젝트를 공유했는지 확인합니다. 또한 해당 해시 내의 access_level의 id를 전달해야 합니다.
  • deploy_key_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": []
}

관련 주제