正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

グループレベルの保護環境API

  • プラン: Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

このAPIを使用して、グループレベルの保護環境とやり取りします。

保護環境については、保護環境APIを参照してください

有効なアクセスレベル

アクセスレベルは、ProtectedEnvironments::DeployAccessLevel::ALLOWED_ACCESS_LEVELSメソッドで定義されています。現在、これらのレベルが認識されています:

30 => Developer access
40 => Maintainer access
60 => Admin access

グループレベルの保護環境の一覧

グループから保護環境のリストを取得します。

GET /groups/:id/protected_environments
属性型必須説明
id整数または文字列はい認証済みユーザーが管理するグループのIDまたはURLエンコードされたパス。
curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/protected_environments/"

レスポンス例:

[
   {
      "name":"production",
      "deploy_access_levels":[
         {
            "id": 12,
            "access_level": 40,
            "access_level_description": "Maintainers",
            "user_id": null,
            "group_id": null
         }
      ],
      "required_approval_count": 0
   }
]

単一の保護環境を取得します

単一の保護環境を取得します。

GET /groups/:id/protected_environments/:name
属性型必須説明
id整数または文字列はい認証済みユーザーが管理するグループのIDまたはURLエンコードされたパス。
name文字列はい保護環境のデプロイ階層。production、staging、testing、development、otherのいずれかデプロイ階層の詳細についてお読みください。
curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/protected_environments/production"

レスポンス例:

{
   "name":"production",
   "deploy_access_levels":[
      {
         "id": 12,
         "access_level":40,
         "access_level_description":"Maintainers",
         "user_id":null,
         "group_id":null
      }
   ],
   "required_approval_count": 0
}

単一の環境を保護する

単一の環境を保護します。

POST /groups/:id/protected_environments
属性型必須説明
id整数または文字列はい認証済みユーザーが管理するグループのIDまたはURLエンコードされたパス。
name文字列はい保護環境のデプロイ階層。production、staging、testing、development、otherのいずれかデプロイ階層の詳細についてお読みください。
deploy_access_levels配列はい各ハッシュで記述された、デプロイを許可されたアクセスレベルの配列。user_id、group_id、またはaccess_levelのいずれか。それらは、{user_id: integer}、{group_id: integer}、または{access_level: integer}の形式をとります。
approval_rules配列いいえ各ハッシュで記述された、承認を許可されたアクセスレベルの配列。user_id、group_id、またはaccess_levelのいずれか。それらは、{user_id: integer}、{group_id: integer}、または{access_level: integer}の形式をとります。指定されたエンティティからの必要な承認の数をrequired_approvalsフィールドで指定することもできます。詳しくは、複数の承認ルールをご覧ください。

割り当て可能なuser_idは、メンテナーロール以上の権限を持つ、特定のグループに所属するユーザーです。割り当て可能なgroup_idは、特定のグループのサブグループです。

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

レスポンス例:

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

複数の承認ルールの例:

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

この構成では、オペレーターグループ"group_id": 138は、品質保証グループ"group_id": 134とセキュリティグループ"group_id": 135がデプロイを承認した後にのみ、productionへのデプロイメントジョブを実行できます。

保護環境を更新する

単一の環境を更新します。

PUT /groups/:id/protected_environments/:name
属性型必須説明
id整数または文字列はい認証済みユーザーが管理するグループのIDまたはURLエンコードされたパス。
name文字列はい保護環境のデプロイ階層。production、staging、testing、development、otherのいずれかデプロイ階層の詳細についてお読みください。
deploy_access_levels配列いいえ各ハッシュで記述された、デプロイを許可されたアクセスレベルの配列。user_id、group_id、またはaccess_levelのいずれか。それらは、{user_id: integer}、{group_id: integer}、または{access_level: integer}の形式をとります。
required_approval_count整数いいえこの環境にデプロイするために必要な承認の数。
approval_rules配列いいえ各ハッシュで記述された、承認を許可されたアクセスレベルの配列。user_id、group_id、またはaccess_levelのいずれか。それらは、{user_id: integer}、{group_id: integer}、または{access_level: integer}の形式をとります。指定されたエンティティからの必要な承認の数をrequired_approvalsフィールドで指定することもできます。詳しくは、複数の承認ルールをご覧ください。

更新するには:

  • user_id: 更新されたユーザーが、メンテナーロール以上の権限を持つ、特定のグループに所属していることを確認してください。それぞれのハッシュで、deploy_access_levelまたはapproval_ruleのidも渡す必要があります。
  • group_id: 更新されたグループが、この保護環境が所属するグループのサブグループであることを確認します。それぞれのハッシュで、deploy_access_levelまたはapproval_ruleのidも渡す必要があります。

削除するには:

  • _destroy``trueに設定して渡す必要があります。次の例を参照してください。

例: deploy_access_levelレコードを作成する

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

レスポンス例:

{
   "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 --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --url "https://gitlab.example.com/api/v4/groups/22034114/protected_environments/production" \
  --data '{"deploy_access_levels": [{"id": 12, "group_id": 22034120}]}'
{
   "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 --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --url "https://gitlab.example.com/api/v4/groups/22034114/protected_environments/production" \
  --data '{"deploy_access_levels": [{"id": 12, "_destroy": true}]}'

レスポンス例:

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

例: approval_ruleレコードを作成する

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

レスポンス例:

{
   "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 --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --url "https://gitlab.example.com/api/v4/groups/22034114/protected_environments/production" \
  --data '{"approval_rules": [{"id": 38, "group_id": 135, "required_approvals": 2}]}'
{
   "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 --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --url "https://gitlab.example.com/api/v4/groups/22034114/protected_environments/production" \
  --data '{"approval_rules": [{"id": 38, "_destroy": true}]}'

レスポンス例:

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

単一の環境の保護を解除する

特定の保護環境の保護を解除します。

DELETE /groups/:id/protected_environments/:name
属性型必須説明
id整数または文字列はい認証済みユーザーが管理するグループのIDまたはURLエンコードされたパス。
name文字列はい保護環境のデプロイ階層。production、staging、testing、development、otherのいずれかデプロイ階層の詳細についてお読みください。
curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/protected_environments/staging"

応答は200コードを返す必要があります。