Skip to main content

Création d’une application GitHub à l’aide de paramètres d’URL

Vous pouvez présélectionner les paramètres d’une nouvelle GitHub App à l’aide des paramètres de requête de l’URL pour définir rapidement la configuration de la nouvelle GitHub App.

À propos des paramètres d’URL de l’GitHub App

Vous pouvez ajouter des paramètres de requête à ces URL pour présélectionner la configuration d’une GitHub App dans un compte personnel ou d’organisation :

  • Compte personnel : https://github.com/settings/apps/new
  • Compte d’organisation : https://github.com/organizations/:org/settings/apps/new

La personne qui crée l’application peut modifier les valeurs présélectionnées à partir de la page d’inscription de l’GitHub App avant de l’envoyer. Si vous n’incluez pas les paramètres obligatoires dans la chaîne de requête de l’URL, par exemple name, la personne qui crée l’application devra entrer une valeur avant de l’envoyer.

Dans le cas des applications qui nécessitent un secret pour sécuriser leur webhook, la valeur du secret doit être définie dans le formulaire par la personne qui crée l’application, et non à l’aide des paramètres de requête. Pour plus d’informations, consultez « Sécurisation de vos webhooks ».

L’URL suivante crée une application publique appelée octocat-github-app avec une URL de rappel et une description préconfigurées. Cette URL sélectionne également les autorisations d’accès en lecture et en écriture pour checks, s’abonne aux événements de webhook check_run et check_suite, puis sélectionne l’option permettant de demander l’autorisation de l’utilisateur (OAuth) durant l’installation :

https://github.com/settings/apps/new?name=octocat-github-app&description=An%20Octocat%20App&callback_urls[]=https://example.com&request_oauth_on_install=true&public=true&checks=write&events[]=check_run&events[]=check_suite

La liste complète des paramètres de requête, des autorisations et des événements disponibles est listée dans les sections ci-dessous.

Paramètres de configuration de l’GitHub App

NomTypeDescription
namestringNom de l’GitHub App. Donnez un nom clair et succinct à votre application. Votre application ne peut pas avoir le même nom qu’un utilisateur GitHub existant, sauf s’il s’agit de votre propre nom d’utilisateur ou d’organisation. Une version avec slug du nom de votre application s’affiche dans l’interface utilisateur quand votre intégration effectue une action.
descriptionstringDescription de l’GitHub App.
urlstringURL complète de la page d’accueil du site web de votre GitHub App.
callback_urlsarray of stringsURL complète de redirection, une fois qu’une personne a autorisé une installation. Vous pouvez fournir jusqu’à 10 URL de rappel. Ces URL sont utilisées si votre application doit identifier et autoriser les requêtes utilisateur à serveur. Par exemple : callback_urls[]=https://example.com&callback_urls[]=https://example-2.com.
request_oauth_on_installbooleanSi votre application autorise les utilisateurs à l’aide du flux OAuth, vous pouvez affecter la valeur true à cette option pour permettre aux utilisateurs d’autoriser l’application quand ils l’installent, et ainsi de sauter une étape. Si vous sélectionnez cette option, setup_url cesse d’être disponible, et les utilisateurs sont redirigés vers votre callback_url après l’installation de l’application.
setup_urlstringURL complète de redirection une fois qu’une personne a installé l’GitHub App, si l’application nécessite une configuration supplémentaire après l’installation.
setup_on_updatebooleanAffectez-lui la valeur true pour rediriger les utilisateurs vers l’URL de configuration quand les installations ont été mises à jour, par exemple après l’ajout ou la suppression de dépôts.
publicbooleanAffectez-lui la valeur true quand votre GitHub App est accessible au public, ou la valeur false quand elle est uniquement accessible au propriétaire de l’application.
webhook_activebooleanAffectez-lui la valeur false pour désactiver le webhook. Le webhook est activé par défaut.
webhook_urlstringURL complète à laquelle vous souhaitez envoyer les charges utiles des événements de webhook.
eventsarray of stringsÉvénements de webhook. Certains événements de webhook nécessitent des autorisations read ou write sur une ressource pour que vous puissiez sélectionner l’événement au moment de l’inscription d’une nouvelle GitHub App. Pour connaître les événements disponibles et les autorisations nécessaires, consultez la section « Événements de webhook de l’GitHub App ». Vous pouvez sélectionner plusieurs événements dans une chaîne de requête. Par exemple events[]=public&events[]=label.
single_file_namestringIl s’agit d’une autorisation à étendue limitée, qui permet à l’application d’accéder à un seul fichier dans n’importe quel dépôt. Quand vous affectez à l’autorisation single_file la valeur read ou write, ce champ fournit le chemin du fichier unique que votre GitHub App va gérer. Si vous avez besoin de gérer plusieurs fichiers, consultez single_file_paths ci-dessous.
single_file_pathsarray of stringsCela permet à l’application d’accéder au maximum à dix fichiers spécifiques dans un dépôt. Quand vous affectez à l’autorisation single_file la valeur read ou write, ce tableau peut stocker les chemins de dix fichiers au maximum que votre GitHub App va gérer. Ces fichiers reçoivent tous la même autorisation définie par single_file. Ils n’ont pas d’autorisations individuelles distinctes. Quand deux fichiers ou plus sont configurés, l’API retourne multiple_single_files=true, sinon elle retourne multiple_single_files=false.

Autorisations de l’GitHub App

Vous pouvez sélectionner des autorisations dans une chaîne de requête en utilisant le nom d’autorisation figurant dans le tableau suivant en tant que nom de paramètre de requête, et le type d’autorisation en tant que valeur de requête. Par exemple, pour sélectionner les autorisations Read & write dans l’interface utilisateur pour contents, votre chaîne de requête doit inclure &contents=write. Pour sélectionner les autorisations Read-only dans l’interface utilisateur pour blocking, votre chaîne de requête doit inclure &blocking=read. Si vous souhaitez sélectionner no-access dans l’interface utilisateur pour checks, votre chaîne de requête ne doit pas inclure l’autorisation checks.

AutorisationDescription
administrationOctroie l’accès à différents points de terminaison pour l’administration de l’organisation et du dépôt. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.
blockingOctroie l’accès à l’API de blocage des utilisateurs. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.
checksOctroie l’accès à l’API des vérifications. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.
contentsOctroie l’accès à divers points de terminaison qui vous permettent de modifier le contenu du dépôt. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.
deploymentsOctroie l’accès à l’API des déploiement. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.
emailsOctroie l’accès à l’API des e-mails. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.
followersOctroie l’accès à l’API des abonné. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.
gpg_keysOctroie l’accès à l’API des clés GPG. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.
issuesOctroie l’accès à l’API des problèmes. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.
keysOctroie l’accès à l’API des clés publiques. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.
membersOctroie l’accès à la gestion des membres d’une organisation. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.
metadataOctroie l’accès aux points de terminaison en lecture seule qui n’entraînent pas de fuite de données sensibles. Peut être read ou none. La valeur par défaut est read quand vous définissez une autorisation, ou none quand vous ne spécifiez aucune autorisation pour l’GitHub App.
organization_administrationOctroie l’accès au point de terminaison « Mettre à jour une organisation » et à l’API des restrictions d’interaction de l’organisation. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.
organization_hooksOctroie l’accès à l’API des webhooks d’organisation. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.
organization_planOctroie l’accès à l’obtention d’informations sur le plan d’une organisation à l’aide du point de terminaison « Obtenir une organisation ». Il peut s’agir de l’une des valeurs suivantes : none ou read.
organization_projectsOctroie l’accès à l’API des projets. Il peut s’agir de l’une des valeurs suivantes : none, read, write ou admin.
organization_user_blockingOctroie l’accès à l’API de blocage des utilisateurs pour une organisation. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.
pagesOctroie l’accès à l’API de GitHub Pages. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.
planOctroie l’accès à l’obtention d’informations sur le plan GitHub d’un utilisateur à l’aide du point de terminaison « Obtenir un utilisateur ». Il peut s’agir de l’une des valeurs suivantes : none ou read.
pull_requestsOctroie l’accès à divers points de terminaison de demande de tirage. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.
repository_hooksOctroie l’accès à l’API des webhooks de dépôt. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.
repository_projectsOctroie l’accès à l’API des projets. Il peut s’agir de l’une des valeurs suivantes : none, read, write ou admin.
secret_scanning_alertsOctroie l’accès à l’API d’analyse des secrets. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.
security_eventsOctroie l’accès à l’API d’analyse du code. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.
single_fileOctroie l’accès à l’API de contenu. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.
starringOctroie l’accès à l’API d’attribution d’étoiles. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.
statusesOctroie l’accès à l’API des états. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.
team_discussionsOctroie l’accès à l’API des discussions d’équipe et à l’API des commentaires de discussion d’équipe. Peut avoir l’une des valeurs suivantes : none, read ou write.
vulnerability_alertsOctroie l’accès à la réception d’Dependabot alerts dans un référentiel. Pour en savoir plus, consultez « À propos des Dependabot alerts ». Peut avoir l’une des valeurs suivantes : none, read ou write.
watchingOctroie l’accès permettant de lister et de changer les dépôts auxquels un utilisateur est abonné. Il peut s’agir de l’une des valeurs suivantes : none, read ou write.

Événements de webhook de l’GitHub App

Nom de l’événement de webhookAutorisation requiseDescription
check_runchecksL’activité de suite d’exécutions a eu lieu. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « check runs ».
check_suitechecksL’activité de suite de vérifications a eu lieu. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « check suites ».
commit_commentcontentsUn commentaire de commit est créé. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « commit comments ».
createcontentsUne branche ou une étiquette Git est créée. Pour plus d’informations, consultez l’API REST « Git database ».
deletecontentsUne branche ou une étiquette Git est supprimée. Pour plus d’informations, consultez l’API REST « Git database ».
deploymentdeploymentsUn déploiement est créé. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « deployment ».
deployment_statusdeploymentsUn déploiement est créé. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « deployments ».
forkcontentsUn utilisateur duplique un dépôt. Pour plus d’informations, consultez l’API REST « forks ».
gollumcontentsUne page wiki est créée ou mise à jour. Pour plus d’informations, consultez « À propos des wikis ».
issuesissuesActivité liée à un problème. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « issues ».
issue_commentissuesActivité liée à un problème ou à un commentaire de demande de tirage. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « issue comments ».
labelmetadataActivité liée à une étiquette. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « labels ».
membermembersActivité liée aux collaborateurs du référentiel. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « collaborators ».
membershipmembersActivité liée à l’appartenance à une équipe. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « team members ».
milestonepull_requestActivité liée aux jalons. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « milestones ».
org_blockorganization_administrationActivité liée aux personnes bloquées dans une organisation. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « blocking organizations users ».
organizationmembersActivité liée à une organisation et à ses membres. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « organizations ».
page_buildpagesReprésente une tentative de génération d’un site GitHub Pages, qu’elle réussisse ou non. Une poussée sur une branche activée pour GitHub Pages (gh-pages pour les pages de projet, la branche par défaut pour les pages d’utilisateur et d’organisation) déclenche cet événement.
projectrepository_projects ou organization_projectsActivité liée aux classic projects. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « projects ».
project_cardrepository_projects ou organization_projectsActivité liée aux cartes dans un classic project. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « project cards ».
project_columnrepository_projects ou organization_projectsActivité liée aux colonnes dans un classic project. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « project columns ».
publicmetadataQuand un dépôt privé est rendu public. Sans aucun doute : le meilleur événement GitHub Enterprise Cloud.
pull_requestpull_requestsActivité liée aux demandes de tirage. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « pull requests ».
pull_request_reviewpull_requestActivité liée aux révisions de demande de tirage. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « pull request reviews ».
pull_request_review_commentpull_requestActivité liée aux commentaires de révision des demandes de tirage dans la différence unifiée de la demande de tirage. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « pull request review comments ».
pull_request_review_threadpull_requestActivité liée à un thread de commentaire sur une demande de tirage marquée comme résolue ou non résolue. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile.
pushcontentsUn ou plusieurs commits sont poussés sur une branche ou une étiquette de dépôt.
releasecontentsActivité liée à une version. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « releases ».
repositorymetadataActivité liée à un dépôt. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « repositories ».
repository_dispatchcontentsPermet aux intégrateurs utilisant GitHub Actions de déclencher des événements personnalisés.
statusstatusesLorsque l’état d’un commit Git change. Pour plus d’informations, consultez l’API REST « statuses ».
teammembersActivité liée à l’équipe d’une organisation. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « teams ».
team_addmembersQuand un dépôt est ajouté à une équipe.
watchmetadataQuand une personne met une étoile à un dépôt. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « starring ».