Présentation
Section intitulée « Présentation »@capgo/capacitor-social-login est le plugin d'authentification sociale omnicanal pour Web, iOS et Android.
Cela implémente :
- L'inscription Google avec le gestionnaire de crédit Android
- S'inscrire avec Apple, y compris OAuth sur Android
- L'inscription Facebook avec le Facebook SDK actuel
- Twitter/X via OAuth 2.0
- Les fournisseurs OAuth2 et OIDC génériques, y compris GitHub, Microsoft Entra ID, Auth0, Okta, Keycloak et autres serveurs conformes
C'est également la voie de migration Capgo 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 branche de @codetrix-studio/capacitor-google-auth Le 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-auth, suivez le guide de migration de l'authentification Google legacy.
Si vous migrez depuis Ionic Auth Connect, utilisez le SocialLoginAuthConnect wrapper intégré pour le auth0, azure, cognito, okta, et les noms de fournisseurs : onelogin Guide de migration d'Auth Connect
Compatibilité
Section intitulée « Compatibilité »| Version du plugin | Compatibilité Capacitor | 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 activement maintenue.
Démarche de démonstration vidéo
Section intitulée “Démarche de démonstration vidéo”Regardez une démo rapide de la configuration et de la connexion du plugin 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 | Seulement web : gérer l'appel de rappel de redirection OAuth et retourner le résultat analysé. |
decodeIdToken | Décodez un JWT (généralement un jeton ID OIDC) en ses revendications. |
getAccessTokenExpirationDate | Convertissez 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écutez des appels spécifiques au fournisseur. |
getPluginVersion | Obtenez la version native du plugin Capacitor. |
openSecureWindow | Ouvrez une fenêtre sécurisée pour l'authentification OAuth2. Pour le web, vous devriez avoir le code dans la page redirigée pour utiliser un canal de diffusion pour envoyer l'URL redirigée vers l'application. Exemple : 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 de l'enregistrer dans l'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é
Section intitulée “Source De Vérité”Cette référence est synchronisée à partir de src/definitions.ts dans capacitor-connexion sociale.
Continuez d'ici à @capgo/capacitor-connexion sociale
Section intitulée “Continuez d'ici à @capgo/capacitor-connexion sociale”Si vous utilisez @capgo/capacitor-connexion sociale pour planifier l'authentification et les flux de compte, connectez-le avec En utilisant @capgo/capacitor-login-social pour la capacité native dans En utilisant @capgo/capacitor-login-social, @capgo/capacitor-passkey pour le détail d'implémentation dans @capgo/capacitor-passkey, @capgo/capacitor-biométrique-natif pour le détail d'implémentation dans @capgo/capacitor-biométrique-natif, 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).