[IMP] Google Oauth Docs edits final review
closes odoo/documentation#4298
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
87245fee25
commit
9fe358ac1c
@@ -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 |
@@ -1,9 +1,9 @@
|
||||
===============================
|
||||
Google Calendar synchronization
|
||||
===============================
|
||||
=====================================
|
||||
Synchronize Google calendar with Odoo
|
||||
=====================================
|
||||
|
||||
Synchronize Google Calendar with Odoo to see and manage meetings from both platforms (updates go
|
||||
in both directions). This integration helps organize your schedule so you never miss a meeting.
|
||||
Synchronize Google Calendar with Odoo to see and manage meetings from both platforms (updates go in
|
||||
both directions). This integration helps organize schedules, so a meeting is never missed.
|
||||
|
||||
.. seealso::
|
||||
- :doc:`/applications/general/auth/google`
|
||||
@@ -12,96 +12,100 @@ in both directions). This integration helps organize your schedule so you never
|
||||
Setup in Google
|
||||
===============
|
||||
|
||||
Enable Google Calendar API
|
||||
--------------------------
|
||||
Select (or create) a project
|
||||
----------------------------
|
||||
|
||||
Begin by creating a new Google API project and enabling the Google Calendar API. Then, go to the
|
||||
`Google API Console <https://console.developers.google.com>`_ and log into your Google account.
|
||||
Create a new Google API project and enable the Google Calendar API. First, go to the `Google API
|
||||
Console <https://console.developers.google.com>`_ and log into the Google account.
|
||||
|
||||
.. note::
|
||||
If this is your first time visiting this page, Google will prompt you to enter a country and
|
||||
If this is the first time visiting this page, Google will prompt the user to enter a country and
|
||||
agree to the Terms of Service. Select a country from the drop-down list and agree to the
|
||||
:abbr:`ToS (Terms of Service)`.
|
||||
|
||||
Next, click :guilabel:`Select a project` and select or create an API project to store credentials.
|
||||
Next, click :guilabel:`Select a project` and select (or create) an API project to configure OAuth
|
||||
in, and store credentials. Click :guilabel:`New Project`.
|
||||
|
||||
.. image:: google/new-api-project.png
|
||||
:align: center
|
||||
:alt: Create a new API project to store credentials.
|
||||
|
||||
.. tip::
|
||||
Give the API Project a clear name like "Odoo Sync" so you can easily find it.
|
||||
Give the API Project a clear name, like "Odoo Sync", so it can be easily identified.
|
||||
|
||||
Then, open the API Project and click :guilabel:`Enable APIs and Services`.
|
||||
Enable Google calendar API
|
||||
--------------------------
|
||||
|
||||
Now, click on :guilabel:`Enabled APIs and Services` in the left menu. Select :guilabel:`Enabled APIs
|
||||
and Services` again if the :guilabel:`Search bar` doesn't appear.
|
||||
|
||||
.. image:: google/enable-apis-services.png
|
||||
:align: center
|
||||
:alt: Enable APIs and Services on the API Project.
|
||||
|
||||
After that, search for *Google Calendar API* using the search bar and select :guilabel:`Google
|
||||
After that, search for `Google Calendar API` using the search bar and select :guilabel:`Google
|
||||
Calendar API` from the search results. Click :guilabel:`Enable`.
|
||||
|
||||
.. image:: google/enable-google-cal-api.png
|
||||
:align: center
|
||||
:alt: Enable the Google Calendar API.
|
||||
|
||||
OAuth consent screen
|
||||
--------------------
|
||||
|
||||
Now that the API project has been created, OAuth should be configured. To do that, click on
|
||||
:guilabel:`OAuth consent` in the left menu and then select the :guilabel:`User Type`.
|
||||
|
||||
.. 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.
|
||||
|
||||
In the second step, :guilabel:`OAuth Consent Screen`, type `Odoo` in the :guilabel:`App name` field,
|
||||
select the email address for the :guilabel:`User support email` field, and type the email address
|
||||
for the :guilabel:`Developer contact information` section. Then, click :guilabel:`Save and
|
||||
Continue`.
|
||||
|
||||
Skip the third step, :menuselection:`Scopes`, by clicking :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`.
|
||||
|
||||
Now, the OAuth consent has been configured, and it's time to create credentials.
|
||||
|
||||
Create credentials
|
||||
------------------
|
||||
|
||||
Now that you have created your API project and enabled the Google Calendar API, you need to create
|
||||
credentials. Begin by clicking :guilabel:`Create Credentials`. Google will then guide you through
|
||||
four steps to create your API credentials.
|
||||
The *Client ID* and the *Client Secret* are both needed to connect Google Calendar to Odoo. This is
|
||||
the last step in the Google console. Begin by clicking :guilabel:`Credentials` in the left menu.
|
||||
Then, click :guilabel:`Create Credentials`, and select :guilabel:`OAuth client ID`, Google will open
|
||||
a guide to create credentials.
|
||||
|
||||
- In the first step, :guilabel:`Credential Type`, select the :guilabel:`Google Calendar API` and
|
||||
:guilabel:`User Data` options. Then, click :guilabel:`Next`.
|
||||
Under :menuselection:`Create OAuth Client ID`, select :guilabel:`Website application` for the
|
||||
:guilabel:`Application Type` field, and type `My Odoo Database` for the :guilabel:`Name`.
|
||||
|
||||
.. image:: google/credential-type.png
|
||||
:align: center
|
||||
:alt: Select Google Calendar API and User Data for the Credential Type.
|
||||
|
||||
- In the second step, :guilabel:`OAuth Consent Screen`, type *Odoo* in the :guilabel:`App name`
|
||||
field, select your email address for the :guilabel:`User support email` field, and type your email
|
||||
address for the :guilabel:`Developer contact information` section. Then, click :guilabel:`Save
|
||||
and Continue`.
|
||||
|
||||
- Skip the third step, :guilabel:`Scopes`, by clicking :guilabel:`Save and Continue`.
|
||||
|
||||
- In the last step, :guilabel:`OAuth Client ID`, select :guilabel:`Website application` for the
|
||||
:guilabel:`Application Type` field and type *My Odoo Database* for the :guilabel:`Name`.
|
||||
|
||||
- Under the :guilabel:`Authorized JavaScript Origins` section, click :guilabel:`+ Add URI` and
|
||||
type your company's Odoo URL address.
|
||||
|
||||
- Under the :guilabel:`Authorized redirect URIs` section, click :guilabel:`+ Add URI` and type
|
||||
your company's Odoo URL address followed by */google_account/authentication*. Finally, click
|
||||
:guilabel:`Create` and :guilabel:`Done`.
|
||||
- Under the :guilabel:`Authorized JavaScript Origins` section, click :guilabel:`+ Add URI` and
|
||||
type the company's Odoo full :abbr:`URL (Uniform Resource Locator)` address.
|
||||
- Under the :guilabel:`Authorized redirect URIs` section, click :guilabel:`+ Add URI` and type
|
||||
the company's Odoo :abbr:`URL (Uniform Resource Locator)` address followed by
|
||||
`/google_account/authentication`. Finally, click :guilabel:`Create`.
|
||||
|
||||
.. image:: google/uri.png
|
||||
:align: center
|
||||
:alt: Add the authorized JavaScript origins and the authorized redirect URIs.
|
||||
|
||||
After successfully creating a new API project, enabling the Google Calendar API, and generating the
|
||||
Google Calendar API credentials, you should now have a Client ID and Client Secret.
|
||||
|
||||
Client ID & Client Secret
|
||||
-------------------------
|
||||
|
||||
The **Client ID** and the **Client Secret** are both needed to connect Google Calendar to Odoo. Find
|
||||
the Client ID and the Client Secret by opening the Google Cloud Platform navigation menu and going
|
||||
to :menuselection:`API & Services --> Credentials --> OAuth 2.0 Client IDs`.
|
||||
|
||||
Next, locate the credentials you just created for the Google Calendar API. Then, click on
|
||||
:guilabel:`Edit OAuth Client` (the pencil icon). The page will redirect to the edit page, where you
|
||||
can view the Client ID and the Client Secret.
|
||||
|
||||
.. image:: google/edit-oauth-2.png
|
||||
:align: center
|
||||
:alt: Click Edit OAuth Client to view the credential details.
|
||||
A :guilabel:`Client ID` and :guilabel:`Client Secret` will appear, copy these to a notepad.
|
||||
|
||||
Setup in Odoo
|
||||
=============
|
||||
|
||||
Once the Client ID and the Client Secret are located, open the Odoo database and go to
|
||||
Once the *Client ID* and the *Client Secret* are located, open the Odoo database and go to
|
||||
:menuselection:`Settings --> General Settings --> Integrations --> Google Calendar`. Check the box
|
||||
next to :guilabel:`Google Calendar`.
|
||||
|
||||
@@ -109,20 +113,25 @@ next to :guilabel:`Google Calendar`.
|
||||
:align: center
|
||||
:alt: The Google Calendar checkbox in General Settings.
|
||||
|
||||
Next, copy and paste the Client ID and the Client Secret from the Google Calendar API Credentials
|
||||
page into their respective fields below the :guilabel:`Google Calendar` checkbox. Then, click
|
||||
:guilabel:`Save`.
|
||||
Next, copy and paste the *Client ID* and the *Client Secret* from the Google Calendar API
|
||||
credentials page into their respective fields below the :guilabel:`Google Calendar` checkbox. Then,
|
||||
click :guilabel:`Save`.
|
||||
|
||||
Finally, open the Calendar module in Odoo and click on the :guilabel:`Google` sync button to sync
|
||||
Google Calendar with Odoo.
|
||||
Sync calendar in Odoo
|
||||
=====================
|
||||
|
||||
Finally, open the :menuselection:`Calendar` app in Odoo and click on the :guilabel:`Google` sync
|
||||
button to sync Google Calendar with Odoo.
|
||||
|
||||
.. image:: google/sync-google.png
|
||||
:align: center
|
||||
:alt: Click the Google sync button in Odoo Calendar to sync Google Calendar with Odoo.
|
||||
|
||||
.. note::
|
||||
The first time you sync your Google Calendar with Odoo, the page will redirect to your Google
|
||||
Account. Click :guilabel:`OK` and :guilabel:`Allow` to authorize Odoo to access Google Calendar.
|
||||
When syncing Google Calendar with Odoo for the first time, the page will redirect to the Google
|
||||
Account. From there, select the :guilabel:`Email Account` that should have access, then select
|
||||
:guilabel:`Continue` (should the app be unverifed), and finally select :guilabel:`Continue` (to
|
||||
give permission for the transfer of data)`.
|
||||
|
||||
.. image:: google/trust-odoo.png
|
||||
:align: center
|
||||
@@ -130,6 +139,17 @@ Google Calendar with Odoo.
|
||||
|
||||
Now, Odoo Calendar is successfully synced with Google Calendar!
|
||||
|
||||
.. image:: google/successful-sync.png
|
||||
:align: center
|
||||
:alt: Successfully sync between Odoo and Google Calendar.
|
||||
.. warning::
|
||||
Odoo highly recommends testing the Google calendar synchronization on a test database and a test
|
||||
email address (that is not used for any other purpose) before attempting to sync the desired
|
||||
Google Calendar with the user's production database.
|
||||
|
||||
Once a user synchronizes their Google calendar with the Odoo calendar:
|
||||
|
||||
- Creating an event in Odoo causes Google to send an invitation to all event attendees.
|
||||
- Deleting an event in Odoo causes Google to send a cancellation to all event attendees.
|
||||
- Adding a contact to an event causes Google to send an invitation to all event attendees.
|
||||
- Removing a contact from an event causes Google to send a cancellation to all event attendees.
|
||||
|
||||
Events can be created in Google Calendar without sending a notification by selecting
|
||||
:guilabel:`Don't Send` when prompted to send invitation emails.
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 30 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 8.3 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 32 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 31 KiB After Width: | Height: | Size: 15 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 65 KiB |
Reference in New Issue
Block a user