Get-GitHubApp

SYNOPSIS

Get the authenticated app or a specific app by its slug.

SYNTAX

__AllParameterSets (Default)

Get-GitHubApp [-Context <Object>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

BySlug

Get-GitHubApp -AppSlug <String> [-Context <Object>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Returns a GitHub App associated with the authentication credentials used or the provided app-slug.

EXAMPLES

EXAMPLE 1

Get-GitHubApp

Get the authenticated app.

EXAMPLE 2

Get-GitHubApp -AppSlug 'github-actions'

Get the GitHub App with the slug 'github-actions'.

PARAMETERS

-AppSlug

The AppSlug is just the URL-friendly name of a GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/{app_slug}). Example: 'github-actions'

Type: String
Parameter Sets: BySlug
Aliases: Name

Required: True
Position: Named
Default value: None
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

Get an app Get the authenticated app | GitHub Docs

RELATED LINKS