Skip to main content

group_shared_groups

Gets or lists a group_shared_groups resource.

Overview​

Namegroup_shared_groups
TypeResource
Idgitlab.groups.group_shared_groups

Fields​

The following fields are returned by SELECT queries:

GraphQL response envelope

NameDatatypeDescription
idstringID of the group.
namestringName of the group.
full_namestringFull name of the group.
actual_repository_size_limitnumberSize limit for repositories in the namespace in bytes. This limit only applies to namespaces under Project limit enforcement.
actual_size_limitnumberThe actual storage size limit (in bytes) based on the enforcement type of either repository or namespace. This limit is agnostic of enforcement type.
additional_purchased_storage_sizenumberAdditional storage purchased for the root namespace in bytes.
admin_edit_pathstringAdmin path for editing group. Only available to admins.
admin_show_pathstringAdmin path of the group. Only available to admins.
allow_stale_runner_pruningbooleanIndicates whether to regularly prune stale group runners. Defaults to false.
archivedbooleanIndicates if the group or any ancestor is archived.
auto_devops_enabledbooleanIndicates whether Auto DevOps is enabled for all projects within the group.
avatar_urlstringAvatar URL of the group.
billable_members_countintegerNumber of billable users in the group.
contains_locked_projectsbooleanIncludes at least one project where the repository size exceeds the limit. This only applies to namespaces under Project limit enforcement.
created_atstringTimestamp of the group creation.
cross_project_pipeline_availablebooleanIndicates if the cross_project_pipeline feature is available for the namespace.
dependency_proxy_blob_countintegerNumber of dependency proxy blobs cached in the group.
dependency_proxy_image_countintegerNumber of dependency proxy images cached in the group.
dependency_proxy_image_prefixstringPrefix for pulling images when using the dependency proxy.
dependency_proxy_total_sizestringTotal size of the dependency proxy cached images.
dependency_proxy_total_size_bytesstringTotal size of the dependency proxy cached images in bytes, encoded as a string.
descendant_groups_countintegerCount of direct descendant groups of the group.
descriptionstringDescription of the namespace.
edit_pathstringPath for editing group.
emails_disabledbooleanIndicates if a group has email notifications disabled.
emails_enabledbooleanIndicates if a group has email notifications enabled.
enforce_free_user_capbooleanIndicates whether the group has limited users for a free plan.
full_pathstringFull path of the group.
group_members_countintegerCount of direct members of the group.
is_linked_to_subscriptionbooleanIndicates if group is linked to a subscription.
is_self_archivedbooleanIndicates if the group is archived.
lfs_enabledbooleanIndicates if Large File Storage (LFS) is enabled for namespace.
lock_math_rendering_limits_enabledbooleanIndicates if math rendering limits are locked for all descendant groups.
math_rendering_limits_enabledbooleanIndicates if math rendering limits are used for the group.
mentions_disabledbooleanIndicates if a group is disabled from getting mentioned.
pathstringPath of the namespace.
project_creation_levelstringPermission level required to create projects in the group.
projects_countintegerCount of direct projects in the group.
repository_size_excess_project_countintegerNumber of projects in the root namespace where the repository size exceeds the limit. This only applies to namespaces under Project limit enforcement.
request_access_enabledbooleanIndicates if users can request access to namespace.
require_two_factor_authenticationbooleanIndicates if all users in the group are required to set up two-factor authentication.
share_with_group_lockbooleanIndicates if sharing a project with another group within the group is prevented.
shared_runners_settingstringShared runners availability for the namespace and its descendants. (DISABLED_AND_UNOVERRIDABLE, DISABLED_AND_OVERRIDABLE, ENABLED)
storage_size_limitnumberThe storage limit (in bytes) included with the root namespace plan. This limit only applies to namespaces under namespace limit enforcement.
subgroup_creation_levelstringPermission level required to create subgroups within the group.
total_repository_sizenumberTotal repository size of all projects in the root namespace in bytes.
total_repository_size_excessnumberTotal excess repository size of all projects in the root namespace in bytes. This only applies to namespaces under Project limit enforcement.
two_factor_grace_periodintegerTime before two-factor authentication is enforced.
updated_atstringTimestamp of when the group was last updated.
visibilitystringVisibility of the namespace.
web_pathstringWeb path of the group.
web_urlstringWeb URL of the group.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectfull_path, hostsearch, sortList of shared groups this group was invited to. Generated from the GitLab GraphQL schema field Group.sharedGroups (connection of Group nodes).

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
full_pathstringFull path of the group, for example gitlab-org
hoststringGitLab host, with an optional port (default gitlab.com). Resolved from the GITLAB_HOST environment variable when it is set (x-stackQL-envVar); a WHERE host value always takes precedence. Self-managed instances: the provider is generated from the gitlab.com schema, so older instances may reject fields they do not serve. (default: gitlab.com, x-stackQL-envVar: GITLAB_HOST)
sortstringOrder by name, created at, updated at, path, id or similarity if searching.

SELECT examples​

List of shared groups this group was invited to. Generated from the GitLab GraphQL schema field Group.sharedGroups (connection of Group nodes).

SELECT
id,
name,
full_name,
actual_repository_size_limit,
actual_size_limit,
additional_purchased_storage_size,
admin_edit_path,
admin_show_path,
allow_stale_runner_pruning,
archived,
auto_devops_enabled,
avatar_url,
billable_members_count,
contains_locked_projects,
created_at,
cross_project_pipeline_available,
dependency_proxy_blob_count,
dependency_proxy_image_count,
dependency_proxy_image_prefix,
dependency_proxy_total_size,
dependency_proxy_total_size_bytes,
descendant_groups_count,
description,
edit_path,
emails_disabled,
emails_enabled,
enforce_free_user_cap,
full_path,
group_members_count,
is_linked_to_subscription,
is_self_archived,
lfs_enabled,
lock_math_rendering_limits_enabled,
math_rendering_limits_enabled,
mentions_disabled,
path,
project_creation_level,
projects_count,
repository_size_excess_project_count,
request_access_enabled,
require_two_factor_authentication,
share_with_group_lock,
shared_runners_setting,
storage_size_limit,
subgroup_creation_level,
total_repository_size,
total_repository_size_excess,
two_factor_grace_period,
updated_at,
visibility,
web_path,
web_url
FROM gitlab.groups.group_shared_groups
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND search = '{{ search }}'
AND sort = '{{ sort }}'
;