Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Gitlab Provider
  4. API Docs
  5. getGroups
Viewing docs for GitLab v10.0.0
published on Friday, Jun 26, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gitlab

gitlab.getGroups

gitlab logo
Viewing docs for GitLab v10.0.0
published on Friday, Jun 26, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gitlab

    The gitlab.getGroups data source allows details of multiple groups to be retrieved given some optional filter criteria.

    Some attributes might not be returned depending on if you’re an admin or not.

    Some available options require administrator privileges.

    Upstream API: GitLab REST API docs

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const example = gitlab.getGroups({
    sort: "desc",
    orderBy: "name",
});
const example_two = gitlab.getGroups({
    search: "GitLab",
});

    import pulumi
import pulumi_gitlab as gitlab

example = gitlab.get_groups(sort="desc",
    order_by="name")
example_two = gitlab.get_groups(search="GitLab")

    package main

import (
	"github.com/pulumi/pulumi-gitlab/sdk/v10/go/gitlab"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gitlab.GetGroups(ctx, &gitlab.GetGroupsArgs{
			Sort:    pulumi.StringRef("desc"),
			OrderBy: pulumi.StringRef("name"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = gitlab.GetGroups(ctx, &gitlab.GetGroupsArgs{
			Search: pulumi.StringRef("GitLab"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;

return await Deployment.RunAsync(() => 
{
    var example = GitLab.GetGroups.Invoke(new()
    {
        Sort = "desc",
        OrderBy = "name",
    });

    var example_two = GitLab.GetGroups.Invoke(new()
    {
        Search = "GitLab",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.GitlabFunctions;
import com.pulumi.gitlab.inputs.GetGroupsArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = GitlabFunctions.getGroups(GetGroupsArgs.builder()
            .sort("desc")
            .orderBy("name")
            .build());

        final var example-two = GitlabFunctions.getGroups(GetGroupsArgs.builder()
            .search("GitLab")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: gitlab:getGroups
      arguments:
        sort: desc
        orderBy: name
  example-two:
    fn::invoke:
      function: gitlab:getGroups
      arguments:
        search: GitLab

    pulumi {
  required_providers {
    gitlab = {
      source = "pulumi/gitlab"
    }
  }
}

data "gitlab_getgroups" "example" {
  sort     = "desc"
  order_by = "name"
}
data "gitlab_getgroups" "example-two" {
  search = "GitLab"
}

    Using getGroups

    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 getGroups(args: GetGroupsArgs, opts?: InvokeOptions): Promise<GetGroupsResult>
function getGroupsOutput(args: GetGroupsOutputArgs, opts?: InvokeOptions): Output<GetGroupsResult>
    def get_groups(order_by: Optional[str] = None,
               search: Optional[str] = None,
               sort: Optional[str] = None,
               top_level_only: Optional[bool] = None,
               opts: Optional[InvokeOptions] = None) -> GetGroupsResult
def get_groups_output(order_by: pulumi.Input[Optional[str]] = None,
               search: pulumi.Input[Optional[str]] = None,
               sort: pulumi.Input[Optional[str]] = None,
               top_level_only: pulumi.Input[Optional[bool]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetGroupsResult]
    func GetGroups(ctx *Context, args *GetGroupsArgs, opts ...InvokeOption) (*GetGroupsResult, error)
func GetGroupsOutput(ctx *Context, args *GetGroupsOutputArgs, opts ...InvokeOption) GetGroupsResultOutput

    > Note: This function is named GetGroups in the Go SDK.

    public static class GetGroups 
{
    public static Task<GetGroupsResult> InvokeAsync(GetGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupsResult> Invoke(GetGroupsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)
public static Output<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)

    fn::invoke:
  function: gitlab:index/getGroups:getGroups
  arguments:
    # arguments dictionary
    data "gitlab_getgroups" "name" {
    # arguments
}

    The following arguments are supported:

    OrderBy string
    Order the groups' list by id, name, path, or similarity. (Requires administrator privileges)
    Search string
    Search groups by name or path.
    Sort string
    Sort groups' list in asc or desc order. (Requires administrator privileges)
    TopLevelOnly bool
    Limit to top level groups, excluding all subgroups.
    OrderBy string
    Order the groups' list by id, name, path, or similarity. (Requires administrator privileges)
    Search string
    Search groups by name or path.
    Sort string
    Sort groups' list in asc or desc order. (Requires administrator privileges)
    TopLevelOnly bool
    Limit to top level groups, excluding all subgroups.
    order_by string
    Order the groups' list by id, name, path, or similarity. (Requires administrator privileges)
    search string
    Search groups by name or path.
    sort string
    Sort groups' list in asc or desc order. (Requires administrator privileges)
    top_level_only bool
    Limit to top level groups, excluding all subgroups.
    orderBy String
    Order the groups' list by id, name, path, or similarity. (Requires administrator privileges)
    search String
    Search groups by name or path.
    sort String
    Sort groups' list in asc or desc order. (Requires administrator privileges)
    topLevelOnly Boolean
    Limit to top level groups, excluding all subgroups.
    orderBy string
    Order the groups' list by id, name, path, or similarity. (Requires administrator privileges)
    search string
    Search groups by name or path.
    sort string
    Sort groups' list in asc or desc order. (Requires administrator privileges)
    topLevelOnly boolean
    Limit to top level groups, excluding all subgroups.
    order_by str
    Order the groups' list by id, name, path, or similarity. (Requires administrator privileges)
    search str
    Search groups by name or path.
    sort str
    Sort groups' list in asc or desc order. (Requires administrator privileges)
    top_level_only bool
    Limit to top level groups, excluding all subgroups.
    orderBy String
    Order the groups' list by id, name, path, or similarity. (Requires administrator privileges)
    search String
    Search groups by name or path.
    sort String
    Sort groups' list in asc or desc order. (Requires administrator privileges)
    topLevelOnly Boolean
    Limit to top level groups, excluding all subgroups.

    getGroups Result

    The following output properties are available:

    Groups List<Pulumi.GitLab.Outputs.GetGroupsGroup>
    The list of groups.
    Id string
    The ID of this datasource. In the format of a hash of the provided search attributes.
    OrderBy string
    Order the groups' list by id, name, path, or similarity. (Requires administrator privileges)
    Search string
    Search groups by name or path.
    Sort string
    Sort groups' list in asc or desc order. (Requires administrator privileges)
    TopLevelOnly bool
    Limit to top level groups, excluding all subgroups.
    Groups []GetGroupsGroup
    The list of groups.
    Id string
    The ID of this datasource. In the format of a hash of the provided search attributes.
    OrderBy string
    Order the groups' list by id, name, path, or similarity. (Requires administrator privileges)
    Search string
    Search groups by name or path.
    Sort string
    Sort groups' list in asc or desc order. (Requires administrator privileges)
    TopLevelOnly bool
    Limit to top level groups, excluding all subgroups.
    groups list(object)
    The list of groups.
    id string
    The ID of this datasource. In the format of a hash of the provided search attributes.
    order_by string
    Order the groups' list by id, name, path, or similarity. (Requires administrator privileges)
    search string
    Search groups by name or path.
    sort string
    Sort groups' list in asc or desc order. (Requires administrator privileges)
    top_level_only bool
    Limit to top level groups, excluding all subgroups.
    groups List<GetGroupsGroup>
    The list of groups.
    id String
    The ID of this datasource. In the format of a hash of the provided search attributes.
    orderBy String
    Order the groups' list by id, name, path, or similarity. (Requires administrator privileges)
    search String
    Search groups by name or path.
    sort String
    Sort groups' list in asc or desc order. (Requires administrator privileges)
    topLevelOnly Boolean
    Limit to top level groups, excluding all subgroups.
    groups GetGroupsGroup[]
    The list of groups.
    id string
    The ID of this datasource. In the format of a hash of the provided search attributes.
    orderBy string
    Order the groups' list by id, name, path, or similarity. (Requires administrator privileges)
    search string
    Search groups by name or path.
    sort string
    Sort groups' list in asc or desc order. (Requires administrator privileges)
    topLevelOnly boolean
    Limit to top level groups, excluding all subgroups.
    groups Sequence[GetGroupsGroup]
    The list of groups.
    id str
    The ID of this datasource. In the format of a hash of the provided search attributes.
    order_by str
    Order the groups' list by id, name, path, or similarity. (Requires administrator privileges)
    search str
    Search groups by name or path.
    sort str
    Sort groups' list in asc or desc order. (Requires administrator privileges)
    top_level_only bool
    Limit to top level groups, excluding all subgroups.
    groups List<Property Map>
    The list of groups.
    id String
    The ID of this datasource. In the format of a hash of the provided search attributes.
    orderBy String
    Order the groups' list by id, name, path, or similarity. (Requires administrator privileges)
    search String
    Search groups by name or path.
    sort String
    Sort groups' list in asc or desc order. (Requires administrator privileges)
    topLevelOnly Boolean
    Limit to top level groups, excluding all subgroups.

    Supporting Types

    GetGroupsGroup

    AllowMergeOnSkippedPipeline bool
    Default to allowing merge on a skipped pipeline for new projects in the group.
    AllowedEmailDomainsList string
    Comma-separated list of email address domains allowed to be added as group members.
    AutoDevopsEnabled bool
    Default to Auto DevOps pipeline for all projects within this group.
    AvatarUrl string
    URL of the group avatar.
    CreatedAt string
    Timestamp at which the group was created.
    CustomAttributes List<ImmutableDictionary<string, string>>
    Custom attributes attached to the group. Each entry is a map with key and value. Requires administrator privileges to read.
    DefaultBranch string
    The default branch of the group.
    DefaultBranchProtection int
    Whether developers and maintainers can push to the applicable default branch. Use defaultBranchProtectionDefaults instead, to be removed in 19.0.

    Deprecated: Use defaultBranchProtectionDefaults instead, to be removed in 19.0.

    DefaultBranchProtectionDefaults List<Pulumi.GitLab.Inputs.GetGroupsGroupDefaultBranchProtectionDefault>
    Default protection settings applied to the default branch of new projects in this group.
    Description string
    The description of the group.
    EmailsDisabled bool
    Whether email notifications are disabled for this group. Use emailsEnabled instead, to be removed in 19.0.

    Deprecated: Use emailsEnabled instead, to be removed in 19.0.

    EmailsEnabled bool
    Whether email notifications are enabled for this group.
    ExtraSharedRunnersMinutesLimit int
    Available in Self-Managed, Premium and Ultimate plans. Can be set by administrators only. Additional CI/CD minutes for this group.
    FileTemplateProjectId int
    The ID of the project used to load custom file templates.
    FullName string
    The full name of the group.
    FullPath string
    The full path of the group.
    GroupId int
    The ID of the group.
    IpRestrictionRanges string
    Comma-separated list of IP addresses or subnet masks that restrict access to the group.
    LdapAccess int
    Default access level for members synced from LDAP.
    LdapCn string
    LDAP common name used to sync members from an LDAP group.
    LfsEnabled bool
    Boolean, is LFS enabled for projects in this group.
    MarkedForDeletionOn string
    Date on which the group was marked for deletion.
    MaxArtifactsSize int
    Maximum artifacts size for the group, in MB.
    MembershipLock bool
    Users cannot be added to projects in this group.
    MentionsDisabled bool
    Whether mentions are disabled for this group.
    Name string
    The name of this group.
    OnlyAllowMergeIfAllDiscussionsAreResolved bool
    Default to only allowing merge if all discussions are resolved for new projects in the group.
    OnlyAllowMergeIfPipelineSucceeds bool
    Default to only allowing merge if the pipeline succeeds for new projects in the group.
    ParentId int
    Integer, ID of the parent group.
    Path string
    The path of the group.
    PreventForkingOutsideGroup bool
    When enabled, users can not fork projects from this group to external namespaces.
    PreventSharingGroupsOutsideHierarchy bool
    When enabled, users cannot invite other groups outside of the top-level group's hierarchy. This option is only available for top-level groups.
    ProjectCreationLevel string
    Determine which roles can create projects in the group. Possible values are noone, maintainer, developer, owner, administrator.
    RepositoryStorage string
    Repository storage shard the group's projects use. (admin only)
    RequestAccessEnabled bool
    Boolean, is request for access enabled to the group.
    RequireTwoFactorAuthentication bool
    Require all users in this group to set up two-factor authentication.
    RunnersToken string
    The group level registration token to use during runner setup.
    ShareWithGroupLock bool
    Prevent sharing a project with another group within this group.
    SharedRunnersMinutesLimit 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.
    SharedRunnersSetting string
    Enable or disable shared runners for a group's subgroups and projects. Valid values are: enabled, disabledAndOverridable, disabledAndUnoverridable, disabledWithOverride.
    SharedWithGroups List<Pulumi.GitLab.Inputs.GetGroupsGroupSharedWithGroup>
    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.
    SubgroupCreationLevel string
    Determine which roles can create subgroups in the group. Possible values are owner, maintainer.
    TwoFactorGracePeriod int
    Grace period, in hours, before enforcing two-factor authentication on group members.
    VisibilityLevel string
    Visibility level of the group. Possible values are private, internal, public.
    WebUrl string
    Web URL of the group.
    WikiAccessLevel string
    The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.
    AllowMergeOnSkippedPipeline bool
    Default to allowing merge on a skipped pipeline for new projects in the group.
    AllowedEmailDomainsList string
    Comma-separated list of email address domains allowed to be added as group members.
    AutoDevopsEnabled bool
    Default to Auto DevOps pipeline for all projects within this group.
    AvatarUrl string
    URL of the group avatar.
    CreatedAt string
    Timestamp at which the group was created.
    CustomAttributes []map[string]string
    Custom attributes attached to the group. Each entry is a map with key and value. Requires administrator privileges to read.
    DefaultBranch string
    The default branch of the group.
    DefaultBranchProtection int
    Whether developers and maintainers can push to the applicable default branch. Use defaultBranchProtectionDefaults instead, to be removed in 19.0.

    Deprecated: Use defaultBranchProtectionDefaults instead, to be removed in 19.0.

    DefaultBranchProtectionDefaults []GetGroupsGroupDefaultBranchProtectionDefault
    Default protection settings applied to the default branch of new projects in this group.
    Description string
    The description of the group.
    EmailsDisabled bool
    Whether email notifications are disabled for this group. Use emailsEnabled instead, to be removed in 19.0.

    Deprecated: Use emailsEnabled instead, to be removed in 19.0.

    EmailsEnabled bool
    Whether email notifications are enabled for this group.
    ExtraSharedRunnersMinutesLimit int
    Available in Self-Managed, Premium and Ultimate plans. Can be set by administrators only. Additional CI/CD minutes for this group.
    FileTemplateProjectId int
    The ID of the project used to load custom file templates.
    FullName string
    The full name of the group.
    FullPath string
    The full path of the group.
    GroupId int
    The ID of the group.
    IpRestrictionRanges string
    Comma-separated list of IP addresses or subnet masks that restrict access to the group.
    LdapAccess int
    Default access level for members synced from LDAP.
    LdapCn string
    LDAP common name used to sync members from an LDAP group.
    LfsEnabled bool
    Boolean, is LFS enabled for projects in this group.
    MarkedForDeletionOn string
    Date on which the group was marked for deletion.
    MaxArtifactsSize int
    Maximum artifacts size for the group, in MB.
    MembershipLock bool
    Users cannot be added to projects in this group.
    MentionsDisabled bool
    Whether mentions are disabled for this group.
    Name string
    The name of this group.
    OnlyAllowMergeIfAllDiscussionsAreResolved bool
    Default to only allowing merge if all discussions are resolved for new projects in the group.
    OnlyAllowMergeIfPipelineSucceeds bool
    Default to only allowing merge if the pipeline succeeds for new projects in the group.
    ParentId int
    Integer, ID of the parent group.
    Path string
    The path of the group.
    PreventForkingOutsideGroup bool
    When enabled, users can not fork projects from this group to external namespaces.
    PreventSharingGroupsOutsideHierarchy bool
    When enabled, users cannot invite other groups outside of the top-level group's hierarchy. This option is only available for top-level groups.
    ProjectCreationLevel string
    Determine which roles can create projects in the group. Possible values are noone, maintainer, developer, owner, administrator.
    RepositoryStorage string
    Repository storage shard the group's projects use. (admin only)
    RequestAccessEnabled bool
    Boolean, is request for access enabled to the group.
    RequireTwoFactorAuthentication bool
    Require all users in this group to set up two-factor authentication.
    RunnersToken string
    The group level registration token to use during runner setup.
    ShareWithGroupLock bool
    Prevent sharing a project with another group within this group.
    SharedRunnersMinutesLimit 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.
    SharedRunnersSetting string
    Enable or disable shared runners for a group's subgroups and projects. Valid values are: enabled, disabledAndOverridable, disabledAndUnoverridable, disabledWithOverride.
    SharedWithGroups []GetGroupsGroupSharedWithGroup
    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.
    SubgroupCreationLevel string
    Determine which roles can create subgroups in the group. Possible values are owner, maintainer.
    TwoFactorGracePeriod int
    Grace period, in hours, before enforcing two-factor authentication on group members.
    VisibilityLevel string
    Visibility level of the group. Possible values are private, internal, public.
    WebUrl string
    Web URL of the group.
    WikiAccessLevel string
    The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.
    allow_merge_on_skipped_pipeline bool
    Default to allowing merge on a skipped pipeline for new projects in the group.
    allowed_email_domains_list string
    Comma-separated list of email address domains allowed to be added as group members.
    auto_devops_enabled bool
    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 key and value. Requires administrator privileges to read.
    default_branch string
    The default branch of the group.
    default_branch_protection number
    Whether developers and maintainers can push to the applicable default branch. Use defaultBranchProtectionDefaults instead, to be removed in 19.0.

    Deprecated: Use defaultBranchProtectionDefaults instead, to be removed in 19.0.

    default_branch_protection_defaults list(object)
    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 emailsEnabled instead, to be removed in 19.0.

    Deprecated: Use emailsEnabled instead, to be removed in 19.0.

    emails_enabled bool
    Whether email notifications are enabled for this group.
    extra_shared_runners_minutes_limit number
    Available in Self-Managed, Premium and Ultimate plans. Can be set by administrators only. Additional CI/CD minutes for this group.
    file_template_project_id number
    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.
    ip_restriction_ranges string
    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_deletion_on string
    Date on which the group was marked for deletion.
    max_artifacts_size number
    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_merge_if_all_discussions_are_resolved bool
    Default to only allowing merge if all discussions are resolved for new projects in the group.
    only_allow_merge_if_pipeline_succeeds bool
    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_outside_group bool
    When enabled, users can not fork projects from this group to external namespaces.
    prevent_sharing_groups_outside_hierarchy bool
    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_level string
    Determine which roles can create projects in the group. Possible values are noone, maintainer, developer, owner, administrator.
    repository_storage string
    Repository storage shard the group's projects use. (admin only)
    request_access_enabled bool
    Boolean, is request for access enabled to the group.
    require_two_factor_authentication bool
    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.
    share_with_group_lock bool
    Prevent sharing a project with another group within this group.
    shared_runners_minutes_limit 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.
    shared_runners_setting string
    Enable or disable shared runners for a group's subgroups and projects. Valid values are: enabled, disabledAndOverridable, disabledAndUnoverridable, disabledWithOverride.
    shared_with_groups 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_level string
    Determine which roles can create subgroups in the group. Possible values are owner, maintainer.
    two_factor_grace_period number
    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_level string
    The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.
    allowMergeOnSkippedPipeline Boolean
    Default to allowing merge on a skipped pipeline for new projects in the group.
    allowedEmailDomainsList String
    Comma-separated list of email address domains allowed to be added as group members.
    autoDevopsEnabled Boolean
    Default to Auto DevOps pipeline for all projects within this group.
    avatarUrl String
    URL of the group avatar.
    createdAt String
    Timestamp at which the group was created.
    customAttributes List<Map<String,String>>
    Custom attributes attached to the group. Each entry is a map with key and value. Requires administrator privileges to read.
    defaultBranch String
    The default branch of the group.
    defaultBranchProtection Integer
    Whether developers and maintainers can push to the applicable default branch. Use defaultBranchProtectionDefaults instead, to be removed in 19.0.

    Deprecated: Use defaultBranchProtectionDefaults instead, to be removed in 19.0.

    defaultBranchProtectionDefaults List<GetGroupsGroupDefaultBranchProtectionDefault>
    Default protection settings applied to the default branch of new projects in this group.
    description String
    The description of the group.
    emailsDisabled Boolean
    Whether email notifications are disabled for this group. Use emailsEnabled instead, to be removed in 19.0.

    Deprecated: Use emailsEnabled instead, to be removed in 19.0.

    emailsEnabled Boolean
    Whether email notifications are enabled for this group.
    extraSharedRunnersMinutesLimit Integer
    Available in Self-Managed, Premium and Ultimate plans. Can be set by administrators only. Additional CI/CD minutes for this group.
    fileTemplateProjectId Integer
    The ID of the project used to load custom file templates.
    fullName String
    The full name of the group.
    fullPath String
    The full path of the group.
    groupId Integer
    The ID of the group.
    ipRestrictionRanges String
    Comma-separated list of IP addresses or subnet masks that restrict access to the group.
    ldapAccess Integer
    Default access level for members synced from LDAP.
    ldapCn String
    LDAP common name used to sync members from an LDAP group.
    lfsEnabled Boolean
    Boolean, is LFS enabled for projects in this group.
    markedForDeletionOn String
    Date on which the group was marked for deletion.
    maxArtifactsSize Integer
    Maximum artifacts size for the group, in MB.
    membershipLock Boolean
    Users cannot be added to projects in this group.
    mentionsDisabled Boolean
    Whether mentions are disabled for this group.
    name String
    The name of this group.
    onlyAllowMergeIfAllDiscussionsAreResolved Boolean
    Default to only allowing merge if all discussions are resolved for new projects in the group.
    onlyAllowMergeIfPipelineSucceeds Boolean
    Default to only allowing merge if the pipeline succeeds for new projects in the group.
    parentId Integer
    Integer, ID of the parent group.
    path String
    The path of the group.
    preventForkingOutsideGroup Boolean
    When enabled, users can not fork projects from this group to external namespaces.
    preventSharingGroupsOutsideHierarchy Boolean
    When enabled, users cannot invite other groups outside of the top-level group's hierarchy. This option is only available for top-level groups.
    projectCreationLevel String
    Determine which roles can create projects in the group. Possible values are noone, maintainer, developer, owner, administrator.
    repositoryStorage String
    Repository storage shard the group's projects use. (admin only)
    requestAccessEnabled Boolean
    Boolean, is request for access enabled to the group.
    requireTwoFactorAuthentication Boolean
    Require all users in this group to set up two-factor authentication.
    runnersToken String
    The group level registration token to use during runner setup.
    shareWithGroupLock Boolean
    Prevent sharing a project with another group within this group.
    sharedRunnersMinutesLimit 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.
    sharedRunnersSetting String
    Enable or disable shared runners for a group's subgroups and projects. Valid values are: enabled, disabledAndOverridable, disabledAndUnoverridable, disabledWithOverride.
    sharedWithGroups List<GetGroupsGroupSharedWithGroup>
    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.
    subgroupCreationLevel String
    Determine which roles can create subgroups in the group. Possible values are owner, maintainer.
    twoFactorGracePeriod Integer
    Grace period, in hours, before enforcing two-factor authentication on group members.
    visibilityLevel String
    Visibility level of the group. Possible values are private, internal, public.
    webUrl String
    Web URL of the group.
    wikiAccessLevel String
    The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.
    allowMergeOnSkippedPipeline boolean
    Default to allowing merge on a skipped pipeline for new projects in the group.
    allowedEmailDomainsList string
    Comma-separated list of email address domains allowed to be added as group members.
    autoDevopsEnabled boolean
    Default to Auto DevOps pipeline for all projects within this group.
    avatarUrl string
    URL of the group avatar.
    createdAt string
    Timestamp at which the group was created.
    customAttributes {[key: string]: string}[]
    Custom attributes attached to the group. Each entry is a map with key and value. Requires administrator privileges to read.
    defaultBranch string
    The default branch of the group.
    defaultBranchProtection number
    Whether developers and maintainers can push to the applicable default branch. Use defaultBranchProtectionDefaults instead, to be removed in 19.0.

    Deprecated: Use defaultBranchProtectionDefaults instead, to be removed in 19.0.

    defaultBranchProtectionDefaults GetGroupsGroupDefaultBranchProtectionDefault[]
    Default protection settings applied to the default branch of new projects in this group.
    description string
    The description of the group.
    emailsDisabled boolean
    Whether email notifications are disabled for this group. Use emailsEnabled instead, to be removed in 19.0.

    Deprecated: Use emailsEnabled instead, to be removed in 19.0.

    emailsEnabled boolean
    Whether email notifications are enabled for this group.
    extraSharedRunnersMinutesLimit number
    Available in Self-Managed, Premium and Ultimate plans. Can be set by administrators only. Additional CI/CD minutes for this group.
    fileTemplateProjectId number
    The ID of the project used to load custom file templates.
    fullName string
    The full name of the group.
    fullPath string
    The full path of the group.
    groupId number
    The ID of the group.
    ipRestrictionRanges string
    Comma-separated list of IP addresses or subnet masks that restrict access to the group.
    ldapAccess number
    Default access level for members synced from LDAP.
    ldapCn string
    LDAP common name used to sync members from an LDAP group.
    lfsEnabled boolean
    Boolean, is LFS enabled for projects in this group.
    markedForDeletionOn string
    Date on which the group was marked for deletion.
    maxArtifactsSize number
    Maximum artifacts size for the group, in MB.
    membershipLock boolean
    Users cannot be added to projects in this group.
    mentionsDisabled boolean
    Whether mentions are disabled for this group.
    name string
    The name of this group.
    onlyAllowMergeIfAllDiscussionsAreResolved boolean
    Default to only allowing merge if all discussions are resolved for new projects in the group.
    onlyAllowMergeIfPipelineSucceeds boolean
    Default to only allowing merge if the pipeline succeeds for new projects in the group.
    parentId number
    Integer, ID of the parent group.
    path string
    The path of the group.
    preventForkingOutsideGroup boolean
    When enabled, users can not fork projects from this group to external namespaces.
    preventSharingGroupsOutsideHierarchy boolean
    When enabled, users cannot invite other groups outside of the top-level group's hierarchy. This option is only available for top-level groups.
    projectCreationLevel string
    Determine which roles can create projects in the group. Possible values are noone, maintainer, developer, owner, administrator.
    repositoryStorage string
    Repository storage shard the group's projects use. (admin only)
    requestAccessEnabled boolean
    Boolean, is request for access enabled to the group.
    requireTwoFactorAuthentication boolean
    Require all users in this group to set up two-factor authentication.
    runnersToken string
    The group level registration token to use during runner setup.
    shareWithGroupLock boolean
    Prevent sharing a project with another group within this group.
    sharedRunnersMinutesLimit 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.
    sharedRunnersSetting string
    Enable or disable shared runners for a group's subgroups and projects. Valid values are: enabled, disabledAndOverridable, disabledAndUnoverridable, disabledWithOverride.
    sharedWithGroups GetGroupsGroupSharedWithGroup[]
    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.
    subgroupCreationLevel string
    Determine which roles can create subgroups in the group. Possible values are owner, maintainer.
    twoFactorGracePeriod number
    Grace period, in hours, before enforcing two-factor authentication on group members.
    visibilityLevel string
    Visibility level of the group. Possible values are private, internal, public.
    webUrl string
    Web URL of the group.
    wikiAccessLevel string
    The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.
    allow_merge_on_skipped_pipeline bool
    Default to allowing merge on a skipped pipeline for new projects in the group.
    allowed_email_domains_list str
    Comma-separated list of email address domains allowed to be added as group members.
    auto_devops_enabled bool
    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 key and value. Requires administrator privileges to read.
    default_branch str
    The default branch of the group.
    default_branch_protection int
    Whether developers and maintainers can push to the applicable default branch. Use defaultBranchProtectionDefaults instead, to be removed in 19.0.

    Deprecated: Use defaultBranchProtectionDefaults instead, to be removed in 19.0.

    default_branch_protection_defaults Sequence[GetGroupsGroupDefaultBranchProtectionDefault]
    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 emailsEnabled instead, to be removed in 19.0.

    Deprecated: Use emailsEnabled instead, to be removed in 19.0.

    emails_enabled bool
    Whether email notifications are enabled for this group.
    extra_shared_runners_minutes_limit int
    Available in Self-Managed, Premium and Ultimate plans. Can be set by administrators only. Additional CI/CD minutes for this group.
    file_template_project_id int
    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.
    ip_restriction_ranges str
    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_deletion_on str
    Date on which the group was marked for deletion.
    max_artifacts_size int
    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_merge_if_all_discussions_are_resolved bool
    Default to only allowing merge if all discussions are resolved for new projects in the group.
    only_allow_merge_if_pipeline_succeeds bool
    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_outside_group bool
    When enabled, users can not fork projects from this group to external namespaces.
    prevent_sharing_groups_outside_hierarchy bool
    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_level str
    Determine which roles can create projects in the group. Possible values are noone, maintainer, developer, owner, administrator.
    repository_storage str
    Repository storage shard the group's projects use. (admin only)
    request_access_enabled bool
    Boolean, is request for access enabled to the group.
    require_two_factor_authentication bool
    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.
    share_with_group_lock bool
    Prevent sharing a project with another group within this group.
    shared_runners_minutes_limit 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.
    shared_runners_setting str
    Enable or disable shared runners for a group's subgroups and projects. Valid values are: enabled, disabledAndOverridable, disabledAndUnoverridable, disabledWithOverride.
    shared_with_groups Sequence[GetGroupsGroupSharedWithGroup]
    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_level str
    Determine which roles can create subgroups in the group. Possible values are owner, maintainer.
    two_factor_grace_period int
    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_level str
    The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.
    allowMergeOnSkippedPipeline Boolean
    Default to allowing merge on a skipped pipeline for new projects in the group.
    allowedEmailDomainsList String
    Comma-separated list of email address domains allowed to be added as group members.
    autoDevopsEnabled Boolean
    Default to Auto DevOps pipeline for all projects within this group.
    avatarUrl String
    URL of the group avatar.
    createdAt String
    Timestamp at which the group was created.
    customAttributes List<Map<String>>
    Custom attributes attached to the group. Each entry is a map with key and value. Requires administrator privileges to read.
    defaultBranch String
    The default branch of the group.
    defaultBranchProtection Number
    Whether developers and maintainers can push to the applicable default branch. Use defaultBranchProtectionDefaults instead, to be removed in 19.0.

    Deprecated: Use defaultBranchProtectionDefaults instead, to be removed in 19.0.

    defaultBranchProtectionDefaults List<Property Map>
    Default protection settings applied to the default branch of new projects in this group.
    description String
    The description of the group.
    emailsDisabled Boolean
    Whether email notifications are disabled for this group. Use emailsEnabled instead, to be removed in 19.0.

    Deprecated: Use emailsEnabled instead, to be removed in 19.0.

    emailsEnabled Boolean
    Whether email notifications are enabled for this group.
    extraSharedRunnersMinutesLimit Number
    Available in Self-Managed, Premium and Ultimate plans. Can be set by administrators only. Additional CI/CD minutes for this group.
    fileTemplateProjectId Number
    The ID of the project used to load custom file templates.
    fullName String
    The full name of the group.
    fullPath String
    The full path of the group.
    groupId Number
    The ID of the group.
    ipRestrictionRanges String
    Comma-separated list of IP addresses or subnet masks that restrict access to the group.
    ldapAccess Number
    Default access level for members synced from LDAP.
    ldapCn String
    LDAP common name used to sync members from an LDAP group.
    lfsEnabled Boolean
    Boolean, is LFS enabled for projects in this group.
    markedForDeletionOn String
    Date on which the group was marked for deletion.
    maxArtifactsSize Number
    Maximum artifacts size for the group, in MB.
    membershipLock Boolean
    Users cannot be added to projects in this group.
    mentionsDisabled Boolean
    Whether mentions are disabled for this group.
    name String
    The name of this group.
    onlyAllowMergeIfAllDiscussionsAreResolved Boolean
    Default to only allowing merge if all discussions are resolved for new projects in the group.
    onlyAllowMergeIfPipelineSucceeds Boolean
    Default to only allowing merge if the pipeline succeeds for new projects in the group.
    parentId Number
    Integer, ID of the parent group.
    path String
    The path of the group.
    preventForkingOutsideGroup Boolean
    When enabled, users can not fork projects from this group to external namespaces.
    preventSharingGroupsOutsideHierarchy Boolean
    When enabled, users cannot invite other groups outside of the top-level group's hierarchy. This option is only available for top-level groups.
    projectCreationLevel String
    Determine which roles can create projects in the group. Possible values are noone, maintainer, developer, owner, administrator.
    repositoryStorage String
    Repository storage shard the group's projects use. (admin only)
    requestAccessEnabled Boolean
    Boolean, is request for access enabled to the group.
    requireTwoFactorAuthentication Boolean
    Require all users in this group to set up two-factor authentication.
    runnersToken String
    The group level registration token to use during runner setup.
    shareWithGroupLock Boolean
    Prevent sharing a project with another group within this group.
    sharedRunnersMinutesLimit 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.
    sharedRunnersSetting String
    Enable or disable shared runners for a group's subgroups and projects. Valid values are: enabled, disabledAndOverridable, disabledAndUnoverridable, disabledWithOverride.
    sharedWithGroups 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.
    subgroupCreationLevel String
    Determine which roles can create subgroups in the group. Possible values are owner, maintainer.
    twoFactorGracePeriod Number
    Grace period, in hours, before enforcing two-factor authentication on group members.
    visibilityLevel String
    Visibility level of the group. Possible values are private, internal, public.
    webUrl String
    Web URL of the group.
    wikiAccessLevel String
    The group's wiki access level. Only available on Premium and Ultimate plans. Valid values are disabled, private, enabled.

    GetGroupsGroupDefaultBranchProtectionDefault

    AllowForcePush bool
    Whether force-push is allowed to the default branch.
    AllowedToMerges List<Pulumi.GitLab.Inputs.GetGroupsGroupDefaultBranchProtectionDefaultAllowedToMerge>
    Access levels allowed to merge into the default branch.
    AllowedToPushes List<Pulumi.GitLab.Inputs.GetGroupsGroupDefaultBranchProtectionDefaultAllowedToPush>
    Access levels allowed to push to the default branch.
    CodeOwnerApprovalRequired bool
    Whether code-owner approval is required on the default branch.
    DeveloperCanInitialPush bool
    Whether developers can make the initial push to the default branch.
    AllowForcePush bool
    Whether force-push is allowed to the default branch.
    AllowedToMerges []GetGroupsGroupDefaultBranchProtectionDefaultAllowedToMerge
    Access levels allowed to merge into the default branch.
    AllowedToPushes []GetGroupsGroupDefaultBranchProtectionDefaultAllowedToPush
    Access levels allowed to push to the default branch.
    CodeOwnerApprovalRequired bool
    Whether code-owner approval is required on the default branch.
    DeveloperCanInitialPush bool
    Whether developers can make the initial push to the default branch.
    allow_force_push bool
    Whether force-push is allowed to the default branch.
    allowed_to_merges list(object)
    Access levels allowed to merge into the default branch.
    allowed_to_pushes list(object)
    Access levels allowed to push to the default branch.
    code_owner_approval_required bool
    Whether code-owner approval is required on the default branch.
    developer_can_initial_push bool
    Whether developers can make the initial push to the default branch.
    allowForcePush Boolean
    Whether force-push is allowed to the default branch.
    allowedToMerges List<GetGroupsGroupDefaultBranchProtectionDefaultAllowedToMerge>
    Access levels allowed to merge into the default branch.
    allowedToPushes List<GetGroupsGroupDefaultBranchProtectionDefaultAllowedToPush>
    Access levels allowed to push to the default branch.
    codeOwnerApprovalRequired Boolean
    Whether code-owner approval is required on the default branch.
    developerCanInitialPush Boolean
    Whether developers can make the initial push to the default branch.
    allowForcePush boolean
    Whether force-push is allowed to the default branch.
    allowedToMerges GetGroupsGroupDefaultBranchProtectionDefaultAllowedToMerge[]
    Access levels allowed to merge into the default branch.
    allowedToPushes GetGroupsGroupDefaultBranchProtectionDefaultAllowedToPush[]
    Access levels allowed to push to the default branch.
    codeOwnerApprovalRequired boolean
    Whether code-owner approval is required on the default branch.
    developerCanInitialPush boolean
    Whether developers can make the initial push to the default branch.
    allow_force_push bool
    Whether force-push is allowed to the default branch.
    allowed_to_merges Sequence[GetGroupsGroupDefaultBranchProtectionDefaultAllowedToMerge]
    Access levels allowed to merge into the default branch.
    allowed_to_pushes Sequence[GetGroupsGroupDefaultBranchProtectionDefaultAllowedToPush]
    Access levels allowed to push to the default branch.
    code_owner_approval_required bool
    Whether code-owner approval is required on the default branch.
    developer_can_initial_push bool
    Whether developers can make the initial push to the default branch.
    allowForcePush Boolean
    Whether force-push is allowed to the default branch.
    allowedToMerges List<Property Map>
    Access levels allowed to merge into the default branch.
    allowedToPushes List<Property Map>
    Access levels allowed to push to the default branch.
    codeOwnerApprovalRequired Boolean
    Whether code-owner approval is required on the default branch.
    developerCanInitialPush Boolean
    Whether developers can make the initial push to the default branch.

    GetGroupsGroupDefaultBranchProtectionDefaultAllowedToMerge

    AccessLevel int
    The access level integer.
    AccessLevel int
    The access level integer.
    access_level number
    The access level integer.
    accessLevel Integer
    The access level integer.
    accessLevel number
    The access level integer.
    access_level int
    The access level integer.
    accessLevel Number
    The access level integer.

    GetGroupsGroupDefaultBranchProtectionDefaultAllowedToPush

    AccessLevel int
    The access level integer.
    AccessLevel int
    The access level integer.
    access_level number
    The access level integer.
    accessLevel Integer
    The access level integer.
    accessLevel number
    The access level integer.
    access_level int
    The access level integer.
    accessLevel Number
    The access level integer.

    GetGroupsGroupSharedWithGroup

    ExpiresAt string
    Share with group expiration date.
    GroupAccessLevel int
    The accessLevel permission level of the shared group.
    GroupFullPath string
    The full path of the group shared with.
    GroupId int
    The ID of the group shared with.
    GroupName string
    The name of the group shared with.
    ExpiresAt string
    Share with group expiration date.
    GroupAccessLevel int
    The accessLevel permission level of the shared group.
    GroupFullPath string
    The full path of the group shared with.
    GroupId int
    The ID of the group shared with.
    GroupName string
    The name of the group shared with.
    expires_at string
    Share with group expiration date.
    group_access_level number
    The accessLevel permission level of the shared group.
    group_full_path string
    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.
    expiresAt String
    Share with group expiration date.
    groupAccessLevel Integer
    The accessLevel permission level of the shared group.
    groupFullPath String
    The full path of the group shared with.
    groupId Integer
    The ID of the group shared with.
    groupName String
    The name of the group shared with.
    expiresAt string
    Share with group expiration date.
    groupAccessLevel number
    The accessLevel permission level of the shared group.
    groupFullPath string
    The full path of the group shared with.
    groupId number
    The ID of the group shared with.
    groupName string
    The name of the group shared with.
    expires_at str
    Share with group expiration date.
    group_access_level int
    The accessLevel permission level of the shared group.
    group_full_path str
    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.
    expiresAt String
    Share with group expiration date.
    groupAccessLevel Number
    The accessLevel permission level of the shared group.
    groupFullPath String
    The full path of the group shared with.
    groupId Number
    The ID of the group shared with.
    groupName 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 gitlab Terraform Provider.
    gitlab logo
    Viewing docs for GitLab v10.0.0
    published on Friday, Jun 26, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-gitlab

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial