Block-GitHubUser

SYNOPSIS

Block a user from user or an organization.

SYNTAX

__AllParameterSets (Default)

Block-GitHubUser -Username <string> [-Organization <string>] [-Context <Object>]
 [<CommonParameters>]

Organization

Block-GitHubUser -Username <string> -Organization <string> [-Context <Object>] [<CommonParameters>]

ALIASES

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

DESCRIPTION

Blocks the given user and returns true. If the user cannot be blocked false is returned.

EXAMPLES

EXAMPLE 1

Block-GitHubUser -Username 'octocat'

Blocks the user 'octocat' for the authenticated user. Returns $true if successful, $false if not.

EXAMPLE 2

Block-GitHubUser -Organization 'GitHub' -Username 'octocat'

Blocks the user 'octocat' from the organization 'GitHub'. Returns $true if successful, $false if not.

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.

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

-Username

The handle for the GitHub user account.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases:
- login
ParameterSets:
- Name: (All)
  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

OUTPUTS

System.Boolean

{{ Fill in the Description }}

NOTES

Block a user Block a user from an organization

RELATED LINKS