Backstage
Docs
Github
Preparing search index...
@backstage/integration
GithubAppCredentialsMux
Class GithubAppCredentialsMux
Corresponds to a Github installation which internally could hold several GitHub Apps.
Index
Constructors
constructor
Methods
get
All
Installations
get
App
Token
Constructors
constructor
new
GithubAppCredentialsMux
(
config
:
GithubIntegrationConfig
,
appIds
?:
number
[]
,
)
:
GithubAppCredentialsMux
Parameters
config
:
GithubIntegrationConfig
appIds
:
number
[]
= []
Returns
GithubAppCredentialsMux
Methods
get
All
Installations
getAllInstallations
()
:
Promise
<
{
access_tokens_url
:
string
;
account
:
|
{
avatar_url
:
string
;
email
?:
string
|
null
;
events_url
:
string
;
followers_url
:
string
;
following_url
:
string
;
gists_url
:
string
;
gravatar_id
:
string
|
null
;
html_url
:
string
;
id
:
number
;
login
:
string
;
name
?:
string
|
null
;
node_id
:
string
;
organizations_url
:
string
;
received_events_url
:
string
;
repos_url
:
string
;
site_admin
:
boolean
;
starred_at
?:
string
;
starred_url
:
string
;
subscriptions_url
:
string
;
type
:
string
;
url
:
string
;
}
|
{
avatar_url
:
string
;
created_at
:
string
|
null
;
description
?:
string
|
null
;
html_url
:
string
;
id
:
number
;
name
:
string
;
node_id
:
string
;
slug
:
string
;
updated_at
:
string
|
null
;
website_url
?:
string
|
null
;
}
|
null
;
app_id
:
number
;
app_slug
:
string
;
contact_email
?:
string
|
null
;
created_at
:
string
;
events
:
string
[]
;
has_multiple_single_files
?:
boolean
;
html_url
:
string
;
id
:
number
;
permissions
:
{
actions
?:
"read"
|
"write"
;
administration
?:
"read"
|
"write"
;
checks
?:
"read"
|
"write"
;
contents
?:
"read"
|
"write"
;
deployments
?:
"read"
|
"write"
;
environments
?:
"read"
|
"write"
;
issues
?:
"read"
|
"write"
;
members
?:
"read"
|
"write"
;
metadata
?:
"read"
|
"write"
;
organization_administration
?:
"read"
|
"write"
;
organization_announcement_banners
?:
"read"
|
"write"
;
organization_custom_roles
?:
"read"
|
"write"
;
organization_hooks
?:
"read"
|
"write"
;
organization_packages
?:
"read"
|
"write"
;
organization_personal_access_token_requests
?:
"read"
|
"write"
;
organization_personal_access_tokens
?:
"read"
|
"write"
;
organization_plan
?:
"read"
;
organization_projects
?:
"read"
|
"write"
|
"admin"
;
organization_secrets
?:
"read"
|
"write"
;
organization_self_hosted_runners
?:
"read"
|
"write"
;
organization_user_blocking
?:
"read"
|
"write"
;
packages
?:
"read"
|
"write"
;
pages
?:
"read"
|
"write"
;
pull_requests
?:
"read"
|
"write"
;
repository_hooks
?:
"read"
|
"write"
;
repository_projects
?:
"read"
|
"write"
|
"admin"
;
secret_scanning_alerts
?:
"read"
|
"write"
;
secrets
?:
"read"
|
"write"
;
security_events
?:
"read"
|
"write"
;
single_file
?:
"read"
|
"write"
;
statuses
?:
"read"
|
"write"
;
team_discussions
?:
"read"
|
"write"
;
vulnerability_alerts
?:
"read"
|
"write"
;
workflows
?:
"write"
;
}
;
repositories_url
:
string
;
repository_selection
:
"all"
|
"selected"
;
single_file_name
:
string
|
null
;
single_file_paths
?:
string
[]
;
suspended_at
:
string
|
null
;
suspended_by
:
|
{
avatar_url
:
string
;
email
?:
string
|
null
;
events_url
:
string
;
followers_url
:
string
;
following_url
:
string
;
gists_url
:
string
;
gravatar_id
:
string
|
null
;
html_url
:
string
;
id
:
number
;
login
:
string
;
name
?:
string
|
null
;
node_id
:
string
;
organizations_url
:
string
;
received_events_url
:
string
;
repos_url
:
string
;
site_admin
:
boolean
;
starred_at
?:
string
;
starred_url
:
string
;
subscriptions_url
:
string
;
type
:
string
;
url
:
string
;
}
|
null
;
target_id
:
number
;
target_type
:
string
;
updated_at
:
string
;
}
[]
,
>
Returns
Promise
<
{
access_tokens_url
:
string
;
account
:
|
{
avatar_url
:
string
;
email
?:
string
|
null
;
events_url
:
string
;
followers_url
:
string
;
following_url
:
string
;
gists_url
:
string
;
gravatar_id
:
string
|
null
;
html_url
:
string
;
id
:
number
;
login
:
string
;
name
?:
string
|
null
;
node_id
:
string
;
organizations_url
:
string
;
received_events_url
:
string
;
repos_url
:
string
;
site_admin
:
boolean
;
starred_at
?:
string
;
starred_url
:
string
;
subscriptions_url
:
string
;
type
:
string
;
url
:
string
;
}
|
{
avatar_url
:
string
;
created_at
:
string
|
null
;
description
?:
string
|
null
;
html_url
:
string
;
id
:
number
;
name
:
string
;
node_id
:
string
;
slug
:
string
;
updated_at
:
string
|
null
;
website_url
?:
string
|
null
;
}
|
null
;
app_id
:
number
;
app_slug
:
string
;
contact_email
?:
string
|
null
;
created_at
:
string
;
events
:
string
[]
;
has_multiple_single_files
?:
boolean
;
html_url
:
string
;
id
:
number
;
permissions
:
{
actions
?:
"read"
|
"write"
;
administration
?:
"read"
|
"write"
;
checks
?:
"read"
|
"write"
;
contents
?:
"read"
|
"write"
;
deployments
?:
"read"
|
"write"
;
environments
?:
"read"
|
"write"
;
issues
?:
"read"
|
"write"
;
members
?:
"read"
|
"write"
;
metadata
?:
"read"
|
"write"
;
organization_administration
?:
"read"
|
"write"
;
organization_announcement_banners
?:
"read"
|
"write"
;
organization_custom_roles
?:
"read"
|
"write"
;
organization_hooks
?:
"read"
|
"write"
;
organization_packages
?:
"read"
|
"write"
;
organization_personal_access_token_requests
?:
"read"
|
"write"
;
organization_personal_access_tokens
?:
"read"
|
"write"
;
organization_plan
?:
"read"
;
organization_projects
?:
"read"
|
"write"
|
"admin"
;
organization_secrets
?:
"read"
|
"write"
;
organization_self_hosted_runners
?:
"read"
|
"write"
;
organization_user_blocking
?:
"read"
|
"write"
;
packages
?:
"read"
|
"write"
;
pages
?:
"read"
|
"write"
;
pull_requests
?:
"read"
|
"write"
;
repository_hooks
?:
"read"
|
"write"
;
repository_projects
?:
"read"
|
"write"
|
"admin"
;
secret_scanning_alerts
?:
"read"
|
"write"
;
secrets
?:
"read"
|
"write"
;
security_events
?:
"read"
|
"write"
;
single_file
?:
"read"
|
"write"
;
statuses
?:
"read"
|
"write"
;
team_discussions
?:
"read"
|
"write"
;
vulnerability_alerts
?:
"read"
|
"write"
;
workflows
?:
"write"
;
}
;
repositories_url
:
string
;
repository_selection
:
"all"
|
"selected"
;
single_file_name
:
string
|
null
;
single_file_paths
?:
string
[]
;
suspended_at
:
string
|
null
;
suspended_by
:
|
{
avatar_url
:
string
;
email
?:
string
|
null
;
events_url
:
string
;
followers_url
:
string
;
following_url
:
string
;
gists_url
:
string
;
gravatar_id
:
string
|
null
;
html_url
:
string
;
id
:
number
;
login
:
string
;
name
?:
string
|
null
;
node_id
:
string
;
organizations_url
:
string
;
received_events_url
:
string
;
repos_url
:
string
;
site_admin
:
boolean
;
starred_at
?:
string
;
starred_url
:
string
;
subscriptions_url
:
string
;
type
:
string
;
url
:
string
;
}
|
null
;
target_id
:
number
;
target_type
:
string
;
updated_at
:
string
;
}
[]
,
>
get
App
Token
getAppToken
(
owner
:
string
,
repo
?:
string
)
:
Promise
<
string
|
undefined
>
Parameters
owner
:
string
Optional
repo
:
string
Returns
Promise
<
string
|
undefined
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
get
All
Installations
get
App
Token
Docs
Github
Backstage
Loading...
Corresponds to a Github installation which internally could hold several GitHub Apps.