Erstellen einer GitHub-App mithilfe von URL-Parametern

Informationen zu GitHub App-URL-Parametern

Du kannst Abfrageparameter zu diesen URLs hinzufügen, um die Konfiguration einer GitHub App auf einem persönlichen oder Organisationskonto vorab auszuwählen:

• Persönliches Konto: http(s)://HOSTNAME/settings/apps/new
• Organisationskonto: http(s)://HOSTNAME/organizations/:org/settings/apps/new

Die Person, die die App erstellt, kann die vorab ausgewählten Werte von der GitHub App-Registrierungsseite bearbeiten, bevor sie die App übermittelt. Wenn du keine erforderlichen Parameter in die URL-Abfragezeichenfolge einschließt, z. B. name, muss die Person, die die App erstellt, einen Wert eingeben, bevor sie die App übermittelt.

Für Apps, die ein Geheimnis zum Sichern ihres Webhooks benötigen, muss der Wert des Geheimnisses durch die Person, die die App erstellt, und nicht mithilfe von Abfrageparametern im Formular festgelegt werden. Weitere Informationen findest du unter Sichern deiner Webhooks.

Die folgende URL erstellt eine neue öffentliche App namens octocat-github-app mit einer vorkonfigurierten Beschreibung und Rückruf-URL. Diese URL wählt auch Lese- und Schreibberechtigungen für checks, abonniert die Webhook-Ereignisse check_run und check_suite und wählt die Option zum Anfordern der Benutzerautorisierung (OAuth) während der Installation aus:

http(s)://HOSTNAME/settings/apps/new?name=octocat-github-app&description=An%20Octocat%20App&callback_urls[]=https://example.com&request_oauth_on_install=true&public=true&checks=write&events[]=check_run&events[]=check_suite

Die vollständige Liste der verfügbaren Abfrageparameter, Berechtigungen und Ereignisse wird in den folgenden Abschnitten aufgeführt.

GitHub App-Konfigurationsparameter

Name	type	BESCHREIBUNG
name	string	Der Name der GitHub App. Gib deiner App einen klaren und kurzen Namen. Deine App kann nicht denselben Namen wie ein vorhandener GitHub-Benutzer haben, es sei denn, es handelt sich um deinen eigenen Benutzer- oder Organisationsnamen. Eine Slugversion des Namens deiner App wird in der Benutzeroberfläche angezeigt, wenn deine Integration eine Aktion ausführt.
description	string	Eine Beschreibung der GitHub App.
url	string	Die vollständige URL der Startseite der Website deiner GitHub App.
callback_urls	array of strings	Vollständige URL, an die Benutzer*innen nach der Autorisierung einer Installation umgeleitet werden. Du kannst bis zu zehn Rückruf-URLs bereitstellen. Diese URLs werden verwendet, wenn deine App Benutzer-zu-Server-Anforderungen identifizieren und autorisieren muss. Beispiel: callback_urls[]=https://example.com&callback_urls[]=https://example-2.com.
request_oauth_on_install	boolean	Wenn deine App Benutzer mit dem OAuth-Flow autorisiert, kannst du diese Option auf true festlegen, damit Personen die App während der Installation autorisieren können, was einen Schritt einspart. Wenn du diese Option auswählst, ist die setup_url nicht mehr verfügbar, und Benutzer werden nach der Installation der App an deine callback_url weitergeleitet.
setup_url	string	Die vollständige URL zum Umleiten nach der Installation der GitHub App, wenn die App nach der Installation ein zusätzliches Setup erfordert.
setup_on_update	boolean	Lege diesen Parameter auf true fest, um Personen an die Setup-URL umzuleiten, wenn Installationen aktualisiert wurden, z. B. nach dem Hinzufügen oder Entfernen von Repositorys.
public	boolean	Lege diesen Parameter auf true fest, wenn deine GitHub App öffentlich verfügbar sein soll, oder auf false, wenn nur der Besitzer der App darauf zugreifen darf.
webhook_active	boolean	Lege diesen Parameter auf false fest, um den Webhook zu deaktivieren. Der Webhook ist standardmäßig aktiviert.
webhook_url	string	Die vollständige URL, an die du Webhook-Ereignisnutzdaten senden möchtest.
events	array of strings	Webhook-Ereignisse. Einige Webhook-Ereignisse erfordern read- oder write-Berechtigungen für eine Ressource, bevor du das Ereignis auswählen kannst, wenn du eine neue GitHub App registrierst. Verfügbare Ereignisse und deren erforderliche Berechtigungen findest du im Abschnitt GitHub App-Webhook-Ereignisse. Du kannst mehrere Ereignisse in einer Abfragezeichenfolge auswählen. Beispiel: events[]=public&events[]=label.
single_file_name	string	Dies ist eine stark begrenzte Berechtigung, mit der die App auf eine einzelne Datei in einem beliebigen Repository zugreifen kann. Wenn du die single_file-Berechtigung auf read oder write festlegst, stellt dieses Feld den Pfad zur einzelnen Datei bereit, die deine GitHub App verwaltet. Wenn du mehrere Dateien verwalten musst, lies unten single_file_paths.
single_file_paths	array of strings	Dadurch kann die App auf bis zu zehn angegebene Dateien in einem Repository zugreifen. Wenn du die single_file-Berechtigung auf read oder write festlegst, kann dieses Array die Pfade für bis zu zehn Dateien speichern, die deine GitHub App verwaltet. Diese Dateien erhalten alle die gleiche Berechtigung, die von single_file festgelegt ist, und verfügen nicht über separate individuelle Berechtigungen. Wenn zwei oder mehr Dateien konfiguriert sind, gibt die API multiple_single_files=true zurück, anderenfalls multiple_single_files=false.

GitHub App-Berechtigungen

Du kannst Berechtigungen in einer Abfragezeichenfolge mithilfe des Berechtigungsnamens in der folgenden Tabelle als Abfrageparameternamen und den Berechtigungstyp als Abfragewert auswählen. Wenn du beispielsweise Read & write-Berechtigungen in der Benutzeroberfläche für contents auswählen möchtest, würde deine Abfragezeichenfolge &contents=write enthalten. Für die Auswahl von Read-only-Berechtigungen auf der Benutzeroberfläche von blocking würde deine Abfragezeichenfolge &blocking=read enthalten. Für die Auswahl von no-access auf der Benutzeroberfläche von checks würde deine Abfragezeichenfolge die checks-Berechtigung nicht enthalten.

Berechtigung	BESCHREIBUNG
administration	Gewährt Zugriff auf verschiedene Endpunkte für die Organisations- und Repositoryverwaltung. Kann none, read oder write sein.
checks	Gewährt Zugriff auf die API für Überprüfungen. Kann none, read oder write sein.
contents	Gewährt Zugriff auf verschiedene Endpunkte, mit denen du Repositoryinhalte ändern kannst. Kann none, read oder write sein.
deployments	Gewährt Zugriff auf die Bereitstellungs-API. Kann none, read oder write sein.
emails	Gewährt Zugriff auf die E-Mail-API. Kann none, read oder write sein.
followers	Gewährt Zugriff auf die Follower-API. Kann none, read oder write sein.
gpg_keys	Gewährt Zugriff auf die GPG-Schlüssel-API. Kann none, read oder write sein.
issues	Gewährt Zugriff auf die Issue-API. Kann none, read oder write sein.
keys	Gewährt Zugriff auf die API für öffentliche Schlüssel. Kann none, read oder write sein.
members	Gewährt Zugriff zum Verwalten der Mitglieder einer Organisation. Kann none, read oder write sein.
organization_hooks	Gewährt Zugriff auf die Organisationswebhook-API. Kann none, read oder write sein.
organization_plan	Gewährt Zugriff zum Abrufen von Informationen über den Plan einer Organisation mithilfe des Endpunkts Organisation abrufen. Kann none oder read sein.
organization_projects	Gewährt Zugriff auf die Projekt-API. Kann none, read, write oder admin sein.
pages	Gewährt Zugriff auf die Seiten-API. Kann none, read oder write sein.
plan	Gewährt Zugriff zum Abrufen von Informationen über den GitHub-Plan eines Benutzers mithilfe des Endpunkts Benutzer abrufen. Kann none oder read sein.
pull_requests	Gewährt Zugriff auf verschiedene Pull Request-Endpunkte. Kann none, read oder write sein.
repository_hooks	Gewährt Zugriff auf die Repository-Webhooks-API. Kann none, read oder write sein.
repository_projects	Gewährt Zugriff auf die Projekt-API. Kann none, read, write oder admin sein.
secret_scanning_alerts	Gewährt Zugriff auf die API zur Überprüfung von Geheimnissen. Kann none, read oder write sein.
security_events	Gewährt Zugriff auf die API zur Codeüberprüfung. Kann none, read oder write sein.
single_file	Gewährt Zugriff auf die Inhalts-API. Kann none, read oder write sein.
starring	Gewährt Zugriff auf die API zum Versehen mit einem Stern. Kann none, read oder write sein.
statuses	Gewährt Zugriff auf die Status-API. Kann none, read oder write sein.
team_discussions	Gewährt Zugriff auf die Teamdiskussions-API und die Teamdiskussionskommentar-API. Mögliche Werte: none, read oder write.
vulnerability_alerts	Gewährt den Zugriff für den Empfang von Dependabot alerts in einem Repository Weitere Informationen findest du unter Informationen zu Dependabot alerts. Diese können none, read oder write lauten.
watching	Gewährt Zugriff zum Auflisten und Ändern von Repositorys, die ein Benutzer abonniert hat. Kann none, read oder write sein.

GitHub App-Webhook-Ereignisse

Name von Webhook-Ereignis	Erforderliche Berechtigung	BESCHREIBUNG
check_run	checks	Die Ausführungsaktivität wurde überprüft. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Überprüfungsausführungen.
check_suite	checks	Prüfsuitenaktivität ist aufgetreten. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Prüfsuiten.
commit_comment	contents	Ein Commitkommentar wird erstellt. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der Commitkommentar-REST-API.
create	contents	Ein Git-Branch oder -Tag wird erstellt. Weitere Informationen findest du in der REST-API für die Git-Datenbank.
delete	contents	Ein Git-Branch oder -Tag wird gelöscht. Weitere Informationen findest du in der REST-API für die Git-Datenbank.
deployment	deployments	Eine Bereitstellung wird erstellt. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für „Bereitstellungen“.
deployment_status	deployments	Eine Bereitstellung wird erstellt. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Bereitstellungen.
fork	contents	Ein Benutzer forkt ein Repository. Weitere Informationen findest du in der „Forks“ REST-API.
gollum	contents	Eine Wiki-Seite wird erstellt oder aktualisiert. Weitere Informationen findest du unter Informationen zu Wikis.
issues	issues	Aktivität im Zusammenhang mit einem Issue. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Issues.
issue_comment	issues	Aktivitäten im Zusammenhang mit einem Issue oder einem Pull Request-Kommentar. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Issuekommentare.
label	metadata	Aktivitäten im Zusammenhang mit einer Bezeichnung. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Bezeichnungen.
member	members	Aktivitäten im Zusammenhang mit Repositorymitarbeitern. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Mitarbeiter.
membership	members	Aktivitäten im Zusammenhang mit der Teammitgliedschaft. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Teammitglieder.
milestone	pull_request	Aktivitäten im Zusammenhang mit Meilensteinen. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Meilensteine.
organization	members	Aktivitäten im Zusammenhang mit einer Organisation und ihren Mitgliedern. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Organisationen.
page_build	pages	Stellt einen versuchten Build einer GitHub Pages-Website dar, unabhängig davon, ob er erfolgreich war. Ein Push an einen GitHub Pages-fähigen Branch (gh-pages für Projektseiten, den Standardbranch für Benutzer- und Organisationsseiten) löst dieses Ereignis aus.
project	repository_projects oder organization_projects	project boards bezogene Aktivität. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Projekte.
project_card	repository_projects oder organization_projects	Kartenbezogene Aktivitäten in einem project board. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Projektkarten.
project_column	repository_projects oder organization_projects	Spaltenbezogene Aktivitäten in einem project board. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Projektspalten.
public	metadata	Wenn ein privates Repository öffentlich gemacht wird. Ohne Zweifel das beste GitHub Enterprise Server-Ereignis.
pull_request	pull_requests	Aktivitäten im Zusammenhang mit Pull Requests. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Pull Requests.
pull_request_review	pull_request	Aktivitäten im Zusammenhang mit Pull Request-Überprüfungen. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der Pull Request-Überprüfungen-REST-API.
pull_request_review_comment	pull_request	Aktivitäten im Zusammenhang mit Pull Request-Reviewkommentaren im Unified Diff des Pull Request. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Pull Request-Reviewkommentare.
pull_request_review_thread	pull_request	Aktivität im Zusammenhang mit einem Kommentarthread zu einem Pull Request, der als aufgelöst oder nicht gelöst markiert wurde Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben.
push	contents	Ein oder mehrere Commits werden in einen Repositorybranch oder ein Tag gepusht.
release	contents	Aktivität im Zusammenhang mit einem Release. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Releases.
repository	metadata	Aktivitäten im Zusammenhang mit einem Repository. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Repositorys.
status	statuses	Wenn sich der Status eines Git-Commits ändert. Weitere Informationen findest du in der Dokumentation zur Status-REST-API.
team	members	Aktivitäten im Zusammenhang mit dem Team einer Organisation. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Teams.
team_add	members	Wenn ein Repository einem Team hinzugefügt wird.
watch	metadata	Wenn jemand ein Repository mit einem Stern versieht. Der Aktivitätstyp wird in der action-Eigenschaft des Nutzdatenobjekts angegeben. Weitere Informationen findest du in der REST-API für Sterne.