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

グループのセキュリティ設定API

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

グループのセキュリティ設定に対するすべてのAPIコールは、認証される必要があります。

ユーザーがプライベートグループのメンバーでない場合、プライベートグループに対するリクエストは、404 Not Foundステータスコードを返します。

secret_push_protection_enabled設定を更新

グループ内のすべてのプロジェクトについて、secret_push_protection_enabled設定を、指定された値に更新します。

trueに設定して、グループ内のすべてのプロジェクトに対してシークレットプッシュ保護を有効にします。

前提要件:

  • グループのメンテナーロール以上を持っている必要があります。
属性型必須説明
id整数または文字列はい認証済みユーザーがメンバーであるグループのIDまたはURLエンコードされたパス
secret_push_protection_enabledブール値はいシークレットプッシュ保護がグループに対して有効になっているかどうか。
projects_to_exclude整数の配列いいえこの機能から除外するプロジェクトのID。
curl --request PUT \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/groups/7/security_settings?secret_push_protection_enabled=true&projects_to_exclude[]=1&projects_to_exclude[]=2"

レスポンス例:

{
  "secret_push_protection_enabled": true,
  "errors": []
}