Ändern einer GitHub-App-Registrierung

Nach dem Registrieren einer GitHub App kannst du Änderungen daran vornehmen.

In diesem Artikel

Informationen zu Modifikationen von GitHub App

Du kannst deine GitHub App-Registrierung bearbeiten, um Einstellungen zu ändern, die beim ursprünglichen Registrieren der App ausgewählt wurden. Weitere Informationen zu den Einstellungen, die du beim Registrieren einer GitHub App auswählen kannst, findest du unter Registrieren einer GitHub-App.

Du kannst z. B. den Namen und die Beschreibung deiner App, die Berechtigungen, die deiner App erteilt wurden, die Webhooks, die deine App abonniert hat, oder die Sichtbarkeit deiner App ändern.

Du kannst auch wählen, neue optionale Features für deine GitHub App zu testen. Weitere Informationen findest du unter Aktivieren optionaler Features für GitHub-Apps.

Um eine GitHub App zu bearbeiten navigiere zuerst zur Seite mit den App-Einstellungen.

  1. Klicke auf GitHub in der oberen rechten Ecke einer beliebigen Seite auf dein Profilfoto.
  2. Navigieren Sie zu den Einstellungen für Ihr Konto.
    • Klicken Sie bei einer App, die zu einem persönlichen Konto gehört, auf Einstellungen.
    • Für eine App im Besitz einer Organisation:
      1. Klicke Sie auf Ihre Organisationen.
      2. Klicken Sie rechts neben der Organisation auf Einstellungen.
  3. Klicke auf der linken Seitenleiste auf Entwicklereinstellungen.
  4. Klicke auf der linken Randleiste auf GitHub Apps .
  5. Klicke rechts neben der GitHub App, die du ändern möchtest, auf Bearbeiten.

Ändern der grundlegenden Informationen einer GitHub App

Du kannst die grundlegenden Informationen deiner GitHub App ändern, z. B. den Namen, die Beschreibung oder die Homepage-URL der App.

  1. Navigiere zur Einstellungsseite für die App, die du ändern möchtest. Weitere Informationen findest du unter Navigieren zu deinenGitHub App-Einstellungen in diesem Artikel.
  2. Bearbeite unter „Grundlegende Informationen“ die Informationen zur GitHub App, die du ändern möchtest.
  3. Klicke auf Änderungen speichern.

Benutzerautorisierung (OAuth) während der Installation anfordern

Du kannst Benutzerinnen dazu auffordern, deine GitHub App bei der Installation zu autorisieren und ein Benutzerzugriffstoken zu generieren. Wenn du die Benutzerautorisierung (OAuth) während der Installation anforderst, musst du auch eine Rückruf-URL angeben, an die Benutzerinnen umgeleitet werden, nachdem sie die Installation autorisiert haben. Weitere Informationen findest du unter Generieren eines Benutzerzugriffstokens für eine GitHub-App.

  1. Navigiere zur Einstellungsseite für die App, die du ändern möchtest. Weitere Informationen findest du unter Navigieren zu deinenGitHub App-Einstellungen in diesem Artikel.
  2. Aktiviere oder deaktiviere Benutzerautorisierung (OAuth) während der Installation anfordern unter „Identifizieren und Autorisieren von Benutzern“.
  3. Gib unter „Rückruf-URL“ die vollständige URL ein, zu der umgeleitet werden soll, nachdem Benutzer*innen die Installation autorisiert haben.

Aktivieren oder Deaktivieren des Geräteflusses

Mit dem Gerätefluss kannst du Benutzer*innen für eine App ohne GUI autorisieren, z. B. ein CLI-Tool oder Git Credential Manager. Weitere Informationen zum Verwenden des Geräteflusses mit GitHub Apps findest du unter Generieren eines Benutzerzugriffstokens für eine GitHub-App.

  1. Navigiere zur Einstellungsseite für die App, die du ändern möchtest. Weitere Informationen findest du unter Navigieren zu deinenGitHub App-Einstellungen in diesem Artikel.
  2. Aktiviere oder deaktiviere Gerätefluss aktivieren unter „Identifizieren und Autorisieren von Benutzern“.

Hinzufügen oder Aktualisieren einer Setup-URL

Du kannst Personen zu einer bestimmten URL umleiten, nachdem sie deine App installiert haben. Weitere Informationen findest du unter Registrieren einer GitHub-App.

Wenn du Benutzerautorisierung (OAuth) während der Installation anfordern ausgewählt hast, kannst du keine Setup-URL eingeben. Benutzer*innen werden im Rahmen des Autorisierungsvorgangs stattdessen zur Rückruf-URL weitergeleitet, wo du das zusätzliche Setup beschreiben kannst. Weitere Informationen findest du unter Informationen zur Rückruf-URL für die Benutzerautorisierung.

  1. Navigiere zur Einstellungsseite für die App, die du ändern möchtest. Weitere Informationen findest du unter Navigieren zu deinenGitHub App-Einstellungen in diesem Artikel.
  2. Gib unter „Nach der Installation“ im Feld „Setup-URL“ die URL ein, an die Benutzer*innen umgeleitet werden sollen, nachdem sie deine App installiert haben.
  3. Wenn du Benutzer*innen nach dem Aktualisieren einer Installation zur Setup-URL umleiten möchtest, kannst du optional Bei Update umleiten aktivieren. Ein Update umfasst das Hinzufügen oder Entfernen eines Repositorys für eine Installation. Wenn „Setup-URL“ leer ist, wird dies ignoriert.

Ändern der Berechtigungen einer GitHub App

Du kannst die Zugriffsberechtigungen für deine GitHub App mit den folgenden Schritten ändern.

Wenn du die Berechtigungen einer App für das Repository oder die Organisation änderst, muss jedes Konto, in dem die App installiert ist, die neuen Berechtigungen genehmigen. Wenn du die Berechtigungen einer App für das Konto änderst, muss jede Benutzerin und jeder Benutzer, die/der die App autorisiert hat, die Berechtigungsänderungen genehmigen. In beiden Fällen sendet GitHub eine E-Mail an jeden Organisationsbesitzer oder jeden Benutzer, und benachrichtigt sie über die Anforderung, die Berechtigungen der App zu aktualisieren. Aktualisierte Berechtigungen werden erst dann für eine Installation oder Benutzerautorisierung wirksam, wenn die neuen Berechtigungen genehmigt wurden. Du kannst den installation-Webhook verwenden, um herauszufinden, wann Personen neue Berechtigungen für deine App akzeptieren.

Das Ändern der Berechtigungen einer App kann auch die Webhooks ändern, die deine App abonnieren kann, sowie die Aktionen, die deine App mit der API ausführen kann. Weitere Informationen findest du unter Auswählen von Berechtigungen für eine GitHub-App.

  1. Navigiere zur Einstellungsseite für die App, die du ändern möchtest. Weitere Informationen findest du unter Navigieren zu deinenGitHub App-Einstellungen in diesem Artikel.
  2. Klicke auf der Randleiste für GitHub Apps-Einstellungen auf Berechtigungen und Ereignisse.
  3. Ändere in den Abschnitten „Repositoryberechtigungen“, „Organisationsberechtigungen“ und „Kontoberechtigungen“ die gewünschten Berechtigungen. Wähle für jeden Berechtigungstyp entweder „Schreibgeschützt“, „Lesen und schreiben“ oder „Kein Zugriff“ in der Dropdownliste aus. Weitere Informationen findest du unter Auswählen von Berechtigungen für eine GitHub-App.
  4. Füge optional unter „Hinweis an Benutzer hinzufügen“ einen Hinweis hinzu, der deinen Benutzer*innen mitteilt, warum du die Berechtigungen änderst, die deine GitHub App anfordert.
  5. Klicke auf Änderungen speichern.

Aktivieren oder Deaktivieren des GitHub App-Webhooks

Du kannst deine GitHub App so konfigurieren, dass sie Webhooks für bestimmte Ereignisse auf GitHub empfängt und automatisch darauf reagiert. Weitere Informationen findest du unter Verwenden von Webhooks mit GitHub-Apps.

  1. Navigiere zur Einstellungsseite für die App, die du ändern möchtest. Weitere Informationen findest du unter Navigieren zu deinenGitHub App-Einstellungen in diesem Artikel.
  2. Um einen Webhook zu aktivieren oder zu deaktivieren, wähle Aktiv aus oder hebe die Auswahl auf.
  3. Wenn du im vorherigen Schritt Aktiv ausgewählt hast, gib unter „Webhook-URL“ die URL ein, an die GitHub Webhookereignisse senden soll.
  4. Wenn du im vorherigen Schritt Aktiv ausgewählt hast, kannst du optional unter „Webhookgeheimnis“ ein geheimes Token eingeben, um deine Webhooks zu schützen. Es empfiehlt sich für GitHub dringend, ein Webhookgeheimnis festzulegen.

Ändern der Webhookereignisabonnements einer GitHub App

Du kannst die Webhookereignisse, die eine GitHub App abonniert, mit den folgenden Schritten ändern.

Die spezifischen Webhookereignisse, die du für deine GitHub App-Registrierung auswählen kannst, werden durch den Typ der Berechtigungen bestimmt, die du für deine App ausgewählt hast. Du musst zuerst die Berechtigungen auswählen, über die deine App verfügen soll, und dann kannst du deine App für Webhookereignisse abonnieren, die sich auf diesen Berechtigungssatz beziehen. Weitere Informationen findest du unter Verwenden von Webhooks mit GitHub-Apps.

  1. Navigiere zur Einstellungsseite für die App, die du ändern möchtest. Weitere Informationen findest du unter Navigieren zu deinenGitHub App-Einstellungen in diesem Artikel.
  2. Aktiviere den GitHub App-Webhook. Weitere Informationen findest du unter Aktivieren oder Deaktivieren des GitHub App-Webhooks in diesem Artikel.
  3. Klicke auf der Randleiste für GitHub Apps-Einstellungen auf Berechtigungen und Ereignisse.
  4. Wähle in den Abschnitten „Repositoryberechtigungen“, „Organisationsberechtigungen“ und „Kontoberechtigungen“ die Berechtigungen aus, die für die von deiner App abonnierten Ereignisse erforderlich sind. Weitere Informationen findest du unter Ändern der Berechtigungen einer GitHub App.
  5. Wähle unter „Ereignisse abonnieren“ die Webhookereignisse aus, die deine GitHub App empfangen soll.
  6. Klicke auf Änderungen speichern.

Ändern der Sichtbarkeit einer GitHub App

Du kannst die Sichtbarkeitseinstellungen deiner GitHub App ändern, um zu steuern, wer die App installieren kann. Öffentliche Apps können nicht als privat festgelegt werden, wenn sie in anderen Konten installiert sind. Weitere Informationen findest du unter Öffentlich- oder Privatmachen einer GitHub-App.

  1. Navigiere zur Einstellungsseite für die App, die du ändern möchtest. Weitere Informationen findest du unter Navigieren zu deinenGitHub App-Einstellungen in diesem Artikel.
  2. Klicke auf der linken Seitenleiste auf Advanced (Erweitert).
  3. Klicke unter „Gefahrenzone“ je nach aktueller Sichtbarkeit deiner GitHub App entweder auf Als öffentlich festlegen oder Als privat festlegen.