published on Monday, Mar 9, 2026 by Pulumi
published on Monday, Mar 9, 2026 by Pulumi
Import
GitHub Team Membership can be imported using the team ID teamid, e.g.
$ pulumi import github:index/teamMembers:TeamMembers some_team 1234567
Example Usage
using System.Collections.Generic;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
// Add a user to the organization
var membershipForSomeUser = new Github.Membership("membershipForSomeUser", new()
{
Username = "SomeUser",
Role = "member",
});
var membershipForAnotherUser = new Github.Membership("membershipForAnotherUser", new()
{
Username = "AnotherUser",
Role = "member",
});
var someTeam = new Github.Team("someTeam", new()
{
Description = "Some cool team",
});
var someTeamMembers = new Github.TeamMembers("someTeamMembers", new()
{
TeamId = someTeam.Id,
Members = new[]
{
new Github.Inputs.TeamMembersMemberArgs
{
Username = "SomeUser",
Role = "maintainer",
},
new Github.Inputs.TeamMembersMemberArgs
{
Username = "AnotherUser",
Role = "member",
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-github/sdk/v4/go/github"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := github.NewMembership(ctx, "membershipForSomeUser", &github.MembershipArgs{
Username: pulumi.String("SomeUser"),
Role: pulumi.String("member"),
})
if err != nil {
return err
}
_, err = github.NewMembership(ctx, "membershipForAnotherUser", &github.MembershipArgs{
Username: pulumi.String("AnotherUser"),
Role: pulumi.String("member"),
})
if err != nil {
return err
}
someTeam, err := github.NewTeam(ctx, "someTeam", &github.TeamArgs{
Description: pulumi.String("Some cool team"),
})
if err != nil {
return err
}
_, err = github.NewTeamMembers(ctx, "someTeamMembers", &github.TeamMembersArgs{
TeamId: someTeam.ID(),
Members: TeamMembersMemberArray{
&TeamMembersMemberArgs{
Username: pulumi.String("SomeUser"),
Role: pulumi.String("maintainer"),
},
&TeamMembersMemberArgs{
Username: pulumi.String("AnotherUser"),
Role: pulumi.String("member"),
},
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.Membership;
import com.pulumi.github.MembershipArgs;
import com.pulumi.github.Team;
import com.pulumi.github.TeamArgs;
import com.pulumi.github.TeamMembers;
import com.pulumi.github.TeamMembersArgs;
import com.pulumi.github.inputs.TeamMembersMemberArgs;
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 membershipForSomeUser = new Membership("membershipForSomeUser", MembershipArgs.builder()
.username("SomeUser")
.role("member")
.build());
var membershipForAnotherUser = new Membership("membershipForAnotherUser", MembershipArgs.builder()
.username("AnotherUser")
.role("member")
.build());
var someTeam = new Team("someTeam", TeamArgs.builder()
.description("Some cool team")
.build());
var someTeamMembers = new TeamMembers("someTeamMembers", TeamMembersArgs.builder()
.teamId(someTeam.id())
.members(
TeamMembersMemberArgs.builder()
.username("SomeUser")
.role("maintainer")
.build(),
TeamMembersMemberArgs.builder()
.username("AnotherUser")
.role("member")
.build())
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
// Add a user to the organization
const membershipForSomeUser = new github.Membership("membershipForSomeUser", {
username: "SomeUser",
role: "member",
});
const membershipForAnotherUser = new github.Membership("membershipForAnotherUser", {
username: "AnotherUser",
role: "member",
});
const someTeam = new github.Team("someTeam", {description: "Some cool team"});
const someTeamMembers = new github.TeamMembers("someTeamMembers", {
teamId: someTeam.id,
members: [
{
username: "SomeUser",
role: "maintainer",
},
{
username: "AnotherUser",
role: "member",
},
],
});
import pulumi
import pulumi_github as github
# Add a user to the organization
membership_for_some_user = github.Membership("membershipForSomeUser",
username="SomeUser",
role="member")
membership_for_another_user = github.Membership("membershipForAnotherUser",
username="AnotherUser",
role="member")
some_team = github.Team("someTeam", description="Some cool team")
some_team_members = github.TeamMembers("someTeamMembers",
team_id=some_team.id,
members=[
github.TeamMembersMemberArgs(
username="SomeUser",
role="maintainer",
),
github.TeamMembersMemberArgs(
username="AnotherUser",
role="member",
),
])
resources:
# Add a user to the organization
membershipForSomeUser:
type: github:Membership
properties:
username: SomeUser
role: member
membershipForAnotherUser:
type: github:Membership
properties:
username: AnotherUser
role: member
someTeam:
type: github:Team
properties:
description: Some cool team
someTeamMembers:
type: github:TeamMembers
properties:
teamId: ${someTeam.id}
members:
- username: SomeUser
role: maintainer
- username: AnotherUser
role: member
Create TeamMembers Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new TeamMembers(name: string, args: TeamMembersArgs, opts?: CustomResourceOptions);@overload
def TeamMembers(resource_name: str,
args: TeamMembersArgs,
opts: Optional[ResourceOptions] = None)
@overload
def TeamMembers(resource_name: str,
opts: Optional[ResourceOptions] = None,
members: Optional[Sequence[TeamMembersMemberArgs]] = None,
team_id: Optional[str] = None)func NewTeamMembers(ctx *Context, name string, args TeamMembersArgs, opts ...ResourceOption) (*TeamMembers, error)public TeamMembers(string name, TeamMembersArgs args, CustomResourceOptions? opts = null)
public TeamMembers(String name, TeamMembersArgs args)
public TeamMembers(String name, TeamMembersArgs args, CustomResourceOptions options)
type: github:TeamMembers
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args TeamMembersArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args TeamMembersArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args TeamMembersArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TeamMembersArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TeamMembersArgs
- 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 teamMembersResource = new Github.TeamMembers("teamMembersResource", new()
{
Members = new[]
{
new Github.Inputs.TeamMembersMemberArgs
{
Username = "string",
Role = "string",
},
},
TeamId = "string",
});
example, err := github.NewTeamMembers(ctx, "teamMembersResource", &github.TeamMembersArgs{
Members: github.TeamMembersMemberArray{
&github.TeamMembersMemberArgs{
Username: pulumi.String("string"),
Role: pulumi.String("string"),
},
},
TeamId: pulumi.String("string"),
})
var teamMembersResource = new TeamMembers("teamMembersResource", TeamMembersArgs.builder()
.members(TeamMembersMemberArgs.builder()
.username("string")
.role("string")
.build())
.teamId("string")
.build());
team_members_resource = github.TeamMembers("teamMembersResource",
members=[{
"username": "string",
"role": "string",
}],
team_id="string")
const teamMembersResource = new github.TeamMembers("teamMembersResource", {
members: [{
username: "string",
role: "string",
}],
teamId: "string",
});
type: github:TeamMembers
properties:
members:
- role: string
username: string
teamId: string
TeamMembers 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 TeamMembers resource accepts the following input properties:
- Members
List<Team
Members Member> - List of team members. See Members below for details.
- Team
Id string - The GitHub team id
- Members
[]Team
Members Member Args - List of team members. See Members below for details.
- Team
Id string - The GitHub team id
- members
List<Team
Members Member> - List of team members. See Members below for details.
- team
Id String - The GitHub team id
- members
Team
Members Member[] - List of team members. See Members below for details.
- team
Id string - The GitHub team id
- members
Sequence[Team
Members Member Args] - List of team members. See Members below for details.
- team_
id str - The GitHub team id
- members List<Property Map>
- List of team members. See Members below for details.
- team
Id String - The GitHub team id
Outputs
All input properties are implicitly available as output properties. Additionally, the TeamMembers resource produces the following output properties:
Look up Existing TeamMembers Resource
Get an existing TeamMembers 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?: TeamMembersState, opts?: CustomResourceOptions): TeamMembers@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
etag: Optional[str] = None,
members: Optional[Sequence[TeamMembersMemberArgs]] = None,
team_id: Optional[str] = None) -> TeamMembersfunc GetTeamMembers(ctx *Context, name string, id IDInput, state *TeamMembersState, opts ...ResourceOption) (*TeamMembers, error)public static TeamMembers Get(string name, Input<string> id, TeamMembersState? state, CustomResourceOptions? opts = null)public static TeamMembers get(String name, Output<String> id, TeamMembersState state, CustomResourceOptions options)resources: _: type: github:TeamMembers get: id: ${id}- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Etag string
- Members
List<Team
Members Member> - List of team members. See Members below for details.
- Team
Id string - The GitHub team id
- Etag string
- Members
[]Team
Members Member Args - List of team members. See Members below for details.
- Team
Id string - The GitHub team id
- etag String
- members
List<Team
Members Member> - List of team members. See Members below for details.
- team
Id String - The GitHub team id
- etag string
- members
Team
Members Member[] - List of team members. See Members below for details.
- team
Id string - The GitHub team id
- etag str
- members
Sequence[Team
Members Member Args] - List of team members. See Members below for details.
- team_
id str - The GitHub team id
- etag String
- members List<Property Map>
- List of team members. See Members below for details.
- team
Id String - The GitHub team id
Supporting Types
TeamMembersMember, TeamMembersMemberArgs
Package Details
- Repository
- GitHub pulumi/pulumi-github
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
githubTerraform Provider.
published on Monday, Mar 9, 2026 by Pulumi
