Présentation
Section intitulée « Présentation »@capgo/capacitor-social-login est le plugin d'authentification sociale tout-en-un pour Web, iOS et Android.
Il implémente :
- Connexion Sign-In Google avec le gestionnaire de crédentiels Android
- Se connecter avec Apple, y compris OAuth sur Android
- Connexion Facebook avec le compte 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 voie de migration Capgo pour les applications en train de passer d'Ionic Appflow Social Login ou Ionic Auth Connect.
Notes de fork et de migration
Section intitulée “Notes de fork et de migration”Cette extension a commencé comme une fork de @codetrix-studio/capacitor-google-auth. Le package original est effectivement archivé, donc Capgo maintient cette extension comme la remplaçante prise en charge.
Si vous utilisez toujours @codetrix-studio/capacitor-google-auth, suivez le guide de migration Google Auth legacy.
Si vous migrez depuis Ionic Auth Connect, utilisez le wrapper intégré pour le SocialLoginAuthConnect , et auth0, azure, cognito, okta, and onelogin noms de fournisseurs :
Compatibilité
Section intitulée “Compatibilité”| Version du plugin | Capacitor compatibilité | Entretenu |
|---|---|---|
| v8.x | v8.x | Oui |
| v7.x | v7.x | À la 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 prise en main vidéo
Section intitulée “Démarche de prise en main vidéo”Découvrez une démo rapide de la configuration et du flux de connexion du plugin en action.
Capacités de base
Sous-titre « Capacités de base »initialize- Initialiser le plugin.login- Se connecter avec le fournisseur sélectionné.logout- Se déconnecter.isLoggedIn- IsLoggedIn.
API Public
Sous-titre « API Public »| Méthode | Description |
|---|---|
initialize | Initialisez le plugin. |
login | Se connectez avec le fournisseur sélectionné. |
logout | Déconnexion. |
isLoggedIn | Est connecté. |
getAuthorizationCode | Récupérez l'autorisation actuelle code. |
refresh | Rafraîchissez le jeton d'accès. |
refreshToken | Outil de rafraîchissement de jeton OAuth2 pour le fournisseur OAuth2 intégré. |
handleRedirectCallback | Seul le 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 une date 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 | 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 de l'enregistrer dans les informations de l'application plist : 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 en capacitor-social-login.
Continuez à partir de @capgo/capacitor-social-login
Section intitulée « Continuez à partir de @capgo/capacitor-social-login »Si vous utilisez @capgo/capacitor-social-login pour planifier l'authentification et les flux de compte, connectez-le avec En utilisant @capgo/capacitor-social-login pour la capacité native dans En utilisant @capgo/capacitor-social-login, @capgo/capacitor-passkey pour le détail d'implémentation dans @capgo/capacitor-passkey, @capgo/capacitor-native-biometric pour le détail d'implémentation dans @capgo/capacitor-native-biometric, La deuxième facteur d'authentification pour les détails d'implémentation dans l'authentification à deux facteurs, et SSO (Entreprise) pour les détails d'implémentation dans SSO (Entreprise).