[WIP] base, auth_totp: add doc links for 2FA & API keys

This commit is contained in:
Xavier Morel
2020-09-10 12:49:00 +00:00
parent eac225e3ea
commit 3e7d096f32
6 changed files with 53 additions and 1 deletions
@@ -114,6 +114,8 @@
<span class="alert alert-info" role="status">
<i class="fa fa-warning"/>
Two-factor authentication not enabled
<a href="https://www.odoo.com/documentation/user/general/auth/2fa.html"
title="What is this?" class="o_doc_link" target="_blank"></a>
</span>
<button name="totp_enable_wizard" type="object" string="Enable two-factor authentication"
class="btn btn-info mx-3"/>
@@ -124,6 +126,8 @@
<span class="text-success">
<i class="fa fa-check-circle"/>
Two-factor authentication enabled
<a href="https://www.odoo.com/documentation/user/general/auth/2fa.html"
title="What is this?" class="o_doc_link" target="_blank"></a>
</span>
<button name="totp_disable" type="object" string="(Disable two-factor authentication)"
class="btn btn-link text-muted"/>
Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

+44
View File
@@ -146,6 +146,50 @@ parameters
username = "admin",
password = <insert password for your admin user (default: admin)>;
API Keys
''''''''
.. versionadded:: 14.0
Odoo has support for **api keys** and (depending on modules or settings) may
**require** these keys to perform webservice operations.
The way to use API Keys in your scripts is to simply replace your **password**
by the key. The login remains in-use. You should store the API Key as carefully
as the password as they essentially provide the same access to your user
account (although they can not be used to log-in via the interface).
In order to add a key to your account, simply go to your
:guilabel:`Preferences` (or :guilabel:`My Profile`):
.. figure:: images/preferences.png
:align: center
then open the :guilabel:`Account Security` tab, and click
:guilabel:`New API Key`:
.. figure:: images/account-security.png
:align: center
Input a description for the key, **this description should be as clear and
complete as possible**: it is the only way you will have to identify your keys
later and know whether you should remove them or keep them around.
Click :guilabel:`Generate Key`, then copy the key provided. **Store this key
carefully**: it is equivalent to your password, and just like your password
the system will not be able to retrieve or show the key again later on. If you lose
this key, you will have to create a new one (and probably delete the one you
lost).
Once you have keys configured on your account, they will appear above the
:guilabel:`New API Key` button, and you will be able to delete them:
.. figure:: images/delete-key.png
:align: center
**A deleted API key can not be undeleted or re-set**. You will have to generate
a new key and update all the places where you used the old one.
demo
''''
+5 -1
View File
@@ -479,7 +479,11 @@
<button name="preference_change_password" type="object" string="Change password" class="btn btn-secondary"/>
</div>
</group>
<group string="Developer API Keys">
<group string="Developer API Keys" help="test">
<a href="https://www.odoo.com/documentation/master/webservice/odoo.html#api-keys" target="_blank">
<i class="fa fa-fw o_button_icon fa-arrow-right"></i>
<span>Documentation</span>
</a>
<div colspan="2" attrs="{'invisible': [('api_key_ids', '=', [])]}">
<field name="api_key_ids" nolabel="1" colspan="4" readonly="0">
<tree editable="bottom" create="false" delete="false">