odoo-addon-fastapi-auth-api-key 18.0.1.0.0.5

Fastapi Auth API Key

Fastapi Auth API Key

Provides FastAPI dependencies for Api Key authentication.

Table of contents

• Usage

  • Getting an odoo environment

  • Getting the authenticated partner

  • Configuration

• Bug Tracker

• Credits

  • Authors

  • Contributors

  • Other credits

  • Maintainers

Usage

Getting an odoo environment

If you need to get an odoo env based on the provided api key, you can use authenticated_env_by_auth_api_key.

@router.get("/example_with_authenticated_env")
def example_with_authenticated_env(
    env: Annotated[Environment, Depends(authenticated_env_by_auth_api_key)],
) -> None:
    # env.user is the user attached to the provided key
    pass

Getting the authenticated partner

If want to get the partned related to the the provided api key, you can use authenticated_partner_by_api_key

@router.get("/example_with_authenticated_partner")
def example_with_authenticated_partner(
    partner: Annotated[Partner, Depends(authenticated_partner_by_api_key)],
) -> None:
    # partner is the partner related to the provided key key.user_id.partner_id
    pass

Configuration

For this to work, the api key must be defined on the Endpoint. A new field auth_api_key_group_id has been added to the Endpoint model.

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

• Camptocamp

Contributors

• Matthieu Méquignon <[e-mail]>

• Son Ho <[e-mail]>

Other credits

The migration of this module from 17.0 to 18.0 was financially supported by Camptocamp

Maintainers

This 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.

Current maintainer:

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.