How to build OIDC enterprise SSO with Android (Kotlin / Java)

Für unsere neuen Freunde:

Logto ist eine Auth0-Alternative, die für moderne Apps und SaaS-Produkte entwickelt wurde. Es bietet sowohl Cloud als auch Open-Source Dienste, um dir zu helfen, dein Identity and Management (IAM) System schnell zu starten. Genieße Authentifizierung, Autorisierung und Multi-Tenant-Management alles in einem.

Wir empfehlen, mit einem kostenlosen Entwicklungsmieter auf Logto Cloud zu beginnen. Dies ermöglicht es dir, alle Funktionen einfach zu erkunden.

In diesem Artikel werden wir die Schritte durchgehen, um schnell die OIDC enterprise SSO Anmeldeerfahrung (Benutzerauthentifizierung) mit Android (Kotlin / Java) und Logto aufzubauen.

Voraussetzungen

Eine laufende Logto-Instanz. Sieh dir die Einführungsseite an, um loszulegen.
Grundkenntnisse in Android (Kotlin / Java).
Ein nutzbares OIDC enterprise SSO Konto.

Create an application in Logto

Logto basiert auf OpenID Connect (OIDC) Authentifizierung und OAuth 2.0 Autorisierung. Es unterstützt föderiertes Identitätsmanagement über mehrere Anwendungen hinweg, was allgemein als Single Sign-On (SSO) bezeichnet wird.

Um deine Native App Anwendung zu erstellen, folge einfach diesen Schritten:

Öffne die Logto Console. Klicke im Abschnitt "Erste Schritte" auf den Link "Alle anzeigen", um die Liste der Anwendungs-Frameworks zu öffnen. Alternativ kannst du zu Logto Console > Applications navigieren und auf die Schaltfläche "Anwendung erstellen" klicken.
Klicke im sich öffnenden Modal auf den Abschnitt "Native App" oder filtere alle verfügbaren "Native App" Frameworks mit den Schnellfilter-Checkboxen auf der linken Seite. Klicke auf die "Android (Kotlin)" / "Android (Java)" Framework-Karte, um mit der Erstellung deiner Anwendung zu beginnen.
Gib den Anwendungsnamen ein, z. B. "Buchladen", und klicke auf "Anwendung erstellen".

🎉 Ta-da! Du hast gerade deine erste Anwendung in Logto erstellt. Du wirst eine Glückwunschseite sehen, die einen detaillierten Integrationsleitfaden enthält. Folge dem Leitfaden, um zu sehen, wie die Erfahrung in deiner Anwendung sein wird.

Integrate Android (Kotlin) / Android (Java) SDK

tipp:

Das Beispiel basiert auf dem View-System und dem View Model, aber die Konzepte sind die gleichen bei der Verwendung von Jetpack Compose.
Das Beispiel ist in Kotlin geschrieben, aber die Konzepte sind die gleichen für Java.
Sowohl Kotlin als auch Java Beispielprojekte sind in unserem SDK-Repository verfügbar.
Das Tutorial-Video ist auf unserem YouTube-Kanal verfügbar.

Installation

hinweis:

Die minimal unterstützte Android API-Ebene des Logto Android SDK ist Ebene 24.

Bevor du das Logto Android SDK installierst, stelle sicher, dass mavenCentral() zu deiner Repository-Konfiguration in der Gradle-Projekt-Build-Datei hinzugefügt wurde:

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

Füge das Logto Android SDK zu deinen Abhängigkeiten hinzu:

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'
}

Da das SDK Internetzugang benötigt, musst du die folgende Berechtigung zu deiner AndroidManifest.xml-Datei hinzufügen:

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

  <!-- Internetberechtigung hinzufügen -->
  <uses-permission android:name="android.permission.INTERNET" />

  <!-- andere Konfigurationen... -->
</manifest>

LogtoClient initialisieren

Erstelle eine LogtoViewModel.kt und initialisiere LogtoClient in diesem ViewModel:

LogtoViewModel.kt
//...mit anderen 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 {
                // Hole das Application-Objekt aus extras
                val application = checkNotNull(extras[APPLICATION_KEY])
                return LogtoViewModel(application) as T
            }
        }
    }
}

erstelle dann ein LogtoViewModel für deine MainActivity.kt:

MainActivity.kt
//...mit anderen Imports
class MainActivity : AppCompatActivity() {
    private val logtoViewModel: LogtoViewModel by viewModels { LogtoViewModel.Factory }
    //...andere Codes
}

Redirect-URI konfigurieren

Wechseln wir zur Seite "Anwendungsdetails" der Logto-Konsole. Füge eine Redirect-URI io.logto.android://io.logto.sample/callback hinzu und klicke auf "Änderungen speichern".

hinweis:

Bevor du logtoClient.signIn aufrufst, stelle sicher, dass du die Redirect-URI im Admin Console korrekt konfiguriert hast.

Du kannst logtoClient.signIn verwenden, um den Benutzer anzumelden, und logtoClient.signOut, um den Benutzer abzumelden.

Zum Beispiel in einer Android-App:

LogtoModelView.kt
//...mit anderen Imports
class LogtoViewModel(application: Application) : AndroidViewModel(application) {
    // ...andere Codes

    // Füge ein Live-Datenobjekt hinzu, um den Authentifizierungsstatus zu beobachten
    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) }
            // Aktualisiere die Live-Daten
            _authenticated.postValue(logtoClient.isAuthenticated)
        }
    }

    fun signOut() {
        logtoClient.signOut { logtoException ->
            logtoException?.let { println(it) }
            // Aktualisiere die Live-Daten
            _authenticated.postValue(logtoClient.isAuthenticated)
        }
    }
}

Rufe dann die Methoden signIn und signOut in deiner Aktivität auf:

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

        // Angenommen, du hast einen Button mit der ID "sign_in_button" in deinem Layout
        val signInButton = findViewById<Button>(R.id.sign_in_button)
        signInButton.setOnClickListener {
            logtoViewModel.signIn(this)
        }

        // Angenommen, du hast einen Button mit der ID "sign_out_button" in deinem Layout
        val signOutButton = findViewById<Button>(R.id.sign_out_button)
        signOutButton.setOnClickListener {
            if (logtoViewModel.authenticated) { // Überprüfe, ob der Benutzer authentifiziert ist
                logtoViewModel.signOut()
            }
        }

        // Beobachte den Authentifizierungsstatus, um die Benutzeroberfläche zu aktualisieren
        logtoViewModel.authenticated.observe(this) { authenticated ->
            if (authenticated) {
                // Der Benutzer ist authentifiziert
                signInButton.visibility = View.GONE
                signOutButton.visibility = View.VISIBLE
            } else {
                // Der Benutzer ist nicht authentifiziert
                signInButton.visibility = View.VISIBLE
                signOutButton.visibility = View.GONE
            }
        }

    }
}

Checkpoint: Teste deine Anwendung

Jetzt kannst du deine Anwendung testen:

Starte deine Anwendung, du wirst den Anmeldebutton sehen.
Klicke auf den Anmeldebutton, das SDK wird den Anmeldeprozess initiieren und dich zur Logto-Anmeldeseite weiterleiten.
Nachdem du dich angemeldet hast, wirst du zurück zu deiner Anwendung geleitet und siehst den Abmeldebutton.
Klicke auf den Abmeldebutton, um den Token-Speicher zu leeren und dich abzumelden.

Add OIDC enterprise SSO connector

To simplify access management and gain enterprise-level safeguards for your big clients, connect with Android (Kotlin) / Android (Java) as a federated identity provider. The Logto enterprise SSO connector helps you establish this connection in minutes by allowing several parameter inputs.

To add an enterprise SSO connector, simply follow these steps:

Navigate to Logto console > Enterprise SSO.

SSO page

Click "Add enterprise connector" button and choose your SSO provider type. Choose from prebuilt connectors for Microsoft Entra ID (Azure AD), Google Workspace, and Okta, or create a custom SSO connection using the standard OpenID Connect (OIDC) or SAML protocol.
Provide a unique name (e.g., SSO sign-in for Acme Company).

Select your SSO provider

Configure the connection with your IdP in the "Connection" tab. Check the guides above for each connector types.

SSO connection

Customize the SSO experience and enterprise’s email domain in the "Experience" tab. Users sign in with the SSO-enabled email domain will be redirected to SSO authentication.

SSO experience

Save changes.

Set up OIDC-Anwendung auf deinem IdP

Schritt 1: Erstelle eine OIDC-Anwendung auf deinem IdP

Starte die OIDC SSO-Integration, indem du eine Anwendung auf der IdP-Seite erstellst. Du musst die folgenden Konfigurationen vom Logto-Server bereitstellen.

Callback-URI: Die Logto Callback-URI, auch bekannt als Redirect-URI oder Reply-URL, ist ein spezifischer Endpunkt oder eine URL, die der IdP verwendet, um den Browser des Benutzers nach erfolgreicher Authentifizierung umzuleiten. Nachdem ein Benutzer sich erfolgreich beim IdP authentifiziert hat, leitet der IdP den Browser des Benutzers zurück zu dieser festgelegten URI zusammen mit einem Autorisierungscode. Logto wird den Authentifizierungsprozess basierend auf dem Autorisierungscode abschließen, der von dieser URI empfangen wird.

Fülle die Logto Callback-URI in das OIDC-Anwendungseinstellungsformular deines IdP aus und fahre mit der Erstellung der Anwendung fort. (Die meisten OIDC IdPs bieten eine breite Palette von Anwendungstypen zur Auswahl an. Um einen webbasierten SSO-Connector auf Logto zu erstellen, wähle bitte den Anwendungstyp Web Application.)

Schritt 2: Konfiguriere OIDC SSO auf Logto

Nachdem du erfolgreich eine OIDC-Anwendung auf der IdP-Seite erstellt hast, musst du die IdP-Konfigurationen an Logto zurückgeben. Navigiere zum Tab Connection und fülle die folgenden Konfigurationen aus:

Client ID: Ein eindeutiger Bezeichner, der deiner OIDC-Anwendung vom IdP zugewiesen wird. Dieser Bezeichner wird von Logto verwendet, um die Anwendung während des OIDC-Flows zu identifizieren und zu authentifizieren.
Client Secret: Ein vertrauliches Geheimnis, das zwischen Logto und dem IdP geteilt wird. Dieses Geheimnis wird verwendet, um die OIDC-Anwendung zu authentifizieren und die Kommunikation zwischen Logto und dem IdP abzusichern.
Aussteller (Issuer): Die Aussteller-URL, ein eindeutiger Bezeichner für den IdP, der den Ort angibt, an dem der OIDC-Identitätsanbieter gefunden werden kann. Sie ist ein wesentlicher Bestandteil der OIDC-Konfiguration, da sie Logto hilft, die erforderlichen Endpunkte zu entdecken. Um den Konfigurationsprozess zu erleichtern, wird Logto automatisch die erforderlichen OIDC-Endpunkte und Konfigurationen abrufen. Dies geschieht, indem der von dir bereitgestellte Aussteller genutzt wird und ein Aufruf zu den OIDC-Entdeckungspunkten des IdP gemacht wird. Es ist zwingend erforderlich, sicherzustellen, dass der Aussteller-Endpunkt gültig und korrekt konfiguriert ist, damit Logto die erforderlichen Informationen korrekt abrufen kann. Nach einem erfolgreichen Abruf solltest du die analysierten IdP-Konfigurationen im Abschnitt der Aussteller sehen können.
Berechtigung (Scope): Eine durch Leerzeichen getrennte Liste von Zeichenfolgen, die die gewünschten Berechtigungen oder Zugriffsebenen definieren, die von Logto während des OIDC-Authentifizierungsprozesses angefordert werden. Der Scope-Parameter ermöglicht es dir, anzugeben, welche Informationen und Zugriffe Logto vom IdP anfordert. Der Scope-Parameter ist optional. Unabhängig von den benutzerdefinierten Scope-Einstellungen wird Logto immer die Berechtigungen openid, profile und email an den IdP senden. Dies soll sicherstellen, dass Logto die Identitätsinformationen und die E-Mail-Adresse des Benutzers ordnungsgemäß vom IdP abrufen kann. Du kannst zusätzliche Berechtigungen zum Scope-Parameter hinzufügen, um mehr Informationen vom IdP anzufordern.

Schritt 3: Setze E-Mail-Domänen und aktiviere den SSO-Connector

Gib die E-Mail-Domains deiner Organisation auf der SSO-Erfahrung-Registerkarte des Logto-Connectors an. Dadurch wird der SSO-Connector als Authentifizierungsmethode für diese Benutzer aktiviert.

Benutzer mit E-Mail-Adressen in den angegebenen Domains werden weitergeleitet, um deinen SSO-Connector als einzige Authentifizierungsmethode zu verwenden.

Save your configuration

Überprüfe, ob du alle notwendigen Werte im Logto Connector-Konfigurationsbereich ausgefüllt hast. Klicke auf "Speichern und Fertig" (oder "Änderungen speichern") und der OIDC enterprise SSO Connector sollte jetzt verfügbar sein.

You don’t need to configure enterprise connectors individually, Logto simplifies SSO integration into your applications with just one click.

Navigate to: Console > Sign-in experience > Sign-up and sign-in.
Enable the "Enterprise SSO" toggle.
Save changes.

Once enabled, a "Single Sign-On" button will appear on your sign-in page. Enterprise users with SSO-enabled email domains can access your services using their enterprise identity providers (IdPs).

Auto detect SSO sign-in via email domain

To learn more about the SSO user experience, including SP-initiated SSO and IdP-initiated SSO, refer to User flows: Enterprise SSO.

Testing and Validation

Kehre zu deiner Android (Kotlin / Java)-App zurück. Du solltest dich jetzt mit OIDC enterprise SSO anmelden können. Viel Spaß!

Create an application in Logto​

Integrate Android (Kotlin) / Android (Java) SDK​

Installation​

LogtoClient initialisieren​

Redirect-URI konfigurieren​

Anmeldung und Abmeldung implementieren​

Checkpoint: Teste deine Anwendung​

Add OIDC enterprise SSO connector​

Set up OIDC-Anwendung auf deinem IdP​

Schritt 1: Erstelle eine OIDC-Anwendung auf deinem IdP​

Schritt 2: Konfiguriere OIDC SSO auf Logto​

Schritt 3: Setze E-Mail-Domänen und aktiviere den SSO-Connector​

Save your configuration​

Enable OIDC enterprise SSO connector in Sign-in Experience​

Testing and Validation​

Further readings​