Add-GitHubUserKey¶
SYNOPSIS¶
Create a public SSH key for the authenticated user
SYNTAX¶
Add-GitHubUserKey [[-Title] <String>] [-Key] <String> [[-Context] <Object>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION¶
Adds a public SSH key to the authenticated user's GitHub account.
Requires that you are authenticated via Basic Auth, or OAuth with at least write:public_key
scope.
EXAMPLES¶
EXAMPLE 1¶
Add-GitHubUserKey -Title 'ssh-rsa AAAAB3NzaC1yc2EAAA' -Key '2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234'
Adds a new public SSH key to the authenticated user's GitHub account.
PARAMETERS¶
-Title¶
A descriptive name for the new key.
Type: String
Parameter Sets: (All)
Aliases: name
Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Key¶
The public SSH key to add to your GitHub account.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
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: 3
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¶
Create a public SSH key for the authenticated user