Configurer la connexion sociale avec GitHub via GitHub App

Intégrez GitHub App pour activer la connexion avec GitHub, la liaison de comptes et l'accès sécurisé aux API GitHub avec des permissions fines et des jetons de rafraîchissement.

astuce:

Ce guide suppose que vous avez une compréhension de base des Connecteurs Logto. Pour ceux qui ne sont pas familiers, veuillez vous référer au guide des Connecteurs pour commencer.

GitHub App vs OAuth App

GitHub propose deux types d'applications pour l'authentification et l'accès à l'API : GitHub Apps et OAuth Apps. Voici un comparatif pour vous aider à choisir :

Fonctionnalité	GitHub App	OAuth App
Permissions (Permissions)	Permissions fines — accès uniquement aux ressources spécifiques	Portées larges — accorde souvent plus d'accès que nécessaire
Gestion des permissions	Configurée uniquement dans le tableau de bord GitHub ; le champ Scope de Logto peut rester vide	Configurée via les portées dans le connecteur Logto
Jetons de rafraîchissement (Refresh tokens)	Toujours émis lors du flux OAuth	Non pris en charge — les jetons n'expirent jamais sauf révocation
Expiration des jetons	Les jetons d’accès expirent après 8 heures ; les jetons de rafraîchissement sont valides 6 mois	Les jetons d’accès n’expirent jamais
Contrôle utilisateur	Les utilisateurs choisissent les dépôts auxquels l’application peut accéder	Accès à tous les dépôts auxquels l’utilisateur a accès
Limites de taux	Limites de taux plus élevées qui évoluent avec les installations	Limites de taux plus basses (5 000 requêtes/heure/utilisateur)
Installation	Installée sur des comptes/organisations avec accès granulaire aux dépôts	Autorisée par les utilisateurs avec un accès large
Webhooks	Prise en charge centralisée des webhooks intégrée	Doit être configurée séparément pour chaque dépôt
Agir de façon indépendante	Peut agir en son propre nom (serveur à serveur)	Agit toujours au nom d’un utilisateur

Quand utiliser GitHub App :

• Vous avez besoin d’un contrôle fin sur les permissions et l’accès aux dépôts
• Vous souhaitez des jetons de rafraîchissement pour un accès API à long terme avec une sécurité renforcée
• Vous avez besoin de limites de taux API plus élevées
• Vous souhaitez effectuer des tâches automatisées indépendamment des sessions utilisateur

Quand utiliser OAuth App :

• Intégration de connexion simple avec un accès API minimal
• Vous avez besoin de jetons qui n’expirent pas (pour des intégrations héritées)
• Vous devez accéder à des ressources de niveau entreprise (les GitHub Apps ne prennent pas encore en charge les permissions de niveau entreprise)

astuce:

GitHub recommande les GitHub Apps plutôt que les OAuth Apps pour la plupart des cas d’utilisation en raison de leurs fonctionnalités de sécurité renforcées et de leurs permissions fines. En savoir plus sur les différences entre GitHub Apps et OAuth Apps.

Commencer

Le connecteur GitHub App permet l’intégration OAuth 2.0 pour que votre application puisse :

• Ajouter l’authentification "Connexion avec GitHub"
• Lier les comptes utilisateurs aux identités GitHub
• Synchroniser les informations de profil utilisateur depuis GitHub
• Accéder aux API GitHub via le stockage sécurisé des jetons dans le Secret Vault de Logto pour des tâches d’automatisation (par exemple, créer des issues GitHub, gérer des dépôts depuis votre application)
• Utiliser des jetons de rafraîchissement (Refresh tokens) (toujours émis par les GitHub Apps) pour maintenir un accès API à long terme sans nécessiter une nouvelle authentification utilisateur

Pour configurer ces fonctionnalités d’authentification, créez d’abord un connecteur GitHub dans Logto :

1. Rendez-vous sur Console Logto > Connecteur > Connecteur social.
2. Cliquez sur Ajouter un connecteur social, sélectionnez GitHub App, cliquez sur Suivant et suivez le tutoriel étape par étape pour finaliser l’intégration.

Étape 1 : Créer une application GitHub

Avant de pouvoir utiliser GitHub comme fournisseur d'authentification, vous devez créer une application GitHub sur GitHub afin d'obtenir des identifiants OAuth 2.0.

1. Rendez-vous sur GitHub et connectez-vous avec votre compte, ou créez un nouveau compte si nécessaire.
2. Accédez à Paramètres > Paramètres développeur > Applications GitHub.
3. Cliquez sur Nouvelle application GitHub pour enregistrer une nouvelle application :
   • Nom de l'application GitHub : Saisissez un nom unique pour votre application. Le nom ne peut pas dépasser 34 caractères et doit être unique sur GitHub.
   • URL de la page d'accueil : Saisissez l'URL de la page d'accueil de votre application.
   • URL de rappel : Copiez l'URI de rappel depuis votre connecteur GitHub Logto et collez-le ici. Vous pouvez ajouter plusieurs URL de rappel si nécessaire. Après la connexion des utilisateurs avec GitHub, ils seront redirigés ici avec un code d'autorisation que Logto utilise pour finaliser l'authentification.
   • Expirer les jetons d’autorisation utilisateur : Laissez cette option cochée (recommandé). Cela active l'expiration des jetons et les jetons de rafraîchissement pour une sécurité renforcée.
   • Demander l’autorisation utilisateur (OAuth) lors de l’installation : Cochez cette option si vous souhaitez inviter les utilisateurs à autoriser votre application lors de l'installation.
   • Webhook : Décochez Actif si vous n'avez pas besoin d'événements webhook. Pour les cas d'utilisation d'authentification uniquement, les webhooks ne sont généralement pas nécessaires.
4. Sous Permissions, configurez les permissions dont votre application a besoin (voir l'étape 2 ci-dessous pour plus de détails).
5. Sous Où cette application GitHub peut-elle être installée ?, sélectionnez N'importe quel compte si vous souhaitez que les utilisateurs de n'importe quel compte GitHub puissent utiliser votre application pour l'authentification.
6. Cliquez sur Créer une application GitHub pour créer l'application GitHub.

remarque:

Contrairement aux applications OAuth, les applications GitHub utilisent des permissions fines au lieu de portées larges. Vous configurez les permissions dans le tableau de bord GitHub lors de la création de l'application, et les utilisateurs accordent l'accès à des dépôts spécifiques lors de l'autorisation.

Pour plus de détails sur la configuration des applications GitHub, consultez Enregistrer une application GitHub.

Étape 2 : Configurer les permissions dans GitHub

Les applications GitHub utilisent des permissions fines au lieu de portées OAuth. Vous devez configurer les permissions dans le tableau de bord GitHub lors de la création ou de la modification de votre application GitHub. Ces permissions déterminent à quelles données votre application peut accéder.

Comprendre les permissions des applications GitHub

Les permissions sont classées en trois types :

• Permissions de dépôt : Accès aux ressources au niveau du dépôt (code, tickets, pull requests, etc.)
• Permissions d'organisation : Accès aux ressources au niveau de l'organisation (membres, équipes, projets, etc.)
• Permissions de compte : Accès aux données du compte utilisateur (e-mail, profil, abonnés, etc.)

Pour chaque permission, vous pouvez sélectionner :

• Aucun accès : L'application ne peut pas accéder à cette ressource
• Lecture seule : L'application peut lire mais pas modifier cette ressource
• Lecture & écriture : L'application peut lire et modifier cette ressource

Permissions recommandées pour l'authentification

Pour la fonctionnalité de base "Se connecter avec GitHub", configurez au minimum ces permissions de compte :

Permission	Niveau d'accès	Objectif
Adresses e-mail	Lecture seule	Obtenir l'adresse e-mail de l'utilisateur pour la création de compte

astuce:

Les applications GitHub ont un accès implicite à la lecture des informations de profil public lorsqu'elles agissent au nom d'un utilisateur. Vous n'avez pas besoin de demander explicitement la permission pour les données de profil de base telles que le nom d'utilisateur, l'avatar et l'URL du profil public.

Permissions supplémentaires pour l'accès à l'API

Si votre application doit accéder aux API GitHub au-delà de l'authentification, ajoutez les permissions correspondantes dans le tableau de bord GitHub. Voici quelques exemples courants :

Type de permission	Permission	Niveau d'accès	Cas d'utilisation
Dépôt	Contenus	Lecture seule / Lecture & écriture	Accéder aux fichiers et au code du dépôt
Dépôt	Tickets	Lecture & écriture	Créer et gérer des tickets
Dépôt	Pull requests	Lecture & écriture	Créer et gérer des pull requests
Dépôt	Métadonnées	Lecture seule	Accéder aux métadonnées du dépôt (requis pour de nombreuses opérations)
Organisation	Membres	Lecture seule	Lister les membres de l'organisation
Compte	Abonnés	Lecture seule	Accéder aux abonnés et abonnements de l'utilisateur

Ceci n'est pas une liste exhaustive — les applications GitHub prennent en charge de nombreuses autres permissions fines. Consultez Permissions requises pour les applications GitHub pour la liste complète.

Différence clé avec les applications OAuth:

Contrairement aux applications OAuth où vous configurez les portées dans le connecteur Logto, les permissions des applications GitHub sont entièrement gérées dans le tableau de bord GitHub. Vous pouvez laisser le champ Scope vide dans votre connecteur GitHub Logto — ce n'est pas nécessaire car les applications GitHub n'utilisent pas les portées OAuth traditionnelles.

Il suffit de configurer les permissions dont vous avez besoin dans GitHub, et les utilisateurs seront invités à accorder l'accès lors de l'autorisation.

Étape 3 : Configurer votre connecteur Logto

Après avoir créé l'application GitHub, vous serez redirigé vers sa page de paramètres où vous pourrez obtenir les identifiants.

1. Sur la page des paramètres de votre application GitHub, copiez l'ID client et collez-le dans le champ clientId dans Logto.
2. Sous Secrets client, cliquez sur Générer un nouveau secret client. Copiez le secret généré et collez-le dans le champ clientSecret dans Logto.
3. Cliquez sur Enregistrer et terminer dans Logto pour connecter votre système d'identité à GitHub.

attention:

Gardez votre secret client en sécurité et ne l'exposez jamais dans du code côté client. Les secrets client GitHub ne peuvent pas être récupérés en cas de perte — vous devrez en générer un nouveau.

remarque:

L'ID client d'une application GitHub est différent de l'ID de l'application. Assurez-vous d'utiliser l'ID client (affiché comme "Client ID" sur la page des paramètres), et non l'ID de l'application.

Étape 4 : Paramètres généraux

Voici quelques paramètres généraux qui ne bloqueront pas la connexion à GitHub mais peuvent affecter l'expérience d'authentification de l'utilisateur final.

Synchroniser les informations de profil

Dans le connecteur GitHub, vous pouvez configurer la façon dont les informations de profil sont synchronisées depuis les informations utilisateur GitHub vers le profil utilisateur Logto, y compris name, avatar et email. Choisissez parmi les options suivantes :

• Synchroniser uniquement lors de l'inscription : Les informations de profil sont récupérées une seule fois lors de la première connexion de l'utilisateur.
• Toujours synchroniser lors de la connexion : Les informations de profil sont mises à jour à chaque connexion de l'utilisateur.

Stocker les jetons pour accéder aux API GitHub (Optionnel)

Si vous souhaitez accéder aux API GitHub et effectuer des actions avec l'autorisation de l'utilisateur (que ce soit via la connexion sociale ou la liaison de compte), activez le stockage des jetons dans Logto :

1. Configurez les permissions requises dans les paramètres de votre application GitHub (Étape 2).
2. Activez Stocker les jetons pour un accès API persistant dans le connecteur GitHub Logto. Logto stockera en toute sécurité à la fois le jeton d’accès et le jeton de rafraîchissement dans le Secret Vault.

remarque:

Comme les applications GitHub émettent toujours des jetons de rafraîchissement, Logto stocke automatiquement les deux jetons. Le jeton d’accès expire après 8 heures, mais Logto peut utiliser le jeton de rafraîchissement pour obtenir de nouveaux jetons d’accès, garantissant un accès API ininterrompu jusqu'à 6 mois.

Étape 5 : Tester votre intégration (Optionnel)

Avant de passer en production, testez l'intégration de votre application GitHub :

1. Utilisez le connecteur dans un tenant de développement Logto.
2. Vérifiez que les utilisateurs peuvent se connecter avec GitHub.
3. Vérifiez que les utilisateurs sont invités à accorder les bonnes permissions lors de l'autorisation.
4. Si vous avez activé le stockage des jetons, vérifiez que les jetons d’accès (et les jetons de rafraîchissement) sont correctement stockés.
5. Testez les appels API en utilisant les jetons stockés pour vous assurer que les permissions fonctionnent comme prévu.

Les applications GitHub fonctionnent immédiatement avec n'importe quel compte utilisateur GitHub — il n'est pas nécessaire d'avoir des utilisateurs de test ou une approbation d'application comme sur d'autres plateformes. Cependant, si votre application est installée sur une organisation, les propriétaires de l'organisation devront peut-être approuver l'installation.

Utiliser le connecteur GitHub

Une fois que vous avez créé un connecteur GitHub et que vous l’avez relié à GitHub, vous pouvez l’intégrer dans vos parcours utilisateurs. Choisissez les options qui correspondent à vos besoins :

Activer "Connexion avec GitHub"

1. Dans la Console Logto, allez sur Expérience de connexion > Inscription et connexion.
2. Ajoutez le connecteur GitHub dans la section Connexion sociale pour permettre aux utilisateurs de s’authentifier avec GitHub.

En savoir plus sur l’expérience de connexion sociale.

Lier ou délier un compte GitHub

Utilisez l’Account API pour construire un Centre de compte personnalisé dans votre application permettant aux utilisateurs connectés de lier ou délier leur compte GitHub. Suivez le tutoriel Account API

astuce:

Il est possible d’activer le connecteur GitHub uniquement pour la liaison de compte et l’accès à l’API, sans l’activer pour la connexion sociale.

Accéder aux API GitHub et effectuer des actions

Votre application peut récupérer les jetons GitHub stockés dans le Secret Vault pour appeler les API GitHub et automatiser des tâches backend (par exemple, créer des issues, gérer des dépôts ou automatiser des workflows). Consultez le guide sur la récupération des jetons stockés pour l’accès API.

Comme les GitHub Apps émettent toujours des jetons de rafraîchissement lors du flux OAuth, Logto stocke à la fois les jetons d’accès et les jetons de rafraîchissement. Les jetons d’accès expirent après 8 heures, mais Logto utilise automatiquement le jeton de rafraîchissement (valide 6 mois) pour obtenir de nouveaux jetons d’accès, garantissant ainsi un accès API ininterrompu.

Gérer l’identité GitHub de l’utilisateur

Après qu’un utilisateur a lié son compte GitHub, les administrateurs peuvent gérer cette connexion dans la Console Logto :

1. Accédez à Console Logto > Gestion des utilisateurs et ouvrez le profil de l’utilisateur.
2. Sous Connexions sociales, localisez l’élément GitHub et cliquez sur Gérer.
3. Sur cette page, les administrateurs peuvent gérer la connexion GitHub de l’utilisateur, voir toutes les informations de profil accordées et synchronisées depuis son compte GitHub, et vérifier le statut du jeton d’accès et du jeton de rafraîchissement.

remarque:

Contrairement aux OAuth Apps qui utilisent des portées, les GitHub Apps utilisent des permissions fines configurées dans le tableau de bord GitHub. Le jeton d’accès utilisateur est limité aux permissions que votre application et l’utilisateur possèdent tous les deux. Logto ne peut pas afficher directement la liste des permissions, mais votre application aura accès selon les permissions configurées dans les paramètres de votre GitHub App.

Référence

Documentation développeur GitHub - À propos des GitHub Apps

Documentation développeur GitHub - Enregistrer une GitHub App

Documentation développeur GitHub - Générer des jetons d’accès utilisateur

Documentation développeur GitHub - Rafraîchir les jetons d’accès utilisateur

GitHub Apps vs OAuth Apps