gitlab.getProjectMembership

GitLab v9.3.0 published on Monday, Sep 29, 2025 by Pulumi

Using getProjectMembership

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 getProjectMembership(args: GetProjectMembershipArgs, opts?: InvokeOptions): Promise<GetProjectMembershipResult>
function getProjectMembershipOutput(args: GetProjectMembershipOutputArgs, opts?: InvokeOptions): Output<GetProjectMembershipResult>

def get_project_membership(full_path: Optional[str] = None,
                           inherited: Optional[bool] = None,
                           project: Optional[str] = None,
                           project_id: Optional[int] = None,
                           query: Optional[str] = None,
                           user_ids: Optional[Sequence[int]] = None,
                           opts: Optional[InvokeOptions] = None) -> GetProjectMembershipResult
def get_project_membership_output(full_path: Optional[pulumi.Input[str]] = None,
                           inherited: Optional[pulumi.Input[bool]] = None,
                           project: Optional[pulumi.Input[str]] = None,
                           project_id: Optional[pulumi.Input[int]] = None,
                           query: Optional[pulumi.Input[str]] = None,
                           user_ids: Optional[pulumi.Input[Sequence[pulumi.Input[int]]]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetProjectMembershipResult]

func LookupProjectMembership(ctx *Context, args *LookupProjectMembershipArgs, opts ...InvokeOption) (*LookupProjectMembershipResult, error)
func LookupProjectMembershipOutput(ctx *Context, args *LookupProjectMembershipOutputArgs, opts ...InvokeOption) LookupProjectMembershipResultOutput

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

public static class GetProjectMembership 
{
    public static Task<GetProjectMembershipResult> InvokeAsync(GetProjectMembershipArgs args, InvokeOptions? opts = null)
    public static Output<GetProjectMembershipResult> Invoke(GetProjectMembershipInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetProjectMembershipResult> getProjectMembership(GetProjectMembershipArgs args, InvokeOptions options)
public static Output<GetProjectMembershipResult> getProjectMembership(GetProjectMembershipArgs args, InvokeOptions options)

fn::invoke:
  function: gitlab:index/getProjectMembership:getProjectMembership
  arguments:
    # arguments dictionary

The following arguments are supported:

FullPath string: The full path of the project.
Deprecated: Will be removed in 19.0. Use project instead.
Inherited bool: Return all project members including members through ancestor groups
Project string: The ID or full path of the project.
ProjectId int: The ID of the project.
Deprecated: Will be removed in 19.0. Use project instead.
Query string: A query string to search for members
UserIds List<int>: List of user ids to filter members by

FullPath string: The full path of the project.
Deprecated: Will be removed in 19.0. Use project instead.
Inherited bool: Return all project members including members through ancestor groups
Project string: The ID or full path of the project.
ProjectId int: The ID of the project.
Deprecated: Will be removed in 19.0. Use project instead.
Query string: A query string to search for members
UserIds []int: List of user ids to filter members by

fullPath String: The full path of the project.
Deprecated: Will be removed in 19.0. Use project instead.
inherited Boolean: Return all project members including members through ancestor groups
project String: The ID or full path of the project.
projectId Integer: The ID of the project.
Deprecated: Will be removed in 19.0. Use project instead.
query String: A query string to search for members
userIds List<Integer>: List of user ids to filter members by

fullPath string: The full path of the project.
Deprecated: Will be removed in 19.0. Use project instead.
inherited boolean: Return all project members including members through ancestor groups
project string: The ID or full path of the project.
projectId number: The ID of the project.
Deprecated: Will be removed in 19.0. Use project instead.
query string: A query string to search for members
userIds number[]: List of user ids to filter members by

full_path str: The full path of the project.
Deprecated: Will be removed in 19.0. Use project instead.
inherited bool: Return all project members including members through ancestor groups
project str: The ID or full path of the project.
project_id int: The ID of the project.
Deprecated: Will be removed in 19.0. Use project instead.
query str: A query string to search for members
user_ids Sequence[int]: List of user ids to filter members by

fullPath String: The full path of the project.
Deprecated: Will be removed in 19.0. Use project instead.
inherited Boolean: Return all project members including members through ancestor groups
project String: The ID or full path of the project.
projectId Number: The ID of the project.
Deprecated: Will be removed in 19.0. Use project instead.
query String: A query string to search for members
userIds List<Number>: List of user ids to filter members by

getProjectMembership Result

The following output properties are available:

FullPath string: The full path of the project.
Deprecated: Will be removed in 19.0. Use project instead.
Id string: The ID of this datasource. In the format <project:query-hash> if query is set, otherwise <project>.
Members List<Pulumi.GitLab.Outputs.GetProjectMembershipMember>: The list of project members.
Project string: The ID or full path of the project.
ProjectId int: The ID of the project.
Deprecated: Will be removed in 19.0. Use project instead.
Inherited bool: Return all project members including members through ancestor groups
Query string: A query string to search for members
UserIds List<int>: List of user ids to filter members by

FullPath string: The full path of the project.
Deprecated: Will be removed in 19.0. Use project instead.
Id string: The ID of this datasource. In the format <project:query-hash> if query is set, otherwise <project>.
Members []GetProjectMembershipMember: The list of project members.
Project string: The ID or full path of the project.
ProjectId int: The ID of the project.
Deprecated: Will be removed in 19.0. Use project instead.
Inherited bool: Return all project members including members through ancestor groups
Query string: A query string to search for members
UserIds []int: List of user ids to filter members by

fullPath String: The full path of the project.
Deprecated: Will be removed in 19.0. Use project instead.
id String: The ID of this datasource. In the format <project:query-hash> if query is set, otherwise <project>.
members List<GetProjectMembershipMember>: The list of project members.
project String: The ID or full path of the project.
projectId Integer: The ID of the project.
Deprecated: Will be removed in 19.0. Use project instead.
inherited Boolean: Return all project members including members through ancestor groups
query String: A query string to search for members
userIds List<Integer>: List of user ids to filter members by

fullPath string: The full path of the project.
Deprecated: Will be removed in 19.0. Use project instead.
id string: The ID of this datasource. In the format <project:query-hash> if query is set, otherwise <project>.
members GetProjectMembershipMember[]: The list of project members.
project string: The ID or full path of the project.
projectId number: The ID of the project.
Deprecated: Will be removed in 19.0. Use project instead.
inherited boolean: Return all project members including members through ancestor groups
query string: A query string to search for members
userIds number[]: List of user ids to filter members by

full_path str: The full path of the project.
Deprecated: Will be removed in 19.0. Use project instead.
id str: The ID of this datasource. In the format <project:query-hash> if query is set, otherwise <project>.
members Sequence[GetProjectMembershipMember]: The list of project members.
project str: The ID or full path of the project.
project_id int: The ID of the project.
Deprecated: Will be removed in 19.0. Use project instead.
inherited bool: Return all project members including members through ancestor groups
query str: A query string to search for members
user_ids Sequence[int]: List of user ids to filter members by

fullPath String: The full path of the project.
Deprecated: Will be removed in 19.0. Use project instead.
id String: The ID of this datasource. In the format <project:query-hash> if query is set, otherwise <project>.
members List<Property Map>: The list of project members.
project String: The ID or full path of the project.
projectId Number: The ID of the project.
Deprecated: Will be removed in 19.0. Use project instead.
inherited Boolean: Return all project members including members through ancestor groups
query String: A query string to search for members
userIds List<Number>: List of user ids to filter members by

Supporting Types

GetProjectMembershipMember

AccessLevel string: The level of access to the group.
AvatarUrl string: The avatar URL of the user.
ExpiresAt string: Expiration date for the group membership.
Id int: The unique id assigned to the user by the gitlab server.
Name string: The name of the user.
State string: Whether the user is active or blocked.
Username string: The username of the user.
WebUrl string: User's website URL.

AccessLevel string: The level of access to the group.
AvatarUrl string: The avatar URL of the user.
ExpiresAt string: Expiration date for the group membership.
Id int: The unique id assigned to the user by the gitlab server.
Name string: The name of the user.
State string: Whether the user is active or blocked.
Username string: The username of the user.
WebUrl string: User's website URL.

accessLevel String: The level of access to the group.
avatarUrl String: The avatar URL of the user.
expiresAt String: Expiration date for the group membership.
id Integer: The unique id assigned to the user by the gitlab server.
name String: The name of the user.
state String: Whether the user is active or blocked.
username String: The username of the user.
webUrl String: User's website URL.

accessLevel string: The level of access to the group.
avatarUrl string: The avatar URL of the user.
expiresAt string: Expiration date for the group membership.
id number: The unique id assigned to the user by the gitlab server.
name string: The name of the user.
state string: Whether the user is active or blocked.
username string: The username of the user.
webUrl string: User's website URL.

access_level str: The level of access to the group.
avatar_url str: The avatar URL of the user.
expires_at str: Expiration date for the group membership.
id int: The unique id assigned to the user by the gitlab server.
name str: The name of the user.
state str: Whether the user is active or blocked.
username str: The username of the user.
web_url str: User's website URL.

accessLevel String: The level of access to the group.
avatarUrl String: The avatar URL of the user.
expiresAt String: Expiration date for the group membership.
id Number: The unique id assigned to the user by the gitlab server.
name String: The name of the user.
state String: Whether the user is active or blocked.
username String: The username of the user.
webUrl 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 v9.3.0 published on Monday, Sep 29, 2025 by Pulumi

pulumi/pulumi-gitlab

gitlab.getProjectMembership

On this page

On this page

Using getProjectMembership

getProjectMembership Result

Supporting Types

GetProjectMembershipMember

Package Details

On this page

On this page