Skip to content

Test GitHubAssignee

Howard Wolosky edited this page Oct 5, 2020 · 2 revisions

Test-GitHubAssignee

SYNOPSIS

Checks if a user has permission to be assigned to an issue in this repository.

SYNTAX

Elements (Default)

Test-GitHubAssignee [-OwnerName <String>] [-RepositoryName <String>] [-Assignee <String>]
 [-AccessToken <String>] [<CommonParameters>]

Uri

Test-GitHubAssignee -Uri <String> [-Assignee <String>] [-AccessToken <String>] [<CommonParameters>]

DESCRIPTION

Checks if a user has permission to be assigned to an issue in this repository.

The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub

EXAMPLES

EXAMPLE 1

Test-GitHubAssignee -OwnerName microsoft -RepositoryName PowerShellForGitHub -Assignee "LoginID123"

Checks if a user has permission to be assigned to an issue from the microsoft\PowerShellForGitHub project.

EXAMPLE 2

$repo = Get-GitHubRepository -OwnerName microsoft -RepositoryName PowerShellForGitHub
$repo | Test-GitHubAssignee -Assignee 'octocat'

Checks if a user has permission to be assigned to an issue from the microsoft\PowerShellForGitHub project.

EXAMPLE 3

$octocat = Get-GitHubUser -UserName 'octocat'
$repo = $octocat | Test-GitHubAssignee -OwnerName microsoft -RepositoryName PowerShellForGitHub

Checks if a user has permission to be assigned to an issue from the microsoft\PowerShellForGitHub project.

PARAMETERS

-AccessToken

If provided, this will be used as the AccessToken for authentication with the REST Api. Otherwise, will attempt to use the configured value or will run unauthenticated.

Type: System.String
Parameter Sets: (All)
Aliases:

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

-Assignee

Username for the assignee

Type: System.String
Parameter Sets: (All)
Aliases: UserName

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

-OwnerName

Owner of the repository. If not supplied here, the DefaultOwnerName configuration property value will be used.

Type: System.String
Parameter Sets: Elements
Aliases:

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

-RepositoryName

Name of the repository. If not supplied here, the DefaultRepositoryName configuration property value will be used.

Type: System.String
Parameter Sets: Elements
Aliases:

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

-Uri

Uri for the repository. The OwnerName and RepositoryName will be extracted from here instead of needing to provide them individually.

Type: System.String
Parameter Sets: Uri
Aliases: RepositoryUrl

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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

GitHub.Branch

GitHub.Content

GitHub.Event

GitHub.Issue

GitHub.IssueComment

GitHub.Label

GitHub.Milestone

GitHub.PullRequest

GitHub.Project

GitHub.ProjectCard

GitHub.ProjectColumn

GitHub.Reaction

GitHub.Release

GitHub.ReleaseAsset

GitHub.Repository

GitHub.User

OUTPUTS

[bool]

If the assignee can be assigned to issues in the repository.

NOTES

RELATED LINKS

PowerShellForGitHub

Docs

PowerShellForGitHub

Functions

Clone this wiki locally