Get-GitHubUser

NAME Get-GitHubUser



SYNOPSIS

Retrieves information about the specified user on GitHub.





SYNTAX

Get-GitHubUser [-User <String>] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]



Get-GitHubUser [-Current] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Retrieves information about the specified user on GitHub.



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





PARAMETERS

-User <String>

The GitHub user to retrieve information for.

If not specified, will retrieve information on all GitHub users (and may take a while to complete).



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Current [<SwitchParameter>]

If specified, gets information on the current user.



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? named

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



NOTES





The email key in the following response is the publicly visible email address from the

user's GitHub profile page. You only see publicly visible email addresses when

authenticated with GitHub.



When setting up your profile, a user can select a primary email address to be public

which provides an email entry for this endpoint. If the user does not set a public

email address for email, then it will have a value of null.



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



PS C:\\>Get-GitHubUser -User octocat



Gets information on just the user named 'octocat'









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-GitHubUser



Gets information on every GitHub user.









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Get-GitHubUser -Current



Gets information on the current authenticated user.











RELATED LINKS