1. Packages
  2. Gitlab Provider
  3. API Docs
  4. getGroupMembership
GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi

gitlab.getGroupMembership

Explore with Pulumi AI

GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi

The gitlab.GroupMembership data source allows to list and filter all members of a group specified by either its id or full path.

Upstream API: GitLab REST API docs

Using getGroupMembership

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 getGroupMembership(args: GetGroupMembershipArgs, opts?: InvokeOptions): Promise<GetGroupMembershipResult>
function getGroupMembershipOutput(args: GetGroupMembershipOutputArgs, opts?: InvokeOptions): Output<GetGroupMembershipResult>
Copy
def get_group_membership(access_level: Optional[str] = None,
                         full_path: Optional[str] = None,
                         group_id: Optional[int] = None,
                         inherited: Optional[bool] = None,
                         opts: Optional[InvokeOptions] = None) -> GetGroupMembershipResult
def get_group_membership_output(access_level: Optional[pulumi.Input[str]] = None,
                         full_path: Optional[pulumi.Input[str]] = None,
                         group_id: Optional[pulumi.Input[int]] = None,
                         inherited: Optional[pulumi.Input[bool]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetGroupMembershipResult]
Copy
func LookupGroupMembership(ctx *Context, args *LookupGroupMembershipArgs, opts ...InvokeOption) (*LookupGroupMembershipResult, error)
func LookupGroupMembershipOutput(ctx *Context, args *LookupGroupMembershipOutputArgs, opts ...InvokeOption) LookupGroupMembershipResultOutput
Copy

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

public static class GetGroupMembership 
{
    public static Task<GetGroupMembershipResult> InvokeAsync(GetGroupMembershipArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupMembershipResult> Invoke(GetGroupMembershipInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGroupMembershipResult> getGroupMembership(GetGroupMembershipArgs args, InvokeOptions options)
public static Output<GetGroupMembershipResult> getGroupMembership(GetGroupMembershipArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: gitlab:index/getGroupMembership:getGroupMembership
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccessLevel string
Only return members with the desired access level. Acceptable values are: guest, reporter, developer, maintainer, owner.
FullPath string
The full path of the group.
GroupId int
The ID of the group.
Inherited bool
Return all project members including members through ancestor groups.
AccessLevel string
Only return members with the desired access level. Acceptable values are: guest, reporter, developer, maintainer, owner.
FullPath string
The full path of the group.
GroupId int
The ID of the group.
Inherited bool
Return all project members including members through ancestor groups.
accessLevel String
Only return members with the desired access level. Acceptable values are: guest, reporter, developer, maintainer, owner.
fullPath String
The full path of the group.
groupId Integer
The ID of the group.
inherited Boolean
Return all project members including members through ancestor groups.
accessLevel string
Only return members with the desired access level. Acceptable values are: guest, reporter, developer, maintainer, owner.
fullPath string
The full path of the group.
groupId number
The ID of the group.
inherited boolean
Return all project members including members through ancestor groups.
access_level str
Only return members with the desired access level. Acceptable values are: guest, reporter, developer, maintainer, owner.
full_path str
The full path of the group.
group_id int
The ID of the group.
inherited bool
Return all project members including members through ancestor groups.
accessLevel String
Only return members with the desired access level. Acceptable values are: guest, reporter, developer, maintainer, owner.
fullPath String
The full path of the group.
groupId Number
The ID of the group.
inherited Boolean
Return all project members including members through ancestor groups.

getGroupMembership Result

The following output properties are available:

AccessLevel string
Only return members with the desired access level. Acceptable values are: guest, reporter, developer, maintainer, owner.
FullPath string
The full path of the group.
GroupId int
The ID of the group.
Id string
The ID of the group membership. In the format of <group-id:access-level>.
Members List<Pulumi.GitLab.Outputs.GetGroupMembershipMember>
The list of group members.
Inherited bool
Return all project members including members through ancestor groups.
AccessLevel string
Only return members with the desired access level. Acceptable values are: guest, reporter, developer, maintainer, owner.
FullPath string
The full path of the group.
GroupId int
The ID of the group.
Id string
The ID of the group membership. In the format of <group-id:access-level>.
Members []GetGroupMembershipMember
The list of group members.
Inherited bool
Return all project members including members through ancestor groups.
accessLevel String
Only return members with the desired access level. Acceptable values are: guest, reporter, developer, maintainer, owner.
fullPath String
The full path of the group.
groupId Integer
The ID of the group.
id String
The ID of the group membership. In the format of <group-id:access-level>.
members List<GetGroupMembershipMember>
The list of group members.
inherited Boolean
Return all project members including members through ancestor groups.
accessLevel string
Only return members with the desired access level. Acceptable values are: guest, reporter, developer, maintainer, owner.
fullPath string
The full path of the group.
groupId number
The ID of the group.
id string
The ID of the group membership. In the format of <group-id:access-level>.
members GetGroupMembershipMember[]
The list of group members.
inherited boolean
Return all project members including members through ancestor groups.
access_level str
Only return members with the desired access level. Acceptable values are: guest, reporter, developer, maintainer, owner.
full_path str
The full path of the group.
group_id int
The ID of the group.
id str
The ID of the group membership. In the format of <group-id:access-level>.
members Sequence[GetGroupMembershipMember]
The list of group members.
inherited bool
Return all project members including members through ancestor groups.
accessLevel String
Only return members with the desired access level. Acceptable values are: guest, reporter, developer, maintainer, owner.
fullPath String
The full path of the group.
groupId Number
The ID of the group.
id String
The ID of the group membership. In the format of <group-id:access-level>.
members List<Property Map>
The list of group members.
inherited Boolean
Return all project members including members through ancestor groups.

Supporting Types

GetGroupMembershipMember

AccessLevel This property is required. string
The level of access to the group.
AvatarUrl This property is required. string
The avatar URL of the user.
ExpiresAt This property is required. string
Expiration date for the group membership.
Id This property is required. int
The unique id assigned to the user by the gitlab server.
Name This property is required. string
The name of the user.
State This property is required. string
Whether the user is active or blocked.
Username This property is required. string
The username of the user.
WebUrl This property is required. string
User's website URL.
AccessLevel This property is required. string
The level of access to the group.
AvatarUrl This property is required. string
The avatar URL of the user.
ExpiresAt This property is required. string
Expiration date for the group membership.
Id This property is required. int
The unique id assigned to the user by the gitlab server.
Name This property is required. string
The name of the user.
State This property is required. string
Whether the user is active or blocked.
Username This property is required. string
The username of the user.
WebUrl This property is required. string
User's website URL.
accessLevel This property is required. String
The level of access to the group.
avatarUrl This property is required. String
The avatar URL of the user.
expiresAt This property is required. String
Expiration date for the group membership.
id This property is required. Integer
The unique id assigned to the user by the gitlab server.
name This property is required. String
The name of the user.
state This property is required. String
Whether the user is active or blocked.
username This property is required. String
The username of the user.
webUrl This property is required. String
User's website URL.
accessLevel This property is required. string
The level of access to the group.
avatarUrl This property is required. string
The avatar URL of the user.
expiresAt This property is required. string
Expiration date for the group membership.
id This property is required. number
The unique id assigned to the user by the gitlab server.
name This property is required. string
The name of the user.
state This property is required. string
Whether the user is active or blocked.
username This property is required. string
The username of the user.
webUrl This property is required. string
User's website URL.
access_level This property is required. str
The level of access to the group.
avatar_url This property is required. str
The avatar URL of the user.
expires_at This property is required. str
Expiration date for the group membership.
id This property is required. int
The unique id assigned to the user by the gitlab server.
name This property is required. str
The name of the user.
state This property is required. str
Whether the user is active or blocked.
username This property is required. str
The username of the user.
web_url This property is required. str
User's website URL.
accessLevel This property is required. String
The level of access to the group.
avatarUrl This property is required. String
The avatar URL of the user.
expiresAt This property is required. String
Expiration date for the group membership.
id This property is required. Number
The unique id assigned to the user by the gitlab server.
name This property is required. String
The name of the user.
state This property is required. String
Whether the user is active or blocked.
username This property is required. String
The username of the user.
webUrl This property is required. String
User's website URL.

Package Details

Repository
GitLab pulumi/pulumi-gitlab
License
Apache-2.0
Notes
This Pulumi package is based on the gitlab Terraform Provider.
GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi