正式なドキュメントは英語版であり、この日本語訳は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は、QAグループ"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コードを返すはずです。