Get-GitHubApp

SYNOPSIS

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

SYNTAX

Get the authenticated app (Default)

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

Get an app by slug

Get-GitHubApp -Slug <string> [-Context <Object>] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

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 -Slug 'github-actions'

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

PARAMETERS

-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: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Slug

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: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Get an app by slug
  Position: Named
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String

{{ Fill in the Description }}

OUTPUTS

GitHubApp

{{ Fill in the Description }}

NOTES

Get an app Get the authenticated app | GitHub Docs

RELATED LINKS