Übersicht
Section titled “Overview”@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.
Fork und Migrationshinweise
Abschnitt mit dem Titel „Fork und Migrationshinweise“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:
Kompatibilität
Abschnitt mit dem Titel „Kompatibilität“| Pluginversion | Capacitor Kompatibilität | Gepflegt |
|---|---|---|
| v8.x | v8.x | Ja |
| v7.x | v7.x | Auf Anfrage |
| 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 unterstützt.
Video-Walkthrough
Abschnitt mit dem Titel “Video-Walkthrough”Beobachten Sie ein schnelles Demo der Plugin-Konfiguration und des Login-Flusses in Aktion.
Grundlegende Funktionen
Abschnitt mit dem Titel “Grundlegende Funktionen”initialize- Initialisieren Sie das Plugin.login- Melden Sie sich mit dem ausgewählten Anbieter an.logout- Abmelden.isLoggedIn- IsLoggedIn.
Öffentlich API
Sektion mit dem Titel “Öffentlich API”| Methode | Beschreibung |
|---|---|
initialize | Initialisieren Sie das Plugin. |
login | Mit dem ausgewählten Anbieter anmelden. |
logout | Abmelden. |
isLoggedIn | IsLoggedIn. |
getAuthorizationCode | Rufen Sie den aktuellen Autorisierungscode code ab. |
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 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). |
providerSpecificCall | Ausführen Sie provider-spezifische Aufrufe. |
getPluginVersion | Ermitteln 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> . |
Quelle der Wahrheit
Abschnitt mit dem Titel „Quelle der Wahrheit“Diese Referenz wird von src/definitions.ts in capacitor-social-login.
Weitergehen von @capgo/capacitor-social-login
Abschnitt mit dem Titel „Weitergehen von @capgo/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).