Vue d'ensemble
Section titled “Overview”@capgo/capacitor-social-login C'est le plugin d'authentification sociale omnicanal pour Web, iOS et Android.
Il implémente :
- Google Sign-In avec le gestionnaire de crédits Android
- Se connecter avec Apple, y compris OAuth sur Android
- Facebook Login avec le Facebook actuel SDK
- Twitter/X via OAuth 2.0
- Fournisseurs OAuth2 et OIDC génériques, y compris GitHub, Microsoft Entra ID, Auth0, Okta, Keycloak et autres serveurs conformes
Il s'agit également de la Capgo de migration pour les applications en train de passer de Ionic Appflow Social Login ou Ionic Auth Connect.
Notes de fork et de migration
Section intitulée « Notes de fork et de migration »Ce plugin a commencé comme une fork de @codetrix-studio/capacitor-google-authLe paquet d'origine est effectivement archivé, donc Capgo maintient ce plugin comme la remplaçante prise en charge.
Si vous utilisez toujours @codetrix-studio/capacitor-google-authsuivez les legacy Google Auth migration guide.
Si vous migrez depuis Ionic Auth Connect, utilisez le wrapper intégré pour le SocialLoginAuthConnect wrapper pour auth0, azure, cognito, okta, and onelogin noms de fournisseurs :
- Compatibilité de l'authentification Auth Connect
- Guide de compatibilité d'Auth Connect
- Configuration de Keycloak
Compatibilité
Section intitulée « Compatibilité »| Version du plugin | Capacitor compatibilité | Entretenu |
|---|---|---|
| v8.x | v8.x | Oui |
| v7.x | v7.x | Sur demande |
| v6.x | v6.x | Non |
| v5.x | v5.x | Non |
La version majeure de ce plugin suit la version majeure de Capacitor. Par exemple, utilisez le plugin v8 avec Capacitor 8. Seule la dernière version majeure est maintenue activement.
Démonstration vidéo
Section intitulée “Démonstration vidéo”Regardez une démo rapide de la configuration du plugin et du flux de connexion en action.
Capacités de base
Section intitulée “Capacités de base”initialize- Initialiser le plugin.login- Se connecter avec le fournisseur sélectionné.logout- Se déconnecter.isLoggedIn- IsLoggedIn.
Public API
Section intitulée “Public API”| Méthode | Description |
|---|---|
initialize | Initialiser le plugin. |
login | Se connecter avec le fournisseur sélectionné. |
logout | Se déconnecter. |
isLoggedIn | IsLoggedIn. |
getAuthorizationCode | Obtenez l'autorisation actuelle code. |
refresh | Rafraîchir le jeton d'accès. |
refreshToken | Assistant de jeton de rafraîchissement OAuth2 pour le fournisseur OAuth2 intégré. |
handleRedirectCallback | Géré uniquement en ligne : gérer l'appel de rappel OAuth et retourner le résultat analysé. |
decodeIdToken | Décoder un JWT (généralement un jeton ID OIDC) dans ses revendications. |
getAccessTokenExpirationDate | Convertir un timestamp d'expiration de jeton d'accès (millisecondes depuis l'époque) en une chaîne de date ISO. |
isAccessTokenAvailable | Vérifiez si un jeton d'accès est disponible (non vide). |
isAccessTokenExpired | Vérifiez si un jeton d'accès est expiré. |
isRefreshTokenAvailable | Vérifiez si un jeton de rafraîchissement est disponible (non vide). |
providerSpecificCall | Exécuter des appels spécifiques au fournisseur. |
getPluginVersion | Obtenez la version native du plugin Capacitor. |
openSecureWindow | Ouvre une fenêtre sécurisée pour l'authentification OAuth2. Pour le web, vous devez avoir le code dans la page redirigée pour utiliser un canal de diffusion pour envoyer l'URL redirigée vers l'application Quelque chose comme : 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> Pour les appareils mobiles, vous devez avoir une URI de redirection qui ouvre l'application, quelque chose comme : myapp://oauth_callback/ Et assurez-vous d'enregistrer-le dans le fichier info.plist de l'application : xml <key>CFBundleURLTypes</key> <array> <dict> <key>CFBundleURLSchemes</key> <array> <string>myapp</string> </array> </dict> </array> Et dans le fichier 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> . |
Source De Vérité
Sous-section intitulée « Source De Vérité »Cette référence est synchronisée à partir de src/definitions.ts en capacitor-social-login.
Continuez de @capgo/capacitor-connexion sociale
Section intitulée “Continuez de @capgo/capacitor-connexion sociale”Si vous utilisez @capgo/capacitor-connexion-social pour planifier l'authentification et les flux de compte, connectez-l’avec En utilisant @capgo/capacitor-connexion-social pour la capacité native dans En utilisant @capgo/capacitor-connexion-social @capgo/capacitor-mot-de-passe pour le détail d'implémentation dans @capgo/capacitor-mot-de-passe @capgo/capacitor-authentification-biometrique pour le détail d'implémentation dans @capgo/capacitor-authentification-native-biometrique L'authentification à deux facteurs pour le détail d'implémentation dans L'authentification à deux facteurs, et SSO (Entreprise) pour le détail d'implémentation dans SSO (Entreprise).