Update-GitHubCurrentUser

NAME Update-GitHubCurrentUser



SYNOPSIS

Updates information about the current authenticated user on GitHub.





SYNTAX

Update-GitHubCurrentUser [[-Name] <String>] [[-Email] <String>] [[-Blog] <String>] [[-Company] <String>]

[[-Location] <String>] [[-Bio] <String>] [-Hireable] [[-AccessToken] <String>] [-NoStatus] [-WhatIf] [-Confirm]

[<CommonParameters>]





DESCRIPTION

Updates information about the current authenticated user on GitHub.



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





PARAMETERS

-Name <String>

The new name of the user.



Required? false

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Email <String>

The publicly visible email address of the user.



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Blog <String>

The new blog URL of the user.



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Company <String>

The new company of the user.



Required? false

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Location <String>

The new location of the user.



Required? false

Position? 5

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Bio <String>

The new short biography of the user.



Required? false

Position? 6

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Hireable [<SwitchParameter>]

Specify to indicate a change in hireable availability for the current authenticated user's

GitHub profile. To change to "not hireable", specify -Hireable:$false



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-AccessToken <String>

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.



Required? false

Position? 7

Default value

Accept pipeline input? false

Accept wildcard characters? false



-NoStatus [<SwitchParameter>]

If this switch is specified, long-running commands will run on the main thread

with no commandline status update. When not specified, those commands run in

the background, enabling the command prompt to provide status information.

If not supplied here, the DefaultNoStatus configuration property value will be used.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Update-GitHubCurrentUser -Location 'Seattle, WA' -Hireable:$false



Updates the current user to indicate that their location is "Seattle, WA" and that they

are not currently hireable.











RELATED LINKS