[16.0][ADD] fastapi_auth_api_key #418
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi @lmignon, |
lmignon
requested changes
Feb 29, 2024
Comment on lines
+1
to
+33
| 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`. | ||
|
|
||
| .. code-block:: python | ||
|
|
||
| @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` | ||
|
|
||
| .. code-block:: python | ||
|
|
||
| @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. |
There was a problem hiding this comment.
@mmequignon Your endpoint should never rely on a specific authentication method. see https://github.com/OCA/rest-framework/blob/16.0/fastapi/readme/USAGE.rst#the-authentication-mechanism for more info on how to do it.
mmequignon
force-pushed
the
16.0-add-fastapi_auth_api_key
branch
from
534a1fd
to
b891ce4
Compare
|
@mmequignon ping |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This module provide
FastApidependencies for Api Key authentication