1. Packages
  2. GitLab
  3. API Docs
  4. getProjectMembership
GitLab v6.11.0 published on Friday, Apr 19, 2024 by Pulumi

gitlab.getProjectMembership

Explore with Pulumi AI

gitlab logo
GitLab v6.11.0 published on Friday, Apr 19, 2024 by Pulumi

    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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as gitlab from "@pulumi/gitlab";
    
    const example = gitlab.getProjectMembership({
        inherited: true,
        projectId: 123,
    });
    
    import pulumi
    import pulumi_gitlab as gitlab
    
    example = gitlab.get_project_membership(inherited=True,
        project_id=123)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gitlab/sdk/v6/go/gitlab"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := gitlab.LookupProjectMembership(ctx, &gitlab.LookupProjectMembershipArgs{
    			Inherited: pulumi.BoolRef(true),
    			ProjectId: pulumi.IntRef(123),
    		}, 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.GetProjectMembership.Invoke(new()
        {
            Inherited = true,
            ProjectId = 123,
        });
    
    });
    
    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.GetProjectMembershipArgs;
    import java.util.List;
    import java.util.ArrayList;
    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.getProjectMembership(GetProjectMembershipArgs.builder()
                .inherited(true)
                .projectId(123)
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: gitlab:getProjectMembership
          Arguments:
            inherited: true
            projectId: 123
    

    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,
                               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,
                               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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: gitlab:index/getProjectMembership:getProjectMembership
      arguments:
        # arguments dictionary

    The following arguments are supported:

    FullPath string
    The full path of the project.
    Inherited bool
    Return all project members including members through ancestor groups
    ProjectId int
    The ID of the project.
    Query string
    A query string to search for members
    FullPath string
    The full path of the project.
    Inherited bool
    Return all project members including members through ancestor groups
    ProjectId int
    The ID of the project.
    Query string
    A query string to search for members
    fullPath String
    The full path of the project.
    inherited Boolean
    Return all project members including members through ancestor groups
    projectId Integer
    The ID of the project.
    query String
    A query string to search for members
    fullPath string
    The full path of the project.
    inherited boolean
    Return all project members including members through ancestor groups
    projectId number
    The ID of the project.
    query string
    A query string to search for members
    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
    fullPath String
    The full path of the project.
    inherited Boolean
    Return all project members including members through ancestor groups
    projectId Number
    The ID of the project.
    query String
    A query string to search for members

    getProjectMembership Result

    The following output properties are available:

    FullPath string
    The full path of the project.
    Id string
    The provider-assigned unique ID for this managed resource.
    Members List<Pulumi.GitLab.Outputs.GetProjectMembershipMember>
    The list of project members.
    ProjectId 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
    FullPath string
    The full path of the project.
    Id string
    The provider-assigned unique ID for this managed resource.
    Members []GetProjectMembershipMember
    The list of project members.
    ProjectId 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
    fullPath String
    The full path of the project.
    id String
    The provider-assigned unique ID for this managed resource.
    members List<GetProjectMembershipMember>
    The list of project members.
    projectId 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
    fullPath string
    The full path of the project.
    id string
    The provider-assigned unique ID for this managed resource.
    members GetProjectMembershipMember[]
    The list of project members.
    projectId 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
    full_path str
    The full path of the project.
    id str
    The provider-assigned unique ID for this managed resource.
    members Sequence[GetProjectMembershipMember]
    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
    fullPath 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.
    projectId 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

    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 logo
    GitLab v6.11.0 published on Friday, Apr 19, 2024 by Pulumi