Zum Inhalt springen

@capgo/capacitor-Social-Login

Alle sozialen Anmeldungen in einem Plugin.

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

Es implementiert:

  • Google-Anmelden mit Android-Credential-Manager
  • Anmelden bei Apple, 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 migrieren.

Fork und Migrationhinweise

Abschnitt: "Fork und Migrationhinweise"

Diese Erweiterung begann als Fork von @codetrix-studio/capacitor-google-auth. Das Originalpaket ist effektiv archiviert, daher hält Capgo diese Erweiterung als unterstützten Ersatz aufrecht.

Wenn Sie noch immer @codetrix-studio/capacitor-google-auth verwenden, folgen Sie bitte den Anleitung zur Migration von Google Auth.

Wenn Sie von Ionic Auth Connect migrieren, verwenden Sie die integrierte SocialLoginAuthConnect Wrapper für das auth0, azure, cognito, okta, und onelogin Anbieternamen:

PluginversionCapacitor-KompatibilitätUnterhalten
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 weiterentwickelt.

Blicken Sie sich einen schnellen Demo-Blick über die Plugin-Einrichtung und den Anmeldefluss an.

  • initialize - Initialisieren Sie das Plugin.
  • login - Melden Sie sich mit dem ausgewählten Anbieter an.
  • logout - Abmelden.
  • isLoggedIn - Ist angemeldet.
MethodeBeschreibung
initializeInitialisieren Sie das Plugin.
loginMit dem ausgewählten Anbieter anmelden.
logoutAbmelden.
isLoggedInIsLoggedIn.
getAuthorizationCodeAktualisieren Sie die aktuelle code-Autorisierung.
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 Epoche) 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 von Anbieter-spezifischen Aufrufen.
getPluginVersionErmitteln Sie die native Capacitor-Pluginversion.
openSecureWindowÖffnen Sie ein sicheres Fenster für die OAuth2-Authentifizierung. Für Web sollten Sie das 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 Geräte sollten Sie eine Umleitungs-URI haben, die die App öffnet, etwas wie: myapp://oauth_callback/ Und stellen Sie sicher, dass Sie es in der app’s info.plist eintragen: xml <key>CFBundleURLTypes</key> <array> <dict> <key>CFBundleURLSchemes</key> <array> <string>myapp</string> </array> </dict> </array> Und in der 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-soziale-Anmeldung.

Wenn Sie soziale Anmeldung verwenden @capgo/capacitor-soziale-Anmeldung um die Authentifizierung und die Kontoflussplanung zu steuern, verbinden Sie es mit Mit @capgo/capacitor-Social-Login für die native Fähigkeit in @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-biometrisch, Zwei-Faktor-Authentifizierung zur Implementierungsdetail in Zwei-Faktor-Authentifizierung, und SSO (Unternehmen) zur Implementierungsdetail in SSO (Unternehmen).