Get-GitHubUserSigningKey¶
SYNOPSIS¶
List SSH signing keys for a given user or the authenticated user.
SYNTAX¶
Username¶
Get-GitHubUserSigningKey -Username <String> [-PerPage <Int32>] [-Context <Object>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Me¶
Get-GitHubUserSigningKey [-ID <String>] [-PerPage <Int32>] [-Context <Object>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION¶
Lists a given user's or the current user's SSH signing keys.
EXAMPLES¶
EXAMPLE 1¶
Get-GitHubUserSigningKey
Gets all SSH signing keys for the authenticated user.
EXAMPLE 2¶
Get-GitHubUserSigningKey -ID '1234567'
Gets the SSH signing key with the ID '1234567' for the authenticated user.
EXAMPLE 3¶
Get-GitHubUserSigningKey -Username 'octocat'
Gets all SSH signing keys for the 'octocat' user.
PARAMETERS¶
-Username¶
The handle for the GitHub user account.
Type: String
Parameter Sets: Username
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-ID¶
The unique identifier of the SSH signing key.
Type: String
Parameter Sets: Me
Aliases: gpg_key_id
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PerPage¶
The number of results per page (max 100).
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-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: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: (Get-GitHubContext)
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction¶
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS¶
OUTPUTS¶
System.Management.Automation.PSObject¶
NOTES¶
List SSH signing keys for the authenticated user Get an SSH signing key for the authenticated user List SSH signing keys for a user