Groups API

• List a group’s subgroups
• List a group’s shared projects
• New group
• New Subgroup
• Update group
• Remove group
• Search for group
• • List group hooks
  • Add group hook
  • Delete group hook
• Sync group with LDAP
• LDAP Group Links
  • Add LDAP group link with CN or filter
  • Delete LDAP group link with CN or filter
• Group badges
• Share Groups with Groups
  • Delete link sharing group with another group

Groups API

获取已认证用户的可见组列表. 在未经身份验证的情况下访问时，仅返回公共组.

默认情况下，此请求一次返回 20 个结果，因为 API 结果是分页的 .

Parameters:

[  {  "id":  1,  "name":  "Foobar Group",  "path":  "foo-bar",  "description":  "An interesting group",  "visibility":  "public",  "share_with_group_lock":  false,  "require_two_factor_authentication":  false,  "two_factor_grace_period":  48,  "project_creation_level":  "developer",  "auto_devops_enabled":  null,  "subgroup_creation_level":  "owner",  "emails_disabled":  null,  "mentions_disabled":  null,  "lfs_enabled":  true,  "default_branch_protection":  2,  "avatar_url":  "http://localhost:3000/uploads/group/avatar/1/foo.jpg",  "web_url":  "http://localhost:3000/groups/foo-bar",  "request_access_enabled":  false,  "full_name":  "Foobar Group",  "full_path":  "foo-bar",  "file_template_project_id":  1,  "parent_id":  null,  "created_at":  "2020-01-15T12:36:29.590Z"  }  ]

当添加参数statistics=true且经过身份验证的用户是管理员时，将返回其他组统计信息.

GET /groups?statistics=true

[  {  "id":  1,  "name":  "Foobar Group",  "path":  "foo-bar",  "description":  "An interesting group",  "visibility":  "public",  "share_with_group_lock":  false,  "require_two_factor_authentication":  false,  "two_factor_grace_period":  48,  "project_creation_level":  "developer",  "auto_devops_enabled":  null,  "subgroup_creation_level":  "owner",  "emails_disabled":  null,  "mentions_disabled":  null,  "lfs_enabled":  true,  "default_branch_protection":  2,  "avatar_url":  "http://localhost:3000/uploads/group/avatar/1/foo.jpg",  "web_url":  "http://localhost:3000/groups/foo-bar",  "request_access_enabled":  false,  "full_name":  "Foobar Group",  "full_path":  "foo-bar",  "file_template_project_id":  1,  "parent_id":  null,  "created_at":  "2020-01-15T12:36:29.590Z",  "statistics":  {  "storage_size"  :  212,  "repository_size"  :  33,  "wiki_size"  :  100,  "lfs_objects_size"  :  123,  "job_artifacts_size"  :  57,  "packages_size":  0,  "snippets_size"  :  50,  }  }  ]

您可以按名称或路径搜索组，请参见下文.

您可以使用以下进行过滤：

GET /groups?custom_attributes[key]=value&custom_attributes[other_key]=other_value

List a group’s subgroups

在 GitLab 10.3 中 .

获取此组中可见的直接子组的列表. 在未经身份验证的情况下访问时，仅返回公共组.

默认情况下，此请求一次返回 20 个结果，因为 API 结果是分页的 .

Parameters:

GET /groups/:id/subgroups

[  {  "id":  1,  "name":  "Foobar Group",  "path":  "foo-bar",  "description":  "An interesting group",  "visibility":  "public",  "share_with_group_lock":  false,  "require_two_factor_authentication":  false,  "two_factor_grace_period":  48,  "project_creation_level":  "developer",  "auto_devops_enabled":  null,  "subgroup_creation_level":  "owner",  "emails_disabled":  null,  "mentions_disabled":  null,  "lfs_enabled":  true,  "default_branch_protection":  2,  "avatar_url":  "http://gitlab.example.com/uploads/group/avatar/1/foo.jpg",  "web_url":  "http://gitlab.example.com/groups/foo-bar",  "request_access_enabled":  false,  "full_name":  "Foobar Group",  "full_path":  "foo-bar",  "file_template_project_id":  1,  "parent_id":  123,  "created_at":  "2020-01-15T12:36:29.590Z"  }  ]

List a group’s projects

获取此组中的项目列表. 在未经身份验证的情况下访问时，仅返回公共项目.

默认情况下，此请求一次返回 20 个结果，因为 API 结果是分页的 .

GET /groups/:id/projects

Parameters:

响应示例：

[  {  "id":  9,  "description":  "foo",  "default_branch":  "master",  "tag_list":  [],  "archived":  false,  "visibility":  "internal",  "ssh_url_to_repo":  "git@gitlab.example.com/html5-boilerplate.git",  "http_url_to_repo":  "http://gitlab.example.com/h5bp/html5-boilerplate.git",  "web_url":  "http://gitlab.example.com/h5bp/html5-boilerplate",  "name":  "Html5 Boilerplate",  "name_with_namespace":  "Experimental / Html5 Boilerplate",  "path":  "html5-boilerplate",  "path_with_namespace":  "h5bp/html5-boilerplate",  "issues_enabled":  true,  "merge_requests_enabled":  true,  "wiki_enabled":  true,  "jobs_enabled":  true,  "snippets_enabled":  true,  "created_at":  "2016-04-05T21:40:50.169Z",  "last_activity_at":  "2016-04-06T16:52:08.432Z",  "shared_runners_enabled":  true,  "creator_id":  1,  "namespace":  {  "id":  5,  "name":  "Experimental",  "path":  "h5bp",  "kind":  "group"  },  "avatar_url":  null,  "star_count":  1,  "forks_count":  0,  "open_issues_count":  3,  "public_jobs":  true,  "shared_with_groups":  [],  "request_access_enabled":  false  }  ]

注意：为了区分组中的项目和共享给组的项目，可以使用namespace属性. 将项目共享给组后，其namespace将与请求的组不同.

List a group’s shared projects

获取共享给该组的项目的列表. 未经身份验证访问时，仅返回公共共享项目.

默认情况下，此请求一次返回 20 个结果，因为 API 结果是分页的 .

GET /groups/:id/projects/shared

Parameters:

响应示例：

[  {  "id":8,  "description":"Shared project for Html5 Boilerplate",  "name":"Html5 Boilerplate",  "name_with_namespace":"H5bp / Html5 Boilerplate",  "path":"html5-boilerplate",  "path_with_namespace":"h5bp/html5-boilerplate",  "created_at":"2020-04-27T06:13:22.642Z",  "default_branch":"master",  "tag_list":[  ],  "ssh_url_to_repo":"ssh://git@gitlab.com/h5bp/html5-boilerplate.git",  "http_url_to_repo":"http://gitlab.com/h5bp/html5-boilerplate.git",  "web_url":"http://gitlab.com/h5bp/html5-boilerplate",  "readme_url":"http://gitlab.com/h5bp/html5-boilerplate/-/blob/master/README.md",  "avatar_url":null,  "star_count":0,  "forks_count":4,  "last_activity_at":"2020-04-27T06:13:22.642Z",  "namespace":{  "id":28,  "name":"H5bp",  "path":"h5bp",  "kind":"group",  "full_path":"h5bp",  "parent_id":null,  "avatar_url":null,  "web_url":"http://gitlab.com/groups/h5bp"  },  "_links":{  "self":"http://gitlab.com/api/v4/projects/8",  "issues":"http://gitlab.com/api/v4/projects/8/issues",  "merge_requests":"http://gitlab.com/api/v4/projects/8/merge_requests",  "repo_branches":"http://gitlab.com/api/v4/projects/8/repository/branches",  "labels":"http://gitlab.com/api/v4/projects/8/labels",  "events":"http://gitlab.com/api/v4/projects/8/events",  "members":"http://gitlab.com/api/v4/projects/8/members"  },  "empty_repo":false,  "archived":false,  "visibility":"public",  "resolve_outdated_diff_discussions":false,  "container_registry_enabled":true,  "container_expiration_policy":{  "cadence":"7d",  "enabled":true,  "keep_n":null,  "older_than":null,  "name_regex":null,  "name_regex_keep":null,  "next_run_at":"2020-05-04T06:13:22.654Z"  },  "issues_enabled":true,  "merge_requests_enabled":true,  "wiki_enabled":true,  "jobs_enabled":true,  "snippets_enabled":true,  "can_create_merge_request_in":true,  "issues_access_level":"enabled",  "repository_access_level":"enabled",  "merge_requests_access_level":"enabled",  "forking_access_level":"enabled",  "wiki_access_level":"enabled",  "builds_access_level":"enabled",  "snippets_access_level":"enabled",  "pages_access_level":"enabled",  "emails_disabled":null,  "shared_runners_enabled":true,  "lfs_enabled":true,  "creator_id":1,  "import_status":"failed",  "open_issues_count":10,  "ci_default_git_depth":50,  "public_jobs":true,  "build_timeout":3600,  "auto_cancel_pending_pipelines":"enabled",  "build_coverage_regex":null,  "ci_config_path":null,  "shared_with_groups":[  {  "group_id":24,  "group_name":"Commit451",  "group_full_path":"Commit451",  "group_access_level":30,  "expires_at":null  }  ],  "only_allow_merge_if_pipeline_succeeds":false,  "request_access_enabled":true,  "only_allow_merge_if_all_discussions_are_resolved":false,  "remove_source_branch_after_merge":true,  "printing_merge_request_link_enabled":true,  "merge_method":"merge",  "suggestion_commit_message":null,  "auto_devops_enabled":true,  "auto_devops_deploy_strategy":"continuous",  "autoclose_referenced_issues":true,  "repository_storage":"default"  }  ]

Details of a group

获取组的所有详细信息. 如果可以公开访问该组，则无需身份验证即可访问该端点. 如果请求的用户是该组的管理员，它将也返回该组的runners_token .

GET /groups/:id

Parameters:

注意：响应中的projects和shared_projects属性已弃用，并将 . 要获取组内所有项目的详细信息，请使用列出组的项目或端点.

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/4"

该端点返回：

• GitLab 12.6及更高版本中最多有 100 个项目和共享项目. 要获取组中所有项目的详细信息，请使用的列表 .

响应示例：

{  "id":  4,  "name":  "Twitter",  "path":  "twitter",  "description":  "Aliquid qui quis dignissimos distinctio ut commodi voluptas est.",  "visibility":  "public",  "avatar_url":  null,  "web_url":  "https://gitlab.example.com/groups/twitter",  "request_access_enabled":  false,  "full_name":  "Twitter",  "full_path":  "twitter",  "runners_token":  "ba324ca7b1c77fc20bb9",  "file_template_project_id":  1,  "parent_id":  null,  "created_at":  "2020-01-15T12:36:29.590Z",  "shared_with_groups":  [  {  "group_id":  28,  "group_name":  "H5bp",  "group_full_path":  "h5bp",  "group_access_level":  20,  "expires_at":  null  }  ],  "projects":  [  //  Deprecated  and  will  be  removed  in  API  v5  {  "id":  7,  "description":  "Voluptas veniam qui et beatae voluptas doloremque explicabo facilis.",  "default_branch":  "master",  "tag_list":  [],  "archived":  false,  "visibility":  "public",  "ssh_url_to_repo":  "git@gitlab.example.com:twitter/typeahead-js.git",  "http_url_to_repo":  "https://gitlab.example.com/twitter/typeahead-js.git",  "web_url":  "https://gitlab.example.com/twitter/typeahead-js",  "name":  "Typeahead.Js",  "name_with_namespace":  "Twitter / Typeahead.Js",  "path":  "typeahead-js",  "path_with_namespace":  "twitter/typeahead-js",  "issues_enabled":  true,  "merge_requests_enabled":  true,  "wiki_enabled":  true,  "jobs_enabled":  true,  "snippets_enabled":  false,  "container_registry_enabled":  true,  "created_at":  "2016-06-17T07:47:25.578Z",  "last_activity_at":  "2016-06-17T07:47:25.881Z",  "shared_runners_enabled":  true,  "creator_id":  1,  "namespace":  {  "id":  4,  "name":  "Twitter",  "path":  "twitter",  "kind":  "group"  },  "avatar_url":  null,  "star_count":  0,  "forks_count":  0,  "open_issues_count":  3,  "public_jobs":  true,  "shared_with_groups":  [],  "request_access_enabled":  false  },  {  "id":  6,  "description":  "Aspernatur omnis repudiandae qui voluptatibus eaque.",  "default_branch":  "master",  "tag_list":  [],  "archived":  false,  "visibility":  "internal",  "ssh_url_to_repo":  "git@gitlab.example.com:twitter/flight.git",  "http_url_to_repo":  "https://gitlab.example.com/twitter/flight.git",  "web_url":  "https://gitlab.example.com/twitter/flight",  "name":  "Flight",  "name_with_namespace":  "Twitter / Flight",  "path":  "flight",  "path_with_namespace":  "twitter/flight",  "issues_enabled":  true,  "merge_requests_enabled":  true,  "wiki_enabled":  true,  "jobs_enabled":  true,  "snippets_enabled":  false,  "container_registry_enabled":  true,  "created_at":  "2016-06-17T07:47:24.661Z",  "last_activity_at":  "2016-06-17T07:47:24.838Z",  "shared_runners_enabled":  true,  "creator_id":  1,  "namespace":  {  "id":  4,  "name":  "Twitter",  "path":  "twitter",  "kind":  "group"  },  "avatar_url":  null,  "star_count":  0,  "forks_count":  0,  "open_issues_count":  8,  "public_jobs":  true,  "shared_with_groups":  [],  "request_access_enabled":  false  }  ],  "shared_projects":  [  //  Deprecated  and  will  be  removed  in  API  v5  {  "id":  8,  "description":  "Velit eveniet provident fugiat saepe eligendi autem.",  "default_branch":  "master",  "tag_list":  [],  "archived":  false,  "visibility":  "private",  "ssh_url_to_repo":  "git@gitlab.example.com:h5bp/html5-boilerplate.git",  "http_url_to_repo":  "https://gitlab.example.com/h5bp/html5-boilerplate.git",  "web_url":  "https://gitlab.example.com/h5bp/html5-boilerplate",  "name":  "Html5 Boilerplate",  "name_with_namespace":  "H5bp / Html5 Boilerplate",  "path":  "html5-boilerplate",  "path_with_namespace":  "h5bp/html5-boilerplate",  "issues_enabled":  true,  "merge_requests_enabled":  true,  "wiki_enabled":  true,  "jobs_enabled":  true,  "snippets_enabled":  false,  "container_registry_enabled":  true,  "created_at":  "2016-06-17T07:47:27.089Z",  "last_activity_at":  "2016-06-17T07:47:27.310Z",  "shared_runners_enabled":  true,  "creator_id":  1,  "namespace":  {  "id":  5,  "name":  "H5bp",  "path":  "h5bp",  "kind":  "group"  },  "avatar_url":  null,  "star_count":  0,  "forks_count":  0,  "open_issues_count":  4,  "public_jobs":  true,  "shared_with_groups":  [  {  "group_id":  4,  "group_name":  "Twitter",  "group_full_path":  "twitter",  "group_access_level":  30,  "expires_at":  null  },  {  "group_id":  3,  "group_name":  "Gitlab Org",  "group_full_path":  "gitlab-org",  "group_access_level":  10,  "expires_at":  "2018-08-14"  }  ]  }  ]  }

使用 GitLab 还将看到shared_runners_minutes_limit和extra_shared_runners_minutes_limit参数：

{  "id":  4,  "description":  "Aliquid qui quis dignissimos distinctio ut commodi voluptas est.",  "shared_runners_minutes_limit":  133,  "extra_shared_runners_minutes_limit":  133,  ...  }

Users on GitLab Silver, Premium, or higher will also see the marked_for_deletion_on attribute:

当添加参数with_projects=false ，将不返回项目.

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/4?with_projects=false"

响应示例：

{  "id":  4,  "name":  "Twitter",  "path":  "twitter",  "description":  "Aliquid qui quis dignissimos distinctio ut commodi voluptas est.",  "visibility":  "public",  "avatar_url":  null,  "web_url":  "https://gitlab.example.com/groups/twitter",  "request_access_enabled":  false,  "full_name":  "Twitter",  "full_path":  "twitter",  "file_template_project_id":  1,  "parent_id":  null  }

如果它破坏了使用 GitLab 12.4 和更早版本开发的集成，则可以禁用 100 个结果限制.

要在迁移到使用终结点时禁用限制，请要求具有 Rails 控制台访问权限的 GitLab 管理员运行以下命令：

Feature.disable(:limit_projects_in_groups_api)

New group

创建一个新的项目组. 仅适用于可以创建组的用户.

POST /groups

Parameters:

Options for default_branch_protection

default_branch_protection属性确定开发人员和维护人员是否可以推送到适用的 master 分支，如下表所示：

-推送新的提交 -强制推送更改 -删除分支 | | 1 | 部分保护. 开发人员和维护人员可以： -推送新的提交 | | 2 | 全面保护. 只有维护者可以： -推送新的提交 |

New Subgroup

这类似于创建” . 您将需要” 列表”组调用中的parent_id . 然后，您可以输入所需的内容：

• subgroup_path
• subgroup_name

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" \
  --data '{"path": "<subgroup_path>", "name": "<subgroup_name>", "parent_id": <parent_group_id> } \
  "https://gitlab.example.com/api/v4/groups/"

将项目传输到组名称空间. 尽管不需要实例管理员访问权限的可用，但仅对实例管理员可用. 当项目存储库中存在标记的程序包时，传输项目可能会失败.

POST  /groups/:id/projects/:project_id

Parameters:

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/4/projects/56"

Update group

更新项目组. 仅对组所有者和管理员可用.

PUT /groups/:id

注意：响应中的projects和shared_projects属性已弃用，并将 . 要获取组内所有项目的详细信息，请使用列出组的项目或端点.

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5?name=Experimental"

该端点返回：

• GitLab 12.5 和更早版本中的所有项目和共享项目.
• GitLab 12.6及更高版本中最多有 100 个项目和共享项目. 要获取组中所有项目的详细信息，请使用的列表 .

响应示例：

{  "id":  5,  "name":  "Experimental",  "path":  "h5bp",  "description":  "foo",  "visibility":  "internal",  "avatar_url":  null,  "web_url":  "http://gitlab.example.com/groups/h5bp",  "request_access_enabled":  false,  "full_name":  "Foobar Group",  "full_path":  "foo-bar",  "file_template_project_id":  1,  "parent_id":  null,  "created_at":  "2020-01-15T12:36:29.590Z",  "projects":  [  //  Deprecated  and  will  be  removed  in  API  v5  {  "id":  9,  "description":  "foo",  "default_branch":  "master",  "tag_list":  [],  "public":  false,  "archived":  false,  "visibility":  "internal",  "ssh_url_to_repo":  "git@gitlab.example.com/html5-boilerplate.git",  "http_url_to_repo":  "http://gitlab.example.com/h5bp/html5-boilerplate.git",  "web_url":  "http://gitlab.example.com/h5bp/html5-boilerplate",  "name":  "Html5 Boilerplate",  "name_with_namespace":  "Experimental / Html5 Boilerplate",  "path":  "html5-boilerplate",  "path_with_namespace":  "h5bp/html5-boilerplate",  "issues_enabled":  true,  "merge_requests_enabled":  true,  "wiki_enabled":  true,  "jobs_enabled":  true,  "snippets_enabled":  true,  "created_at":  "2016-04-05T21:40:50.169Z",  "last_activity_at":  "2016-04-06T16:52:08.432Z",  "shared_runners_enabled":  true,  "creator_id":  1,  "namespace":  {  "id":  5,  "name":  "Experimental",  "path":  "h5bp",  "kind":  "group"  },  "avatar_url":  null,  "star_count":  1,  "forks_count":  0,  "open_issues_count":  3,  "public_jobs":  true,  "shared_with_groups":  [],  "request_access_enabled":  false  }  ]  }

Disabling the results limit

The 100 results limit can be disabled if it breaks integrations developed using GitLab 12.4 and earlier.

要在迁移到使用列表的组项目终结点时禁用限制，请要求具有 Rails 控制台访问权限的 GitLab 管理员运行以下命令：

Feature.disable(:limit_projects_in_groups_api)

Remove group

仅对组所有者和管理员可用.

该端点：

• 删除组，并在后台作业中排队以删除该组中的所有项目.
• 从GitLab 12.8 开始 ，在或更高级别上，将一个组标记为删除. 默认情况下，删除将在 7 天后进行，但是可以在实例设置中进行更改.

DELETE /groups/:id

Parameters:

如果用户具有授权，则响应将为202 Accepted .

Restore group marked for deletion

在 GitLab 12.8 中 .

恢复标记为删除的组.

POST /groups/:id/restore

Parameters:

Search for group

GET /groups?search=foobar

Hooks

也称为群组挂钩和 Webhooks. 这些不同于系统范围的和限于一个项目的项目挂钩 .

List group hooks

获取组挂钩列表

GET /groups/:id/hooks

获取组的特定挂钩.

GET /groups/:id/hooks/:hook_id

{  "id":  1,  "url":  "http://example.com/hook",  "group_id":  3,  "push_events":  true,  "issues_events":  true,  "confidential_issues_events":  true,  "merge_requests_events":  true,  "tag_push_events":  true,  "note_events":  true,  "confidential_note_events":  true,  "job_events":  true,  "pipeline_events":  true,  "wiki_page_events":  true,  "enable_ssl_verification":  true,  "created_at":  "2012-10-12T17:04:47Z"  }

Add group hook

将钩子添加到指定的组.

POST /groups/:id/hooks

Edit group hook

编辑指定组的挂钩.

PUT /groups/:id/hooks/:hook_id

Delete group hook

从组中删除钩子. 这是幂等方法，可以多次调用. 挂钩是否可用.

DELETE /groups/:id/hooks/:hook_id

Group Audit Events

可以通过” 组审核事件” API访问

将组与其链接的 LDAP 组同步. 仅对组所有者和管理员可用.

POST /groups/:id/ldap_sync

Parameters:

• id （必填）-用户组的 ID 或路径

Group members

请查阅文档.

LDAP Group Links

列出，添加和删除 LDAP 组链接.

列出 LDAP 组链接.

GET /groups/:id/ldap_group_links

Add LDAP group link with CN or filter

使用 CN 或过滤器添加 LDAP 组链接. 仅在高级级别和更高级别中，才支持通过过滤器添加组链接.

POST /groups/:id/ldap_group_links

注意：要定义 LDAP 组链接，请提供cn或filter ，但不能同时提供两者.

Delete LDAP group link

删除 LDAP 组链接. 不推荐使用. 在将来的版本中将被删除.

DELETE /groups/:id/ldap_group_links/:cn

删除特定 LDAP 提供程序的 LDAP 组链接. 不推荐使用. 在将来的版本中将被删除.

DELETE /groups/:id/ldap_group_links/:provider/:cn

Delete LDAP group link with CN or filter

使用 CN 或过滤器删除 LDAP 组链接. 仅高级级别和更高级别支持按过滤器删除.

DELETE /groups/:id/ldap_group_links

注意：要删除 LDAP 组链接，请提供cn或filter ，但不能同时提供两者.

Namespaces in groups

默认情况下，由于 API 结果是分页的，因此组一次只能获得 20 个名称空间.

要获得更多（最多 100 个），请将以下内容作为参数传递给 API 调用：

/groups?per_page=100

并切换页面添加：

/groups?per_page=100&page=2

Group badges

在组徽章文档中了解更多信息.

Group Import/Export

在组导入/导出文档中了解更多信息.

Share Groups with Groups

这些端点创建和删除用于与另一个组共享一个组的链接. 有关更多信息，请参见GitLab 组页面中的相关讨论.

与另一个群组共享群组. 返回200和成功的 .

Delete link sharing group with another group

DELETE /groups/:id/share/:group_id