Zum Inhalt springen

@capgo/capacitor-Social-Login

Alle Social-Logins in einem Plugin

@capgo/capacitor-social-login ist das umfassende Plugin für soziale Authentifizierung für Web, iOS und Android.

Es implementiert:

  • Google-Anmeldung mit Android-Credential-Manager
  • Mit Apple anmelden, einschließlich OAuth auf Android
  • Facebook-Login mit dem aktuellen Facebook SDK
  • Twitter/X über OAuth 2.0
  • Allgemeine OAuth2- und OIDC-Anbieter, einschließlich GitHub, Microsoft Entra ID, Auth0, Okta, Keycloak und anderer kompatibler Server

Es ist auch die Capgo-Migration für Apps, die von Ionic Appflow Social Login oder Ionic Auth Connect wechseln.

Dieses Plugin begann als Fork von @codetrix-studio/capacitor-google-authDer ursprüngliche Paket ist effektiv archiviert, daher Capgo hält dieses Plugin als unterstützten Ersatz aufrecht.

Wenn Sie noch immer @codetrix-studio/capacitor-google-authfolgen Sie bitte der Legacy Google Auth-Migrationanleitung.

Wenn Sie von Ionic Auth Connect migrieren, verwenden Sie den SocialLoginAuthConnect Wrapper für den auth0, azure, cognito, oktaund onelogin Provider-Namen:

PluginversionCapacitor KompatibilitätGepflegt
v8.xv8.xJa
v7.xv7.xAuf Anfrage
v6.xv6.xNein
v5.xv5.xNein

Die Hauptversion dieses Plugins folgt der Hauptversion von Capacitor. Zum Beispiel verwenden Sie das Plugin v8 mit Capacitor 8. Nur die aktuellste Hauptversion wird aktiv unterstützt.

Beobachten Sie ein schnelles Demo der Plugin-Konfiguration und des Login-Flusses in Aktion.

  • initialize - Initialisieren Sie das Plugin.
  • login - Melden Sie sich mit dem ausgewählten Anbieter an.
  • logout - Abmelden.
  • isLoggedIn - IsLoggedIn.
MethodeBeschreibung
initializeInitialisieren Sie das Plugin.
loginMit dem ausgewählten Anbieter anmelden.
logoutAbmelden.
isLoggedInIsLoggedIn.
getAuthorizationCodeRufen Sie den aktuellen Autorisierungscode code ab.
refreshAktualisieren Sie den Zugriffstoken.
refreshTokenOAuth2-Refresh-Token-Helfer für den eingebauten OAuth2-Anbieter.
handleRedirectCallbackWeb-only: Behandeln Sie den OAuth-Redirect-Callback und geben Sie das geparste Ergebnis zurück.
decodeIdTokenDecodieren Sie ein JWT (typischerweise ein OIDC-ID-Token) in seine Ansprüche.
getAccessTokenExpirationDateKonvertieren Sie eine Zugriffstoken-Ablaufzeitstempel (Millisekunden seit der Epoch) in eine ISO-Datumszeichenkette.
isAccessTokenAvailableÜberprüfen Sie, ob ein Zugriffstoken verfügbar ist (nicht leer).
isAccessTokenExpiredÜberprüfen Sie, ob ein Zugriffstoken abgelaufen ist.
isRefreshTokenAvailableÜberprüfen Sie, ob ein Refresh-Token verfügbar ist (nicht leer).
providerSpecificCallAusführen Sie provider-spezifische Aufrufe.
getPluginVersionErmitteln Sie die native Capacitor-Pluginversion.
openSecureWindowÖffnen Sie ein sichergesichertes Fenster für die OAuth2-Authentifizierung. Für Web sollten Sie die code in der umgeleiteten Seite haben, um über einen Broadcast-Channel die umgeleitete URL an die App zu senden. Etwas wie: html <html> <head></head> <body> <script> const searchParams = new URLSearchParams(location.search) if (searchParams.has("code")) { new BroadcastChannel("my-channel-name").postMessage(location.href); window.close(); } </script> </body> </html> Für mobile sollten Sie eine Redirect-URI haben, die die App öffnet, etwas wie: myapp://oauth_callback/ Und stellen Sie sicher, dass Sie es im app’s info.plist registrieren: xml <key>CFBundleURLTypes</key> <array> <dict> <key>CFBundleURLSchemes</key> <array> <string>myapp</string> </array> </dict> </array> Und im Datei AndroidManifest.xml: xml <activity> <intent-filter> <action android:name="android.intent.action.VIEW" /> <category android:name="android.intent.category.DEFAULT" /> <category android:name="android.intent.category.BROWSABLE" /> <data android:host="oauth_callback" android:scheme="myapp" /> </intent-filter> </activity> .

Diese Referenz wird von src/definitions.ts in capacitor-social-login.

Wenn Sie die Verwendung von @capgo/capacitor-Social-Login zum Planen der Authentifizierung und der Kontoflows verwenden, verbinden Sie es mit Mit @capgo/capacitor-social-login für die native Fähigkeit in Verwendung von @capgo/capacitor-social-login, @capgo/capacitor-Passkey für die Implementierungsdetails in @capgo/capacitor-passkey, @capgo/capacitor-native-biometrisch für die Implementierungsdetails in @capgo/capacitor-native-biometric, Zwei-Faktor-Authentifizierung für die Implementierungsdetails in Zwei-Faktor-Authentifizierung und SSO (Unternehmen) für die Implementierungsdetails in SSO (Unternehmen).