概要
概要@capgo/capacitor-social-login Web、iOS、Android向けのすべてのソーシャル認証プラグインです。
実装している機能は次のとおりです。
- Google Sign-In with Android Credential Manager
- Sign in with Apple、Android向けのOAuthも含みます。
- Facebook Login、現在のFacebook SDKを使用します。
- Twitter/X ではOAuth 2.0を使用
- OAuth2およびOIDCプロバイダー、GitHub、Microsoft Entra ID、Auth0、Okta、Keycloak、他に準拠するサーバー
CapgoはIonic Appflow Social LoginまたはIonic Auth Connectからアプリを移行するための移行パスでもあります。
フォークと移行の注意
フォークと移行の注意このプラグインは @codetrix-studio/capacitor-google-authのフォークとして始まりました。オリジナルのパッケージは実質的にアーカイブされているため、Capgoはこのプラグインをサポートされた置き換えとして維持しています。
Ionic Auth Connectを使用している場合、 @codetrix-studio/capacitor-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
セクション「パブリック API」| メソッド | 概要 |
|---|---|
initialize | プラグインを初期化します。 |
login | 選択したプロバイダーでログインします。 |
logout | ログアウト。 |
isLoggedIn | ログイン中かどうかを確認します。 |
getAuthorizationCode | 現在の認証情報を取得します。code。 |
refresh | アクセストークンを更新します。 |
refreshToken | OAuth2 リフレッシュトークンハンドラーです。 |
handleRedirectCallback | Web-only: OAuth 認証のリダイレクトコールバックを処理し、パースされた結果を返します。 |
decodeIdToken | JWT (OIDC ID トークン) をそのCLAIMSにデコードします。 |
getAccessTokenExpirationDate | アクセストークン有効期限 (エポック時間以降のミリ秒) をISO形式の日付文字列に変換します。 |
isAccessTokenAvailable | アクセストークンが利用可能かどうかを確認します (空でない) |
isAccessTokenExpired | アクセストークンが期限切れであるかどうかを確認します。 |
isRefreshTokenAvailable | リフレッシュトークンが利用可能であるかどうかを確認します (空でない)。 |
providerSpecificCall | プロバイダ固有の呼び出しを実行します。 |
getPluginVersion | CapgoのネイティブCapacitorプラグインのバージョンを取得します。 |
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から続けてください/@capacitor-social-login
「capgoから続けてください/@capacitor-social-login」__CAPGO_KEEP_0__を使用している場合 @capgo/capacitor-ソーシャルログイン @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-social-loginを使用して 、@capgo/capacitor-social-loginのネイティブ機能 @capgo/capacitor-passkey @capgo/capacitor-passkeyの実装詳細 @capgo/capacitor-native-biometric @capgo/capacitor-native-biometricの実装詳細 for the capgo implementation detail in capacitor-native-biometric 2要素認証 2要素認証の実装詳細については SSO (エンタープライズ) SSO (エンタープライズ)の実装詳細については