How to build Naver sign-in with Android (Kotlin / Java)

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 Android (Kotlin / Java) and Logto.

Prerequisites

A running Logto instance. Check out the introduction page to get started.
Basic knowledge of Android (Kotlin / Java).
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 Native app 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 "Native app" section or filter all the available "Native app" frameworks using the quick filter checkboxes on the left. Click the "Android" 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 Android SDK

팁:

The example is based on View system and View Model, but the concepts are the same when using Jetpack Compose.
The example is written in Kotlin, but the concepts are the same for Java.
Both Kotlin and Java sample projects are available on our SDK repository.
The tutorial video is available on our YouTube channel.

Installation

노트:

The minimum supported Android API level of Logto Android SDK is level 24.

Before you install Logto Android SDK, ensure mavenCentral() is added to your repository configuration in the Gradle project build file:

settings.gradle.kts
dependencyResolutionManagement {
  repositories {
    mavenCentral()
  }
}

Add Logto Android SDK to your dependencies:

Kotlin
Groovy

build.gradle.kts
dependencies {
  implementation("io.logto.sdk:android:1.1.3")
}

build.gradle
dependencies {
  implementation 'io.logto.sdk:android:1.1.3'
}

Since the SDK needs internet access, you need to add the following permission to your AndroidManifest.xml file:

AndroidManifest.xml
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
  xmlns:tools="http://schemas.android.com/tools">

  <!-- add internet permission -->
  <uses-permission android:name="android.permission.INTERNET" />

  <!-- other configurations... -->
</manifest>

Init LogtoClient

Create a LogtoViewModel.kt and init LogtoClient in this view model:

LogtoViewModel.kt
//...with other imports
import io.logto.sdk.android.LogtoClient
import io.logto.sdk.android.type.LogtoConfig

class LogtoViewModel(application: Application) : AndroidViewModel(application) {
    private val logtoConfig = LogtoConfig(
          endpoint = "<your-logto-endpoint>",
          appId = "<your-app-id>",
          scopes = null,
          resources = null,
          usingPersistStorage = true,
    )

    private val logtoClient = LogtoClient(logtoConfig, application)

    companion object {
        val Factory: ViewModelProvider.Factory = object : ViewModelProvider.Factory {
            @Suppress("UNCHECKED_CAST")
            override fun <T : ViewModel> create(
                modelClass: Class<T>,
                extras: CreationExtras
            ): T {
                // Get the Application object from extras
                val application = checkNotNull(extras[APPLICATION_KEY])
                return LogtoViewModel(application) as T
            }
        }
    }
}

then, create a LogtoViewModel for your MainActivity.kt:

MainActivity.kt
//...with other imports
class MainActivity : AppCompatActivity() {
    private val logtoViewModel: LogtoViewModel by viewModels { LogtoViewModel.Factory }
    //...other codes
}

Configure redirect URI

Let's switch to the Application details page of Logto Console. Add a Redirect URI io.logto.android://io.logto.sample/callback and click "Save changes".

노트:

Before calling logtoClient.signIn, make sure you have correctly configured Redirect URI in Admin Console.

You can use logtoClient.signIn to sign in the user and logtoClient.signOut to sign out the user.

For example, in an Android app:

LogtoModelView.kt
//...with other imports
class LogtoViewModel(application: Application) : AndroidViewModel(application) {
    // ...other codes

    // Add a live data to observe the authentication status
    private val _authenticated = MutableLiveData(logtoClient.isAuthenticated)
    val authenticated: LiveData<Boolean>
        get() = _authenticated

    fun signIn(context: Activity) {
        logtoClient.signIn(context, "io.logto.android://io.logto.sample/callback") { logtoException ->
            logtoException?.let { println(it) }
            // Update the live data
            _authenticated.postValue(logtoClient.isAuthenticated)
        }
    }

    fun signOut() {
        logtoClient.signOut { logtoException ->
            logtoException?.let { println(it) }
            // Update the live data
            _authenticated.postValue(logtoClient.isAuthenticated)
        }
    }
}

Then call the signIn and signOut methods in your activity:

MainActivity.kt
class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        //...other codes

        // Assume you have a button with id "sign_in_button" in your layout
        val signInButton = findViewById<Button>(R.id.sign_in_button)
        signInButton.setOnClickListener {
            logtoViewModel.signIn(this)
        }

        // Assume you have a button with id "sign_out_button" in your layout
        val signOutButton = findViewById<Button>(R.id.sign_out_button)
        signOutButton.setOnClickListener {
            if (logtoViewModel.authenticated) { // Check if the user is authenticated
                logtoViewModel.signOut()
            }
        }

        // Observe the authentication status to update the UI
        logtoViewModel.authenticated.observe(this) { authenticated ->
            if (authenticated) {
                // The user is authenticated
                signInButton.visibility = View.GONE
                signOutButton.visibility = View.VISIBLE
            } else {
                // The user is not authenticated
                signInButton.visibility = View.VISIBLE
                signOutButton.visibility = View.GONE
            }
        }

    }
}

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 Android 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 Android (Kotlin / Java) app. You should now be able to sign in with Naver. Enjoy!

Create an application in Logto​

Integrate Android SDK​

Installation​

Init LogtoClient​

Configure redirect URI​

Implement sign-in and sign-out​

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​