Skip to content

Commit 6ffe3b9

Browse files
Copilothpsinjc-clark
authored
Add GitHub authentication metadata documents page (#60980)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: hpsin <1666363+hpsin@users.noreply.github.com> Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com>
1 parent ff66921 commit 6ffe3b9

2 files changed

Lines changed: 39 additions & 0 deletions

File tree

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: GitHub authentication discovery endpoints
3+
shortTitle: OAuth 2.0 and OIDC Discovery documents
4+
intro: '{% data variables.product.github %} publishes OAuth 2.0 and OpenID Connect metadata documents.'
5+
versions:
6+
fpt: '*'
7+
ghes: '*'
8+
ghec: '*'
9+
category:
10+
- Understand GitHub Apps
11+
---
12+
13+
> [!NOTE]
14+
> The {% data variables.product.github %} authentication metadata documents described in this article are in {% data variables.release-phases.public_preview %} and subject to change.
15+
> While the endpoints may be present on {% data variables.enterprise.data_residency %} and some versions of {% data variables.product.prodname_ghe_server %}, they contain incorrect information.
16+
17+
{% data variables.product.github %} publishes two metadata documents used in the OAuth 2.0 and OpenID Connect protocols:
18+
19+
* **OAuth 2.0 Authorization Server Metadata** ([RFC 8414](https://datatracker.ietf.org/doc/html/rfc8414)): `https://github.com/.well-known/oauth-authorization-server/login/oauth`
20+
* **OpenID Connect Discovery** ([OpenID Connect Discovery 1.0](https://openid.net/specs/openid-connect-discovery-1_0.html)): `https://github.com/login/oauth/.well-known/openid-configuration`
21+
22+
These documents are used to validate tokens issued by {% data variables.product.github %} as well as programmatically determine how to sign in a user.
23+
24+
## Intended use
25+
26+
These documents are only published for MCP clients using [RFC 9728](https://datatracker.ietf.org/doc/html/rfc9728) to discover the OAuth 2.0 endpoints needed to get a token for the {% data variables.product.github %} MCP server.
27+
28+
{% data variables.product.github %} does not currently implement OpenID Connect in its OAuth flows and does not issue ID tokens for users or apps.
29+
30+
## Issuer
31+
32+
The issuer for {% data variables.product.prodname_dotcom_the_website %} is `https://github.com/login/oauth`.
33+
34+
This is the base URL used to find the other documents listed and an important parameter when configuring authentication libraries.
35+
36+
## Difference from GitHub Actions tokens
37+
38+
These metadata documents do not apply to the tokens issued for {% data variables.product.prodname_actions %} workflows. {% data variables.product.prodname_actions %} uses a separate dedicated issuer and token profile. For more information about Actions tokens, see [AUTOTITLE](/actions/concepts/security/openid-connect).

content/apps/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ children:
4141
- /maintaining-github-apps
4242
- /github-marketplace
4343
- /oauth-apps
44+
- /github-authentication-discovery-endpoints
4445
redirect_from:
4546
- /developers
4647
- /developers/apps/getting-started-with-apps

0 commit comments

Comments
 (0)