Informations d’identification OAuth 2.0 pour GitHub les applications : code d’autorisation

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 4 minutes de lecture

    • Effectuez les étapes suivantes pour intégrer vos applications GitHub à l’aide du code d’autorisation.

    Avant de commencer

    Rôle requis :
    • oauth_admin dans Changements de vélocité DevOps.
    • Compte administrateur dans GitHub.
    Remarque :
    Seuls les référentiels au niveau de l’utilisateur sont pris en charge. Vous devez avoir accès à tous les GitHub référentiels que vous souhaitez configurer à Changements de vélocité DevOps l’aide du code d’autorisation.
    Remarque :
    Pour GitHub Enterprise Server (instance locale), OAuth n’est pas pris en charge si vous vous connectez à l’aide d’un MID Server.

    Configurer l’application GitHub dans votre GitHub compte (code d’autorisation)

    Créez une application personnalisée GitHub à partir de votre GitHub compte pour activer l’authentification OAuth 2.0 avec votre ServiceNow instance.

    Avant de commencer

    GitHub Condition requise : GitHub Application configurée pour s’intégrer à ServiceNow

    Rôle requis : aucun rôle d’instance requis

    Pourquoi et quand exécuter cette tâche

    Suivez ces étapes à partir de votre GitHub compte. Reportez-vous à Bâtiment GitHub Applications sur le site Developer pour obtenir des instructions sur la création et la GitHub configuration d’applications personnalisées.

    Procédure

    1. À partir de votre GitHub compte, créez votre GitHub application en accédant à Paramètres de développeur > Applications GitHub.
    2. Dans le champ URL de la page d’accueil , saisissez https://<nom-instance>.service-now.com.
    3. Dans le champ URL de rappel d’autorisation de l’utilisateur , saisissez https://<nom-instance>.service-now.com/oauth_redirect.do.
    4. Dans la section Identification et autorisation des utilisateurs , désélectionnez le champ Faire expirer les jetons d’autorisation de l’utilisateur .
    5. Dans la section Webhook , désélectionnez le champ Actif .
    6. Laissez les champs restants vides (par défaut).
    7. Dans la section Autorisations du référentiel , configurez ces paramètres.
      Action Lecture seule
      Vérifications Lecture seule
      Contenus Lecture seule
      Déploiements Lecture et écriture
      Environnements Lecture seule
      Métadonnées Lecture seule
      Demandes d'extraction Lecture seule
      Clés secrètes Lecture seule
      Webhooks Lecture et écriture
      Remarque :
      Des autorisations de lecture et d’écriture sont nécessaires pour configurer des webhooks à partir de ServiceNow.
    8. Laissez les autorisations restantes sur Aucun accès (par défaut).
    9. Installez l’application nouvellement créée GitHub sur les comptes de votre choix.

    Ajouter l’ID client à la propriété DevOps

    Après avoir configuré votre application GitHub, vous devez vous assurer que le préfixe d’ID client (3 premiers caractères ou plus de l’ID) est ajouté à la propriété DevOps : Spécificateur d’ID client pour l’application GitHub.

    Avant de commencer

    Rôle requis : sn_devops.admin

    Procédure

    1. Accédez à la Espaces de travail > Espace de travail de changement DevOps > Administration > Configuration système > Propriétés.
    2. Changez le périmètre de l’application en DevOps Data Model.
    3. Recherchez la propriété : Spécificateur d’ID client pour l’application GitHub [sn_devops.github_oauth_client_id_specifier].
    4. Entrez le préfixe de l’ID client (3 premiers caractères ou plus de l’ID) de votre application GitHub dans la propriété.
    5. Sélectionnez Enregistrer.

    S’inscrire GitHub en tant que fournisseur OAuth (code d’autorisation)

    Utilisez les informations générées pendant GitHub la configuration du compte d’application pour vous inscrire GitHub en tant que fournisseur OAuth et permettre à l’instance de demander des jetons OAuth 2.0.

    Avant de commencer

    Rôle requis : admin, sn_devops.admin

    Procédure

    1. Accédez à la Tout > OAuth système > Registre d'application.
    2. Cliquez sur Nouveau.
      Le système affiche le message Quel type d’application OAuth ?
    3. Sélectionnez Se connecter à un fournisseur OAuth tiers.
      Le système affiche un formulaire Registres d’application vide.
    4. Renseignez le formulaire.
      Champ Valeur requise
      Nom Saisissez un nom pour identifier l’enregistrement de façon unique. Par exemple, saisissez Mon fournisseur d’application GitHub.
      ID client Saisissez l’ID client de votre GitHub application (indice : disponible dans la section À propos de votre GitHub configuration d’application dans GitHub ).
      Secret client Saisissez le secret client de votre GitHub application (indice : disponible dans la section À propos de votre GitHub configuration d’application dans GitHub ).
      Script de l’API OAuth Sélectionnez OAuthDevOpsGitHubHandler.
      Type d'accord par défaut Sélectionnez Code d'autorisation.
      URL d'autorisation

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

      Pour un déploiement sur site, utilisez l’URL d’hôte appropriée GitHub .
      URL de jeton

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

      Pour un déploiement sur site, utilisez l’URL d’hôte appropriée GitHub .
    5. Laissez les autres champs de formulaire par défaut.
      Formulaire Registre d’application
    6. Cliquez avec le bouton droit de la souris sur l'en-tête du formulaire, puis cliquez sur Enregistrer.
      • Le système valide les informations d’identification OAuth et renseigne l’URL de redirection (indice : elle doit correspondre à l’URL de rappel d’autorisation d’utilisateur précédemment fournie dans la configuration de votre GitHub application).
      • Le système remplit le profil d’entité OAuth avec le type d’accord comme code d’autorisation. Par exemple, le profil de l’entité OAuth est créé avec le nom par défaut, mon fournisseur d’application GitHub default_profile

    Créer un enregistrement d’informations d’identification pour GitHub le fournisseur d’application (code d’autorisation)

    Créez un enregistrement d’informations d’identification auprès du fournisseur d’application GitHub précédemment créé pour autoriser les actions.

    Avant de commencer

    Rôle requis : admin, credential_admin

    Procédure

    1. Accédez à la Tout > Connexions et informations d'identification > Informations d'identification.
    2. Cliquez sur Nouveau.
      Le système affiche le message Quel type d’informations d’identification voulez-vous créer ?
    3. Sélectionnez Informations d'identification OAuth 2.0.
      La fenêtre contextuelle affiche un formulaire d’informations d’identification OAuth 2.0 vide.
    4. Renseignez ces valeurs.
      Champ Valeur requise
      Nom Saisissez un nom pour identifier l’enregistrement de façon unique. Par exemple, saisissez Mes informations d’identification de l’application GitHub.
      Actif Activer
      Profil de l'entité OAuth Sélectionnez le profil d’entité OAuth par défaut que vous avez créé précédemment.
      Concerne Sélectionnez les MID Server qui peuvent utiliser ces informations d’identification. Par exemple, sélectionnez Tous les MID Servers.
      Remarque :
      Vous devez vous connecter à votre instance d’outil GitHub à l’aide du Serveur MID pour utiliser ces informations d’identification.
      Commande Sélectionnez la commande d’application de ces informations d’identification. Par exemple, saisissez 100.
    5. Enregistrez l'enregistrement.
    6. Cliquez sur le lien connexe Obtenir le jeton OAuth pour générer le jeton OAuth.