Skip to content

Unblock-GitHubUser

SYNOPSIS

Unblock a user

SYNTAX

__AllParameterSets

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

ALIASES

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

DESCRIPTION

Unblocks the given user and returns true.

EXAMPLES

EXAMPLE 1

Unblock-GitHubUser -Username 'octocat'

Unblocks the user 'octocat' for the authenticated user. Returns $true if successful.

EXAMPLE 2

Unblock-GitHubUser -Organization 'GitHub' -Username 'octocat'

Unblocks the user 'octocat' from the organization 'GitHub'. Returns $true if successful.

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: 2
  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: 1
  IsRequired: false
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: true
  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: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: true
  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

System.Boolean

{{ Fill in the Description }}

NOTES

Unblock a user Unblock a user from an organization