OAuth 2.0-Anmeldeinformationen für GitHub Apps – Autorisierungscode

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 3 Minuten Lesedauer

    • Führen Sie die folgenden Schritte aus, um Ihre GitHub-Apps mit Autorisierungscode zu integrieren.

    Bevor Sie beginnen

    Erforderliche Rolle:
    • oauth_admin in DevOps Change-Geschwindigkeit.
    • Administratorkonto in GitHub.
    Hinweis:
    Nur Repositorys auf Anwenderebene werden unterstützt. Sie müssen Zugriff auf alle GitHub -Repositorys haben, die Sie in DevOps Change-Geschwindigkeit mit dem Autorisierungscode konfigurieren möchten.

    Der Gewährungstyp „OAuth-Autorisierungscode“ wird für GitHub und GitHub Enterprise mit MID-Server unterstützt.

    Konfigurieren Sie die App GitHub in Ihrem Konto GitHub (Autorisierungscode)

    Erstellen Sie eine anwenderdefinierte GitHub App von Ihrem GitHub -Konto, um die OAuth 2.0-Authentifizierung mit Ihrer ServiceNow -Instanz zu aktivieren.

    Vorbereitungen

    GitHub Anforderung: App GitHub für Integration mit ServiceNowkonfiguriert

    Erforderliche Rolle: Keine Instanzrolle erforderlich

    Warum und wann dieser Vorgang ausgeführt wird

    Führen Sie diese Schritte in Ihrem Konto GitHub aus. Siehe Gebäude GitHub Apps Auf der Developer Site GitHub finden Sie Anweisungen zum Erstellen und Konfigurieren benutzerdefinierter Anwendungen.

    Prozedur

    1. Erstellen Sie in Ihrem Konto GitHub Ihre App GitHub, indem Sie zu navigieren Entwicklereinstellungen > GitHub-Apps.
    2. Geben Sie im Feld Homepage-URLden Wert https://ein.<instance-name> .service-now.com .
    3. Geben Sie im Feld Rückruf-URL für Anwenderautorisierungden Wert https://ein.<instance-name> .service-now.com/oauth_redirect.do
    4. Deaktivieren Sie im Abschnitt „Identifizieren und Autorisieren von Anwendern“ das Feld Anwenderautorisierungstoken ablaufen lassen.
    5. Deaktivieren Sie im Abschnitt „Webhook“ das Feld Aktiv.
    6. Lassen Sie die verbleibenden Felder leer (Standard).
    7. Konfigurieren Sie im Abschnitt Repository-Berechtigungen diese Einstellungen.
      Aktion Schreibgeschützt
      Überprüfungen Schreibgeschützt
      Inhalt Schreibgeschützt
      Bereitstellungen Lesen und schreiben
      Umgebungen Schreibgeschützt
      Metadaten Schreibgeschützt
      Abrufanforderungen Schreibgeschützt
      Geheimnisse Schreibgeschützt
      Webhooks Lesen und schreiben
      Hinweis:
      Zum Konfigurieren von Webhooks in ServiceNowsind Lese- und Schreibberechtigungen erforderlich.
    8. Belassen Sie die verbleibenden Berechtigungen als Kein Zugriff (Standard).
    9. Installieren Sie die neu erstellte App GitHub auf den Konten Ihrer Wahl.

    Client-ID zur Eigenschaft „DevOps“ hinzufügen

    Nach der Konfiguration Ihrer GitHub-App müssen Sie sicherstellen, dass das Präfix für die Client-ID (die ersten 3 oder mehr Zeichen der ID) der DevOps-Eigenschaft hinzugefügt wird: Client-ID-Bezeichner für GitHub-App.

    Vorbereitungen

    Erforderliche Rolle: sn_devops.admin

    Prozedur

    1. Navigieren zu Arbeitsbereiche > DevOps – Change-Arbeitsbereich > Administration > Systemkonfiguration > Eigenschaften.
    2. Ändern Sie den Anwendungsbereich in DevOps-Datenmodell.
    3. Suchen Sie nach der Eigenschaft: Client-ID-Bezeichner für GitHub-App [sn_devops.github_oauth_client_id_specifier].
    4. Geben Sie das Client-ID-Präfix (die ersten 3 Zeichen der ID) Ihrer GitHub-App für die Eigenschaft ein.
    5. Wählen Sie Speichern.

    GitHub als OAuth-Provider registrieren (Autorisierungscode)

    Verwenden Sie die Informationen, die während der Konfiguration des App-Accounts GitHub von generiert wurden, um GitHub als OAuth-Anbieter zu registrieren und der Instanz die Anforderung von OAuth 2.0-Token zu gestatten.

    Vorbereitungen

    Erforderliche Rolle: admin, sn_devops.admin

    Prozedur

    1. Navigieren zu Alle > System-OAuth > Applikationsregistrierung.
    2. Klicken Sie auf Neu.
      Das System zeigt die Meldung Welche Art von OAuth-Anwendung?
    3. Wählen Sie Verbindung zu einem fremden OAuth-Provider herstellen aus.
      Das System zeigt ein leeres Formular „Anwendungsregistrierungen“ an.
    4. Füllen Sie das Formular aus.
      Feld Wert erforderlich
      Name Geben Sie einen beliebigen Namen ein, um den Datensatz eindeutig zu identifizieren. Geben Sie beispielsweise Mein GitHub-App-Anbieterein.
      Client-ID Geben Sie die Client-ID Ihrer App GitHub ein (Hinweis: verfügbar im Abschnitt „Info“ Ihrer Konfiguration der App GitHub in GitHub ).
      Geheimer Clientschlüssel Geben Sie den geheimen Clientschlüssel Ihrer App GitHub ein (Hinweis: verfügbar im Abschnitt „Info“ Ihrer Konfiguration der App GitHub in GitHub ).
      OAuth-API-Skript Wählen Sie OAuthDevOpsGitHubHandleraus.
      Standardgewährungstyp Wählen Sie Autorisierungscode.
      Autorisierungs-URL

      Geben Sie https://github.com/login/oauth/authorizeein.

      Verwenden Sie für eine lokale Bereitstellung die richtige Host-URL GitHub.
      Token-URL

      Geben Sie https://github.com/login/oauth/access_tokenein.

      Verwenden Sie für eine lokale Bereitstellung die richtige Host-URL GitHub.
    5. Behalten Sie für die restlichen Formularfelder den Standardwert bei.
      Formular „Anwendungsregistrierung“.
    6. Klicken Sie mit der rechten Maustaste auf den Formularheader und wählen Sie Speichern aus.
      • Das System validiert die OAuth-Anmeldeinformationen und füllt die Umleitungs-URL aus (Hinweis: Sie muss mit der Rückruf-URL für die Anwenderautorisierung übereinstimmen, die Sie zuvor in Ihrer Konfiguration der App GitHub angegeben haben).
      • Das System trägt im OAuth-Entitätsprofil den Erteilungstyp als Autorisierungscodeein. Beispielsweise wird das OAuth-Entitätsprofil mit dem StandardnamenMein GitHub-App-Provider default_profileerstellt

    Anmeldeinformationsdatensatz für App-Anbieter GitHub erstellen (Autorisierungscode)

    Erstellen Sie einen Anmeldeinformationsdatensatz für den zuvor erstellten App-Anbieter GitHub, um Aktionen zu autorisieren.

    Vorbereitungen

    Erforderliche Rolle: admin, account_admin

    Prozedur

    1. Navigieren zu Alle > Verbindungen und Anmeldeinformationen > Anmeldeinformationen.
    2. Klicken Sie auf Neu.
      Das System zeigt die Meldung Welche Art von Anmeldeinformationen möchten Sie erstellen? an..
    3. Wählen Sie OAuth 2.0-Anmeldeinformationen aus.
      Im Popup-Fenster wird ein leeres Formular mit OAuth 2.0-Anmeldeinformationen angezeigt.
    4. Füllen Sie diese Werte aus.
      Feld Wert erforderlich
      Name Geben Sie einen beliebigen Namen ein, um den Datensatz eindeutig zu identifizieren. Geben Sie beispielsweise Meine GitHub-App-Anmeldeinformationen ein.
      Aktiv Aktivieren
      OAuth-Einheitenprofil Wählen Sie das standardmäßige OAuth-Entitätsprofil aus, das Sie zuvor erstellt haben.
      Betrifft Wählen Sie die MID-Server aus, die diese Anmeldeinformationen verwenden können. Wählen Sie beispielsweise Alle MID Server aus.
      Hinweis:
      Sie müssen über den MID-Server eine Verbindung zu Ihrer GitHub-Toolinstanz herstellen, um diese Anmeldeinformationen zu verwenden.
      Auftrag Wählen Sie die Reihenfolge aus, in der diese Anmeldeinformationen angewendet werden sollen. Geben Sie z. B. 100 ein.
    5. Speichern Sie den Datensatz.
    6. Klicken Sie auf den zugehörigen Link OAuth-Token abrufen, um das OAuth-Token zu generieren.