Retrieves information about the specified user on GitHub.

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

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

Retrieves information about the specified user on GitHub.

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

Get-GitHubUser -UserName octocat

Gets information on just the user named 'octocat'

'octocat', 'PowerShellForGitHubTeam' | Get-GitHubUser

Gets information on the users named 'octocat' and 'PowerShellForGitHubTeam'

Get-GitHubUser

Gets information on every GitHub user.

Get-GitHubUser -Current

Gets information on the current authenticated user.

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

If specified, gets information on the current user.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: Current
Aliases:

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

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.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

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

{{ Fill UserName Description }}

Type: System.String
Parameter Sets: ListAndSearch
Aliases: User, Name

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

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

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.