From 51a07645a7b2f9628a360bacf0e3efbc83d96d55 Mon Sep 17 00:00:00 2001 From: Dan Moore Date: Tue, 25 Jun 2024 10:03:49 -0600 Subject: [PATCH 1/2] 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. --- .../identity-providers/social/_github-troubleshooting.mdx | 6 ++++++ .../identity-providers/social/github.mdx | 8 +++++++- 2 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 astro/src/content/docs/lifecycle/authenticate-users/identity-providers/social/_github-troubleshooting.mdx diff --git a/astro/src/content/docs/lifecycle/authenticate-users/identity-providers/social/_github-troubleshooting.mdx b/astro/src/content/docs/lifecycle/authenticate-users/identity-providers/social/_github-troubleshooting.mdx new file mode 100644 index 0000000000..2185733dc8 --- /dev/null +++ b/astro/src/content/docs/lifecycle/authenticate-users/identity-providers/social/_github-troubleshooting.mdx @@ -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 Public Profile -> Public Email. 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. diff --git a/astro/src/content/docs/lifecycle/authenticate-users/identity-providers/social/github.mdx b/astro/src/content/docs/lifecycle/authenticate-users/identity-providers/social/github.mdx index 95fd4d2b3a..2eda53626f 100644 --- a/astro/src/content/docs/lifecycle/authenticate-users/identity-providers/social/github.mdx +++ b/astro/src/content/docs/lifecycle/authenticate-users/identity-providers/social/github.mdx @@ -8,14 +8,16 @@ tertcategory: identity providers quatercategory: social --- import Aside from 'src/components/Aside.astro'; +import Breadcrumb from 'src/components/Breadcrumb.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 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. @@ -75,3 +77,7 @@ The final item to configure is under the Options tab. For GitHu That's it, now the `Login with GitHub` button will show up on the login page of our `Pied Piper` application. FusionAuth GitHub IdP Configuration + +## Troubleshooting + + From 3902302f346b3c183a9ec887ce464b777aa7b1e2 Mon Sep 17 00:00:00 2001 From: Dan Moore Date: Tue, 25 Jun 2024 10:08:37 -0600 Subject: [PATCH 2/2] removing breadcrumb import from main page, as it is not used --- .../authenticate-users/identity-providers/social/github.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/astro/src/content/docs/lifecycle/authenticate-users/identity-providers/social/github.mdx b/astro/src/content/docs/lifecycle/authenticate-users/identity-providers/social/github.mdx index 2eda53626f..a424c35b06 100644 --- a/astro/src/content/docs/lifecycle/authenticate-users/identity-providers/social/github.mdx +++ b/astro/src/content/docs/lifecycle/authenticate-users/identity-providers/social/github.mdx @@ -8,7 +8,6 @@ tertcategory: identity providers quatercategory: social --- import Aside from 'src/components/Aside.astro'; -import Breadcrumb from 'src/components/Breadcrumb.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';