@capgo/capacitor-social-login

あらゆるソーシャルログインを、この1つのプラグインで。

概要

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

以下を実装しています：

Android Credential Managerを使用したGoogle Sign-In
AndroidでのOAuthを含むSign in with Apple
最新のFacebook SDKを使用したFacebook Login
OAuth 2.0によるTwitter/X
GitHub、Microsoft Entra ID、Auth0、Okta、Keycloak、その他の準拠サーバーを含む、汎用的なOAuth2およびOIDCプロバイダー

Ionic Appflow Social LoginやIonic Auth Connectから移行するアプリ向けの、Capgoな移行パスでもあります。

フォークと移行の注意点

このプラグインは、以下をフォークして開発が開始されました： @codetrix-studio/capacitor-google-auth。元のパッケージは実質的にアーカイブされているため、Capgo がこのプラグインをサポート対象の代替品としてメンテナンスしています。

まだ @codetrix-studio/capacitor-google-authを使用している場合は、以下に従ってください：レガシー Google Auth 移行ガイド.

Ionic Auth Connect から移行する場合は、組み込みの SocialLoginAuthConnect ラッパーを使用してください： auth0, azure, cognito, oktaや onelogin プロバイダー名：

互換性

プラグインのバージョン	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`	IsLoggedIn.
`getAuthorizationCode`	現在の認可codeを取得します。
`refresh`	アクセストークンを更新します。
`refreshToken`	組み込みのOAuth2プロバイダー用のOAuth2リフレッシュトークンヘルパー。
`handleRedirectCallback`	Web専用: OAuthリダイレクトコールバックを処理し、解析された結果を返します。
`decodeIdToken`	JWT（通常はOIDC IDトークン）をクレームにデコードします。
`getAccessTokenExpirationDate`	アクセストークンの有効期限タイムスタンプ（エポックからのミリ秒）をISO日付文字列に変換します。
`isAccessTokenAvailable`	アクセストークンが利用可能（空でない）かどうかを確認します。
`isAccessTokenExpired`	アクセストークンが期限切れかどうかを確認します。
`isRefreshTokenAvailable`	リフレッシュトークンが利用可能（空でない）かどうかを確認します。
`providerSpecificCall`	プロバイダー固有の呼び出しを実行します。
`getPluginVersion`	ネイティブの Capacitor プラグインのバージョンを取得します。
`openSecureWindow`	OAuth2認証用のセキュアなウィンドウを開きます。Webの場合は、リダイレクト先のページに code を含め、Broadcast Channelを使ってリダイレクト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>` .

Source of Truth

このリファレンスは以下から同期されています： src/definitions.ts における capacitor-social-login.

使用している場合 @capgo/capacitor-social-login 認証とアカウントフローを計画するには、これを次と連携させてください @capgo/capacitor-social-login の使用「@capgo/capacitor-social-login の使用」のネイティブ機能のために、 @capgo/capacitor-passkey @capgo/capacitor-passkey の実装詳細については、 @capgo/capacitor-native-biometric @capgo/capacitor-native-biometric の実装の詳細については、 2要素認証二要素認証の実装の詳細については、また、 SSO (エンタープライズ) SSO (Enterprise) の実装の詳細については。