@capgo/capacitor-social-login

すべてのソーシャルログインを1つのプラグインで。

概要

@capgo/capacitor-social-login Web、iOS、Android向けのすべてのソーシャル認証プラグインです。

実装しているものは次のとおりです。

Google Sign-In with Android Credential Manager
Sign in with Apple、Android向けのOAuthを含む
Facebook でのログインに使用する現在の Facebook SDK
Twitter/X ではOAuth 2.0を使用
Generic OAuth2 and OIDC providers, including GitHub, Microsoft Entra ID, Auth0, Okta, Keycloak, and other compliant servers

また、Ionic Appflow Social LoginまたはIonic Auth Connectからアプリを移行するためのCapgoの移行パスでもあります。

フォークと移行に関する注記

このプラグインは @codetrix-studio/capacitor-google-authのフォークとして始まりました。オリジナルのパッケージは実質的にアーカイブされているため、Capgoはこのプラグインをサポートされた置き換えとして維持しています。

Ionic Auth Connectからアプリを移行している場合、built-in @codetrix-studio/capacitor-google-authIonic Auth Connectからアプリを移行している場合、built-in Ionic Auth Connectからアプリを移行している場合、built-in.

Ionic Auth Connectからアプリを移行している場合、built-in SocialLoginAuthConnect wrapper for the auth0, azure, cognito, okta、および onelogin provider names:

互換性

プラグインのバージョン	Capacitor の互換性	メンテナンス
v8.x	v8.x	はい
v7.x	v7.x	オンデマンド
v6.x	v6.x	いいえ
v5.x	v5.x	いいえ

Capacitorのメジャーバージョンに従ってください。例えば、Capacitor 8を使用してプラグインv8を使用します。ただし、最新のメジャーバージョンだけがアクティブにメンテナンスされます。

動画ウォークスルー

このプラグインのセットアップとログインフローを視覚的に確認してください。

基本機能

initialize - プラグインを初期化します。
login - 選択したプロバイダーでログインします。
logout - ログアウトします。
isLoggedIn - IsLoggedIn。

パブリック API

メソッド	説明
`initialize`	プラグインを初期化します。
`login`	選択したプロバイダーでログインします。
`logout`	ログアウト。
`isLoggedIn`	ログイン中かどうかを確認します。
`getAuthorizationCode`	Get the current authorization code.
`refresh`	アクセストークンを更新します。
`refreshToken`	OAuth2 リフレッシュトークンハンドラーです。
`handleRedirectCallback`	Web-only: OAuth リダイレクトコールバックを処理し、パースされた結果を返します。
`decodeIdToken`	JWT (OIDC ID トークン) をそのCLAIMSにデコードします。
`getAccessTokenExpirationDate`	アクセストークン有効期限 (エポック時間以降のミリ秒) をISO形式の日付文字列に変換します。
`isAccessTokenAvailable`	アクセストークンが利用可能かどうかを確認します (空でない).
`isAccessTokenExpired`	アクセストークンが期限切れかどうかを確認します。
`isRefreshTokenAvailable`	リフレッシュトークンが利用可能かどうかを確認します (空でない).
`providerSpecificCall`	プロバイダーの特定のコールを実行します。
`getPluginVersion`	Get the native Capacitor plugin version.
`openSecureWindow`	OAuth2認証のために安全なウィンドウを開きます。ウェブの場合、リダイレクトされたページにcodeを含める必要があります。リダイレクトされたURLをアプリに送信するために、ブロードキャストチャンネルを使用します。例えば: `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>` モバイルの場合、リダイレクトURIがアプリを開くように設定する必要があります。例えば: `myapp://oauth_callback/` アプリのinfo.plistに登録するようにしてください。 `xml <key>CFBundleURLTypes</key> <array> <dict> <key>CFBundleURLSchemes</key> <array> <string>myapp</string> </array> </dict> </array>` 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>` .

真実の源

このリファレンスは src/definitions.ts in capacitor-social-login.

Capgoを使用している場合 @capgo/capacitor-social-login __CAPGO_KEEP_0__を使用して Using @capgo/capacitor-social-login for the native capability in Using @capgo/capacitor-social-login, @capgo/capacitor-passkey for the implementation detail in @capgo/capacitor-passkey, @capgo/capacitor-native-biometric Capacitorのネイティブバイオメトリック (@capgo/capacitor-native-biometric)の実装詳細 2要素認証 Capacitorの2要素認証の実装詳細、 SSO (エンタープライズ) CapacitorのSSO (エンタープライズ)の実装詳細。