About
Sign-in provider accounts (ORCID, GitHub…) linked to users, and the one OAuth flow every provider registers on (register_oauth_provider): sign-in, connect, and new accounts through /account/complete-signup, a typed address opening one only through a mailed link. With the identities page, disconnecting, the rule that keeps a product without signup closed, and an optional hint on the login page
Provides
Models
ExternalIdentity
Services
IdentitiesService
Routes
/account/complete-signup/account/complete-signup/<token>/account/disconnect/<provider>/<provider_id>/account/identities/account/reauthenticate/<provider>
Hooks filled
auth.login.error_hintauth.reauthenticate.methodslayout.scripts
Signals
identity-disconnectedidentity-linked
Translations
es
Configuration
| Setting | Default | What it does |
|---|---|---|
EXTERNAL_LOGIN_PASSWORD_HINT |
false
|
On the login page, after a wrong email or password, name the providers the account signs in with ("This account signs in with ORCID"), for people who opened their account through a provider and never had a password. Off by default because it tells whoever types an address that an account exists for it and how it signs in. |
OAUTH_REDIRECT_BASE_URL |
empty | The address people reach the site at (https://www.example.org). Every provider's callback is built on it, so it is the one registered with the provider whatever Host header a request carries. Empty builds it from the request, which behind a reverse proxy needs SPLENT_TRUSTED_PROXIES. |
OAUTH_TIMEOUT |
10
|
Seconds to wait for a provider on every request of the sign-in (the token, who signed in) before telling the person it could not be reached. |
These are the defaults. A product changes them in its own pyproject.toml, under [tool.splent.config], or in .env.deploy in production.
Dependencies
In product lines
-
openhubs_spl
Optional in this line
Needs
authprofile
Extension points
Templates
hooks/disconnect_modal.htmlhooks/login_password_hint.htmlhooks/reauthenticate_providers.htmlidentities/complete_signup.htmlidentities/confirm_signup.htmlidentities/identities.html
Services
IdentitiesService
Models
ExternalIdentity
Routes
A refinement can add routes to its blueprint
Other features fill its hook slots. A refinement can override its templates and services or extend its models without forking it.
Compatibility
Python
>=3.13
SPLENT framework
>=1.30.0
Python packages
Authlib==1.6.12