Viewing docs for GitLab v10.0.0
published on Friday, Jun 26, 2026 by Pulumi
published on Friday, Jun 26, 2026 by Pulumi
Viewing docs for GitLab v10.0.0
published on Friday, Jun 26, 2026 by Pulumi
published on Friday, Jun 26, 2026 by Pulumi
The gitlab.Group data source allows details of a group to be retrieved by its id or full path.
Upstream API: GitLab REST API docs
Using getGroup
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOptions): Output<GetGroupResult>def get_group(full_path: Optional[str] = None,
group_id: Optional[int] = None,
opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(full_path: pulumi.Input[Optional[str]] = None,
group_id: pulumi.Input[Optional[int]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetGroupResult]func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput> Note: This function is named LookupGroup in the Go SDK.
public static class GetGroup
{
public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
public static Output<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
fn::invoke:
function: gitlab:index/getGroup:getGroup
arguments:
# arguments dictionarydata "gitlab_getgroup" "name" {
# arguments
}The following arguments are supported:
getGroup Result
The following output properties are available:
- Allow
Merge boolOn Skipped Pipeline - Default to allowing merge on a skipped pipeline for new projects in the group.
- Allowed
Email stringDomains List - Comma-separated list of email address domains allowed to be added as group members.
- Auto
Devops boolEnabled - Default to Auto DevOps pipeline for all projects within this group.
- Avatar
Url string - URL of the group avatar.
- Created
At string - Timestamp at which the group was created.
- Custom
Attributes List<ImmutableDictionary<string, string>> - Custom attributes attached to the group. Each entry is a map with
keyandvalue. Requires administrator privileges to read. - Default
Branch string - The default branch of the group.
- Default
Branch intProtection - Whether developers and maintainers can push to the applicable default branch. Use
defaultBranchProtectionDefaultsinstead, to be removed in 19.0. - Default
Branch List<Pulumi.Protection Defaults Git Lab. Outputs. Get Group Default Branch Protection Default> - Default protection settings applied to the default branch of new projects in this group.
- Description string
- The description of the group.
- Emails
Disabled bool - Whether email notifications are disabled for this group. Use
emailsEnabledinstead, to be removed in 19.0. - Emails
Enabled bool - Whether email notifications are enabled for this group.
- int
- Available in Self-Managed, Premium and Ultimate plans. Can be set by administrators only. Additional CI/CD minutes for this group.
- File
Template intProject Id - The ID of the project used to load custom file templates.
- Full
Name string - The full name of the group.
- Full
Path string - The full path of the group.
- Group
Id int - The ID of the group.
- Id string
- The ID of this datasource. In the format
<group-id>. - Ip
Restriction stringRanges - Comma-separated list of IP addresses or subnet masks that restrict access to the group.
- Ldap
Access int - Default access level for members synced from LDAP.
- Ldap
Cn string - LDAP common name used to sync members from an LDAP group.
- Lfs
Enabled bool - Boolean, is LFS enabled for projects in this group.
- Marked
For stringDeletion On - Date on which the group was marked for deletion.
- Max
Artifacts intSize - Maximum artifacts size for the group, in MB.
- Membership
Lock bool - Users cannot be added to projects in this group.
- Mentions
Disabled bool - Whether mentions are disabled for this group.
- Name string
- The name of this group.
- Only
Allow boolMerge If All Discussions Are Resolved - Default to only allowing merge if all discussions are resolved for new projects in the group.
- Only
Allow boolMerge If Pipeline Succeeds - Default to only allowing merge if the pipeline succeeds for new projects in the group.
- Parent
Id int - Integer, ID of the parent group.
- Path string
- The path of the group.
- Prevent
Forking boolOutside Group - When enabled, users can not fork projects from this group to external namespaces.
- Prevent
Sharing boolGroups Outside Hierarchy - When enabled, users cannot invite other groups outside of the top-level group's hierarchy. This option is only available for top-level groups.
- Project
Creation stringLevel - Determine which roles can create projects in the group. Possible values are
noone,maintainer,developer,owner,administrator. - Push
Rules List<Pulumi.Git Lab. Outputs. Get Group Push Rule> - Push rules for the group. Push rules are only available on Premium and Ultimate plans, and only if the authenticated user has permission to read them.
- Repository
Storage string - Repository storage shard the group's projects use. (admin only)
- Request
Access boolEnabled - Boolean, is request for access enabled to the group.
- Require
Two boolFactor Authentication - Require all users in this group to set up two-factor authentication.
- Runners
Token string - The group level registration token to use during runner setup.
- bool
- Prevent sharing a project with another group within this group.
- int
- Available in Self-Managed, Premium and Ultimate plans. Can be set by administrators only. Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.
- string
- Enable or disable shared runners for a group's subgroups and projects. Valid values are:
enabled,disabledAndOverridable,disabledAndUnoverridable,disabledWithOverride. -
List<Pulumi.
Git Lab. Outputs. Get Group Shared With Group> - Describes groups which have access shared to this group.
- Statistics Dictionary<string, int>
- Statistics for the group. Keys:
commitCount,storageSize,repositorySize,wikiSize,lfsObjectsSize,jobArtifactsSize,pipelineArtifactsSize,packagesSize,snippetsSize,uploadsSize,containerRegistrySize. - Subgroup
Creation stringLevel - Determine which roles can create subgroups in the group. Possible values are
owner,maintainer. - Two
Factor intGrace Period - Grace period, in hours, before enforcing two-factor authentication on group members.
- Visibility
Level string - Visibility level of the group. Possible values are
private,internal,public. - Web
Url string - Web URL of the group.
- Wiki
Access stringLevel - The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are
disabled,private,enabled.
- Allow
Merge boolOn Skipped Pipeline - Default to allowing merge on a skipped pipeline for new projects in the group.
- Allowed
Email stringDomains List - Comma-separated list of email address domains allowed to be added as group members.
- Auto
Devops boolEnabled - Default to Auto DevOps pipeline for all projects within this group.
- Avatar
Url string - URL of the group avatar.
- Created
At string - Timestamp at which the group was created.
- Custom
Attributes []map[string]string - Custom attributes attached to the group. Each entry is a map with
keyandvalue. Requires administrator privileges to read. - Default
Branch string - The default branch of the group.
- Default
Branch intProtection - Whether developers and maintainers can push to the applicable default branch. Use
defaultBranchProtectionDefaultsinstead, to be removed in 19.0. - Default
Branch []GetProtection Defaults Group Default Branch Protection Default - Default protection settings applied to the default branch of new projects in this group.
- Description string
- The description of the group.
- Emails
Disabled bool - Whether email notifications are disabled for this group. Use
emailsEnabledinstead, to be removed in 19.0. - Emails
Enabled bool - Whether email notifications are enabled for this group.
- int
- Available in Self-Managed, Premium and Ultimate plans. Can be set by administrators only. Additional CI/CD minutes for this group.
- File
Template intProject Id - The ID of the project used to load custom file templates.
- Full
Name string - The full name of the group.
- Full
Path string - The full path of the group.
- Group
Id int - The ID of the group.
- Id string
- The ID of this datasource. In the format
<group-id>. - Ip
Restriction stringRanges - Comma-separated list of IP addresses or subnet masks that restrict access to the group.
- Ldap
Access int - Default access level for members synced from LDAP.
- Ldap
Cn string - LDAP common name used to sync members from an LDAP group.
- Lfs
Enabled bool - Boolean, is LFS enabled for projects in this group.
- Marked
For stringDeletion On - Date on which the group was marked for deletion.
- Max
Artifacts intSize - Maximum artifacts size for the group, in MB.
- Membership
Lock bool - Users cannot be added to projects in this group.
- Mentions
Disabled bool - Whether mentions are disabled for this group.
- Name string
- The name of this group.
- Only
Allow boolMerge If All Discussions Are Resolved - Default to only allowing merge if all discussions are resolved for new projects in the group.
- Only
Allow boolMerge If Pipeline Succeeds - Default to only allowing merge if the pipeline succeeds for new projects in the group.
- Parent
Id int - Integer, ID of the parent group.
- Path string
- The path of the group.
- Prevent
Forking boolOutside Group - When enabled, users can not fork projects from this group to external namespaces.
- Prevent
Sharing boolGroups Outside Hierarchy - When enabled, users cannot invite other groups outside of the top-level group's hierarchy. This option is only available for top-level groups.
- Project
Creation stringLevel - Determine which roles can create projects in the group. Possible values are
noone,maintainer,developer,owner,administrator. - Push
Rules []GetGroup Push Rule - Push rules for the group. Push rules are only available on Premium and Ultimate plans, and only if the authenticated user has permission to read them.
- Repository
Storage string - Repository storage shard the group's projects use. (admin only)
- Request
Access boolEnabled - Boolean, is request for access enabled to the group.
- Require
Two boolFactor Authentication - Require all users in this group to set up two-factor authentication.
- Runners
Token string - The group level registration token to use during runner setup.
- bool
- Prevent sharing a project with another group within this group.
- int
- Available in Self-Managed, Premium and Ultimate plans. Can be set by administrators only. Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.
- string
- Enable or disable shared runners for a group's subgroups and projects. Valid values are:
enabled,disabledAndOverridable,disabledAndUnoverridable,disabledWithOverride. -
[]Get
Group Shared With Group - Describes groups which have access shared to this group.
- Statistics map[string]int
- Statistics for the group. Keys:
commitCount,storageSize,repositorySize,wikiSize,lfsObjectsSize,jobArtifactsSize,pipelineArtifactsSize,packagesSize,snippetsSize,uploadsSize,containerRegistrySize. - Subgroup
Creation stringLevel - Determine which roles can create subgroups in the group. Possible values are
owner,maintainer. - Two
Factor intGrace Period - Grace period, in hours, before enforcing two-factor authentication on group members.
- Visibility
Level string - Visibility level of the group. Possible values are
private,internal,public. - Web
Url string - Web URL of the group.
- Wiki
Access stringLevel - The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are
disabled,private,enabled.
- allow_
merge_ boolon_ skipped_ pipeline - Default to allowing merge on a skipped pipeline for new projects in the group.
- allowed_
email_ stringdomains_ list - Comma-separated list of email address domains allowed to be added as group members.
- auto_
devops_ boolenabled - Default to Auto DevOps pipeline for all projects within this group.
- avatar_
url string - URL of the group avatar.
- created_
at string - Timestamp at which the group was created.
- custom_
attributes list(map(string)) - Custom attributes attached to the group. Each entry is a map with
keyandvalue. Requires administrator privileges to read. - default_
branch string - The default branch of the group.
- default_
branch_ numberprotection - Whether developers and maintainers can push to the applicable default branch. Use
defaultBranchProtectionDefaultsinstead, to be removed in 19.0. - default_
branch_ list(object)protection_ defaults - Default protection settings applied to the default branch of new projects in this group.
- description string
- The description of the group.
- emails_
disabled bool - Whether email notifications are disabled for this group. Use
emailsEnabledinstead, to be removed in 19.0. - emails_
enabled bool - Whether email notifications are enabled for this group.
- number
- Available in Self-Managed, Premium and Ultimate plans. Can be set by administrators only. Additional CI/CD minutes for this group.
- file_
template_ numberproject_ id - The ID of the project used to load custom file templates.
- full_
name string - The full name of the group.
- full_
path string - The full path of the group.
- group_
id number - The ID of the group.
- id string
- The ID of this datasource. In the format
<group-id>. - ip_
restriction_ stringranges - Comma-separated list of IP addresses or subnet masks that restrict access to the group.
- ldap_
access number - Default access level for members synced from LDAP.
- ldap_
cn string - LDAP common name used to sync members from an LDAP group.
- lfs_
enabled bool - Boolean, is LFS enabled for projects in this group.
- marked_
for_ stringdeletion_ on - Date on which the group was marked for deletion.
- max_
artifacts_ numbersize - Maximum artifacts size for the group, in MB.
- membership_
lock bool - Users cannot be added to projects in this group.
- mentions_
disabled bool - Whether mentions are disabled for this group.
- name string
- The name of this group.
- only_
allow_ boolmerge_ if_ all_ discussions_ are_ resolved - Default to only allowing merge if all discussions are resolved for new projects in the group.
- only_
allow_ boolmerge_ if_ pipeline_ succeeds - Default to only allowing merge if the pipeline succeeds for new projects in the group.
- parent_
id number - Integer, ID of the parent group.
- path string
- The path of the group.
- prevent_
forking_ booloutside_ group - When enabled, users can not fork projects from this group to external namespaces.
- prevent_
sharing_ boolgroups_ outside_ hierarchy - When enabled, users cannot invite other groups outside of the top-level group's hierarchy. This option is only available for top-level groups.
- project_
creation_ stringlevel - Determine which roles can create projects in the group. Possible values are
noone,maintainer,developer,owner,administrator. - push_
rules list(object) - Push rules for the group. Push rules are only available on Premium and Ultimate plans, and only if the authenticated user has permission to read them.
- repository_
storage string - Repository storage shard the group's projects use. (admin only)
- request_
access_ boolenabled - Boolean, is request for access enabled to the group.
- require_
two_ boolfactor_ authentication - Require all users in this group to set up two-factor authentication.
- runners_
token string - The group level registration token to use during runner setup.
- bool
- Prevent sharing a project with another group within this group.
- number
- Available in Self-Managed, Premium and Ultimate plans. Can be set by administrators only. Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.
- string
- Enable or disable shared runners for a group's subgroups and projects. Valid values are:
enabled,disabledAndOverridable,disabledAndUnoverridable,disabledWithOverride. - list(object)
- Describes groups which have access shared to this group.
- statistics map(number)
- Statistics for the group. Keys:
commitCount,storageSize,repositorySize,wikiSize,lfsObjectsSize,jobArtifactsSize,pipelineArtifactsSize,packagesSize,snippetsSize,uploadsSize,containerRegistrySize. - subgroup_
creation_ stringlevel - Determine which roles can create subgroups in the group. Possible values are
owner,maintainer. - two_
factor_ numbergrace_ period - Grace period, in hours, before enforcing two-factor authentication on group members.
- visibility_
level string - Visibility level of the group. Possible values are
private,internal,public. - web_
url string - Web URL of the group.
- wiki_
access_ stringlevel - The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are
disabled,private,enabled.
- allow
Merge BooleanOn Skipped Pipeline - Default to allowing merge on a skipped pipeline for new projects in the group.
- allowed
Email StringDomains List - Comma-separated list of email address domains allowed to be added as group members.
- auto
Devops BooleanEnabled - Default to Auto DevOps pipeline for all projects within this group.
- avatar
Url String - URL of the group avatar.
- created
At String - Timestamp at which the group was created.
- custom
Attributes List<Map<String,String>> - Custom attributes attached to the group. Each entry is a map with
keyandvalue. Requires administrator privileges to read. - default
Branch String - The default branch of the group.
- default
Branch IntegerProtection - Whether developers and maintainers can push to the applicable default branch. Use
defaultBranchProtectionDefaultsinstead, to be removed in 19.0. - default
Branch List<GetProtection Defaults Group Default Branch Protection Default> - Default protection settings applied to the default branch of new projects in this group.
- description String
- The description of the group.
- emails
Disabled Boolean - Whether email notifications are disabled for this group. Use
emailsEnabledinstead, to be removed in 19.0. - emails
Enabled Boolean - Whether email notifications are enabled for this group.
- Integer
- Available in Self-Managed, Premium and Ultimate plans. Can be set by administrators only. Additional CI/CD minutes for this group.
- file
Template IntegerProject Id - The ID of the project used to load custom file templates.
- full
Name String - The full name of the group.
- full
Path String - The full path of the group.
- group
Id Integer - The ID of the group.
- id String
- The ID of this datasource. In the format
<group-id>. - ip
Restriction StringRanges - Comma-separated list of IP addresses or subnet masks that restrict access to the group.
- ldap
Access Integer - Default access level for members synced from LDAP.
- ldap
Cn String - LDAP common name used to sync members from an LDAP group.
- lfs
Enabled Boolean - Boolean, is LFS enabled for projects in this group.
- marked
For StringDeletion On - Date on which the group was marked for deletion.
- max
Artifacts IntegerSize - Maximum artifacts size for the group, in MB.
- membership
Lock Boolean - Users cannot be added to projects in this group.
- mentions
Disabled Boolean - Whether mentions are disabled for this group.
- name String
- The name of this group.
- only
Allow BooleanMerge If All Discussions Are Resolved - Default to only allowing merge if all discussions are resolved for new projects in the group.
- only
Allow BooleanMerge If Pipeline Succeeds - Default to only allowing merge if the pipeline succeeds for new projects in the group.
- parent
Id Integer - Integer, ID of the parent group.
- path String
- The path of the group.
- prevent
Forking BooleanOutside Group - When enabled, users can not fork projects from this group to external namespaces.
- prevent
Sharing BooleanGroups Outside Hierarchy - When enabled, users cannot invite other groups outside of the top-level group's hierarchy. This option is only available for top-level groups.
- project
Creation StringLevel - Determine which roles can create projects in the group. Possible values are
noone,maintainer,developer,owner,administrator. - push
Rules List<GetGroup Push Rule> - Push rules for the group. Push rules are only available on Premium and Ultimate plans, and only if the authenticated user has permission to read them.
- repository
Storage String - Repository storage shard the group's projects use. (admin only)
- request
Access BooleanEnabled - Boolean, is request for access enabled to the group.
- require
Two BooleanFactor Authentication - Require all users in this group to set up two-factor authentication.
- runners
Token String - The group level registration token to use during runner setup.
- Boolean
- Prevent sharing a project with another group within this group.
- Integer
- Available in Self-Managed, Premium and Ultimate plans. Can be set by administrators only. Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.
- String
- Enable or disable shared runners for a group's subgroups and projects. Valid values are:
enabled,disabledAndOverridable,disabledAndUnoverridable,disabledWithOverride. -
List<Get
Group Shared With Group> - Describes groups which have access shared to this group.
- statistics Map<String,Integer>
- Statistics for the group. Keys:
commitCount,storageSize,repositorySize,wikiSize,lfsObjectsSize,jobArtifactsSize,pipelineArtifactsSize,packagesSize,snippetsSize,uploadsSize,containerRegistrySize. - subgroup
Creation StringLevel - Determine which roles can create subgroups in the group. Possible values are
owner,maintainer. - two
Factor IntegerGrace Period - Grace period, in hours, before enforcing two-factor authentication on group members.
- visibility
Level String - Visibility level of the group. Possible values are
private,internal,public. - web
Url String - Web URL of the group.
- wiki
Access StringLevel - The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are
disabled,private,enabled.
- allow
Merge booleanOn Skipped Pipeline - Default to allowing merge on a skipped pipeline for new projects in the group.
- allowed
Email stringDomains List - Comma-separated list of email address domains allowed to be added as group members.
- auto
Devops booleanEnabled - Default to Auto DevOps pipeline for all projects within this group.
- avatar
Url string - URL of the group avatar.
- created
At string - Timestamp at which the group was created.
- custom
Attributes {[key: string]: string}[] - Custom attributes attached to the group. Each entry is a map with
keyandvalue. Requires administrator privileges to read. - default
Branch string - The default branch of the group.
- default
Branch numberProtection - Whether developers and maintainers can push to the applicable default branch. Use
defaultBranchProtectionDefaultsinstead, to be removed in 19.0. - default
Branch GetProtection Defaults Group Default Branch Protection Default[] - Default protection settings applied to the default branch of new projects in this group.
- description string
- The description of the group.
- emails
Disabled boolean - Whether email notifications are disabled for this group. Use
emailsEnabledinstead, to be removed in 19.0. - emails
Enabled boolean - Whether email notifications are enabled for this group.
- number
- Available in Self-Managed, Premium and Ultimate plans. Can be set by administrators only. Additional CI/CD minutes for this group.
- file
Template numberProject Id - The ID of the project used to load custom file templates.
- full
Name string - The full name of the group.
- full
Path string - The full path of the group.
- group
Id number - The ID of the group.
- id string
- The ID of this datasource. In the format
<group-id>. - ip
Restriction stringRanges - Comma-separated list of IP addresses or subnet masks that restrict access to the group.
- ldap
Access number - Default access level for members synced from LDAP.
- ldap
Cn string - LDAP common name used to sync members from an LDAP group.
- lfs
Enabled boolean - Boolean, is LFS enabled for projects in this group.
- marked
For stringDeletion On - Date on which the group was marked for deletion.
- max
Artifacts numberSize - Maximum artifacts size for the group, in MB.
- membership
Lock boolean - Users cannot be added to projects in this group.
- mentions
Disabled boolean - Whether mentions are disabled for this group.
- name string
- The name of this group.
- only
Allow booleanMerge If All Discussions Are Resolved - Default to only allowing merge if all discussions are resolved for new projects in the group.
- only
Allow booleanMerge If Pipeline Succeeds - Default to only allowing merge if the pipeline succeeds for new projects in the group.
- parent
Id number - Integer, ID of the parent group.
- path string
- The path of the group.
- prevent
Forking booleanOutside Group - When enabled, users can not fork projects from this group to external namespaces.
- prevent
Sharing booleanGroups Outside Hierarchy - When enabled, users cannot invite other groups outside of the top-level group's hierarchy. This option is only available for top-level groups.
- project
Creation stringLevel - Determine which roles can create projects in the group. Possible values are
noone,maintainer,developer,owner,administrator. - push
Rules GetGroup Push Rule[] - Push rules for the group. Push rules are only available on Premium and Ultimate plans, and only if the authenticated user has permission to read them.
- repository
Storage string - Repository storage shard the group's projects use. (admin only)
- request
Access booleanEnabled - Boolean, is request for access enabled to the group.
- require
Two booleanFactor Authentication - Require all users in this group to set up two-factor authentication.
- runners
Token string - The group level registration token to use during runner setup.
- boolean
- Prevent sharing a project with another group within this group.
- number
- Available in Self-Managed, Premium and Ultimate plans. Can be set by administrators only. Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.
- string
- Enable or disable shared runners for a group's subgroups and projects. Valid values are:
enabled,disabledAndOverridable,disabledAndUnoverridable,disabledWithOverride. -
Get
Group Shared With Group[] - Describes groups which have access shared to this group.
- statistics {[key: string]: number}
- Statistics for the group. Keys:
commitCount,storageSize,repositorySize,wikiSize,lfsObjectsSize,jobArtifactsSize,pipelineArtifactsSize,packagesSize,snippetsSize,uploadsSize,containerRegistrySize. - subgroup
Creation stringLevel - Determine which roles can create subgroups in the group. Possible values are
owner,maintainer. - two
Factor numberGrace Period - Grace period, in hours, before enforcing two-factor authentication on group members.
- visibility
Level string - Visibility level of the group. Possible values are
private,internal,public. - web
Url string - Web URL of the group.
- wiki
Access stringLevel - The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are
disabled,private,enabled.
- allow_
merge_ boolon_ skipped_ pipeline - Default to allowing merge on a skipped pipeline for new projects in the group.
- allowed_
email_ strdomains_ list - Comma-separated list of email address domains allowed to be added as group members.
- auto_
devops_ boolenabled - Default to Auto DevOps pipeline for all projects within this group.
- avatar_
url str - URL of the group avatar.
- created_
at str - Timestamp at which the group was created.
- custom_
attributes Sequence[Mapping[str, str]] - Custom attributes attached to the group. Each entry is a map with
keyandvalue. Requires administrator privileges to read. - default_
branch str - The default branch of the group.
- default_
branch_ intprotection - Whether developers and maintainers can push to the applicable default branch. Use
defaultBranchProtectionDefaultsinstead, to be removed in 19.0. - default_
branch_ Sequence[Getprotection_ defaults Group Default Branch Protection Default] - Default protection settings applied to the default branch of new projects in this group.
- description str
- The description of the group.
- emails_
disabled bool - Whether email notifications are disabled for this group. Use
emailsEnabledinstead, to be removed in 19.0. - emails_
enabled bool - Whether email notifications are enabled for this group.
- int
- Available in Self-Managed, Premium and Ultimate plans. Can be set by administrators only. Additional CI/CD minutes for this group.
- file_
template_ intproject_ id - The ID of the project used to load custom file templates.
- full_
name str - The full name of the group.
- full_
path str - The full path of the group.
- group_
id int - The ID of the group.
- id str
- The ID of this datasource. In the format
<group-id>. - ip_
restriction_ strranges - Comma-separated list of IP addresses or subnet masks that restrict access to the group.
- ldap_
access int - Default access level for members synced from LDAP.
- ldap_
cn str - LDAP common name used to sync members from an LDAP group.
- lfs_
enabled bool - Boolean, is LFS enabled for projects in this group.
- marked_
for_ strdeletion_ on - Date on which the group was marked for deletion.
- max_
artifacts_ intsize - Maximum artifacts size for the group, in MB.
- membership_
lock bool - Users cannot be added to projects in this group.
- mentions_
disabled bool - Whether mentions are disabled for this group.
- name str
- The name of this group.
- only_
allow_ boolmerge_ if_ all_ discussions_ are_ resolved - Default to only allowing merge if all discussions are resolved for new projects in the group.
- only_
allow_ boolmerge_ if_ pipeline_ succeeds - Default to only allowing merge if the pipeline succeeds for new projects in the group.
- parent_
id int - Integer, ID of the parent group.
- path str
- The path of the group.
- prevent_
forking_ booloutside_ group - When enabled, users can not fork projects from this group to external namespaces.
- prevent_
sharing_ boolgroups_ outside_ hierarchy - When enabled, users cannot invite other groups outside of the top-level group's hierarchy. This option is only available for top-level groups.
- project_
creation_ strlevel - Determine which roles can create projects in the group. Possible values are
noone,maintainer,developer,owner,administrator. - push_
rules Sequence[GetGroup Push Rule] - Push rules for the group. Push rules are only available on Premium and Ultimate plans, and only if the authenticated user has permission to read them.
- repository_
storage str - Repository storage shard the group's projects use. (admin only)
- request_
access_ boolenabled - Boolean, is request for access enabled to the group.
- require_
two_ boolfactor_ authentication - Require all users in this group to set up two-factor authentication.
- runners_
token str - The group level registration token to use during runner setup.
- bool
- Prevent sharing a project with another group within this group.
- int
- Available in Self-Managed, Premium and Ultimate plans. Can be set by administrators only. Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.
- str
- Enable or disable shared runners for a group's subgroups and projects. Valid values are:
enabled,disabledAndOverridable,disabledAndUnoverridable,disabledWithOverride. -
Sequence[Get
Group Shared With Group] - Describes groups which have access shared to this group.
- statistics Mapping[str, int]
- Statistics for the group. Keys:
commitCount,storageSize,repositorySize,wikiSize,lfsObjectsSize,jobArtifactsSize,pipelineArtifactsSize,packagesSize,snippetsSize,uploadsSize,containerRegistrySize. - subgroup_
creation_ strlevel - Determine which roles can create subgroups in the group. Possible values are
owner,maintainer. - two_
factor_ intgrace_ period - Grace period, in hours, before enforcing two-factor authentication on group members.
- visibility_
level str - Visibility level of the group. Possible values are
private,internal,public. - web_
url str - Web URL of the group.
- wiki_
access_ strlevel - The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are
disabled,private,enabled.
- allow
Merge BooleanOn Skipped Pipeline - Default to allowing merge on a skipped pipeline for new projects in the group.
- allowed
Email StringDomains List - Comma-separated list of email address domains allowed to be added as group members.
- auto
Devops BooleanEnabled - Default to Auto DevOps pipeline for all projects within this group.
- avatar
Url String - URL of the group avatar.
- created
At String - Timestamp at which the group was created.
- custom
Attributes List<Map<String>> - Custom attributes attached to the group. Each entry is a map with
keyandvalue. Requires administrator privileges to read. - default
Branch String - The default branch of the group.
- default
Branch NumberProtection - Whether developers and maintainers can push to the applicable default branch. Use
defaultBranchProtectionDefaultsinstead, to be removed in 19.0. - default
Branch List<Property Map>Protection Defaults - Default protection settings applied to the default branch of new projects in this group.
- description String
- The description of the group.
- emails
Disabled Boolean - Whether email notifications are disabled for this group. Use
emailsEnabledinstead, to be removed in 19.0. - emails
Enabled Boolean - Whether email notifications are enabled for this group.
- Number
- Available in Self-Managed, Premium and Ultimate plans. Can be set by administrators only. Additional CI/CD minutes for this group.
- file
Template NumberProject Id - The ID of the project used to load custom file templates.
- full
Name String - The full name of the group.
- full
Path String - The full path of the group.
- group
Id Number - The ID of the group.
- id String
- The ID of this datasource. In the format
<group-id>. - ip
Restriction StringRanges - Comma-separated list of IP addresses or subnet masks that restrict access to the group.
- ldap
Access Number - Default access level for members synced from LDAP.
- ldap
Cn String - LDAP common name used to sync members from an LDAP group.
- lfs
Enabled Boolean - Boolean, is LFS enabled for projects in this group.
- marked
For StringDeletion On - Date on which the group was marked for deletion.
- max
Artifacts NumberSize - Maximum artifacts size for the group, in MB.
- membership
Lock Boolean - Users cannot be added to projects in this group.
- mentions
Disabled Boolean - Whether mentions are disabled for this group.
- name String
- The name of this group.
- only
Allow BooleanMerge If All Discussions Are Resolved - Default to only allowing merge if all discussions are resolved for new projects in the group.
- only
Allow BooleanMerge If Pipeline Succeeds - Default to only allowing merge if the pipeline succeeds for new projects in the group.
- parent
Id Number - Integer, ID of the parent group.
- path String
- The path of the group.
- prevent
Forking BooleanOutside Group - When enabled, users can not fork projects from this group to external namespaces.
- prevent
Sharing BooleanGroups Outside Hierarchy - When enabled, users cannot invite other groups outside of the top-level group's hierarchy. This option is only available for top-level groups.
- project
Creation StringLevel - Determine which roles can create projects in the group. Possible values are
noone,maintainer,developer,owner,administrator. - push
Rules List<Property Map> - Push rules for the group. Push rules are only available on Premium and Ultimate plans, and only if the authenticated user has permission to read them.
- repository
Storage String - Repository storage shard the group's projects use. (admin only)
- request
Access BooleanEnabled - Boolean, is request for access enabled to the group.
- require
Two BooleanFactor Authentication - Require all users in this group to set up two-factor authentication.
- runners
Token String - The group level registration token to use during runner setup.
- Boolean
- Prevent sharing a project with another group within this group.
- Number
- Available in Self-Managed, Premium and Ultimate plans. Can be set by administrators only. Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.
- String
- Enable or disable shared runners for a group's subgroups and projects. Valid values are:
enabled,disabledAndOverridable,disabledAndUnoverridable,disabledWithOverride. - List<Property Map>
- Describes groups which have access shared to this group.
- statistics Map<Number>
- Statistics for the group. Keys:
commitCount,storageSize,repositorySize,wikiSize,lfsObjectsSize,jobArtifactsSize,pipelineArtifactsSize,packagesSize,snippetsSize,uploadsSize,containerRegistrySize. - subgroup
Creation StringLevel - Determine which roles can create subgroups in the group. Possible values are
owner,maintainer. - two
Factor NumberGrace Period - Grace period, in hours, before enforcing two-factor authentication on group members.
- visibility
Level String - Visibility level of the group. Possible values are
private,internal,public. - web
Url String - Web URL of the group.
- wiki
Access StringLevel - The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are
disabled,private,enabled.
Supporting Types
GetGroupDefaultBranchProtectionDefault
- Allow
Force boolPush - Whether force-push is allowed to the default branch.
- Allowed
To List<Pulumi.Merges Git Lab. Inputs. Get Group Default Branch Protection Default Allowed To Merge> - Access levels allowed to merge into the default branch.
- Allowed
To List<Pulumi.Pushes Git Lab. Inputs. Get Group Default Branch Protection Default Allowed To Push> - Access levels allowed to push to the default branch.
- Code
Owner boolApproval Required - Whether code-owner approval is required on the default branch.
- Developer
Can boolInitial Push - Whether developers can make the initial push to the default branch.
- Allow
Force boolPush - Whether force-push is allowed to the default branch.
- Allowed
To []GetMerges Group Default Branch Protection Default Allowed To Merge - Access levels allowed to merge into the default branch.
- Allowed
To []GetPushes Group Default Branch Protection Default Allowed To Push - Access levels allowed to push to the default branch.
- Code
Owner boolApproval Required - Whether code-owner approval is required on the default branch.
- Developer
Can boolInitial Push - Whether developers can make the initial push to the default branch.
- allow_
force_ boolpush - Whether force-push is allowed to the default branch.
- allowed_
to_ list(object)merges - Access levels allowed to merge into the default branch.
- allowed_
to_ list(object)pushes - Access levels allowed to push to the default branch.
- code_
owner_ boolapproval_ required - Whether code-owner approval is required on the default branch.
- developer_
can_ boolinitial_ push - Whether developers can make the initial push to the default branch.
- allow
Force BooleanPush - Whether force-push is allowed to the default branch.
- allowed
To List<GetMerges Group Default Branch Protection Default Allowed To Merge> - Access levels allowed to merge into the default branch.
- allowed
To List<GetPushes Group Default Branch Protection Default Allowed To Push> - Access levels allowed to push to the default branch.
- code
Owner BooleanApproval Required - Whether code-owner approval is required on the default branch.
- developer
Can BooleanInitial Push - Whether developers can make the initial push to the default branch.
- allow
Force booleanPush - Whether force-push is allowed to the default branch.
- allowed
To GetMerges Group Default Branch Protection Default Allowed To Merge[] - Access levels allowed to merge into the default branch.
- allowed
To GetPushes Group Default Branch Protection Default Allowed To Push[] - Access levels allowed to push to the default branch.
- code
Owner booleanApproval Required - Whether code-owner approval is required on the default branch.
- developer
Can booleanInitial Push - Whether developers can make the initial push to the default branch.
- allow_
force_ boolpush - Whether force-push is allowed to the default branch.
- allowed_
to_ Sequence[Getmerges Group Default Branch Protection Default Allowed To Merge] - Access levels allowed to merge into the default branch.
- allowed_
to_ Sequence[Getpushes Group Default Branch Protection Default Allowed To Push] - Access levels allowed to push to the default branch.
- code_
owner_ boolapproval_ required - Whether code-owner approval is required on the default branch.
- developer_
can_ boolinitial_ push - Whether developers can make the initial push to the default branch.
- allow
Force BooleanPush - Whether force-push is allowed to the default branch.
- allowed
To List<Property Map>Merges - Access levels allowed to merge into the default branch.
- allowed
To List<Property Map>Pushes - Access levels allowed to push to the default branch.
- code
Owner BooleanApproval Required - Whether code-owner approval is required on the default branch.
- developer
Can BooleanInitial Push - Whether developers can make the initial push to the default branch.
GetGroupDefaultBranchProtectionDefaultAllowedToMerge
- Access
Level int - The access level integer.
- Access
Level int - The access level integer.
- access_
level number - The access level integer.
- access
Level Integer - The access level integer.
- access
Level number - The access level integer.
- access_
level int - The access level integer.
- access
Level Number - The access level integer.
GetGroupDefaultBranchProtectionDefaultAllowedToPush
- Access
Level int - The access level integer.
- Access
Level int - The access level integer.
- access_
level number - The access level integer.
- access
Level Integer - The access level integer.
- access
Level number - The access level integer.
- access_
level int - The access level integer.
- access
Level Number - The access level integer.
GetGroupPushRule
- string
- All commit author emails must match this regex, e.g.
@my-company.com$. - Branch
Name stringRegex - All branch names must match this regex, e.g.
(feature|hotfix)\/*. - Commit
Committer boolCheck - Users can only push commits to projects in this group that were committed with one of their own verified emails.
- Commit
Committer boolName Check - Users can only push commits to projects in this group if the commit author name is consistent with their GitLab account name.
- Commit
Message stringNegative Regex - No commit message is allowed to match this regex, for example
ssh\:\/\/. - Commit
Message stringRegex - All commit messages must match this regex, e.g.
Fixed \d+\..*. - Deny
Delete boolTag - Deny deleting a tag.
- File
Name stringRegex - All committed filenames must not match this regex, e.g.
(jar|exe)$. - Max
File intSize - Maximum file size (MB).
- Member
Check bool - Restrict commits by author (email) to existing GitLab users.
- Prevent
Secrets bool - GitLab will reject any files that are likely to contain secrets.
- Reject
Non boolDco Commits - Reject commit when it's not DCO certified.
- Reject
Unsigned boolCommits - Reject commit when it's not signed through GPG.
- string
- All commit author emails must match this regex, e.g.
@my-company.com$. - Branch
Name stringRegex - All branch names must match this regex, e.g.
(feature|hotfix)\/*. - Commit
Committer boolCheck - Users can only push commits to projects in this group that were committed with one of their own verified emails.
- Commit
Committer boolName Check - Users can only push commits to projects in this group if the commit author name is consistent with their GitLab account name.
- Commit
Message stringNegative Regex - No commit message is allowed to match this regex, for example
ssh\:\/\/. - Commit
Message stringRegex - All commit messages must match this regex, e.g.
Fixed \d+\..*. - Deny
Delete boolTag - Deny deleting a tag.
- File
Name stringRegex - All committed filenames must not match this regex, e.g.
(jar|exe)$. - Max
File intSize - Maximum file size (MB).
- Member
Check bool - Restrict commits by author (email) to existing GitLab users.
- Prevent
Secrets bool - GitLab will reject any files that are likely to contain secrets.
- Reject
Non boolDco Commits - Reject commit when it's not DCO certified.
- Reject
Unsigned boolCommits - Reject commit when it's not signed through GPG.
- string
- All commit author emails must match this regex, e.g.
@my-company.com$. - branch_
name_ stringregex - All branch names must match this regex, e.g.
(feature|hotfix)\/*. - commit_
committer_ boolcheck - Users can only push commits to projects in this group that were committed with one of their own verified emails.
- commit_
committer_ boolname_ check - Users can only push commits to projects in this group if the commit author name is consistent with their GitLab account name.
- commit_
message_ stringnegative_ regex - No commit message is allowed to match this regex, for example
ssh\:\/\/. - commit_
message_ stringregex - All commit messages must match this regex, e.g.
Fixed \d+\..*. - deny_
delete_ booltag - Deny deleting a tag.
- file_
name_ stringregex - All committed filenames must not match this regex, e.g.
(jar|exe)$. - max_
file_ numbersize - Maximum file size (MB).
- member_
check bool - Restrict commits by author (email) to existing GitLab users.
- prevent_
secrets bool - GitLab will reject any files that are likely to contain secrets.
- reject_
non_ booldco_ commits - Reject commit when it's not DCO certified.
- reject_
unsigned_ boolcommits - Reject commit when it's not signed through GPG.
- String
- All commit author emails must match this regex, e.g.
@my-company.com$. - branch
Name StringRegex - All branch names must match this regex, e.g.
(feature|hotfix)\/*. - commit
Committer BooleanCheck - Users can only push commits to projects in this group that were committed with one of their own verified emails.
- commit
Committer BooleanName Check - Users can only push commits to projects in this group if the commit author name is consistent with their GitLab account name.
- commit
Message StringNegative Regex - No commit message is allowed to match this regex, for example
ssh\:\/\/. - commit
Message StringRegex - All commit messages must match this regex, e.g.
Fixed \d+\..*. - deny
Delete BooleanTag - Deny deleting a tag.
- file
Name StringRegex - All committed filenames must not match this regex, e.g.
(jar|exe)$. - max
File IntegerSize - Maximum file size (MB).
- member
Check Boolean - Restrict commits by author (email) to existing GitLab users.
- prevent
Secrets Boolean - GitLab will reject any files that are likely to contain secrets.
- reject
Non BooleanDco Commits - Reject commit when it's not DCO certified.
- reject
Unsigned BooleanCommits - Reject commit when it's not signed through GPG.
- string
- All commit author emails must match this regex, e.g.
@my-company.com$. - branch
Name stringRegex - All branch names must match this regex, e.g.
(feature|hotfix)\/*. - commit
Committer booleanCheck - Users can only push commits to projects in this group that were committed with one of their own verified emails.
- commit
Committer booleanName Check - Users can only push commits to projects in this group if the commit author name is consistent with their GitLab account name.
- commit
Message stringNegative Regex - No commit message is allowed to match this regex, for example
ssh\:\/\/. - commit
Message stringRegex - All commit messages must match this regex, e.g.
Fixed \d+\..*. - deny
Delete booleanTag - Deny deleting a tag.
- file
Name stringRegex - All committed filenames must not match this regex, e.g.
(jar|exe)$. - max
File numberSize - Maximum file size (MB).
- member
Check boolean - Restrict commits by author (email) to existing GitLab users.
- prevent
Secrets boolean - GitLab will reject any files that are likely to contain secrets.
- reject
Non booleanDco Commits - Reject commit when it's not DCO certified.
- reject
Unsigned booleanCommits - Reject commit when it's not signed through GPG.
- str
- All commit author emails must match this regex, e.g.
@my-company.com$. - branch_
name_ strregex - All branch names must match this regex, e.g.
(feature|hotfix)\/*. - commit_
committer_ boolcheck - Users can only push commits to projects in this group that were committed with one of their own verified emails.
- commit_
committer_ boolname_ check - Users can only push commits to projects in this group if the commit author name is consistent with their GitLab account name.
- commit_
message_ strnegative_ regex - No commit message is allowed to match this regex, for example
ssh\:\/\/. - commit_
message_ strregex - All commit messages must match this regex, e.g.
Fixed \d+\..*. - deny_
delete_ booltag - Deny deleting a tag.
- file_
name_ strregex - All committed filenames must not match this regex, e.g.
(jar|exe)$. - max_
file_ intsize - Maximum file size (MB).
- member_
check bool - Restrict commits by author (email) to existing GitLab users.
- prevent_
secrets bool - GitLab will reject any files that are likely to contain secrets.
- reject_
non_ booldco_ commits - Reject commit when it's not DCO certified.
- reject_
unsigned_ boolcommits - Reject commit when it's not signed through GPG.
- String
- All commit author emails must match this regex, e.g.
@my-company.com$. - branch
Name StringRegex - All branch names must match this regex, e.g.
(feature|hotfix)\/*. - commit
Committer BooleanCheck - Users can only push commits to projects in this group that were committed with one of their own verified emails.
- commit
Committer BooleanName Check - Users can only push commits to projects in this group if the commit author name is consistent with their GitLab account name.
- commit
Message StringNegative Regex - No commit message is allowed to match this regex, for example
ssh\:\/\/. - commit
Message StringRegex - All commit messages must match this regex, e.g.
Fixed \d+\..*. - deny
Delete BooleanTag - Deny deleting a tag.
- file
Name StringRegex - All committed filenames must not match this regex, e.g.
(jar|exe)$. - max
File NumberSize - Maximum file size (MB).
- member
Check Boolean - Restrict commits by author (email) to existing GitLab users.
- prevent
Secrets Boolean - GitLab will reject any files that are likely to contain secrets.
- reject
Non BooleanDco Commits - Reject commit when it's not DCO certified.
- reject
Unsigned BooleanCommits - Reject commit when it's not signed through GPG.
GetGroupSharedWithGroup
- Expires
At string - Share with group expiration date.
- Group
Access intLevel - The accessLevel permission level of the shared group.
- Group
Full stringPath - The full path of the group shared with.
- Group
Id int - The ID of the group shared with.
- Group
Name string - The name of the group shared with.
- Expires
At string - Share with group expiration date.
- Group
Access intLevel - The accessLevel permission level of the shared group.
- Group
Full stringPath - The full path of the group shared with.
- Group
Id int - The ID of the group shared with.
- Group
Name string - The name of the group shared with.
- expires_
at string - Share with group expiration date.
- group_
access_ numberlevel - The accessLevel permission level of the shared group.
- group_
full_ stringpath - The full path of the group shared with.
- group_
id number - The ID of the group shared with.
- group_
name string - The name of the group shared with.
- expires
At String - Share with group expiration date.
- group
Access IntegerLevel - The accessLevel permission level of the shared group.
- group
Full StringPath - The full path of the group shared with.
- group
Id Integer - The ID of the group shared with.
- group
Name String - The name of the group shared with.
- expires
At string - Share with group expiration date.
- group
Access numberLevel - The accessLevel permission level of the shared group.
- group
Full stringPath - The full path of the group shared with.
- group
Id number - The ID of the group shared with.
- group
Name string - The name of the group shared with.
- expires_
at str - Share with group expiration date.
- group_
access_ intlevel - The accessLevel permission level of the shared group.
- group_
full_ strpath - The full path of the group shared with.
- group_
id int - The ID of the group shared with.
- group_
name str - The name of the group shared with.
- expires
At String - Share with group expiration date.
- group
Access NumberLevel - The accessLevel permission level of the shared group.
- group
Full StringPath - The full path of the group shared with.
- group
Id Number - The ID of the group shared with.
- group
Name String - The name of the group shared with.
Package Details
- Repository
- GitLab pulumi/pulumi-gitlab
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
gitlabTerraform Provider.
Viewing docs for GitLab v10.0.0
published on Friday, Jun 26, 2026 by Pulumi
published on Friday, Jun 26, 2026 by Pulumi