Repository navigation
docs: document how to get the user email from Google - #323
Merged
Merged
Conversation
the built-in Google provider requests only the userinfo.profile scope, so Google never returns the email and an email attribute mapping stays empty. The new README section shows AddCustomProvider registered as "google" with the email scope, keeping the built-in callback URI and user ids, and sets Email only for a verified address. Drops the backlog item it implements. Related to #249
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues are blocking approval of the documentation changes.
No open issues 🎉
What changed in this PR
Documents how to retrieve a verified Google email address without changing the built-in provider’s deliberately minimal scope.
Changes:
- Adds a custom Google provider example that requests email access while preserving existing user IDs and the callback URI.
- Clarifies when a custom provider can use a built-in provider name.
- Replaces the completed Google-email backlog item with a follow-up to document
AddProviderWithUserAttributes.
| File | Description |
|---|---|
| README.md | Adds Google email guidance and clarifies custom provider naming. |
| docs/backlog/readme-user-attributes-undocumented.md | Tracks missing documentation for user-attribute mapping. |
| docs/backlog/readme-google-email-scope-undocumented.md | Removes the completed Google email documentation task. |
Review effort: Balanced
Coverage Report for CI Build 41331320703Coverage remained the same at 86.88%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsNo coverage regressions found. Coverage Stats
💛 - Coveralls |
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
the built-in Google provider requests only the
userinfo.profilescope, so Google never returns the user's email and anemailmapping viaAddProviderWithUserAttributesstays empty. The minimal scope is deliberate (#37), so this documents the way around it instead of changing the scope.AddCustomProviderexample registered asgooglein place ofAddProvider("google", ...). It keeps the/auth/google/callbackURI and the built-in user id, requests the email scope, and setsEmailonly when Google reports it as verifiedNamebullet now allows a built-in name when the custom provider is registered in its placeAddProviderWithUserAttributesRelated to #249