Add-GitHubUserGpgKey¶
SYNOPSIS¶
Create a GPG key for the authenticated user
SYNTAX¶
Add-GitHubUserGpgKey [-Name] <String> [-ArmoredPublicKey] <String> [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION¶
Adds a GPG key to the authenticated user's GitHub account.
Requires that you are authenticated via Basic Auth, or OAuth with at least write:gpg_key
scope.
EXAMPLES¶
EXAMPLE 1¶
Add-GitHubUserGpgKey -Name 'GPG key for GitHub' -ArmoredPublicKey @'
-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: GnuPG v1
mQINBFnZ2ZIBEADQ2Z7Z7 -----END PGP PUBLIC KEY BLOCK----- '@
Adds a GPG key to the authenticated user's GitHub account.
PARAMETERS¶
-Name¶
A descriptive name for the new key.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-ArmoredPublicKey¶
A GPG key in ASCII-armored format.
Type: String
Parameter Sets: (All)
Aliases: armored_public_key
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
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 GPG key for the authenticated user