Hinweis: Auslaufende Benutzertoken sind derzeit ein optionales Feature und unterliegen Änderungen. Informationen zum Aktivieren oder Deaktivieren des Ablaufs von Benutzer-zu-Server-Token findest du unter Aktivieren optionaler Features für Apps. Weitere Informationen findest du unter Ablauf von Benutzer-zu-Server-Zugriffstoken für GitHub Apps.
Wenn die GitHub-App im Auftrag eines Benutzers eingesetzt wird, werden von ihr Benutzer-zu-Server-Anforderungen ausgeführt. Diese Anforderungen müssen mit dem Zugriffstoken eines Benutzers autorisiert werden. Benutzer-zu-Server-Anforderungen umfassen das Anfordern von Daten für einen Benutzer, z. B. die Bestimmung, welche Repositorys für einen bestimmten Benutzer angezeigt werden sollen. Diese Anforderungen enthalten auch Aktionen, die von einem Benutzer ausgelöst werden, z. B. das Ausführen eines Builds.
Um Token für den Zugriff von Benutzern auf Server sicherer zu gestalten, kannst du Zugriffstoken, die nach acht Stunden ablaufen, und ein Aktualisierungstoken verwenden, das gegen ein neues Zugriffstoken ausgetauscht werden kann. Weitere Informationen findest du unter Aktualisieren von Benutzer-zu-Server-Zugriffstoken.
Identifizieren von Benutzern auf der Website
Verwende den Webanwendungsfluss zum Autorisieren von Benutzer*innen für Standard-Apps, die im Browser ausgeführt werden.
Verwende den Gerätefluss zum Autorisieren von Benutzer*innen für monitorlose Apps ohne direkten Zugriff auf den Browser, z. B. CLI-Tools oder Git Credential Manager. Im Gerätefluss wird die Erweiterung OAuth 2.0 Device Authorization Grant verwendet.
Webanwendungsfluss
Mithilfe des Webanwendungsflusses läuft der Prozess zum Identifizieren von Benutzer*innen auf deiner Website wie folgt ab:
- Benutzer werden umgeleitet, um ihre GitHub-Identität anzufordern.
- Benutzer*innen werden von GitHub wieder zu deiner Website umgeleitet.
- Die GitHub-App greift mit dem Zugriffstoken des Benutzers auf die API zu.
Wenn du beim Erstellen oder Ändern der App Anfordern der Benutzerautorisierung (OAuth) während der Installation auswählst, wird Schritt 1 während der App-Installation abgeschlossen. Weitere Informationen findest du unter Autorisieren von Benutzer*innen während der Installation.
1. Anfordern der GitHub-Identität eines Benutzers
Leite den Benutzer bzw. die Benutzerin im Browser an die folgende URL weiter:
GET http(s)://HOSTNAME/login/oauth/authorize
Wenn von der GitHub-App ein login
-Parameter angegeben wird, erfolgt die Benutzeraufforderung mit einem bestimmten Konto, das die Benutzer für die Anmeldung und Autorisierung der App verwenden können.
Parameter
Name | type | BESCHREIBUNG |
---|---|---|
client_id | string | Erforderlich. Die Client-ID für die GitHub-App. Du kannst diese in den GitHub-App-Einstellungen finden, wenn du deine App auswählst. Hinweis: Die App-ID und die Client-ID sind nicht identisch und können nicht ausgetauscht werden. |
redirect_uri | string | Die URL in der Anwendung, an die Benutzer nach der Autorisierung gesendet werden. Diese muss genau mit einer der URLs übereinstimmen, die du als Rückruf-URL bereitgestellt hast , als du deine GitHub-App eingerichtet hast, und darf keine zusätzlichen Parameter enthalten. |
state | string | Dies sollte zum Schutz vor Fälschungsangriffen eine zufällige Zeichenfolge enthalten und könnte andere beliebige Daten umfassen. |
login | string | Schlägt ein bestimmtes Konto vor, das zum Anmelden und Autorisieren der App verwendet werden soll. |
allow_signup | string | Ob nicht authentifizierten Benutzern während des OAuth-Flusses eine Option zum Registrieren für GitHub angeboten wird. Der Standardwert ist true . Verwende false , wenn eine Richtlinie die Anmeldung verbietet. |
Hinweis: Du musst keine Bereiche in der Autorisierungsanforderung angeben. Im Gegensatz zum herkömmlichen OAuth-Protokoll ist das Autorisierungstoken auf die Berechtigungen beschränkt, die der GitHub-App und denen des Benutzers zugeordnet sind.
2. Benutzer*innen werden von GitHub wieder zu deiner Website umgeleitet.
Wenn Benutzer*innen die Anforderung akzeptieren, werden sie von GitHub mit einem temporären code
in einem Codeparameter sowie dem Status, den du im vorherigen Schritt in einem state
-Parameter bereitgestellt hast, wieder zu deiner Website umgeleitet. Wenn die Status nicht übereinstimmen, wurde die Anforderung von Dritten erstellt und der Prozess sollte abgebrochen werden.
Hinweis: Wenn du beim Erstellen oder Ändern der App Anfordern der Benutzerautorisierung (OAuth) während der Installation auswählst, wird von GitHub ein temporärer code
zurückgegeben, den du gegen ein Zugriffstoken austauschen musst. Der state
-Parameter wird nicht zurückgegeben, wenn der OAuth-Fluss während der App-Installation von GibHub initiiert wird.
Tausche diesen code
gegen ein Zugriffstoken aus. Wenn ablaufende Token aktiviert sind, läuft das Zugriffstoken in 8 Stunden ab, und das Aktualisierungstoken läuft in 6 Monaten ab. Jedes Mal, wenn du das Token aktualisierst, erhältst du ein neues Aktualisierungstoken. Weitere Informationen findest du unter Aktualisieren von Benutzer-zu-Server-Zugriffstoken.
Ablaufende Benutzertoken sind derzeit ein optionales Feature, bei dem sich Änderungen ergeben können. Wenn du das Feature für ablaufende Benutzer-zu-Server-Token aktivieren möchtest, findest du entsprechende Informationen unter Aktivieren optionaler Features für Apps.
Stelle eine Anforderung an den folgenden Endpunkt, um ein Zugriffstoken zu erhalten:
POST http(s)://HOSTNAME/login/oauth/access_token
Parameter
Name | type | BESCHREIBUNG |
---|---|---|
client_id | string | Erforderlich. Die Client-ID für die GitHub-App. |
client_secret | string | Erforderlich. Der geheime Clientschlüssel für die GitHub-App. |
code | string | Erforderlich. Der Code, den du als Antwort auf Schritt 1 erhalten hast. |
redirect_uri | string | Die URL in der Anwendung, an die Benutzer nach der Autorisierung gesendet werden. Diese muss genau mit einer der URLs übereinstimmen, die du als Rückruf-URL bereitgestellt hast , als du deine GitHub-App eingerichtet hast, und darf keine zusätzlichen Parameter enthalten. |
Antwort
Standardmäßig weist die Antwort das folgende Format auf. Die Antwortparameter expires_in
, refresh_token
und refresh_token_expires_in
werden nur zurückgegeben, wenn du ablaufende Benutzer-zu-Server-Zugriffstoken aktivierst.
{
"access_token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a",
"expires_in": 28800,
"refresh_token": "ghr_1B4a2e77838347a7E420ce178F2E7c6912E169246c34E1ccbF66C46812d16D5B1A9Dc86A1498",
"refresh_token_expires_in": 15811200,
"scope": "",
"token_type": "bearer"
}
3. Die GitHub-App greift mit dem Zugriffstoken des Benutzers auf die API zu.
Das Zugriffstoken des Benutzers ermöglicht es der GitHub-App, Anforderungen im Auftrag eines Benutzers an die API zu senden.
Authorization: Bearer OAUTH-TOKEN
GET http(s)://HOSTNAME/api/v3/user
In curl kannst du beispielsweise den Autorisierungsheader wie folgt festlegen:
curl -H "Authorization: Bearer OAUTH-TOKEN" http(s)://HOSTNAME/api/v3/user
Gerätefluss
Hinweis: Der Gerätefluss befindet sich in der öffentlichen Betaversion und kann geändert werden.
Mit dem Gerätefluss kannst du Benutzer*innen für eine monitorlose App autorisieren, z. B. ein CLI-Tool oder Git Credential Manager.
Weitere Informationen zum Autorisieren von Benutzer*innen mit dem Gerätefluss findest du unter Autorisieren von OAuth-Apps.
Überprüfen, auf welche Ressourcen der Installation ein Benutzer zugreifen kann
Sobald du über ein OAuth-Token für einen Benutzer oder eine Benutzerin verfügst, kannst du überprüfen, auf welche Installationen er oder sie zugreifen kann.
Authorization: Bearer OAUTH-TOKEN
GET /user/installations
Du kannst auch überprüfen, welche Repositorys für Benutzer*innen zum Installieren zugänglich sind.
Authorization: Bearer OAUTH-TOKEN
GET /user/installations/:installation_id/repositories
Weitere Details findest du unter Auflisten der für das Benutzerzugriffstoken zugänglichen App-Installationen und Auflisten der für das Benutzerzugriffstoken zugänglichen Repositorys.
Behandeln einer widerrufenen GitHub-App-Autorisierung
Wenn ein Benutzer die Autorisierung einer GitHub-App widerruft, erhält die App standardmäßig den github_app_authorization
-Webhook. GitHub-Apps können sich nicht von diesem Ereignis abmelden. Jede Person kann ihre Autorisierung einer GitHub-App über ihre Seite mit GitHub-Kontoeinstellungen widerrufen. Durch Widerrufen der Autorisierung einer GitHub-App wird die GitHub-App nicht deinstalliert. Du solltest deine GitHub-App so programmieren, dass sie nach dem Empfang dieses Webhooks die API nicht mehr im Auftrag der Person aufruft, die das Token widerrufen hat. Wenn deine GitHub-App ein widerrufenes Zugriffstoken weiterhin verwendet, erhält sie den Fehler 401 Bad Credentials
.
Berechtigungen auf Benutzerebene
Du kannst der GitHub-App Berechtigungen auf Benutzerebene für den Zugriff auf Benutzerressourcen hinzufügen, z. B. auf E-Mails, die von einzelnen Benutzer*innen als Teil des Benutzerberechtigungsflusses gewährt werden. Berechtigungen auf Benutzerebene unterscheiden sich von Berechtigungen auf Repository- und Organisationsebene, die zum Zeitpunkt der Installation für eine Organisation oder ein persönliches Konto gewährt werden.
Du kannst Berechtigungen auf Benutzerebene in den Einstellungen der GitHub-App auf der Seite Berechtigungen und Webhooks im Abschnitt Benutzerberechtigungen auswählen. Weitere Informationen zum Auswählen von Berechtigungen findest du unter Bearbeiten der Berechtigungen einer GitHub-App.
Wenn Benutzerinnen deine App mit ihrem Konto installieren, werden in der Installationsaufforderung die Berechtigungen auf Benutzerebene aufgelistet, die von der App angefordert werden. Außerdem wird erläutert, dass einzelne Benutzerinnen von der App nach diesen Berechtigungen gefragt werden können.
Da Berechtigungen auf Benutzerebene für einzelne Benutzerinnen gewährt werden, kannst du diese der vorhandenen App hinzufügen, ohne Benutzerinnen zum Upgrade aufzufordern. Du musst vorhandene Benutzer*innen jedoch den Benutzerberechtigungsfluss durchlaufen lassen, um die neue Berechtigung zu autorisieren und ein neues Benutzer-zu-Server-Token für diese Anforderungen abzurufen.
Benutzer-zu-Server-Anforderungen
Während der Großteil der API-Interaktion unter Verwendung der Server-zu-Server-Zugriffstoken für die Installation erfolgen sollte, lassen es bestimmte Endpunkte zu, dass du Aktionen über die API mithilfe eines Benutzerzugriffstokens ausführst. Von der App können die folgenden Anforderungen mithilfe der GraphQL- oder REST-Endpunkte durchgeführt werden.
Unterstützte Endpunkte
Überprüfungsausführungen
- Erstellen einer Überprüfungsausführung
- Abrufen einer Überprüfungsausführung
- Aktualisieren einer Überprüfungsausführung
- Auflisten von Anmerkungen von Überprüfungsausführungen
- Auflisten von Überprüfungsausführungen in einer Überprüfungssammlung
- Auflisten von Überprüfungsausführungen für einen Git-Verweis
Prüfsuiten
- Erstellen einer Überprüfungssammlung
- Abrufen einer Überprüfungssammlung
- Anfordern einer Überprüfungssammlung
- Aktualisieren von Repositoryeinstellungen für Überprüfungssamlungen
- Auflisten von Überprüfungssammlungen für einen Git-Verweis
Verhaltensregeln
Bereitstellungsstatus
- Auflisten von Bereitstellungsstatus
- Erstellen eines Bereitstellungsstatus
- Abrufen eines Bereitstellungsstatus
Bereitstellungen
- Auflisten von Bereitstellungen
- Erstellen einer Bereitstellung
- Abrufen einer Bereitstellung
- Löschen einer Bereitstellung
Ereignisse
- Auflisten öffentlicher Ereignisse für ein Netzwerk von Repositorys
- Auflisten öffentlicher Organisationsereignisse
Feeds
Git-Blobs
Git-Commits
Git-Verweise
- Erstellen eines Verweises
- Abrufen eines Verweises
- Auflisten übereinstimmender Verweise
- Aktualisieren eines Verweises
- Löschen eines Verweises
Git-Tags
Git-Strukturen
Gitignore-Vorlagen
Installationen
Issues zugewiesene Personen
- Hinzufügen von zugewiesenen Personen zu einem Issue
- Entfernen von zugewiesenen Personen von einem Issue
Issue-Kommentare
- Auflisten von Issue-Komponenten
- Erstellen eines Issue-Kommentars
- Auflisten von Issue-Kommentaren für ein Repository
- Abrufen eines Issue-Kommentars
- Aktualisieren eines Issue-Kommentars
- Löschen eines Issue-Kommentars
Issue-Ereignisse
Issue-Zeitachse
Probleme
- Auflisten der dem authentifizierten Benutzer zugewiesenen Issues
- Auflisten der zugewiesenen Personen
- Überprüfen, ob ein Benutzer zugewiesen werden kann
- Auflisten von Repository-Issues
- Ausgabe erstellen
- Abrufen eines Issues
- Aktualisieren eines Issues
- Sperren eines Issues
- Entsperren eines Issues
Bezeichnungen
- Auflisten von Bezeichnungen für ein Issue
- Hinzufügen von Bezeichnungen zu einem Issue
- Festlegen von Bezeichnungen für ein Issue
- Entfernen aller Bezeichnungen aus einem Issue
- Entfernen einer Bezeichnung aus einem Issue
- Auflisten von Bezeichnungen für ein Repository
- Erstellen einer Bezeichnung
- Abrufen einer Bezeichnung
- Aktualisieren einer Bezeichnung
- Löschen einer Bezeichnung
- Abrufen von Bezeichnungen für jedes Issue in einem Meilenstein
Lizenzen
Markdown
Meta
Meilensteine
- Auflisten von Meilensteinen
- Erstellen eines Meilensteins
- Abrufen eines Meilensteins
- Aktualisieren eines Meilensteins
- Löschen eines Meilensteins
Organisationshooks
- Auflisten von Organisationswebhooks
- Erstellen eines Organisationswebhooks
- Abrufen eines Organisationswebhooks
- Aktualisieren eines Organisationswebhooks
- Löschen eines Organisationswebhooks
- Pingen eines Organisationswebhooks
Organisationsmitglieder
- Auflisten von Organisationsmitgliedern
- Überprüfen der Organisationsmitgliedschaft für einen Benutzer
- Entfernen eines Organisationsmitglieds
- Abrufen der Organisationsmitgliedschaft für einen Benutzer
- Festlegen der Organisationsmitgliedschaft für einen Benutzer
- Entfernen der Organisationsmitgliedschaft für einen Benutzer
- Auflisten öffentlicher Organisationsmitglieder
- Überprüfen der Organisationsmitgliedschaft für einen Benutzer
- Festlegen der öffentlichen Organisationsmitgliedschaft für den authentifizierten Benutzer
- Entfernen der öffentlichen Organisationsmitgliedschaft für den authentifizierten Benutzer
Projektmitarbeiter außerhalb der Organisation
- Auflisten von externen Projektmitarbeitern für eine Organisation
- Umwandeln eines Organisationsmitglieds in einen externen Projektmitarbeiter
- Entfernen eines externen Projektmitarbeiters aus einer Organisation
Pre-Receive-Hooks für eine Organisation
- Auflisten von Pre-Receive-Hooks für eine Organisation
- Abrufen eines Pre-Receive-Hooks für eine Organisation
- Aktualisieren der Erzwingung eines Pre-Receive-Hooks für eine Organisation
- Entfernen der Erzwingung eines Pre-Receive-Hooks für eine Organisation
Teamprojekte einer Organisation
- Auflisten von Teamprojekten
- Überprüfen der Teamberechtigungen für ein Projekt
- Hinzufügen oder Aktualisieren von Teamprojektberechtigungen
- Entfernen eines Projekts aus einem Team
Teamrepositorys einer Organisation
- Auflisten von Teamrepositorys
- Überprüfen der Teamberechtigungen für ein Repository
- Hinzufügen oder Aktualisieren von Berechtigungen für Teamrepositorys
- Entfernen eines Repositorys aus einem Team
Organisationsteams
- Auflisten von Teams
- Zusammenstellen eines Teams
- Abrufen eines Teams nach Namen
- Aktualisieren eines Teams
- Löschen eines Teams
- Auflisten von Teammitgliedern
- Abrufen der Teammitgliedschaft für einen Benutzer
- Hinzufügen oder Aktualisieren der Teammitgliedschaft für einen Benutzer
- Entfernen der Teammitgliedschaft für einen Benutzer
- Auflisten untergeordneter Teams
- Auflisten von Teams für den authentifizierten Benutzer
Organisationen
- Auflisten von Organisationen
- Abrufen einer Organisation
- Aktualisieren einer Organisation
- Auflisten von Organisationsmitgliedschaften für den authentifizierten Benutzer
- Abrufen der Organisationsmitgliedschaft für den authentifizierten Benutzer
- Aktualisieren der Organisationsmitgliedschaft für den authentifizierten Benutzer
- Auflisten von Organisationen für den authentifizierten Benutzer
- Auflisten von Organisationen für einen Benutzer
Projektmitarbeiter
- Auflisten von Projektmitarbeitern
- Hinzufügen eines Projektmitarbeiters
- Entfernen eines Projektmitarbeiters
- Abrufen der Projektberechtigung für einen Benutzer
Projekte
- Auflisten von Organisationsprojekten
- Erstellen eines Organisationsprojekts
- Abrufen eines Projekts
- Aktualisieren eines Projekts
- Löschen eines Projekts
- Auflisten von Projektspalten
- Auflisten einer Projektspalte
- Abrufen einer Projektspalte
- Aktualisieren einer Projektspalte
- Löschen einer Projektspalte
- Auflisten von Projektkarten
- Erstellen einer Projektkarte
- Verschieben einer Projektspalte
- Abrufen einer Projektkarte
- Aktualisieren einer Projektkarte
- Löschen einer Projektkarte
- Verschieben einer Projektkarte
- Auflisten von Repositoryprojekten
- Erstellen eines Repositoryprojekts
Pullkommentare
- Auflisten von Überprüfungskommentaren zu einem Pull Request
- Erstellen eines Überprüfungskommentars für einen Pull Request
- Auflisten von Überprüfungskommentaren in einem Repository
- Abrufen eines Überprüfungskommentars für einen Pull Request
- Aktualisieren eines Überprüfungskommentars für einen Pull Request
- Löschen eines Überprüfungskommentars für einen Pull Request
Überprüfungsereignisse für Pull Requests
- Schließen einer Überprüfung für einen Pull Request
- Übermitteln einer Überprüfung für einen Pull Request
Überprüfungsanforderungen für Pull Requests
- Auflisten angeforderter Prüfer für einen Pull Request
- Anfordern von Prüfern für einen Pull Request
- Entfernen angeforderter Prüfer aus einem Pull Request
Prüfer von Pull Requests
- Auflisten von Prüfungen für einen Pull Request
- Erstellen einer Überprüfung für einen Pull Request
- Abrufen einer Überprüfung für einen Pull Request
- Aktualisieren einer Überprüfung für einen Pull Request
- Auflisten von Kommentaren für eine Überprüfung eines Pull Requests
Pulls
- Auflisten von Pull Requests
- Erstellen eines Pull Requests
- Abrufen eines Pull Requests
- Aktualisieren eines Pull Requests
- Auflisten von Commits in einem Pull Request
- Auflisten von Pull-Request-Dateien
- Überprüfen, ob ein Pull Request zusammengeführt wurde
- Zusammenführen eines Pull Requests (Schaltfläche „Zusammenführen“)
Reaktionen
- Löschen einer Reaktion
- Auflisten von Reaktionen für einen Commitkommentar
- Erstellen einer Reaktionen für einen Commitkommentar
- Auflisten von Reaktionen für ein Issue
- Erstellen einer Reaktionen für ein Issue
- Auflisten von Reaktionen für einen Issuekommentar
- Erstellen einer Reaktion für einen Issuekommentar
- Auflisten von Reaktionen für einen Überprüfungskommentar für einen Pull Request
- Erstellen einer Reaktion für einen Überprüfungskommentar für einen Pull Request
- Auflisten von Reaktionen für einen Teamdiskussionskommentar
- Erstellen einer Reaktion für einen Teamdiskussionskommentar
- Auflisten von Reaktionen für eine Teamdiskussion
- Erstellen einer Reaktion auf eine Teamdiskussion
- Löschen einer Reaktion für einen Commitkommentar
- Löschen einer Issue-Reaktion
- Löschen einer Reaktion auf einen Commitkommentar
- Löschen einer Reaktion für einen Pull-Request-Kommentar
- Löschen einer Teamdiskussionsreaktion
- Löschen einer Reaktion auf einen Teamdiskussionskommentar
Repositorys
- Auflisten von Organisationsrepositorys
- Erstellen eines Repositorys für den authentifizierten Benutzer
- Abrufen eines Repositorys
- Aktualisieren eines Repositorys
- Löschen eines Repositorys
- Vergleichen von zwei Commits
- Auflisten von Mitwirkenden eines Repositorys
- Auflisten von Forks
- Erstellen eines Forks
- Auflisten von Repositorysprachen
- Auflisten von Repositorytags
- Auflisten von Repositoryteams
- Übertragen eines Repositorys
- Auflisten öffentlicher Repositorys
- Auflisten von Repositorys für den authentifizierten Benutzer
- Auflisten von Repositorys für einen Benutzer
- Erstellen eines Repositorys mithilfe einer Repositoryvorlage
Repositoryaktivität
- Auflisten von Stargazern
- Auflisten von Watchern
- Auflisten der von einem Benutzer markierten Repositorys
- Überprüfen, ob ein Repository vom authentifizierten Benutzer markiert ist
- Markieren eines Repositorys für den authentifizierten Benutzer
- Aufheben der Markierung eines Repositorys für den authentifizierten Benutzer
- Auflisten von Repositorys, die von einem Benutzer überwacht werden
Repositorybranches
- Auflisten von Branches
- Abrufen von Branches
- Abrufen von Branchschutz
- Aktualisieren von Branchschutz
- Löschen von Branchschutz
- Abrufen von Administratorbranchschutz
- Festlegen von Administratorbranchschutz
- Löschen von Administratorbranchschutz
- Abrufen von Schutz für Pull-Request-Überprüfungen
- Aktualisieren von Schutz für Pull-Request-Überprüfungen
- Löschen von Schutz für Pull-Request-Überprüfungen
- Abrufen von Schutz für Commitsignaturen
- Erstellen von Schutz für Commitsignaturen
- Löschen von Schutz für Commitsignaturen
- Abrufen von Schutz für Statusüberprüfungen
- Aktualisieren von Schutz für Statusüberprüfungen
- Entfernen von Schutz für Statusüberprüfungen
- Abrufen aller Statusüberprüfungskontexte
- Hinzufügen von Statusüberprüfungskontexten
- Festlegen von Statusüberprüfungskontexten
- Entfernen von Statusüberprüfungskontexten
- Abrufen von Zugriffseinschränkungen
- Löschen von Zugriffseinschränkungen
- Auflisten von Teams mit Zugriff auf den geschützten Branch
- Hinzufügen von Teamzugriffseinschränkungen
- Festlegen von Teamzugriffseinschränkungen
- Entfernen von Teamzugriffseinschränkungen
- Auflisten von Benutzereinschränkungen von geschützten Branches
- Hinzufügen von Benutzerzugriffseinschränkungen
- Festlegen von Benutzerzugriffseinschränkungen
- Entfernen von Benutzerzugriffseinschränkungen
- Zusammenführen einer Verzweigung
Projektmitarbeiter für Repositorys
- Auflisten von Projektmitarbeitern für Repositorys
- Überprüfen, ob ein Benutzer ein Projektmitarbeiter für Repositorys ist
- Hinzufügen eines Projektmitarbeiters für Repositorys
- Entfernen eines Projektmitarbeiters für Repositorys
- Abrufen von Repositoryberechtigungen für einen Benutzer
Commitkommentare für Repositorys
- Auflisten von Commitkommentaren für ein Repository
- Abrufen eines Commitkommentars
- Aktualisieren eines Commitkommentars
- Löschen eines Commitkommentars
- Auflisten von Commitkommentaren
- Erstellen eines Commitkommentars
Repositorycommits
- Auflisten von Commits
- Abrufen eines Commits
- Auflisten von Branches für Head-Commit
- Auflisten von mit dem Commit verknüpften Pull Requests
Repositorycommunity
Repositoryinhalte
- Herunterladen eines Repositoryarchivs
- Abrufen von Repositoryinhalt
- Erstellen oder Aktualisieren von Dateiinhalten
- Löschen von Dateien
- Abrufen der Infodatei eines Repositorys
- Abrufen der Lizenz für ein Repository
Repositoryereignisdispatches
Repositoryhooks
- Auflisten von Repositorywebhooks
- Erstellen eines Repositorywebhooks
- Abrufen eines Repositorywebhooks
- Aktualisieren eines Repositorywebhooks
- Löschen eines Repositorywebhooks
- Pingen eines Repositorywebhooks
- Testen des Pushrepositorywebhooks
Repositoryeinladungen
- Auflisten von Repositoryeinladungen
- Aktualisieren einer Repositoryeinladung
- Löschen einer Repositoryeinladung
- Auflisten von Repositoryeinladungen für den authentifizierten Benutzer
- Akzeptieren einer Repositoryeinladung
- Ablehnen einer Repositoryeinladung
Repositoryschlüssel
- Auflisten von Bereitstellungsschlüsseln
- Erstellen eines Bereitstellungsschlüssels
- Abrufen eines Bereitstellungsschlüssels
- Löschen eines Bereitstellungsschlüssels
Repositoryseiten
- Abrufen einer GitHub Pages-Website
- Erstellen einer GitHub Pages-Website
- Aktualisieren von Informationen zu einer GitHub Pages-Website
- Löschen einer GitHub Pages-Website
- Auflisten von GitHub Pages-Builds
- Anfordern eines GitHub Pages-Builds
- Abrufen eines GitHub Pages-Builds
- Abrufen des aktuellen Pages-Builds
Pre-Receive-Hooks für Repository
- Auflisten von Pre-Receive-Hooks für ein Repository
- Abrufen eines Pre-Receive-Hooks für ein Repository
- Aktualisieren der Erzwingung eines Pre-Receive-Hooks für ein Repository
- Entfernen der Erzwingung eines Pre-Receive-Hooks für ein Repository
Repositoryreleases
- Releases auflisten
- Erstellen eines Release
- Abrufen eines Release
- Aktualisieren eines Release
- Löschen eines Release
- Auflisten von Releaseressourcen
- Abrufen einer Releaseressource
- Aktualisieren einer Releaseressource
- Löschen einer Releaseressource
- Abrufen des aktuellen Release
- Abrufen eines Release nach Tagnamen
Repositorystatistiken
- Abrufen der wöchentlichen Commitaktivität
- Abrufen des letzten Jahres der Commitaktivität
- Abrufen aller Commitaktivitäten für Mitwirkende
- Abrufen der wöchentlichen Commitanzahl
- Abrufen der stündlichen Commitanzahl für jeden Tag
Root
Suche
- Durchsuchen von Code
- Durchsuchen von Commits
- Durchsuchen von Bezeichnungen
- Durchsuchen von Repositorys
- Durchsuchen von Themen
- Benutzer suchen
Status
- Abrufen des kombinierten Status für einen bestimmten Verweis
- Auflisten von Commitstatus für einen Verweis
- Erstellen eines Commitstatus
Teamdiskussionen
- Auflisten von Diskussionen
- Erstellen einer Diskussion
- Abrufen einer Diskussion
- Aktualisieren einer Diskussion
- Löschen einer Diskussion
- Auflisten von Diskussionskommentaren
- Erstellen eines Diskussionskommentars
- Abrufen eines Diskussionskommentars
- Aktualisieren eines Diskussionskommentars
- Löschen eines Diskussionskommentars
Themen
Benutzer-E-Mails
- Auflisten von E-Mail-Adressen für den authentifizierten Benutzer
- Hinzufügen von E-Mail-Adresse(n)
- Löschen von E-Mail-Adresse(n)
- Auflisten öffentlicher E-Mail-Adressen für den authentifizierten Benutzer
Benutzerfollower
- Auflisten der Follower eines Benutzers
- Auflisten der Personen, denen ein Benutzer folgt
- Überprüfen, ob der authentifizierte Benutzer einer Person folgt
- Einem Benutzer folgen
- Einem Benutzer nicht mehr folgen
- Überprüfen, ob ein Benutzer einem anderen Benutzer folgt
Benutzer-GPG-Schlüssel
- Auflisten von GPG-Schlüsseln für den authentifizierten Benutzer
- Erstellen eines GPG-Schlüssels für den authentifizierten Benutzer
- Festlegen eines GPG-Schlüssels für den authentifizierten Benutzer
- Löschen eines GPG-Schlüssels für den authentifizierten Benutzer
- Auflisten von GPG-Schlüsseln für einen Benutzer
Öffentliche Schlüssel für Benutzer
- Auflisten der öffentlichen SSH-Schlüssel für den authentifizierten Benutzer
- Erstellen eines öffentlichen SSH-Schlüssels für den authentifizierten Benutzer
- Abrufen eines öffentlichen SSH-Schlüssels für den authentifizierten Benutzer
- Löschen eines öffentlichen SSH-Schlüssels für den authentifizierten Benutzer
- Auflisten öffentlicher Schlüssel für einen Benutzer
Benutzer
- Abrufen des authentifizierten Benutzers
- Auflisten der mit dem Benutzerzugriffstoken zugänglichen App-Installationen
- Auflisten von Benutzern
- Abrufen eines Benutzers