Skip to content

Get-GitHubRepositoryPermission

SYNOPSIS

Get the permission level for a team on a repository.

SYNTAX

Get-GitHubRepositoryPermission [-Owner] <String> [-Name] <String> [-Team] <String> [[-TeamOwner] <String>]
 [[-Context] <Object>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

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'.

EXAMPLE 2

PARAMETERS

-Owner

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

Type: String
Parameter Sets: (All)
Aliases: Organization

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Name

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

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Team

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

Type: String
Parameter Sets: (All)
Aliases: Slug, TeamSlug

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

-TeamOwner

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
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: 5
Default value: None
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

GitHubRepository

OUTPUTS

string

NOTES

Check team permissions for a repository

https://psmodule.io/GitHub/Functions/Get-GitHubRepositoryPermission/