Get-GitHubUserContextualInformation

NAME Get-GitHubUserContextualInformation



SYNOPSIS

Retrieves contextual information about the specified user on GitHub.





SYNTAX

Get-GitHubUserContextualInformation [-User] <String> [[-Subject] <String>] [[-SubjectId] <String>] [[-AccessToken]

<String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Retrieves contextual 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.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Subject <String>

Identifies which additional information to receive about the user's hovercard.



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-SubjectId <String>

The ID for the Subject. Required when Subject has been specified.



Required? false

Position? 3

Default value

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

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:\\>Get-GitHubUserContextualInformation -User octocat













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



PS C:\\>Get-GitHubUserContextualInformation -User octocat -Subject Repository -SubjectId 1300192















RELATED LINKS