Get-GitHubAppJSONWebToken¶
SYNOPSIS¶
Generates a JSON Web Token (JWT) for a GitHub App.
SYNTAX¶
PrivateKey (Default)¶
Get-GitHubAppJSONWebToken -ClientId <String> -PrivateKey <Object> [-ProgressAction <ActionPreference>]
[<CommonParameters>]
FilePath¶
Get-GitHubAppJSONWebToken -ClientId <String> -PrivateKeyFilePath <String> [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION¶
Generates a JSON Web Token (JWT) for a GitHub App.
EXAMPLES¶
EXAMPLE 1¶
Get-GitHubAppJWT -ClientId 'Iv987654321' -PrivateKeyFilePath '/path/to/private-key.pem'
Generates a JSON Web Token (JWT) for a GitHub App using the specified client ID and private key file path.
EXAMPLE 2¶
Get-GitHubAppJWT -ClientId 'Iv987654321' -PrivateKey '--- BEGIN RSA PRIVATE KEY --- ... --- END RSA PRIVATE KEY ---'
Generates a JSON Web Token (JWT) for a GitHub App using the specified client ID and private key.
PARAMETERS¶
-ClientId¶
The client ID of the GitHub App. Can use the GitHub App ID or the client ID. Example: 'Iv23li8tyK9NUwl7rWlQ' Example: '123456'
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PrivateKeyFilePath¶
The path to the private key file of the GitHub App. Example: '/path/to/private-key.pem'
Type: String
Parameter Sets: FilePath
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PrivateKey¶
The private key of the GitHub App. Example: @' -----BEGIN RSA PRIVATE KEY----- qwe ... -----END RSA PRIVATE KEY----- '@
Type: Object
Parameter Sets: PrivateKey
Aliases:
Required: True
Position: Named
Default value: None
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.String¶
NOTES¶
Generating a JSON Web Token (JWT) for a GitHub App | GitHub Docs