-
-
Notifications
You must be signed in to change notification settings - Fork 108
Add Auth0 OAuth2 backend documentation #359
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Co-authored-by: nijel <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds documentation for the Auth0 OAuth2 backend. The documentation covers the original Auth0OAuth2 backend and distinguishes it from the newer OpenID Connect implementation.
- Adds
auth0.rstdocumentation file with setup instructions, configuration examples, and scopes - Updates the backends index to include the auth0 backend reference in alphabetical order
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/backends/index.rst | Adds auth0 backend to the table of contents in alphabetical order |
| docs/backends/auth0.rst | New documentation file describing Auth0 OAuth2 setup, configuration, and scopes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| AUTHENTICATION_BACKENDS = ( | ||
| ... | ||
| 'social_core.backends.auth0.Auth0OAuth2', | ||
| ... | ||
| ) |
Copilot
AI
Nov 10, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The setting name should be AUTHENTICATION_BACKENDS not SOCIAL_AUTH_AUTHENTICATION_BACKENDS. However, looking at other backend documentation files (e.g., apple.rst uses SOCIAL_AUTH_AUTHENTICATION_BACKENDS, azuread.rst uses AUTHENTICATION_BACKENDS, github.rst uses AUTHENTICATION_BACKENDS), there's inconsistency across the documentation. This file uses AUTHENTICATION_BACKENDS which matches github.rst and azuread.rst, so this is acceptable given the existing patterns.
| SOCIAL_AUTH_AUTH0_SCOPE = ['openid', 'profile', 'email'] | ||
|
|
Copilot
AI
Nov 10, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The scopes documentation shows a Python list format ['openid', 'profile', 'email'], but the auth0_openidconnect.rst documentation shows scopes as a space-separated string: 'openid profile email offline_access'. For consistency and to avoid user confusion, consider clarifying which format is expected by the Auth0OAuth2 backend, or align the format with the auth0_openidconnect backend if both accept the same format.
| SOCIAL_AUTH_AUTH0_SCOPE = ['openid', 'profile', 'email'] | |
| SOCIAL_AUTH_AUTH0_SCOPE = 'openid profile email' | |
| You may also use a Python list (e.g., ``['openid', 'profile', 'email']``), but for consistency with other backends, a space-separated string is recommended. |
The Auth0OAuth2 backend exists in social-core but was undocumented, leaving users unable to discover or configure it.
Changes
Added
docs/backends/auth0.rst: Documentation for theAuth0OAuth2backend including:SOCIAL_AUTH_AUTH0_KEY,SOCIAL_AUTH_AUTH0_SECRET,SOCIAL_AUTH_AUTH0_DOMAINAuth0OpenIDConnectimplementationUpdated
docs/backends/index.rst: Addedauth0entry in alphabetical order betweenarcgisandauth0_openidconnectUsage
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
docs.python.org/usr/bin/python3 /home/REDACTED/.local/bin/sphinx-build -b html -d _build/doctrees . _build/html(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.