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>] [<CommonParameters>]

List all teams with access to a repository

Get-GitHubTeam -Organization <string> -Repository <string> [-Context <Object>] [<CommonParameters>]

Get a specific team by slug

Get-GitHubTeam -Organization <string> -Slug <string> [-Context <Object>] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

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.

EXAMPLE 3

Get-GitHubTeam -Organization 'github' -Repository 'my-repo'

Lists all teams that have access to the 'my-repo' repository owned by github.

PARAMETERS

-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: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Organization

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

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Repository

The name of the repository without the .git extension. The name is not case sensitive.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: List all teams with access to a repository
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Slug

The slug of the team name.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Get a specific team by slug
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

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

INPUTS

System.String

{{ Fill in the Description }}

OUTPUTS

GitHubTeam

{{ Fill in the Description }}

NOTES

RELATED LINKS