보호된 환경 API

Tier: Premium, Ultimate

Offering: GitLab.com, Self-managed, GitLab Dedicated

유효한 액세스 수준

액세스 수준은 ProtectedEnvironments::DeployAccessLevel::ALLOWED_ACCESS_LEVELS 메서드에서 정의됩니다. 현재 인식되는 수준은 다음과 같습니다:

30 => 개발자 액세스
40 => 유지관리자 액세스
60 => 관리자 액세스

그룹 상속 유형

그룹 상속을 통해 배포 액세스 수준 및 액세스 규칙이 상속된 그룹 멤버십을 고려할 수 있습니다. 그룹 상속 유형은 ProtectedEnvironments::Authorizable::GROUP_INHERITANCE_TYPE에 의해 정의됩니다. 인식되는 유형은 다음과 같습니다:

0 => 직접 그룹 멤버십만 (기본값)
1 => 모든 상속된 그룹

보호된 환경 목록

프로젝트에서 보호된 환경의 목록을 가져옵니다:

GET /projects/:id/protected_environments
속성 유형 필수 설명
id 정수/문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로. 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_environments/"

예시 응답:

[
   {
      "name":"production",
      "deploy_access_levels":[
         {
            "id": 12,
            "access_level":40,
            "access_level_description":"유지관리자",
            "user_id":null,
            "group_id":null,
            "group_inheritance_type": 0
         }
      ],
      "required_approval_count": 0
   }
]

단일 보호된 환경 가져오기

단일 보호된 환경을 가져옵니다:

GET /projects/:id/protected_environments/:name
속성 유형 필수 설명
id 정수/문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로
name 문자열 예 보호된 환경의 이름 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_environments/production"

예시 응답:

{
   "name":"production",
   "deploy_access_levels":[
      {
         "id": 12,
         "access_level": 40,
         "access_level_description": "유지관리자",
         "user_id": null,
         "group_id": null,
         "group_inheritance_type": 0
      }
   ],
   "required_approval_count": 0
}

단일 환경 보호

단일 환경을 보호합니다:

POST /projects/:id/protected_environments
속성 유형 필수 설명
id 정수/문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로.
name 문자열 예 환경의 이름.
deploy_access_levels 배열 예 배포를 허용하는 액세스 수준 배열, 각 항목은 해시로 설명됩니다.
approval_rules 배열 아니오 승인할 수 있는 액세스 수준 배열, 각 항목은 해시로 설명됩니다. 다수의 승인 규칙을 참조하세요.

deploy_access_levels 및 approval_rules 배열의 요소는 user_id, group_id 또는 access_level 중 하나여야 하며 다음 형태를 취해야 합니다: {user_id: 정수}, {group_id: 정수} 또는 {access_level: 정수}. 선택적으로 각 항목에 대해 유효한 그룹 상속 유형 중 하나로 group_inheritance_type을 지정할 수 있습니다.

각 사용자는 프로젝트에 접근할 수 있어야 하고 각 그룹은 이 프로젝트를 공유해야 합니다.

curl --header 'Content-Type: application/json' --request POST \
     --data '{"name": "production", "deploy_access_levels": [{"group_id": 9899826}], "approval_rules": [{"group_id": 134}, {"group_id": 135, "required_approvals": 2}]}' \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/projects/22034114/protected_environments"

예시 응답:

{
   "name": "production",
   "deploy_access_levels": [
      {
         "id": 12,
         "access_level": 40,
         "access_level_description": "protected-access-group",
         "user_id": null,
         "group_id": 9899826,
         "group_inheritance_type": 0
      }
   ],
   "required_approval_count": 0,
   "approval_rules": [
      {
         "id": 38,
         "user_id": null,
         "group_id": 134,
         "access_level": null,
         "access_level_description": "qa-group",
         "required_approvals": 1,
         "group_inheritance_type": 0
      },
      {
         "id": 39,
         "user_id": null,
         "group_id": 135,
         "access_level": null,
         "access_level_description": "security-group",
         "required_approvals": 2,
         "group_inheritance_type": 0
      }
   ]
}

보호된 환경 업데이트

  • GitLab 15.4에서 도입됨.

단일 환경을 업데이트합니다.

PUT /projects/:id/protected_environments/:name
속성 유형 필수 설명
id 정수/문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로.
name 문자열 예 환경의 이름입니다.
deploy_access_levels 배열 아니요 각 해시로 설명된 배포를 허용하는 액세스 수준의 배열입니다.
approval_rules 배열 아니요 각 해시로 설명된 승인을 허용하는 액세스 수준의 배열입니다. 자세한 내용은 다중 승인 규칙을 참조하세요.

deploy_access_levels 및 approval_rules 배열의 요소는 user_id, group_id 또는 access_level 중 하나여야 하며, 형식은 {user_id: 정수}, {group_id: 정수} 또는 {access_level: 정수}입니다. 각 요소에 대해 유효한 그룹 상속 유형 중 하나로 group_inheritance_type을 선택적으로 지정할 수 있습니다.

업데이트하려면:

  • user_id: 업데이트된 사용자가 프로젝트에 액세스할 수 있는지 확인하세요. 각각의 해시에서 deploy_access_level 또는 approval_rule의 id도 통과해야 합니다.
  • group_id: 업데이트된 그룹이 이 프로젝트를 공유하고 있는지 확인하세요. 각각의 해시에서 deploy_access_level 또는 approval_rule의 id도 통과해야 합니다.

삭제하려면:

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

예제: deploy_access_level 레코드 생성 

curl --header 'Content-Type: application/json' --request PUT \
     --data '{"deploy_access_levels": [{"group_id": 9899829, access_level: 40}]}' \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/projects/22034114/protected_environments/production"

예제 응답:

{
   "name": "production",
   "deploy_access_levels": [
      {
         "id": 12,
         "access_level": 40,
         "access_level_description": "protected-access-group",
         "user_id": null,
         "group_id": 9899829,
         "group_inheritance_type": 1
      }
   ],
   "required_approval_count": 0
}

예제: deploy_access_level 레코드 업데이트 

curl --header 'Content-Type: application/json' --request PUT \
     --data '{"deploy_access_levels": [{"id": 12, "group_id": 22034120}]}' \
     --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/22034114/protected_environments/production"

{
   "name": "production",
   "deploy_access_levels": [
      {
         "id": 12,
         "access_level": 40,
         "access_level_description": "protected-access-group",
         "user_id": null,
         "group_id": 22034120,
         "group_inheritance_type": 0
      }
   ],
   "required_approval_count": 2
}

예제: deploy_access_level 레코드 삭제 

curl --header 'Content-Type: application/json' --request PUT \
     --data '{"deploy_access_levels": [{"id": 12, "_destroy": true}]}' \
     --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/22034114/protected_environments/production"

예제 응답:

{
   "name": "production",
   "deploy_access_levels": [],
   "required_approval_count": 0
}

예제: approval_rule 레코드 생성 

curl --header 'Content-Type: application/json' --request PUT \
     --data '{"approval_rules": [{"group_id": 134, "required_approvals": 1}]}' \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/projects/22034114/protected_environments/production"

예제 응답:

{
   "name": "production",
   "approval_rules": [
      {
         "id": 38,
         "user_id": null,
         "group_id": 134,
         "access_level": null,
         "access_level_description": "qa-group",
         "required_approvals": 1,
         "group_inheritance_type": 0
      }
   ]
}

예제: approval_rule 레코드 업데이트 

curl --header 'Content-Type: application/json' --request PUT \
     --data '{"approval_rules": [{"id": 38, "group_id": 135, "required_approvals": 2}]}' \
     --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/22034114/protected_environments/production"

{
   "name": "production",
   "approval_rules": [
      {
         "id": 38,
         "user_id": null,
         "group_id": 135,
         "access_level": null,
         "access_level_description": "security-group",
         "required_approvals": 2,
         "group_inheritance_type": 0
      }
   ]
}

예제: approval_rule 레코드 삭제 

curl --header 'Content-Type: application/json' --request PUT \
     --data '{"approval_rules": [{"id": 38, "_destroy": true}]}' \
     --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/22034114/protected_environments/production"

예제 응답:

{
   "name": "production",
   "approval_rules": []
}

단일 환경 보호 해제

지정된 보호된 환경의 보호를 해제합니다:

DELETE /projects/:id/protected_environments/:name
속성 유형 필수 설명
id integer/string 예 프로젝트의 ID 또는 URL-인코딩된 경로입니다.
name string 예 보호된 환경의 이름입니다. 
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_environments/staging"