How to build Google sign-in with Python and Logto

November 22, 2024 · 2 min read

The better identity infrastructure for developers

For our new friends

Every app needs authentication and authorization. Logto is an Auth0 alternative designed for modern apps and SaaS products.

In this article, we will go through the steps to quickly build the Google sign-in experience (user authentication) with Python and Logto.

Prerequisites

A running Logto instance. Check out the get started page if you don't have one.
Basic knowledge of Python.
A usable Google account.

Create an application in Logto

In you browser, open a new tab and enter the link of Logto Admin Console.

Get Started

Once the page is loaded, in the "Get Started" section click the View all link to open the application framework list page.

Choose your application type

Framework List

In the opening modal, scroll to the "Traditional web" section or filter all the available " Traditional web" frameworks using the quick filter checkboxes on the left.

Click the "Flask" framework card to start creating your application.

Enter application name

Enter the application name, e.g., "Bookstore," and click "Create application."

🎉 Ta-da! You just created your first application in Logto. You'll see a congrats page which includes a detailed integration guide. Follow the guide to see what the experience will be in your application.

Integrate Logto SDK

tip

The example uses Flask, but the concepts are the same for other frameworks.
The Python sample project is available on our Python SDK repo.
Logto SDK leverages coroutines, remember to use await when calling async functions.

Installation

Execute in the project root directory:

pip install logto # or `poetry add logto` or whatever you use

Init LogtoClient

First, create a Logto config:

client.py
from logto import LogtoClient, LogtoConfig

client = LogtoClient(
    LogtoConfig(
        endpoint="https://you-logto-endpoint.app",  # Replace with your Logto endpoint
        appId="replace-with-your-app-id",
        appSecret="replace-with-your-app-secret",
    ),
)

tip

You can find and copy "App Secret" from application details page in Admin Console:

Also replace the default memory storage with a persistent storage, for example:

client.py
from logto import LogtoClient, LogtoConfig, Storage
from flask import session
from typing import Union

class SessionStorage(Storage):
    def get(self, key: str) -> Union[str, None]:
        return session.get(key, None)

    def set(self, key: str, value: Union[str, None]) -> None:
        session[key] = value

    def delete(self, key: str) -> None:
        session.pop(key, None)

client = LogtoClient(
    LogtoConfig(...),
    storage=SessionStorage(),
)

See Storage for more details.

In your web application, add a route to properly handle the sign-in request from users. Let's use /sign-in as an example:

flask.py
@app.route("/sign-in")
async def sign_in():
  # Get the sign-in URL and redirect the user to it
  return redirect(await client.signIn(
      redirectUri="http://localhost:3000/callback",
  ))

Replace http://localhost:3000/callback with the callback URL you set in your Logto Console for this application.

If you want to show the sign-up page on the first screen, you can set interactionMode to signUp:

flask.py
@app.route("/sign-in")
async def sign_in():
  return redirect(await client.signIn(
      redirectUri="http://localhost:3000/callback",
      interactionMode="signUp", # Show the sign-up page on the first screen
  ))

Now, whenever your users visit http://localhost:3000/sign-in, it will start a new sign-in attempt and redirect the user to the Logto sign-in page.

Note Creating a sign-in route isn't the only way to start a sign-in attempt. You can always use the signIn method to get the sign-in URL and redirect the user to it.

After the user makes a signing-out request, Logto will clear all user authentication information in the session.

To clean up the Python session and Logto session, a sign-out route can be implemented as follows:

flask.py
@app.route("/sign-out")
async def sign_out():
  return redirect(
      # Redirect the user to the home page after a successful sign-out
      await client.signOut(postLogoutRedirectUri="http://localhost:3000/")
  )

Handle authentication status

In Logto SDK, we can use client.isAuthenticated() to check the authentication status, if the user is signed in, the value will be true, otherwise, the value will be false.

Here we also implement a simple home page for demonstration:

If the user is not signed in, show a sign-in button;
If the user is signed in, show a sign-out button.

@app.route("/")
async def home():
    if client.isAuthenticated() is False:
        return "Not authenticated <a href='/sign-in'>Sign in</a>"
    return "Authenticated <a href='/sign-out'>Sign out</a>"

Test your integration

Open your Python app to test if the integration works. When you click the "Sign In" button, the page should be redirected to a Logto sign-in page, and you should be able to create a new account by entering username and password and complete the sign-in process.

Add Google connector

To add a social connector, go to the "Connector" tab in the Admin Console, then click on "Social connectors". From there, click "Add social connector".

In the openning modal, select "Google" and click "Next".

On the next page, you will see a two-column layout with the README content on the left and configuration on the right.

Feel free to follow the README file in place or read the following section to complete the configuration process. If you follow the in-place guide, you can skip the next section.

Set up Google OAuth app

Set up a project in the Google API Console

Visit the Google API Console and sign in with your Google account.
Click the Select a project button on the top menu bar, and click the New Project button to create a project.
In your newly created project, click the APIs & Services to enter the APIs & Services menu.

On the left APIs & Services menu, click the OAuth consent screen button.
Choose the User Type you want, and click the Create button. (Note: If you select External as your User Type, you will need to add test users later.)

Now you will be on the Edit app registration page.

Follow the instructions to fill out the OAuth consent screen form.
Click SAVE AND CONTINUE to continue.

Config scopes

Click ADD OR REMOVE SCOPES and select ../auth/userinfo.email, ../auth/userinfo.profile and openid in the popup drawer, and click UPDATE to finish.
Fill out the form as you need.
Click SAVE AND CONTINUE to continue.

Add test users (External user type only)

Click ADD USERS and add test users to allow these users to access your application while testing.
Click SAVE AND CONTINUE to continue.

Now you should have the Google OAuth 2.0 consent screen configured.

Obtain OAuth 2.0 credentials

On the left APIs & Services menu, click the Credentials button.
On the Credentials page, click the + CREATE CREDENTIALS button on the top menu bar, and select OAuth client ID.
On the Create OAuth client ID page, select Web application as the application type.
Fill out the basic information for your application.
Click + Add URI to add an authorized domain to the Authorized JavaScript origins section. This is the domain that your logto authorization page will be served from. In our case, this will be ${your_logto_origin}. e.g.https://logto.dev.
Click + Add URI in the **Authorized redirect URIs** section to set up the **Authorized redirect URIs**, which redirect the user to the application after logging in. In our case, this will be ${your_logto_endpoint}/callback/${connector_id}. e.g. https://logto.dev/callback/${connector_id}. The connector_id can be found on the top bar of the Logto Admin Console connector details page.
Click Create to finish and then you will get the Client ID and Client Secret.

References

Config types

Name	Type
clientId	string
clientSecret	string

Google developer docs

Google Identity: Setting up OAuth 2.0

Save your configuration

Double check you have filled out necessary values in the Logto connector configuration area. Click "Save and Done" (or "Save changes") and the Google connector should be available now.

Switch to the "Sign-in experience" tab, then click the "Sign-up and sign-in" tab.

note

If it's the first time you enter the tab, you will see a quick introduction about Sign-in Experience and its basic configuration.

Sign-in Experience tab

Select "None" for the "Sign-up identifier" to provide minimum sign-up effort for Google sign-in, which may increase your conversion rate.

In the "Social sign-in" section, add "Add Social Connector" and choose "Google". Then you should be able to see a button with text "Continue with Google" in the preview section.

Save changes

Finally, click "Save changes" on the bottom right corner.

Testing and Validation

Return to your Python app. You should now be able to sign in with Google. Enjoy!

Create an application in Logto​

Choose your application type​

Enter application name​

Integrate Logto SDK​

Installation​

Init LogtoClient​

Implement sign-in and sign-out​

Handle authentication status​

Add Google connector​

Set up Google OAuth app​

Set up a project in the Google API Console​

Configure your consent screen​

Config OAuth consent screen​

Config scopes​

Add test users (External user type only)​

Obtain OAuth 2.0 credentials​

References​

Config types​

Google developer docs​

Save your configuration​

Enable Google connector in Sign-in Experience​

Testing and Validation​

Further readings​