This module extends the built-in Odoo API Keys by allowing you to define a scope at the moment of creation.
With scopes, you can restrict an API Key so that it only grants access to a specific application, model, or functional area of the system.
auto_awesome What this module does
AI-generated from the code · Odoo 17.0Lets you choose an optional scope when creating an API key in Odoo, so the key's access can be restricted to a specific area instead of being unrestricted.
When you create an API key from your user preferences, this module adds extra fields to the key creation dialog. You can pick a predefined scope from a dropdown (currently only "rpc"), or tick the "I want a custom scope" option and type your own scope text. If you leave the scope empty, the key is created without a scope, exactly as before.
The dialog explains that entering a scope restricts what the key can access. The chosen scope is passed along when the key is generated, so the key is stored with the scope you selected rather than the default one.
This module only changes the API key creation wizard (res.users.apikeys.description) and the underlying key generation logic (res.users.apikeys). It does not add new menus or reports; the new fields appear inside the existing API key creation form. It depends only on the standard base module.
Depends on
Models and fields (1)
- res.users.apikeys.description · extends an existing modelscope, custom_scope, has_custom_scope
Text generated by AI (DeepSeek) from reading the Odoo 17.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: 1 confirmed, 8 with no information of 9 versions.
Sources · Odoo 17.0
Confirmed on 2026-11-03 in branch 17.0 of OCA/server-auth.
terminal Installation and usage
OCA documentation · Odoo 17.0Usage
Source · Odoo 17.0To use this module, you need to:
- Click on your user icon and then "Preferences"
- Go to the "Account Security" tab, and then click the "New Api Key" button.
- Fill the data, a new field will appear to set the key scope.
No verified information in OCA: Installation, Configuration.
Installation 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.