@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 を使用している場合、 @codetrix-studio/capacitor-google-authのを参照してください。.

Ionic Auth Connect から移行している場合、組み込みの SocialLoginAuthConnect wrapper for the auth0, azure, cognito, okta, and onelogin provider names:

Compatibility

Plugin version	Capacitor compatibility	Maintained
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 トークン) をクレームに分解します。
`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.

If you are using @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 (企業)の実装詳細については。