getTeam

GitHub v4.17.0 (4.x), Mar 9 26

Viewing docs for GitHub v4.17.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-github

Viewing docs for GitHub v4.17.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-github

Example Usage

using System.Collections.Generic;
using Pulumi;
using Github = Pulumi.Github;

return await Deployment.RunAsync(() => 
{
    var example = Github.GetTeam.Invoke(new()
    {
        Slug = "example",
    });

});

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.LookupTeam(ctx, &GetTeamArgs{
			Slug: "example",
		}, nil)
		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.GithubFunctions;
import com.pulumi.github.inputs.GetTeamArgs;
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 = GithubFunctions.getTeam(GetTeamArgs.builder()
            .slug("example")
            .build());

    }
}

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

const example = pulumi.output(github.getTeam({
    slug: "example",
}));

import pulumi
import pulumi_github as github

example = github.get_team(slug="example")

variables:
  example:
    Fn::Invoke:
      Function: github:getTeam
      Arguments:
        slug: example

Using getTeam

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 getTeam(args: GetTeamArgs, opts?: InvokeOptions): Promise<GetTeamResult>
function getTeamOutput(args: GetTeamOutputArgs, opts?: InvokeOptions): Output<GetTeamResult>

def get_team(membership_type: Optional[str] = None,
             slug: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetTeamResult
def get_team_output(membership_type: Optional[pulumi.Input[str]] = None,
             slug: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetTeamResult]

func LookupTeam(ctx *Context, args *LookupTeamArgs, opts ...InvokeOption) (*LookupTeamResult, error)
func LookupTeamOutput(ctx *Context, args *LookupTeamOutputArgs, opts ...InvokeOption) LookupTeamResultOutput

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

public static class GetTeam 
{
    public static Task<GetTeamResult> InvokeAsync(GetTeamArgs args, InvokeOptions? opts = null)
    public static Output<GetTeamResult> Invoke(GetTeamInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetTeamResult> getTeam(GetTeamArgs args, InvokeOptions options)
public static Output<GetTeamResult> getTeam(GetTeamArgs args, InvokeOptions options)

fn::invoke:
  function: github:index/getTeam:getTeam
  arguments:
    # arguments dictionary

The following arguments are supported:

Slug string: The team slug.
MembershipType string: Type of membershp to be requested to fill the list of members. Can be either "all" or "immediate". Default: "all"

Slug string: The team slug.
MembershipType string: Type of membershp to be requested to fill the list of members. Can be either "all" or "immediate". Default: "all"

slug String: The team slug.
membershipType String: Type of membershp to be requested to fill the list of members. Can be either "all" or "immediate". Default: "all"

slug string: The team slug.
membershipType string: Type of membershp to be requested to fill the list of members. Can be either "all" or "immediate". Default: "all"

slug str: The team slug.
membership_type str: Type of membershp to be requested to fill the list of members. Can be either "all" or "immediate". Default: "all"

slug String: The team slug.
membershipType String: Type of membershp to be requested to fill the list of members. Can be either "all" or "immediate". Default: "all"

getTeam Result

The following output properties are available:

Description string: the team's description.
Id string: The provider-assigned unique ID for this managed resource.
Members List<string>: List of team members (list of GitHub usernames)
Name string: the team's full name.
NodeId string: the Node ID of the team.
Permission string: the team's permission level.
Privacy string: the team's privacy type.
Repositories List<string>: List of team repositories (list of repo names)
Slug string
MembershipType string

Description string: the team's description.
Id string: The provider-assigned unique ID for this managed resource.
Members []string: List of team members (list of GitHub usernames)
Name string: the team's full name.
NodeId string: the Node ID of the team.
Permission string: the team's permission level.
Privacy string: the team's privacy type.
Repositories []string: List of team repositories (list of repo names)
Slug string
MembershipType string

description String: the team's description.
id String: The provider-assigned unique ID for this managed resource.
members List<String>: List of team members (list of GitHub usernames)
name String: the team's full name.
nodeId String: the Node ID of the team.
permission String: the team's permission level.
privacy String: the team's privacy type.
repositories List<String>: List of team repositories (list of repo names)
slug String
membershipType String

description string: the team's description.
id string: The provider-assigned unique ID for this managed resource.
members string[]: List of team members (list of GitHub usernames)
name string: the team's full name.
nodeId string: the Node ID of the team.
permission string: the team's permission level.
privacy string: the team's privacy type.
repositories string[]: List of team repositories (list of repo names)
slug string
membershipType string

description str: the team's description.
id str: The provider-assigned unique ID for this managed resource.
members Sequence[str]: List of team members (list of GitHub usernames)
name str: the team's full name.
node_id str: the Node ID of the team.
permission str: the team's permission level.
privacy str: the team's privacy type.
repositories Sequence[str]: List of team repositories (list of repo names)
slug str
membership_type str

description String: the team's description.
id String: The provider-assigned unique ID for this managed resource.
members List<String>: List of team members (list of GitHub usernames)
name String: the team's full name.
nodeId String: the Node ID of the team.
permission String: the team's permission level.
privacy String: the team's privacy type.
repositories List<String>: List of team repositories (list of repo names)
slug String
membershipType String

Package Details

Repository: GitHub pulumi/pulumi-github
License: Apache-2.0
Notes: This Pulumi package is based on the github Terraform Provider.

Viewing docs for GitHub v4.17.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-github

github.getTeam

On this page

On this page

Example Usage

Using getTeam

getTeam Result

Package Details

On this page

On this page