[IMP] Google Oauth Docs edits final review
closes odoo/documentation#4303
X-original-commit: 5b63bfcba9
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
This commit is contained in:
Timothy Kukulka (tiku)
committed by
Zachary Straub (ZST)
Zachary Straub (ZST)
parent
09ce44f314
commit
5683287892
@@ -2,14 +2,14 @@
|
||||
Google Sign-In Authentication
|
||||
=============================
|
||||
|
||||
The **Google Sign-In Authentication** is a useful function that allows your users to sign in to Odoo
|
||||
with their Google account.
|
||||
The *Google Sign-In Authentication* is a useful function that allows Odoo users to sign in to their
|
||||
database with their Google account.
|
||||
|
||||
This is particularly helpful if your organization uses Google Workforce and you want the employees
|
||||
within your organization to connect to Odoo with their Google Accounts.
|
||||
This is particularly helpful if the organization uses Google Workspace, and wants employees within
|
||||
the organization to connect to Odoo using their Google Accounts.
|
||||
|
||||
.. seealso::
|
||||
- :doc:`../../productivity/calendar/google`
|
||||
- :doc:`/applications/productivity/calendar/google`
|
||||
- :doc:`/administration/maintain/google_oauth`
|
||||
|
||||
.. _google-sign-in/configuration:
|
||||
@@ -17,7 +17,7 @@ within your organization to connect to Odoo with their Google Accounts.
|
||||
Configuration
|
||||
=============
|
||||
|
||||
The integration of the Google sign-in function requires configuration both on Google and on Odoo.
|
||||
The integration of the Google sign-in function requires configuration both on Google *and* Odoo.
|
||||
|
||||
.. _google-sign-in/api:
|
||||
|
||||
@@ -25,15 +25,16 @@ Google API Dashboard
|
||||
--------------------
|
||||
|
||||
#. Go to the `Google API Dashboard <https://console.developers.google.com/>`_.
|
||||
#. Make sure the right project is opened. If you don't have a project yet, click on *Create
|
||||
Project*, fill out the project name and other details of your company, and click on *Create*.
|
||||
#. Make sure the right project is opened. If there isn't a project yet, click on :guilabel:`Create
|
||||
Project`, fill out the project name and other details of the company, and click on
|
||||
:guilabel:`Create`.
|
||||
|
||||
.. image:: google/new-project-details.png
|
||||
:align: center
|
||||
:alt: Filling out the details of a new project
|
||||
:alt: Filling out the details of a new project.
|
||||
|
||||
.. tip::
|
||||
Choose the name of your own company from the drop-down menu.
|
||||
Choose the name of the company from the drop-down menu.
|
||||
|
||||
.. _google-sign-in/oauth:
|
||||
|
||||
@@ -44,16 +45,30 @@ OAuth consent screen
|
||||
|
||||
.. image:: google/consent-selection.png
|
||||
:align: center
|
||||
:alt: Google oauth consent selection menu
|
||||
:alt: Google OAuth consent selection menu.
|
||||
|
||||
#. Choose the option for :guilabel:`internal`, and click on :guilabel:`Create`.
|
||||
#. Choose one of the options (:guilabel:`Internal` / :guilabel:`External`), and click on
|
||||
:guilabel:`Create`.
|
||||
|
||||
.. image:: google/consent.png
|
||||
:align: center
|
||||
:alt: Choice of a user type in oauth consent
|
||||
:alt: Choice of a user type in OAuth consent.
|
||||
|
||||
#. Fill out your details and domain info, then click on *Save and Continue*.
|
||||
#. On the **Scopes** page, leave all fields as is, and click on *Save and Continue*.
|
||||
.. warning::
|
||||
*Personal* Gmail Accounts are only allowed to be **External** User Type, which means Google
|
||||
may require an approval, or for *Scopes* to be added on. However, using a *Google WorkSpace*
|
||||
account allows for **Internal** User Type to be used.
|
||||
|
||||
Note, as well, that while the API connection is in the *External* testing mode, then no
|
||||
approval is necessary from Google. User limits in this testing mode is set to 100 users.
|
||||
|
||||
#. Fill out the required details and domain info, then click on :guilabel:`Save and Continue`.
|
||||
#. On the :menuselection:`Scopes` page, leave all fields as is, and click on :guilabel:`Save and
|
||||
Continue`.
|
||||
#. Next, if continuing in testing mode (*External*), add the email addresses being configured under
|
||||
the :guilabel:`Test users` step by clicking on :guilabel:`Add Users`, and then the
|
||||
:guilabel:`Save and Continue` button. A summary of the app registration appears.
|
||||
#. Finally, scroll to the bottom, and click on :guilabel:`Back to Dashboard`.
|
||||
|
||||
.. _google-sign-in/credentials:
|
||||
|
||||
@@ -64,24 +79,24 @@ Credentials
|
||||
|
||||
.. image:: google/credentials-button.png
|
||||
:align: center
|
||||
:alt: Credentials button menu
|
||||
:alt: Credentials button menu.
|
||||
|
||||
#. Click on *Create Credentials* and select **OAuth client ID**.
|
||||
#. Click on :guilabel:`Create Credentials`, and select :guilabel:`OAuth client ID`.
|
||||
|
||||
.. image:: google/client-id.png
|
||||
:align: center
|
||||
:alt: Oauth client id selection
|
||||
:alt: OAuth client id selection.
|
||||
|
||||
#. Select **Web Application** as the Application type. Now configure the allowed pages on which you
|
||||
will be redirected.
|
||||
#. Select :guilabel:`Web Application` as the :guilabel:`Application Type`. Now, configure the
|
||||
allowed pages on which Odoo will be redirected.
|
||||
|
||||
In order to achieve this, in the **Authorized redirect URIs** field, enter your database's domain
|
||||
immediately followed by ``/auth_oauth/signin``. For example:
|
||||
``https://mydomain.odoo.com/auth_oauth/signin``, then click on *Create*.
|
||||
In order to achieve this, in the :guilabel:`Authorized redirect URIs` field, enter the database's
|
||||
domain immediately followed by `/auth_oauth/signin`. For example:
|
||||
`https://mydomain.odoo.com/auth_oauth/signin`, then click on :guilabel:`Create`.
|
||||
|
||||
.. image:: google/create-client-id.png
|
||||
:align: center
|
||||
:alt: Creating oauth client id
|
||||
#. Now that the *OAuth client* has been created, a screen will appear with the :guilabel:`Client ID`
|
||||
and :guilabel:`Client Secret`. Copy the :guilabel:`Client ID` for later, as it will be necessary
|
||||
for the configuration in Odoo, which will be covered in the following steps.
|
||||
|
||||
.. _google-sign-in/auth-odoo:
|
||||
|
||||
@@ -93,47 +108,53 @@ Google Authentication on Odoo
|
||||
Retrieve the Client ID
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Once you have done the previous steps, two keys are generated on the Google API Dashboard: *Client
|
||||
ID* and *Client Secret*. Copy the *Client ID*.
|
||||
Once the previous steps are complete, two keys are generated on the Google API Dashboard:
|
||||
:guilabel:`Client ID` and :guilabel:`Client Secret`. Copy the :guilabel:`Client ID`.
|
||||
|
||||
.. image:: google/secret-ids.png
|
||||
:align: center
|
||||
:alt: Google OAuth Client ID generated
|
||||
:alt: Google OAuth Client ID generated.
|
||||
|
||||
.. _google-sign-in/odoo-activation:
|
||||
|
||||
Odoo activation
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
#. Go to :menuselection:`Odoo General Settings --> Integrations` and activate **OAuth
|
||||
Authentication**.
|
||||
#. Go to :menuselection:`Odoo General Settings --> Integrations` and activate :guilabel:`OAuth
|
||||
Authentication`.
|
||||
|
||||
.. note::
|
||||
You may have to log in again after this step.
|
||||
Odoo may prompt the user to log-in again after this step.
|
||||
|
||||
#. Go back to :menuselection:`General Settings --> Integrations`, activate **Google
|
||||
Authentication**, then fill out the *Client ID* with the key from the Google API Dashboard, and
|
||||
*Save*.
|
||||
#. Go back to :menuselection:`General Settings --> Integrations --> OAuth Authentication`, activate
|
||||
the selection and :guilabel:`Save`. Next, return to :menuselection:`General Settings -->
|
||||
Integrations --> Google Authentication` and activate the selection. Then fill out the
|
||||
:guilabel:`Client ID` with the key from the Google API Dashboard, and :guilabel:`Save`.
|
||||
|
||||
.. image:: google/odoo-client-id.png
|
||||
:align: center
|
||||
:alt: Filling out the client id in Odoo settings
|
||||
:alt: Filling out the client id in Odoo settings.
|
||||
|
||||
.. note::
|
||||
Google OAuth2 configuration can also be accessed by clicking on :guilabel:`OAuth Providers`
|
||||
under the :guilabel:`OAuth Authentication` heading in :menuselection:`Integrations`.
|
||||
|
||||
.. _google-sign-in/log-in:
|
||||
|
||||
Log in to Odoo with Google
|
||||
==========================
|
||||
|
||||
To link your Google account to your Odoo profile, click on *Log in with Google* when you are asked
|
||||
to choose a new password.
|
||||
To link the Google account to the Odoo profile, click on :guilabel:`Log in with Google` when first
|
||||
logging into Odoo.
|
||||
|
||||
.. image:: google/first-login.png
|
||||
:align: center
|
||||
:alt: Reset password screen with "Log in with Google" button
|
||||
:alt: Reset password screen with "Log in with Google" button.
|
||||
|
||||
Existing users must :ref:`reset their password <users/reset-password>` to access the *reset
|
||||
password* page, while new users can directly click on *Log in with Google* instead of choosing a new
|
||||
password.
|
||||
|
||||
Existing users must :ref:`reset their password <users/reset-password>` to access the
|
||||
:menuselection:`Reset Password` page, while new users can directly click on :guilabel:`Log in with
|
||||
Google`, instead of choosing a new password.
|
||||
|
||||
.. seealso::
|
||||
- `Google Cloud Platform Console Help - Setting up OAuth 2.0
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 7.7 KiB |
Reference in New Issue
Block a user