Get-GitHubRepositoryPermission

SYNOPSIS

Get the permission level for a team on a repository.

SYNTAX

__AllParameterSets

Get-GitHubRepositoryPermission [-Owner] <string> [-Name] <string> [-Team] <string>
 [[-TeamOwner] <string>] [[-Context] <Object>] [<CommonParameters>]

ALIASES

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

DESCRIPTION

Retrieves the permission level assigned to a specific team for a given GitHub repository.

EXAMPLES

EXAMPLE 1

Get-GitHubRepositoryPermission -Owner 'octocat' -Name 'Hello-World' -Team 'core'

Output:

Admin

Retrieves the permission of the 'core' team on the 'Hello-World' repository owned by 'octocat'.

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: 4
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Name

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

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

-Owner

The account owner of the repository. The name is not case sensitive.

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

-Team

The slug of the team to add or update repository permissions for.

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

-TeamOwner

The owner of the team. If not specified, the owner will default to the value of -Owner.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 3
  IsRequired: false
  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

GitHubRepository

{{ Fill in the Description }}

System.String

{{ Fill in the Description }}

OUTPUTS

string

{{ Fill in the Description }}

System.String

{{ Fill in the Description }}

NOTES

Check team permissions for a repository

RELATED LINKS