Übersicht
Abschnitt mit dem Titel “Übersicht”@capgo/capacitor-social-login es ist das umfassende Plugin für soziale Authentifizierung für Web, iOS und Android.
Es implementiert:
- Google-Anmeldung mit Android-Credential-Manager
- Anmeldung bei Apple, einschließlich OAuth auf Android
- Facebook Login with the current Facebook SDK
- Twitter/X über OAuth 2.0
- Generic OAuth2 and OIDC providers, including GitHub, Microsoft Entra ID, Auth0, Okta, Keycloak, and other compliant servers
It is also the Capgo migration path for apps moving from Ionic Appflow Social Login or Ionic Auth Connect.
Fork- und Migrationshinweise
Abschnitt mit dem Titel „Fork- und Migrationshinweise“Dieses Plugin begann als Fork von @codetrix-studio/capacitor-google-auth. The original package is effectively archived, so Capgo maintains this plugin as the supported replacement.
Wenn Sie noch immer @codetrix-studio/capacitor-google-authverwenden, folgen Sie den Legacy Google Auth-Migrationsanleitung.
Wenn Sie von Ionic Auth Connect migrieren, verwenden Sie die integrierte SocialLoginAuthConnect Wrapper für die auth0, azure, cognito, okta, und onelogin Anbieternamen:
Kompatibilität
Abschnitt mit dem Titel „Kompatibilität“| Pluginversion | Capacitor-Kompatibilität | Unterhalten |
|---|---|---|
| v8.x | v8.x | Ja |
| v7.x | v7.x | Zu den Bedürfnissen |
| v6.x | v6.x | Nein |
| v5.x | v5.x | Nein |
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.
Video Walkthrough
Abschnitt mit dem Titel “Video Walkthrough”Blicken Sie sich einen schnellen Demo-Blick an, wie die Plugin-Einrichtung und der Anmeldeprozess funktionieren.
Hauptfunktionen
Abschnitt mit dem Titel “Hauptfunktionen”initialize- Initialisieren Sie das Plugin.login- Melden Sie sich mit dem ausgewählten Anbieter an.logout- Abmelden.isLoggedIn- Ist angemeldet.
Öffentlich API
Abschnitt mit dem Titel “Öffentlich API”| Methode | Beschreibung |
|---|---|
initialize | Initialisieren Sie das Plugin. |
login | Mit dem ausgewählten Anbieter anmelden. |
logout | Abmelden. |
isLoggedIn | IsLoggedIn. |
getAuthorizationCode | Ermitteln Sie den aktuellen Autorisierungscode code. |
refresh | Aktualisieren Sie den Zugriffstoken. |
refreshToken | OAuth2-Refresh-Token-Helfer für den eingebauten OAuth2-Anbieter. |
handleRedirectCallback | Web-only: Behandeln Sie den OAuth-Redirect-Callback und geben Sie das geparste Ergebnis zurück. |
decodeIdToken | Decodieren Sie ein JWT (typischerweise ein OIDC-ID-Token) in seine Ansprüche. |
getAccessTokenExpirationDate | Konvertieren 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). |
providerSpecificCall | Ausführen von Anbieter-spezifischen Aufrufen. |
getPluginVersion | Rufen Sie die native Capacitor-Pluginversion ab. |
openSecureWindow | Öffnen Sie ein sichergesichertes 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> . |
Quelle der Wahrheit
Sektion mit dem Titel „Quelle der Wahrheit“Diese Referenz wird von src/definitions.ts in capacitor-social-login.
Weitermachen von @capgo/capacitor-social-login
Abschnitt mit dem Titel “Weitermachen von @capgo/capacitor-social-login”Wenn Sie “@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-social-login” verwenden @capgo/capacitor-social-login Verbinden Sie es mit “@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-social-login” Verwenden Sie “@capgo/capacitor-social-login” für die native Fähigkeit in Verwenden Sie “@capgo/capacitor-social-login” @capgo/capacitor-passkey für die Implementierungsdetail in @capgo/capacitor-passkey @capgo/capacitor-native-biometric für die Implementierungsdetails in @capgo/capacitor-native-biometrisch Zwei-Faktor-Authentifizierung für die Implementierungsdetails in der Zwei-Faktor-Authentifizierung und SSO (Unternehmen) für die Implementierungsdetails in SSO (Unternehmen).