OAuth 2,0-Anmeldeinformationen für GitHubApps: Autorisierungscode

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

    • Führen Sie die folgenden Schritte aus, um Ihre GitHub-Apps mithilfe des Autorisierungscodes zu integrieren.

    Bevor Sie beginnen

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

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

    Konfigurieren Sie GitHubApp in Ihrem GitHubAccount (Autorisierungscode)

    Erstellen Sie einen anwenderdefinierten GitHubApp von Ihrem GitHubAccount zum Aktivieren der OAuth 2,0-Authentifizierung mit Ihrem ServiceNowInstanz.

    Vorbereitungen

    GitHubAnforderung: GitHubApp für die Integration in konfiguriert ServiceNow

    Rolle erforderlich: Keine Instanzrolle erforderlich

    Warum und wann dieser Vorgang ausgeführt wird

    Führen Sie diese Schritte über aus GitHubAccount. Siehe Gebäude GitHub Apps Auf GitHubEntwickler-Website für Anweisungen zum Erstellen und Konfigurieren anwenderdefinierter Anwendungen.

    Prozedur

    1. Von Ihrem GitHubAccount, erstellen Sie Ihren GitHubApp, indem Sie zu navigieren Entwicklereinstellungen > GitHub-Appsan.
    2. In Homepage-URL Feld eingeben https://<instance-name>.service-now.com .
    3. In Rückruf-URL für 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 Konfigurieren Sie diese Einstellungen.
      Aktion Abgebrochen
      Überprüfungen Abgebrochen
      Inhalt Abgebrochen
      Bereitstellungen Lesen und schreiben
      Umgebungen Abgebrochen
      Metadaten Abgebrochen
      Abrufanforderungen Abgebrochen
      Geheimnisse Abgebrochen
      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 GitHubApp auf 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. Nach der Eigenschaft suchen: 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 GitHubAls OAuth-Anbieter (Autorisierungscode)

    Verwenden Sie die während generierten Informationen GitHubZu registrierende App-Account-Konfiguration GitHubAls OAuth-Anbieter und zulassen, dass die Instanz OAuth 2,0-Token anfordert.

    Vorbereitungen

    Erforderliche Rolle: administrator, sn_devops.admin

    Prozedur

    1. Navigieren zu Alle > System-OAuth > Applikationsregistrierungan.
    2. Klicken Sie auf Neu.
      Das System zeigt die Nachricht an Welche Art von OAuth-Anwendung?
    3. Wählen Sie Aus Stellen Sie eine Verbindung zu einem externen OAuth-Anbieter her .
      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 von ein GitHubApp (Tipp: Verfügbar in Über Abschnitt von GitHubApp-Konfiguration in GitHub).
      Geheimer Clientschlüssel Geben Sie das geheime Clientgeheimnis Ihres ein GitHubApp (Tipp: Verfügbar in Über Abschnitt von GitHubApp-Konfiguration in GitHub).
      OAuth-API-Skript Wählen Sie Aus OAuthDevOpsGitHubHandler .
      Standardgewährungstyp Wählen Sie Autorisierungscode.
      Autorisierungs-URL

      Eingabetaste https://github.com/login/oauth/authorize .

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

      Eingabetaste https://github.com/login/oauth/access_token .

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

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

    Erstellen Sie einen Anmeldeinformationsdatensatz für GitHubApp-Anbieter wurde zuvor zum Autorisieren von Aktionen erstellt.

    Vorbereitungen

    Erforderliche Rolle: administrator, credential_admin

    Prozedur

    1. Navigieren zu Alle > Verbindungen und Anmeldeinformationen > Anmeldeinformationenan.
    2. Klicken Sie auf Neu.
      Das System zeigt die Nachricht 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.
      Beschreibung 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 den MID-Server herstellen, um diese Anmeldeinformationen zu verwenden.
      Bestellung 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.