Remarque
Envisagez de créer une GitHub App à la place d’une OAuth app. Les GitHub Apps utilisent des autorisations de granularité fine à la place des étendues, ce qui vous permet de mieux contrôler ce que votre application est en mesure de faire. Pour plus d’informations, consultez « Différences entre les applications GitHub et les applications OAuth » et « À propos de la création d’applications GitHub ».
Durant la configuration d’une OAuth app sur GitHub, l’utilisateur voit s’afficher les étendues demandées dans le formulaire d’autorisation.
Remarque
Si vous créez une application GitHub, vous n’avez pas besoin de fournir d’étendues dans votre demande d’autorisation. Pour plus d’informations à ce sujet, consultez « Authentification auprès d’une application GitHub pour le compte d’un utilisateur ».
Si votre OAuth app n’a pas accès à un navigateur (dans le cas d’un outil CLI, par exemple), vous n’avez pas besoin de spécifier d’étendue pour permettre aux utilisateurs de s’authentifier auprès de votre application. Pour plus d’informations, consultez « Autorisation des applications OAuth ».
Vérifiez les en-têtes pour voir vos étendues OAuth et ce qui est accepté par l’action d’API :
$ curl -H "Authorization: Bearer OAUTH-TOKEN" http(s)://HOSTNAME/api/v3/users/codertocat -I
HTTP/2 200
X-OAuth-Scopes: repo, user
X-Accepted-OAuth-Scopes: user
X-OAuth-Scopesliste les étendues autorisées par votre jeton.X-Accepted-OAuth-Scopesliste les étendues vérifiées par l’action.
Étendues disponibles
| Nom | Description |
|---|---|
(no scope) | Accorde un accès en lecture seule aux informations publiques (y compris les informations du profil de l’utilisateur, les informations du référentiel et les gists) |
site_admin | Accorde aux administrateurs de site l’accès aux points de terminaison d’API pour l’administrationGitHub Enterprise Server. |
repo | Accorde un accès complet aux référentiels publics et privés, y compris un accès en lecture et en écriture au code, aux statuts des commits, aux invitations au référentiel, aux collaborateurs, aux statuts de déploiement et aux webhooks du référentiel. Remarque : En plus des ressources associées au dépôt, l’étendue repo accorde également l’accès à la gestion des ressources appartenant à l’organisation, notamment les projets, les invitations, les appartenances aux équipes et les webhooks. Cette étendue accorde également la possibilité de gérer des projets appartenant aux utilisateurs. |
repo:status | Accorde un accès en lecture/écriture aux statuts des commits dans les référentiels . Cette étendue est nécessaire uniquement pour octroyer à d’autres utilisateurs ou services l’accès aux états de commit des dépôts privés sans octroyer l’accès au code. |
repo_deployment | Accorde l’accès aux états de déploiement pour les référentiels publics et privés. Cette étendue n’est nécessaire que pour accorder à d’autres utilisateurs ou services l’accès aux états de déploiement, sans accorder l’accès au code. |
public_repo | Limite l’accès aux référentiels publics. Cela inclut l’accès en lecture/écriture au code, les états de commit, les projets de dépôt, les collaborateurs ainsi que les états de déploiement pour les dépôts publics et les organisations. Obligatoire également pour l’affichage des référentiels publics. |
repo:invite | Accorde des capacités d’acceptation et de refus pour les invitations à collaborer sur un référentiel. Cette étendue n’est nécessaire que pour accorder à d’autres utilisateurs ou services l’accès aux invitations sans accorder l’accès au code. |
security_events | Accorde : Un accès en lecture et en écriture aux événements de sécurité dans l’API code scanning Cette étendue n’est nécessaire que pour accorder à d’autres utilisateurs ou services l’accès aux événements de sécurité sans accorder l’accès au code. |
admin:repo_hook | Accorde l’accès en lecture, écriture, test Ping et suppression aux hooks du référentiel dans . Les étendues repo et public_repo octroient un contrôle total sur les dépôts, y compris les hooks de dépôt. Utilisez l’étendue admin:repo_hook pour limiter l’accès aux crochets de dépôt uniquement. |
write:repo_hook | Accorde l’accès en lecture, écriture et test Ping aux hooks dans les référentiels . |
read:repo_hook | Accorde un accès en lecture et en test Ping aux hooks dans les référentiels . |
admin:org | Gérez complètement l’organisation et ses équipes, ses projets et ses membres. |
write:org | Permet d’accéder en lecture et en écriture aux membres de l'organisation et aux projets de l'organisation. |
read:org | Permet d’accéder en lecture seule aux membres de l’organisation, aux projets de l’organisation et aux membres de l’équipe. |
admin:public_key | Permet de gérer entièrement les clés publiques. |
write:public_key | Permet de créer, de lister et d’afficher les détails des clés publiques. |
read:public_key | Permet de lister et d’afficher les détails des clés publiques. |
admin:org_hook | Accorde un accès en lecture, en écriture, en test Ping et en suppression aux hooks de l’organisation. Remarque : Les jetons OAuth ne peuvent effectuer ces actions que sur les crochets d’organisation créés par l’OAuth app. Les Personal access token ne peuvent effectuer ces actions que sur les crochets d’organisation créés par un utilisateur. |
gist | Accorde un accès en écriture aux gists. |
notifications | Accorde : Un accès en lecture aux notifications d’un utilisateur Un accès au marquage des threads comme étant lus Un accès à l’activation et à la désactivation de la surveillance d’un référentiel Un accès en lecture, en écriture et en suppression aux abonnements aux threads |
user | Accorde un accès en lecture/écriture aux seules informations du profil. Notez que cette étendue comprend user:email et user:follow. |
read:user | Accorde l’accès à la lecture des données du profil d’un utilisateur. |
user:email | Accorde un accès en lecture aux adresses e-mail d’un utilisateur. |
user:follow | Accorde l’accès pour suivre ou ne plus suivre d’autres utilisateurs. |
delete_repo | Accorde l’accès pour supprimer les référentiels administrables. |
write:packages | Accorde l’accès au téléchargement ou à la publication d’un package dans GitHub Packages. Pour plus d’informations, consultez « Publication d'un package ». |
read:packages | Accorde l’accès au téléchargement et à l’installation de packages à partir de GitHub Packages. Pour plus d’informations, consultez « Installation d'un package ». |
delete:packages | Accorde l’accès à la suppression de packages à partir de GitHub Packages. Pour plus d’informations, consultez « Suppression et restauration d'un package ». |
admin:gpg_key | Permet de gérer entièrement les clés GPG. |
write:gpg_key | Permet de créer, lister et afficher les détails des clés GPG. |
read:gpg_key | Permet de lister et d’afficher les détails des clés GPG. |
workflow | Permet d’ajouter et de mettre à jour les fichiers de flux de travail GitHub Actions. Les fichiers de workflow peuvent être commités sans cette étendue si le même fichier (avec le même chemin et le même contenu) existe dans une autre branche du même dépôt. Les fichiers de workflow peuvent exposer GITHUB_TOKEN, qui peut avoir un ensemble différent d’étendues. Pour plus d’informations, consultez Utiliser GITHUB_TOKEN pour l’authentification dans les flux de travail. |
admin:enterprise | Donne un contrôle total des fonctionnalités d’entreprise. Pour plus d’informations, consultez Gestion des comptes d’entreprise dans la documentation de l’API GraphQL. Inclut manage_runners:enterprise, manage_billing:enterprise et read:enterprise. |
manage_runners:enterprise | Donne un contrôle total sur les exécuteurs auto-hébergés au sein de l’entreprise. Pour plus d’informations, consultez « Exécuteurs auto-hébergés ». |
manage_billing:enterprise | Lisez et écrivez les données de facturation de l’entreprise. Pour plus d’informations, consultez « Points de terminaison d’API REST pour la facturation ». |
read:enterprise | Lisez toutes les données d’un profil d’entreprise. Ne comprend pas les données de profil des membres de l'entreprise ou des organisations. |
read:audit_log | Lire les données du journal d'audit. |
Remarque
Votre OAuth app. peut demander les étendues dans la redirection initiale. Vous pouvez spécifier plusieurs étendues en les séparant par un espace à l’aide de %20 :
https://github.com/login/oauth/authorize?
client_id=...&
scope=user%20repo_deployment
Étendues demandées et étendues octroyées
L’attribut scope liste les étendues attachées au jeton qui ont été octroyées par l’utilisateur. Normalement, ces étendues sont identiques à ce que vous avez demandé.
Toutefois, les utilisateurs peuvent modifier leurs étendues, ce qui permet d’octroyer à votre application moins d’accès que ce que vous avez demandé à l’origine. De plus, les utilisateurs peuvent modifier les étendues des jetons, une fois le flux OAuth effectué.
Vous devez être conscient de cette éventualité, et en tenir compte pour ajuster le comportement de votre application.
Il est important de gérer les cas d’erreur où un utilisateur choisit de vous octroyer un accès inférieur à celui que vous avez demandé à l’origine. Par exemple, les applications peuvent avertir les utilisateurs, ou leur indiquer qu’ils seront confrontés à des fonctionnalités réduites ou qu’ils ne pourront pas effectuer certaines actions.
De plus, les applications peuvent toujours renvoyer les utilisateurs dans le flux pour obtenir des autorisations supplémentaires. Toutefois, n’oubliez pas que les utilisateurs peuvent toujours dire non.
Consultez le Guide des informations de base sur l’authentification, qui fournit des conseils sur la gestion des étendues de jeton modifiables.
Étendues normalisées
Quand vous demandez plusieurs étendues, le jeton est enregistré avec une liste normalisée d’étendues, en écartant celles qui sont implicitement incluses par une autre étendue demandée. Par exemple, si vous demandez user,gist,user:email, vous obtenez un jeton avec les étendues user et gist uniquement, car l’accès octroyé avec l’étendue user:email est inclus dans l’étendue user.