Skip to content

Get-GitHubTeam

SYNOPSIS

List teams from an org or get a team by name

SYNTAX

List all teams in an organization (Default)

Get-GitHubTeam -Organization <String> [-Context <Object>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

BySlug

Get-GitHubTeam -Organization <String> -Slug <String> [-Context <Object>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

Lists all teams in an organization that are visible to the authenticated user or gets a team using the team's slug. To create the slug, GitHub replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, "My TEam Näme" would become my-team-name.

EXAMPLES

EXAMPLE 1

Get-GitHubTeam -Organization 'GitHub'

Gets all teams in the github organization.

EXAMPLE 2

Get-GitHubTeam -Organization 'github' -Slug 'my-team-name'

Gets the team with the slug 'my-team-name' in the github organization.

PARAMETERS

-Organization

The organization name. The name is not case sensitive. If not provided, the owner from the context will be used.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Slug

The slug of the team name.

Type: String
Parameter Sets: BySlug
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Context

The context to run the command in. Used to get the details for the API call. Can be either a string or a GitHubContext object.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: (Get-GitHubContext)
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

GitHubTeam

NOTES

List teams

https://psmodule.io/GitHub/Functions/Teams/Get-GitHubTeam