Provide API key auth for endpoints.
auto_awesome What this module does
AI-generated from the code · Odoo 19.0Lets you protect Odoo endpoints with API keys, choosing which API key groups are allowed to call each endpoint.
This module adds a new authentication option for endpoints: API key. On any endpoint record, you can now pick "API key" as the authentication type.
When that option is selected, two extra elements appear in the authentication section of the endpoint form: - A field called "Allowed API key groups" where you select one or more API key groups. - A "Manage groups" button that opens the list of API key groups, filtered to the ones already selected on the endpoint.
At runtime, when a request arrives at an endpoint configured with API key authentication, Odoo checks the API key used in the request. If that key does not belong to any of the allowed API key groups, the request is rejected with a Forbidden error and the attempt is logged. If the key is allowed, the request proceeds normally.
The module extends the shared endpoint behaviour (endpoint.mixin) and adds the field auth_api_key_group_ids, so the same setting is available on all endpoint types that use that mixin. It relies on the endpoint and auth_api_key_group modules, and the demo data shows a sample endpoint at /demo/api/key protected by a demo API key group.
Depends on
Models and fields (1)
- endpoint.mixin · extends an existing modelauth_api_key_group_ids (Allowed API key groups)
Text generated by AI (DeepSeek) from reading the Odoo 19.0 code on GitHub; it may contain mistakes, so check the code before deciding. View the code on GitHub
Availability by version
Reviewed: 2026-11-03Confirmation status: 5 confirmed, 4 with no information of 9 versions.
Sources · Odoo 14.0
Confirmed on 2026-11-03 in branch 14.0 of OCA/web-api.
terminal Installation and usage
No verified informationInstallation instructions, the distribution package, dependencies and configuration steps are not shown because they have not yet been verified in the module documentation for any version.
Data imported from GitHub: this sheet reflects the latest catalog review, not a live lookup. Always check the module documentation and staging before installing in production.