Skip to content
forgit api docs

Update group attributes

PUT
/api/v4/groups/{id}

Updates the attributes for a specified group. You must be an administrator or have the Owner role for the group.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
id
required
string

The ID of a group

Request Body

Section titled “ Request Body ”
Media type multipart/form-data
object
name

The name of the group

string
nullable
path

The path of the group

string
nullable
shared_runners_setting

Enable/disable shared runners for the group and its subgroups and projects

string
nullable
Allowed values: disabled_and_unoverridable disabled_and_overridable enabled
description

The description of the group

string
nullable
visibility

The visibility of the group

string
nullable
Allowed values: private internal public
avatar

Avatar image for the group

string format: binary
nullable
share_with_group_lock

Prevent sharing a project with another group within this group

boolean
nullable
require_two_factor_authentication

Require all users in this group to setup Two-factor authentication

boolean
nullable
two_factor_grace_period

Time before Two-factor authentication is enforced

integer
nullable
project_creation_level

Determine if developers can create projects in the group

string
nullable
Allowed values: noone owner maintainer developer administrator
auto_devops_enabled

Default to Auto DevOps pipeline for all projects within this group

boolean
nullable
subgroup_creation_level

Allowed to create subgroups

string
nullable
Allowed values: owner maintainer
emails_disabled

(Deprecated) Disable email notifications. Use: emails_enabled

boolean
nullable
emails_enabled

Enable email notifications

boolean
nullable
show_diff_preview_in_email

Include the code diff preview in merge request notification emails

boolean
nullable
mentions_disabled

Disable a group from getting mentioned

boolean
nullable
lfs_enabled

Enable/disable LFS for the projects in this group

boolean
nullable
request_access_enabled

Allow users to request member access

boolean
nullable
default_branch

The default branch of group’s projects

string
nullable
Example 
main
default_branch_protection

Determine if developers can push to default branch

integer
nullable
Allowed values: 0 3 1 2 4
default_branch_protection_defaults

Determine if developers can push to default branch

object
allowed_to_push

An array of access levels allowed to push

Array<object>
nullable
object
access_level
required

A valid access level

integer
Allowed values: 30 40 60 0
allow_force_push

Allow force push for all users with push access.

boolean
nullable
allowed_to_merge

An array of access levels allowed to merge

Array<object>
nullable
object
access_level
required

A valid access level

integer
Allowed values: 30 40 60 0
code_owner_approval_required

Require approval from code owners

boolean
nullable
developer_can_initial_push

Allow developers to initial push

boolean
nullable
enabled_git_access_protocol

Allow only the selected protocols to be used for Git access.

string
nullable
Allowed values: ssh http all
crm_enabled

Enable Customer Relations Management for this group

boolean
nullable
resource_access_token_notify_inherited

Send access token expiry notifications to all inherited members of the group

boolean
nullable
lock_resource_access_token_notify_inherited

Prevent subgroups from overriding the access token expiry notification setting

boolean
nullable
membership_lock

Prevent adding new members to projects within this group

boolean
nullable
ldap_cn

LDAP Common Name

string
nullable
ldap_access

A valid access level

integer
nullable
shared_runners_minutes_limit

(admin-only) compute minutes quota for this group

integer
nullable
extra_shared_runners_minutes_limit

(admin-only) Extra compute minutes quota for this group

integer
nullable
wiki_access_level

Wiki access level. One of disabled, private or enabled

string
nullable
Allowed values: disabled private enabled
duo_availability

Duo availability. One of default_on, default_off, never_on or always_on

string
nullable
Allowed values: default_on default_off never_on always_on
duo_remote_flows_availability

Enable GitLab Duo remote flows for this group

boolean
nullable
duo_foundational_flows_availability

Enable GitLab foundational Duo flows for this group

boolean
nullable
duo_custom_agents_availability

Enable GitLab Duo custom agents for this group

boolean
nullable
duo_custom_flows_availability

Enable GitLab Duo custom flows for this group

boolean
nullable
duo_external_agents_availability

Enable GitLab Duo external agents for this group

boolean
nullable
tool_approval_for_session_availability

Tool approval for session availability. One of default_on, default_off or never_on

string
nullable
Allowed values: default_on default_off never_on
amazon_q_auto_review_enabled

Enable Amazon Q auto review for merge request

boolean
nullable
experiment_features_enabled

Enable experiment features for this group

boolean
nullable
model_prompt_cache_enabled

Enable model prompt cache for this group

boolean
nullable
foundational_agents_statuses

Whether each foundational agent has been enabled or disabled.

Array<object>
nullable
object
reference
required

Reference of the foundational agent.

string
nullable
enabled
required

Whether foundational agent has been enabled or disabled.

boolean
nullable
ai_settings_attributes

AI-related settings

object
duo_agent_platform_enabled

Whether Duo Agent Platform features are enabled

boolean
nullable
duo_workflow_mcp_enabled

Enable MCP support for Duo Agent Platform

boolean
nullable
ai_usage_data_collection_enabled

Enable AI usage data collection for this namespace

boolean
nullable
ai_catalog_restricted_to_group_hierarchy

Restrict the AI Catalog to items within this top-level group hierarchy

boolean
nullable
foundational_agents_default_enabled

Whether new foundational agents are enabled by default

boolean
nullable
prompt_injection_protection_level

Prompt injection protection level. One of no_checks, log_only or interrupt

string
nullable
Allowed values: no_checks log_only interrupt
include_recommended_allowed

Whether to include recommended domains in the network access allowlist

boolean
nullable
allow_all_unix_sockets

Whether to allow all Unix sockets for network access

boolean
nullable
allow_project_extension

Whether to allow projects to extend the network access domain allowlist

boolean
nullable
minimum_access_level_execute

The minimum access level required to execute Duo Agent Platform. This field is behind a feature flag.

integer
nullable
Allowed values: 10 15 20 30 40 50
minimum_access_level_execute_async

The minimum access level required to execute Duo Agent Platform features in CI/CD. This field is behind a feature flag.

integer
nullable
Allowed values: 30 40 50
minimum_access_level_manage

The minimum access level required to manage Duo Agent Platform. This field is behind a feature flag.

integer
nullable
Allowed values: 30 40 50
minimum_access_level_enable_on_projects

The minimum access level required to enable Duo Agent Platform. This field is behind a feature flag.

integer
nullable
Allowed values: 30 40 50
prevent_sharing_groups_outside_hierarchy

Prevent sharing groups within this namespace with any groups outside the namespace. Only available on top-level groups.

boolean
nullable
step_up_auth_required_oauth_provider

OAuth provider required for step-up authentication. Pass empty string to disable.

string
nullable
lock_math_rendering_limits_enabled

Indicates if math rendering limits are locked for all descendent groups.

boolean
nullable
math_rendering_limits_enabled

Indicates if math rendering limits are used for this group.

boolean
nullable
max_artifacts_size

Set the maximum file size for each job’s artifacts

integer
nullable
file_template_project_id

The ID of a project to use for custom templates in this group

integer
nullable
prevent_forking_outside_group

Prevent forking projects inside this group to external namespaces

boolean
nullable
unique_project_download_limit

Maximum number of unique projects a user can download in the specified time period before they are banned.

integer
nullable
unique_project_download_limit_interval_in_seconds

Time period during which a user can download a maximum amount of projects before they are banned.

integer
nullable
unique_project_download_limit_allowlist

List of usernames excluded from the unique project download limit

Array<string>
nullable
unique_project_download_limit_alertlist

List of user ids who will be emailed when Git abuse rate limit is exceeded

Array<integer>
nullable
auto_ban_user_on_excessive_projects_download

Ban users from the group when they exceed maximum number of unique projects download in the specified time period

boolean
nullable
ip_restriction_ranges

List of IP addresses which need to be restricted for group

string
nullable
allowed_email_domains_list

List of allowed email domains for group

string
nullable
service_access_tokens_expiration_enforced

To enforce token expiration for Service accounts users for group

boolean
nullable
duo_core_features_enabled

[Experimental] Indicates whether GitLab Duo Core features are enabled for the group

boolean
nullable
duo_features_enabled

Indicates whether GitLab Duo features are enabled for the group

boolean
nullable
lock_duo_features_enabled

Indicates if the GitLab Duo features enabled setting is enforced for all subgroups

boolean
nullable
auto_duo_code_review_enabled

Enable automatic reviews by GitLab Duo on merge requests

boolean
nullable
ai_audit_events_storage_enabled

Indicates whether AI audit events are stored for the group

boolean
nullable
lock_ai_audit_events_storage_enabled

Indicates whether AI audit events storage is enforced for all subgroups and projects

boolean
nullable
web_based_commit_signing_enabled

Enable web based commit signing for this group

boolean
nullable
only_allow_merge_if_pipeline_succeeds

Only allow to merge if builds succeed

boolean
nullable
allow_merge_on_skipped_pipeline

Allow to merge if pipeline is skipped

boolean
nullable
only_allow_merge_if_all_discussions_are_resolved

Only allow to merge if all threads are resolved

boolean
nullable
enabled_foundational_flows

References of enabled foundational flows

Array<string>
nullable
duo_template_project_id

The ID of a project to use as the Duo Code Review custom instructions template for this group

integer
nullable
allow_personal_snippets

Allow creation of personal snippets for enterprise users of this group

boolean
nullable
duo_namespace_access_rules

AI entity access rules for controlling Duo feature access

Array<object>
nullable
object
through_namespace

Object containing through namespace information

object
id
required

ID of the through namespace

integer
nullable
name

Name of the through namespace

string
nullable
full_path

Full path of the through namespace

string
nullable
features
required

List of accessible features

Array<string>
nullable
built_in_project_templates_enabled

Enable built-in project templates for project creation

boolean
nullable
lock_built_in_project_templates_enabled

Enforce the built-in project templates setting for all subgroups

boolean
nullable
create_code_review_flow_consent

When true, records explicit namespace consent for DAP-based Code Review routing

boolean
nullable

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

OK

Media type application/json
object
id
integer format: int64
web_url
string
name
string
path
string
description
string
visibility
string
share_with_group_lock
boolean
require_two_factor_authentication
boolean
two_factor_grace_period
integer
project_creation_level
string
auto_devops_enabled
string
subgroup_creation_level
string
emails_disabled
boolean
emails_enabled
boolean
show_diff_preview_in_email
boolean
mentions_disabled
string
lfs_enabled
boolean
archived
boolean
math_rendering_limits_enabled
boolean
lock_math_rendering_limits_enabled
boolean
crm_enabled
boolean
resource_access_token_notify_inherited
boolean
lock_resource_access_token_notify_inherited
boolean
default_branch
string
default_branch_protection
integer
default_branch_protection_defaults
string
avatar_url
string
request_access_enabled
boolean
full_name
string
full_path
string
created_at
string
parent_id
string
organization_id
integer format: int64
shared_runners_setting
string
max_artifacts_size
integer
custom_attributes
object
key
string
value
string
statistics
string
marked_for_deletion_on
string
root_storage_statistics
object
build_artifacts_size

CI artifacts size in bytes.

integer
container_registry_size

Container registry size in bytes.

integer
container_registry_size_is_estimated

Indicates whether the deduplicated container registry size for the namespace is an estimated value or not.

boolean
dependency_proxy_size

Dependency Proxy sizes in bytes.

integer
lfs_objects_size

LFS objects size in bytes.

integer
packages_size

Packages size in bytes.

integer
pipeline_artifacts_size

CI pipeline artifacts size in bytes.

integer
repository_size

Git repository size in bytes.

integer
snippets_size

Snippets size in bytes.

integer
storage_size

Total storage in bytes.

integer
uploads_size

Uploads size in bytes.

integer
wiki_size

Wiki size in bytes.

integer
ldap_cn
string
ldap_access
string
ldap_group_links
object
cn
string
group_access
integer
provider
string
filter
string
member_role_id
integer format: int64
saml_group_links
object
name
string
access_level
integer
member_role_id
integer format: int64
provider
string
file_template_project_id
string
wiki_access_level
string
repository_storage
string
duo_core_features_enabled

[Experimental] Indicates whether GitLab Duo Core features are enabled for the group

boolean
duo_features_enabled
string
lock_duo_features_enabled
string
auto_duo_code_review_enabled
string
web_based_commit_signing_enabled
string
allow_personal_snippets
string
duo_namespace_access_rules
string
built_in_project_templates_enabled
boolean
lock_built_in_project_templates_enabled
boolean
Example 
{
  "web_url": "http://gitlab.example.com/groups/diaspora",
  "name": "Diaspora",
  "custom_attributes": {
    "key": "foo",
    "value": "bar"
  },
  "ldap_group_links": {
    "cn": "ldap-group-1",
    "group_access": 10,
    "provider": "ldapmain",
    "filter": "id >= 500",
    "member_role_id": 12
  },
  "saml_group_links": {
    "name": "saml-group-1",
    "access_level": 40,
    "member_role_id": 12,
    "provider": "saml"
  }
}

400

Section titled “ 400 ”

Bad Request

404

Section titled “ 404 ”

Not Found