Package: odoo-addon-fastapi-auth-jwt
This module providesFastAPIDependsto allow authentication withauth_jwt.Table of contentsUsageBug TrackerCreditsAuthorsMaintainersUsageThe following FastAPI dependencies  are provided and importable fromodoo.addons.fastapi_auth_jwt.dependencies:def auth_jwt_authenticated_payload()->PayloadReturn the authenticated JWT payload. Raise a 401 (unauthorized) if absent or invalid.def auth_jwt_optionally_authenticated_payload()->Payload | NoneReturn the authenticated JWT payload, orNoneif theAuthorizationheader and
cookie are absent. Raise a 401 (unauthorized) if present and invalid.def auth_jwt_authenticated_partner()->PartnerObtain the authenticated partner corresponding to the provided JWT token, according to
the partner strategy defined on theauth_jwtvalidator. Raise a 401 (unauthorized)
if the partner could not be determined for any reason.This is function suitable and intended to overrideodoo.addons.fastapi.dependencies.authenticated_partner_impl.The partner record returned by this function is bound to an environment that uses the
Odoo user obtained from the user strategy defined on theauth_jwtvalidator. When
usedauthenticated_partner_implthis in turn ensures thatodoo.addons.fastapi.dependencies.authenticated_partner_envis also bound to the
correct Odoo user.def auth_jwt_optionally_authenticated_partner()->PartnerSame asauth_jwt_partnerexcept it returns an empty recordset bound to thepublicuser if theAuthorizationheader and cookie are absent, or if the JWT
validator could not find the partner and declares that the partner is not required.def auth_jwt_authenticated_odoo_env()->EnvironmentReturn an Odoo environment using the the Odoo user obtained from the user strategy
defined on theauth_jwtvalidator, if the request could be authenticated using a
JWT validator. Raise a 401 (unauthorized) otherwise.This is function suitable and intended to overrideodoo.addons.fastapi.dependencies.authenticated_odoo_env_impl.def auth_jwt_default_validator_name()->str | NoneReturn the name of the default JWT validator to use.The default implementation returnsNonemeaning only one active JWT validator is
allowed. This dependency is meant to be overridden.def auth_jwt_http_header_authorization()->str | NoneBy default, return the credentials part of theAuthorizationheader, orNoneif absent. This dependency is meant to be overridden, in particular withfastapi.security.OAuth2AuthorizationCodeBearerto let swagger handle OAuth2
authorization (such override is only necessary for comfort when using the swagger
interface).Bug TrackerBugs are tracked onGitHub Issues.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomedfeedback.Do not contact contributors directly about support or help with technical issues.CreditsAuthorsACSONE SA/NVMaintainersThis module is maintained by the OCA.OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.Currentmaintainer:This module is part of theOCA/rest-frameworkproject on GitHub.You are welcome to contribute. To learn how please visithttps://odoo-community.org/page/Contribute.