GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
gitlab.getProjectMembership
Explore with Pulumi AI
The gitlab.ProjectMembership data source allows to list and filter all members of a project specified by either its id or full path.
Note exactly one of project_id or full_path must be provided.
Upstream API: GitLab REST API docs
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_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_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 dictionaryThe following arguments are supported:
- full_
path str - The full path of the project.
 - inherited bool
 - Return all project members including members through ancestor groups
 - project_
id int - The ID of the project.
 - query str
 - A query string to search for members
 - user_
ids Sequence[int] - List of user ids to filter members by
 
getProjectMembership Result
The following output properties are available:
- Full
Path string - The full path of the project.
 - Id string
 - The provider-assigned unique ID for this managed resource.
 - Members
List<Pulumi.
Git Lab. Outputs. Get Project Membership Member>  - The list of project members.
 - Project
Id int - The ID of the project.
 - Inherited bool
 - Return all project members including members through ancestor groups
 - Query string
 - A query string to search for members
 - User
Ids List<int> - List of user ids to filter members by
 
- Full
Path string - The full path of the project.
 - Id string
 - The provider-assigned unique ID for this managed resource.
 - Members
[]Get
Project Membership Member  - The list of project members.
 - Project
Id int - The ID of the project.
 - Inherited bool
 - Return all project members including members through ancestor groups
 - Query string
 - A query string to search for members
 - User
Ids []int - List of user ids to filter members by
 
- full
Path String - The full path of the project.
 - id String
 - The provider-assigned unique ID for this managed resource.
 - members
List<Get
Project Membership Member>  - The list of project members.
 - project
Id Integer - The ID of the project.
 - inherited Boolean
 - Return all project members including members through ancestor groups
 - query String
 - A query string to search for members
 - user
Ids List<Integer> - List of user ids to filter members by
 
- full
Path string - The full path of the project.
 - id string
 - The provider-assigned unique ID for this managed resource.
 - members
Get
Project Membership Member[]  - The list of project members.
 - project
Id number - The ID of the project.
 - inherited boolean
 - Return all project members including members through ancestor groups
 - query string
 - A query string to search for members
 - user
Ids number[] - List of user ids to filter members by
 
- full_
path str - The full path of the project.
 - id str
 - The provider-assigned unique ID for this managed resource.
 - members
Sequence[Get
Project Membership Member]  - The list of project members.
 - project_
id int - The ID of the project.
 - 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
 
- full
Path String - The full path of the project.
 - id String
 - The provider-assigned unique ID for this managed resource.
 - members List<Property Map>
 - The list of project members.
 - project
Id Number - The ID of the project.
 - inherited Boolean
 - Return all project members including members through ancestor groups
 - query String
 - A query string to search for members
 - user
Ids List<Number> - List of user ids to filter members by
 
Supporting Types
GetProjectMembershipMember   
- Access
Level string - The level of access to the group.
 - Avatar
Url string - The avatar URL of the user.
 - Expires
At 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.
 - Web
Url string - User's website URL.
 
- Access
Level string - The level of access to the group.
 - Avatar
Url string - The avatar URL of the user.
 - Expires
At 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.
 - Web
Url string - User's website URL.
 
- access
Level String - The level of access to the group.
 - avatar
Url String - The avatar URL of the user.
 - expires
At 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.
 - web
Url String - User's website URL.
 
- access
Level string - The level of access to the group.
 - avatar
Url string - The avatar URL of the user.
 - expires
At 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.
 - web
Url 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.
 
- access
Level String - The level of access to the group.
 - avatar
Url String - The avatar URL of the user.
 - expires
At 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.
 - web
Url String - User's website URL.
 
Package Details
- Repository
 - GitLab pulumi/pulumi-gitlab
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
gitlabTerraform Provider.