OAuth 2,0-Anmeldeinformationen für GitHub Apps: Autorisierungscode

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 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.
    • Administratoraccount in GitHub.
    Hinweis:
    Nur Repositorys auf Anwenderebene werden unterstützt. Sie müssen Zugriff auf alle haben GitHub Repositorys, die Sie in konfigurieren möchten DevOps Change-Geschwindigkeit Mit Autorisierungscode.

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

    Konfigurieren Sie GitHub App in Ihrem GitHub Account (Autorisierungscode)

    Erstellen Sie eine anwenderdefinierte GitHub App aus Ihrem GitHub Account zum Aktivieren der OAuth 2,0-Authentifizierung mit Ihrem ServiceNow Instanz.

    Vorbereitungen

    GitHub Anforderung: GitHub App für die Integration mit konfiguriert ServiceNow

    Erforderliche Rolle: Keine Instanzrolle erforderlich

    Warum und wann dieser Vorgang ausgeführt wird

    Führen Sie diese Schritte aus Ihrem aus GitHub Account. Siehe Gebäude GitHub Apps Auf der GitHub Entwickler-Website für Anweisungen zum Erstellen und Konfigurieren anwenderdefinierter Anwendungen.

    Prozedur

    1. Von Ihrem GitHub Account erstellen Sie Ihren GitHub App, indem Sie zu navigieren Entwicklereinstellungen > GitHub-Appsan.
    2. In Homepage-URL Feld eingeben https://<instance-name>.service-now.com .
    3. In Rückruf-URL der Anwenderautorisierung Feld eingeben https://<instance-name>.service-now.com/oauth_redirect.do .
    4. In Identifizieren und Autorisieren von Anwendern Deaktivieren Sie den Abschnitt Anwenderautorisierungstoken ablaufen lassen Feld.
    5. In Webhook Deaktivieren Sie den Abschnitt Aktiv Feld.
    6. Lassen Sie die verbleibenden Felder leer (Standard).
    7. In Repository-Berechtigungen Abschnitt konfigurieren Sie diese Einstellungen.
      Aktion Schreibgeschützt
      Überprüfungen Schreibgeschützt
      Inhalte Schreibgeschützt
      Bereitstellungen Lesen und schreiben
      Umgebungen Schreibgeschützt
      Metadaten Schreibgeschützt
      Abrufanforderungen Schreibgeschützt
      Geheimnisse Schreibgeschützt
      Webhooks Lesen und schreiben
      Hinweis:
      Lese- und Schreibberechtigungen sind erforderlich, um Webhooks von zu konfigurieren ServiceNow.
    8. Belassen Sie die verbleibenden Berechtigungen als Kein Zugriff (Standard).
    9. Installieren Sie neu erstellte GitHub App in den Accounts Ihrer Wahl.

    Fügen Sie der DevOps-Eigenschaft eine Client-ID hinzu

    Nach der Konfiguration Ihrer GitHub-App müssen Sie sicherstellen, dass das Client-ID-Präfix (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 > Eigenschaftenan.
    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 oder mehr Zeichen der ID) Ihrer GitHub-App für die Eigenschaft ein.
    5. Wählen Sie Speichern.

    Registrieren GitHub Als OAuth-Anbieter (Autorisierungscode)

    Verwenden Sie die während generierten Informationen GitHub Zu registrierende App-Account-Konfiguration GitHub Als OAuth-Provider und zulassen, dass die Instanz OAuth 2,0-Token anfordert.

    Vorbereitungen

    Erforderliche Rolle: admin, sn_devops.admin

    Prozedur

    1. Navigieren zu Alle > System-OAuth > Applikationsregistrierungan.
    2. Klicken Sie auf Neu.
      Das System zeigt die Meldung an 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 ein Mein GitHub-App-Anbieter .
      Client-ID Geben Sie die Client-ID Ihres ein GitHub App (Tipp: Verfügbar in Über Abschnitt von GitHub App-Konfiguration in GitHub).
      Geheimer Clientschlüssel Geben Sie das geheime Clientgeheimnis Ihres ein GitHub App (Tipp: Verfügbar in Über Abschnitt von GitHub App-Konfiguration in GitHub).
      OAuth-API-Skript Wählen Sie Aus OAuthDevOpsGitHubHandler .
      Standardgewährungstyp Wählen Sie Autorisierungscode.
      Autorisierungs-URL

      Geben Sie Ein https://github.com/login/oauth/authorize .

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

      Geben Sie Ein https://github.com/login/oauth/access_token .

      Verwenden Sie für eine lokale Bereitstellung die richtige GitHub Host-URL.
    5. Belassen Sie die restlichen Formularfelder als Standard.
      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 aus Umleitungs-URL (Tipp: Muss mit übereinstimmen Rückruf-URL der Anwenderautorisierung Zuvor in angegeben GitHub App-Konfiguration).
      • Das System wird ausgefüllt OAuth-Entitätsprofil Mit Gewährungstyp Als Autorisierungscode . Beispiel: OAuth-Entitätsprofil Wird standardmäßig erstellt Name , Mein GitHub-App-Anbieter, default_Profile

    Erstellen Sie einen Anmeldeinformationsdatensatz für GitHub App-Anbieter (Autorisierungscode)

    Erstellen Sie einen Anmeldeinformationsdatensatz für GitHub App-Anbieter, der zuvor zum Autorisieren von Aktionen erstellt wurde.

    Vorbereitungen

    Erforderliche Rolle: admin, credential_admin

    Prozedur

    1. Navigieren zu Alle > Verbindungen und Anmeldeinformationen > Anmeldeinformationenan.
    2. Klicken Sie auf Neu.
      Das System zeigt die Meldung an Welche Art von Anmeldeinformationen möchten Sie erstellen? .
    3. Wählen Sie OAuth 2.0-Anmeldeinformationen aus.
      Im Popup-Fenster wird ein leeres OAuth 2,0-Anmeldeinformationsformular angezeigt.
    4. Geben Sie diese Werte ein.
      Feld Wert erforderlich
      Name Geben Sie einen beliebigen Namen ein, um den Datensatz eindeutig zu identifizieren. Geben Sie beispielsweise ein Meine GitHub-App-Anmeldeinformationen .
      Aktiv Aktivieren
      OAuth-Einheitenprofil Wählen Sie das zuvor erstellte Standard-OAuth-Entitätsprofil aus.
      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 eine Verbindung zu Ihrer GitHub-Toolinstanz über MID-Server herstellen, um diese Anmeldeinformationen zu verwenden.
      Reihenfolge 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 OAuth-Token abrufen Zugehöriger Link zum Generieren des OAuth-Tokens.