How to build Naver sign-in with Python

For our new friends:

Logto is an Auth0 alternative designed for modern apps and SaaS products. It offers both Cloud and Open-source services to help you quickly launch your identity and management (IAM) system. Enjoy authentication, authorization, and multi-tenant management all in one.

We recommend starting with a free development tenant on Logto Cloud. This allows you to explore all the features easily.

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

Prerequisites

A running Logto instance. Check out the introduction page to get started.
Basic knowledge of Python.
A usable Naver account.

Create an application in Logto

Logto is based on OpenID Connect (OIDC) authentication and OAuth 2.0 authorization. It supports federated identity management across multiple applications, commonly called Single Sign-On (SSO).

To create your Traditional web application, simply follow these steps:

Open the Logto Console. In the "Get started" section, click the "View all" link to open the application frameworks list. Alternatively, you can navigate to Logto Console > Applications, and click the "Create application" button.
In the opening modal, click 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 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 Flask SDK

팁:

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",
    ),
)

팁:

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>"

Checkpoint: Test your application

Now, you can test your application:

Run your application, you will see the sign-in button.
Click the sign-in button, the SDK will init the sign-in process and redirect you to the Logto sign-in page.
After you signed in, you will be redirected back to your application and see the sign-out button.
Click the sign-out button to clear token storage and sign out.

Add Naver connector

To enable quick sign-in and improve user conversion, connect with Flask as an identity provider. The Logto social connector helps you establish this connection in minutes by allowing several parameter inputs.

To add a social connector, simply follow these steps:

Navigate to Console > Connectors > Social Connectors.
Click "Add social connector" and select "Naver".
Follow the README guide and complete required fields and customize settings.

노트:

If you are following the in-place Connector guide, you can skip the next section.

Set up Naver login

Developer Site Only Korean Support Now

Currently Naver Developers site only supports Korean. Please consider use a translator.

For the Production

For the production, you have to get review from Naver team. Otherwise, only registered users can sign in.
- You can add a tester from 맴버관리(Member Manage) menu.
To get a review, please check 애플리케이션 개발 상태(Application Devlopment Status) from API 설정(API Setting) from your application project setting.

Set up a project in the Naver Developers

Visit the Naver Developers and sign in with your Naver account.
Click the Application -> 어플리케이션 등록 from the menu to create new project.
Follow the instruction below to create application.

Application Name (어플리케이션 이름)

Type your application name on 어플리케이션 이름 (This name is shown while a user sign in.)

API Usage (사용 API)

Choose 네이버 로그인(Naver Login) for 사용 API(API Usage)
Check 이메일 주소(Email Address), 별명(Nickname), 프로필 사진(Profile Image) as 필수(Neccessary) from 권한(Role) (You can check 추가(Add) as optional these options, but you cannot get the information from the user.)

For 로그인 오픈 API 서비스 환경(Sign in Open API Service Environment), add two environment PC웹(PC Web) and 모바일웹(Mobile Web).

PC Web (PC 웹)

For 서비스 URL(Service URL), type http(s)://YOUR_URL (ex. https://logto.io)
For 네이버 로그인(Naver Login) Callback URL, type http(s)://YOUR_URL/callback/${connector_id} (e.g. https://logto.io/callback/${connector_id})

Mobile Web (Mobile 웹)

For 서비스 URL(Service URL), type http(s)://YOUR_URL (ex. https://logto.io)
For 네이버 로그인(Naver Login) Callback URL, type http(s)://YOUR_URL/callback/${connector_id} (e.g. https://logto.io/callback/${connector_id})

주의:

The connector_id can be found on the top bar of the Logto Admin Console connector details page.

Configure Logto

Config types

Name	Type
clientId	string
clientSecret	string

clientId

clientId is Client ID of your project. (You can find it from 애플리케이션 정보(Application Info) of your project from Naver developers.)

clientSeceret

clientSecret is Client Secret of your project. (You can find it from 애플리케이션 정보(Application Info) of your project from Naver developers.)

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 Naver connector should be available now.

Once you create a social connector successfully, you can enable it as a "Continue with Naver" button in Sign-in Experience.

Navigate to Console > Sign-in experience > Sign-up and sign-in.
(Optional) Choose "Not applicable" for sign-up identifier if you need social login only.
Add configured Naver connector to the "Social sign-in" section.

Testing and Validation

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

Create an application in Logto​

Integrate Flask SDK​

Installation​

Init LogtoClient​

Implement sign-in and sign-out​

Handle authentication status​

Checkpoint: Test your application​

Add Naver connector​

Set up Naver login​

Developer Site Only Korean Support Now​

For the Production​

Set up a project in the Naver Developers​

Application Name (어플리케이션 이름)​

API Usage (사용 API)​

Sign in Open API Service Environment (로그인 오픈 API 서비스 환경)​

PC Web (PC 웹)​

Mobile Web (Mobile 웹)​

Configure Logto​

Config types​

clientId​

clientSeceret​

Save your configuration​

Enable Naver connector in Sign-in Experience​

Testing and Validation​

Further readings​