Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Gitlab Provider
  3. API Docs
  4. ProjectMembership
GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-gitlab

gitlab.ProjectMembership

Explore with Pulumi AI

GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-gitlab

The gitlab.ProjectMembership resource allows to manage the lifecycle of a users project membership.

If a project should grant membership to an entire group use the gitlab.ProjectShareGroup resource instead.

Upstream API: GitLab REST API docs

Example Usage

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

const test = new gitlab.ProjectMembership("test", {
    project: "12345",
    userId: 1337,
    accessLevel: "guest",
});
const example = new gitlab.ProjectMembership("example", {
    project: "67890",
    userId: 1234,
    accessLevel: "guest",
    expiresAt: "2022-12-31",
});
Copy
import pulumi
import pulumi_gitlab as gitlab

test = gitlab.ProjectMembership("test",
    project="12345",
    user_id=1337,
    access_level="guest")
example = gitlab.ProjectMembership("example",
    project="67890",
    user_id=1234,
    access_level="guest",
    expires_at="2022-12-31")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gitlab.NewProjectMembership(ctx, "test", &gitlab.ProjectMembershipArgs{
			Project:     pulumi.String("12345"),
			UserId:      pulumi.Int(1337),
			AccessLevel: pulumi.String("guest"),
		})
		if err != nil {
			return err
		}
		_, err = gitlab.NewProjectMembership(ctx, "example", &gitlab.ProjectMembershipArgs{
			Project:     pulumi.String("67890"),
			UserId:      pulumi.Int(1234),
			AccessLevel: pulumi.String("guest"),
			ExpiresAt:   pulumi.String("2022-12-31"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;

return await Deployment.RunAsync(() => 
{
    var test = new GitLab.ProjectMembership("test", new()
    {
        Project = "12345",
        UserId = 1337,
        AccessLevel = "guest",
    });

    var example = new GitLab.ProjectMembership("example", new()
    {
        Project = "67890",
        UserId = 1234,
        AccessLevel = "guest",
        ExpiresAt = "2022-12-31",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.ProjectMembership;
import com.pulumi.gitlab.ProjectMembershipArgs;
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) {
        var test = new ProjectMembership("test", ProjectMembershipArgs.builder()
            .project("12345")
            .userId(1337)
            .accessLevel("guest")
            .build());

        var example = new ProjectMembership("example", ProjectMembershipArgs.builder()
            .project("67890")
            .userId(1234)
            .accessLevel("guest")
            .expiresAt("2022-12-31")
            .build());

    }
}
Copy
resources:
  test:
    type: gitlab:ProjectMembership
    properties:
      project: '12345'
      userId: 1337
      accessLevel: guest
  example:
    type: gitlab:ProjectMembership
    properties:
      project: '67890'
      userId: 1234
      accessLevel: guest
      expiresAt: 2022-12-31
Copy

Create ProjectMembership Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ProjectMembership(name: string, args: ProjectMembershipArgs, opts?: CustomResourceOptions);
@overload
def ProjectMembership(resource_name: str,
                      args: ProjectMembershipArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def ProjectMembership(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      access_level: Optional[str] = None,
                      project: Optional[str] = None,
                      user_id: Optional[int] = None,
                      expires_at: Optional[str] = None,
                      member_role_id: Optional[int] = None)
func NewProjectMembership(ctx *Context, name string, args ProjectMembershipArgs, opts ...ResourceOption) (*ProjectMembership, error)
public ProjectMembership(string name, ProjectMembershipArgs args, CustomResourceOptions? opts = null)
public ProjectMembership(String name, ProjectMembershipArgs args)
public ProjectMembership(String name, ProjectMembershipArgs args, CustomResourceOptions options)

type: gitlab:ProjectMembership
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ProjectMembershipArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ProjectMembershipArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ProjectMembershipArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ProjectMembershipArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ProjectMembershipArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var projectMembershipResource = new GitLab.ProjectMembership("projectMembershipResource", new()
{
    AccessLevel = "string",
    Project = "string",
    UserId = 0,
    ExpiresAt = "string",
    MemberRoleId = 0,
});
Copy
example, err := gitlab.NewProjectMembership(ctx, "projectMembershipResource", &gitlab.ProjectMembershipArgs{
	AccessLevel:  pulumi.String("string"),
	Project:      pulumi.String("string"),
	UserId:       pulumi.Int(0),
	ExpiresAt:    pulumi.String("string"),
	MemberRoleId: pulumi.Int(0),
})
Copy
var projectMembershipResource = new ProjectMembership("projectMembershipResource", ProjectMembershipArgs.builder()
    .accessLevel("string")
    .project("string")
    .userId(0)
    .expiresAt("string")
    .memberRoleId(0)
    .build());
Copy
project_membership_resource = gitlab.ProjectMembership("projectMembershipResource",
    access_level="string",
    project="string",
    user_id=0,
    expires_at="string",
    member_role_id=0)
Copy
const projectMembershipResource = new gitlab.ProjectMembership("projectMembershipResource", {
    accessLevel: "string",
    project: "string",
    userId: 0,
    expiresAt: "string",
    memberRoleId: 0,
});
Copy
type: gitlab:ProjectMembership
properties:
    accessLevel: string
    expiresAt: string
    memberRoleId: 0
    project: string
    userId: 0
Copy

ProjectMembership Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ProjectMembership resource accepts the following input properties:

AccessLevel This property is required. string
The access level for the member. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
Project
This property is required.
Changes to this property will trigger replacement.
string
The ID or URL-encoded path of the project.
UserId
This property is required.
Changes to this property will trigger replacement.
int
The id of the user.
ExpiresAt string
Expiration date for the project membership. Format: YYYY-MM-DD
MemberRoleId int
The ID of a custom member role. Only available for Ultimate instances.
AccessLevel This property is required. string
The access level for the member. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
Project
This property is required.
Changes to this property will trigger replacement.
string
The ID or URL-encoded path of the project.
UserId
This property is required.
Changes to this property will trigger replacement.
int
The id of the user.
ExpiresAt string
Expiration date for the project membership. Format: YYYY-MM-DD
MemberRoleId int
The ID of a custom member role. Only available for Ultimate instances.
accessLevel This property is required. String
The access level for the member. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
project
This property is required.
Changes to this property will trigger replacement.
String
The ID or URL-encoded path of the project.
userId
This property is required.
Changes to this property will trigger replacement.
Integer
The id of the user.
expiresAt String
Expiration date for the project membership. Format: YYYY-MM-DD
memberRoleId Integer
The ID of a custom member role. Only available for Ultimate instances.
accessLevel This property is required. string
The access level for the member. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
project
This property is required.
Changes to this property will trigger replacement.
string
The ID or URL-encoded path of the project.
userId
This property is required.
Changes to this property will trigger replacement.
number
The id of the user.
expiresAt string
Expiration date for the project membership. Format: YYYY-MM-DD
memberRoleId number
The ID of a custom member role. Only available for Ultimate instances.
access_level This property is required. str
The access level for the member. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
project
This property is required.
Changes to this property will trigger replacement.
str
The ID or URL-encoded path of the project.
user_id
This property is required.
Changes to this property will trigger replacement.
int
The id of the user.
expires_at str
Expiration date for the project membership. Format: YYYY-MM-DD
member_role_id int
The ID of a custom member role. Only available for Ultimate instances.
accessLevel This property is required. String
The access level for the member. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
project
This property is required.
Changes to this property will trigger replacement.
String
The ID or URL-encoded path of the project.
userId
This property is required.
Changes to this property will trigger replacement.
Number
The id of the user.
expiresAt String
Expiration date for the project membership. Format: YYYY-MM-DD
memberRoleId Number
The ID of a custom member role. Only available for Ultimate instances.

Outputs

All input properties are implicitly available as output properties. Additionally, the ProjectMembership resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ProjectMembership Resource

Get an existing ProjectMembership resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ProjectMembershipState, opts?: CustomResourceOptions): ProjectMembership
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_level: Optional[str] = None,
        expires_at: Optional[str] = None,
        member_role_id: Optional[int] = None,
        project: Optional[str] = None,
        user_id: Optional[int] = None) -> ProjectMembership
func GetProjectMembership(ctx *Context, name string, id IDInput, state *ProjectMembershipState, opts ...ResourceOption) (*ProjectMembership, error)
public static ProjectMembership Get(string name, Input<string> id, ProjectMembershipState? state, CustomResourceOptions? opts = null)
public static ProjectMembership get(String name, Output<String> id, ProjectMembershipState state, CustomResourceOptions options)
resources:  _:    type: gitlab:ProjectMembership    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AccessLevel string
The access level for the member. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
ExpiresAt string
Expiration date for the project membership. Format: YYYY-MM-DD
MemberRoleId int
The ID of a custom member role. Only available for Ultimate instances.
Project Changes to this property will trigger replacement. string
The ID or URL-encoded path of the project.
UserId Changes to this property will trigger replacement. int
The id of the user.
AccessLevel string
The access level for the member. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
ExpiresAt string
Expiration date for the project membership. Format: YYYY-MM-DD
MemberRoleId int
The ID of a custom member role. Only available for Ultimate instances.
Project Changes to this property will trigger replacement. string
The ID or URL-encoded path of the project.
UserId Changes to this property will trigger replacement. int
The id of the user.
accessLevel String
The access level for the member. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
expiresAt String
Expiration date for the project membership. Format: YYYY-MM-DD
memberRoleId Integer
The ID of a custom member role. Only available for Ultimate instances.
project Changes to this property will trigger replacement. String
The ID or URL-encoded path of the project.
userId Changes to this property will trigger replacement. Integer
The id of the user.
accessLevel string
The access level for the member. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
expiresAt string
Expiration date for the project membership. Format: YYYY-MM-DD
memberRoleId number
The ID of a custom member role. Only available for Ultimate instances.
project Changes to this property will trigger replacement. string
The ID or URL-encoded path of the project.
userId Changes to this property will trigger replacement. number
The id of the user.
access_level str
The access level for the member. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
expires_at str
Expiration date for the project membership. Format: YYYY-MM-DD
member_role_id int
The ID of a custom member role. Only available for Ultimate instances.
project Changes to this property will trigger replacement. str
The ID or URL-encoded path of the project.
user_id Changes to this property will trigger replacement. int
The id of the user.
accessLevel String
The access level for the member. Valid values are: no one, minimal, guest, reporter, developer, maintainer, owner
expiresAt String
Expiration date for the project membership. Format: YYYY-MM-DD
memberRoleId Number
The ID of a custom member role. Only available for Ultimate instances.
project Changes to this property will trigger replacement. String
The ID or URL-encoded path of the project.
userId Changes to this property will trigger replacement. Number
The id of the user.

Import

Starting in Terraform v1.5.0 you can use an import block to import gitlab_project_membership. For example:

terraform

import {

to = gitlab_project_membership.example

id = “see CLI command below for ID”

}

Import using the CLI is supported using the following syntax:

GitLab project membership can be imported using an id made up of project_id:user_id, e.g.

$ pulumi import gitlab:index/projectMembership:ProjectMembership test "12345:1337"
Copy

To learn more about importing existing cloud resources, see Importing resources.

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
pulumi/pulumi-gitlab