group_shared_groups
Gets or lists a group_shared_groups resource.
Overview​
| Name | group_shared_groups |
| Type | Resource |
| Id | gitlab.groups.group_shared_groups |
Fields​
The following fields are returned by SELECT queries:
- list
GraphQL response envelope
| Name | Datatype | Description |
|---|---|---|
id | string | ID of the group. |
name | string | Name of the group. |
full_name | string | Full name of the group. |
actual_repository_size_limit | number | Size limit for repositories in the namespace in bytes. This limit only applies to namespaces under Project limit enforcement. |
actual_size_limit | number | The 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_size | number | Additional storage purchased for the root namespace in bytes. |
admin_edit_path | string | Admin path for editing group. Only available to admins. |
admin_show_path | string | Admin path of the group. Only available to admins. |
allow_stale_runner_pruning | boolean | Indicates whether to regularly prune stale group runners. Defaults to false. |
archived | boolean | Indicates if the group or any ancestor is archived. |
auto_devops_enabled | boolean | Indicates whether Auto DevOps is enabled for all projects within the group. |
avatar_url | string | Avatar URL of the group. |
billable_members_count | integer | Number of billable users in the group. |
contains_locked_projects | boolean | Includes at least one project where the repository size exceeds the limit. This only applies to namespaces under Project limit enforcement. |
created_at | string | Timestamp of the group creation. |
cross_project_pipeline_available | boolean | Indicates if the cross_project_pipeline feature is available for the namespace. |
dependency_proxy_blob_count | integer | Number of dependency proxy blobs cached in the group. |
dependency_proxy_image_count | integer | Number of dependency proxy images cached in the group. |
dependency_proxy_image_prefix | string | Prefix for pulling images when using the dependency proxy. |
dependency_proxy_total_size | string | Total size of the dependency proxy cached images. |
dependency_proxy_total_size_bytes | string | Total size of the dependency proxy cached images in bytes, encoded as a string. |
descendant_groups_count | integer | Count of direct descendant groups of the group. |
description | string | Description of the namespace. |
edit_path | string | Path for editing group. |
emails_disabled | boolean | Indicates if a group has email notifications disabled. |
emails_enabled | boolean | Indicates if a group has email notifications enabled. |
enforce_free_user_cap | boolean | Indicates whether the group has limited users for a free plan. |
full_path | string | Full path of the group. |
group_members_count | integer | Count of direct members of the group. |
is_linked_to_subscription | boolean | Indicates if group is linked to a subscription. |
is_self_archived | boolean | Indicates if the group is archived. |
lfs_enabled | boolean | Indicates if Large File Storage (LFS) is enabled for namespace. |
lock_math_rendering_limits_enabled | boolean | Indicates if math rendering limits are locked for all descendant groups. |
math_rendering_limits_enabled | boolean | Indicates if math rendering limits are used for the group. |
mentions_disabled | boolean | Indicates if a group is disabled from getting mentioned. |
path | string | Path of the namespace. |
project_creation_level | string | Permission level required to create projects in the group. |
projects_count | integer | Count of direct projects in the group. |
repository_size_excess_project_count | integer | Number of projects in the root namespace where the repository size exceeds the limit. This only applies to namespaces under Project limit enforcement. |
request_access_enabled | boolean | Indicates if users can request access to namespace. |
require_two_factor_authentication | boolean | Indicates if all users in the group are required to set up two-factor authentication. |
share_with_group_lock | boolean | Indicates if sharing a project with another group within the group is prevented. |
shared_runners_setting | string | Shared runners availability for the namespace and its descendants. (DISABLED_AND_UNOVERRIDABLE, DISABLED_AND_OVERRIDABLE, ENABLED) |
storage_size_limit | number | The storage limit (in bytes) included with the root namespace plan. This limit only applies to namespaces under namespace limit enforcement. |
subgroup_creation_level | string | Permission level required to create subgroups within the group. |
total_repository_size | number | Total repository size of all projects in the root namespace in bytes. |
total_repository_size_excess | number | Total excess repository size of all projects in the root namespace in bytes. This only applies to namespaces under Project limit enforcement. |
two_factor_grace_period | integer | Time before two-factor authentication is enforced. |
updated_at | string | Timestamp of when the group was last updated. |
visibility | string | Visibility of the namespace. |
web_path | string | Web path of the group. |
web_url | string | Web URL of the group. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | full_path, host | search, sort | List 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.
| Name | Datatype | Description |
|---|---|---|
full_path | string | Full path of the group, for example gitlab-org |
host | string | GitLab 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) |
search | string | Search for a specific group. |
sort | string | Order by name, created at, updated at, path, id or similarity if searching. |
SELECT examples​
- list
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 }}'
;