Skip to content

Commit

Permalink
Update GitHub OIDC page (#3133)
Browse files Browse the repository at this point in the history
* refined the error docs for GH

want to make sure it is clear how to fix the no email found error.

also broke it out to a troubleshooting section.

* removing breadcrumb import from main page, as it is not used
  • Loading branch information
mooreds authored Jul 2, 2024
1 parent 6314f7d commit 013d7af
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import Breadcrumb from 'src/components/Breadcrumb.astro';

GitHub users must have a public email address to allow FusionAuth to link their account on an email address. If they do not, you will get an error message stating `An email address was not provided for the user. This account cannot be used to login, unable to complete this login request.` You have two options:

* Require all users who use GitHub to log in have a public email address. This is configured on a per-user basis under <Breadcrumb>Public Profile -> Public Email</Breadcrumb>. This is done **on GitHub**.
* Link on [username or create an anonymous link](/docs/lifecycle/authenticate-users/identity-providers/#linking-strategies). Using these strategies ensure the configured GitHub OIDC connection works for every user, no matter their GitHub privacy settings, but means you won't have access to their email address.
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,14 @@ quatercategory: social
---
import Aside from 'src/components/Aside.astro';
import IdentityProviderOverviewDiagram from 'src/content/docs/_shared/_identity-provider-overview-diagram.astro';
import GitHubTroubleshooting from 'src/content/docs/lifecycle/authenticate-users/identity-providers/social/_github-troubleshooting.mdx';
import InlineField from 'src/components/InlineField.astro';
import OpenidConnectExampleLambda from 'src/content/docs/_shared/_openid-connect-example-lambda.mdx';

## Configure OpenID Connect with GitHub

<Aside type="note">
GitHub user's must have a public email address configured to link on email (See [Linking Strategies for more on this](/docs/lifecycle/authenticate-users/identity-providers/#linking-strategies)). An approach that will work for all users is to link on username or create an anonymous link. Using these strategies ensure that the configured GitHub OIDC connection works for every user, no matter their GitHub privacy settings.
<GitHubTroubleshooting />
</Aside>

Once you have completed this configuration you may enable an OpenID Connect "Login with GitHub" button for one or more FusionAuth Applications. See [GitHub - Creating an OAuth App](https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/) for an additional reference.
Expand Down Expand Up @@ -75,3 +76,7 @@ The final item to configure is under the <strong>Options</strong> tab. For GitHu
That's it, now the `Login with GitHub` button will show up on the login page of our `Pied Piper` application.

<img src="/img/docs/lifecycle/authenticate-users/identity-providers/social/github-openid-connect-configuration.png" alt="FusionAuth GitHub IdP Configuration" role="shadowed bottom-cropped top-cropped" />

## Troubleshooting

<GitHubTroubleshooting />

0 comments on commit 013d7af

Please sign in to comment.