Skip to main content

This provides an implementation of auth_partner for FastAPI

Project description

Odoo Community Association

Fastapi Auth Partner

Beta License: AGPL-3 OCA/rest-framework Translate me on Weblate Try me on Runboat

This module is the FastAPI implementation of auth_partner it provides all the routes to manage the authentication of partners.

Table of contents

Usage

First you have to add the auth router to your FastAPI endpoint and the authentication dependency to your app dependencies:

from odoo.addons.fastapi import dependencies
from odoo.addons.fastapi_auth_partner.dependencies import (
  auth_partner_authenticated_partner,
)
from odoo.addons.fastapi_auth_partner.routers.auth import auth_router

class FastapiEndpoint(models.Model):
    _inherit = "fastapi.endpoint"

    def _get_fastapi_routers(self):
      if self.app == "myapp":
          return [
              auth_router,
          ]
      return super()._get_fastapi_routers()

    def _get_app_dependencies_overrides(self):
        res = super()._get_app_dependencies_overrides()
        if self.app == "myapp":
            res.update(
                {
                    dependencies.authenticated_partner_impl: auth_partner_authenticated_partner,
                }
            )
        return res

Next you can manage your authenticable partners and directories in the Odoo interface:

FastAPI > Authentication > Partner

and

FastAPI > Authentication > Directory

Next you must set the directory used for the authentication in the FastAPI endpoint:

FastAPI > FastAPI Endpoint > myapp > Directory

Then you can use the auth router to authenticate your requests:

  • POST /auth/register to register a partner

  • POST /auth/login to authenticate a partner

  • POST /auth/logout to unauthenticate a partner

  • POST /auth/validate_email to validate a partner email

  • POST /auth/request_reset_password to request a password reset

  • POST /auth/set_password to set a new password

  • GET /auth/profile to get the partner profile

  • GET /auth/impersonate to impersonate a partner

Bug Tracker

Bugs are tracked on GitHub 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 welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • Akretion

Contributors

  • Akretion:

    • Sébastien Beau

    • Florian Mounier

Maintainers

This module is maintained by the OCA.

Odoo Community Association

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.

This module is part of the OCA/rest-framework project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file odoo_addon_fastapi_auth_partner-16.0.1.0.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for odoo_addon_fastapi_auth_partner-16.0.1.0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b62cb3f7408005377fa69a114948e86e251850ff9e42f16c74bb945fb3afc8fd
MD5 424f7a5f85eec75428f2deb895a5b66f
BLAKE2b-256 77a3d4d502b040c9d8be99afaa398805c55d8a1097ab2501be80d437be31d028

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page