Ionic Auth 接続の移行から @capgo/capacitor-social-login に続けてください。

インストール手順とこのプラグインのフルマークダウンガイドまでの手順を含む設定用の質問をコピーする。

概要

Capgo ソーシャルログインは、Google、Apple、Facebook、他のアイデンティティプロバイダーを含む、プロバイダー固有のOAuth2フローでIonic Auth Connectを置き換えます。複数のプロバイダーを1つのプラグインでサポートし、iOS、Android、Webで動作します。

なぜこれが機能するか

プラグインには、 SocialLoginAuthConnect 互換性のあるAuth Connectラッパーが含まれます。 auth0, azure これは、Ionic Auth ConnectのプロバイダーIDを、組み込みのOAuth2エンジンにマップするため、 okta.

例えば、

bun add @capgo/capacitor-social-login
bunx cap sync

インポートを置き換える

// Before
import { AuthConnect } from '@ionic-enterprise/auth-connect';

// After
import { SocialLoginAuthConnect } from '@capgo/capacitor-social-login';

プロバイダを初期化する

「 authConnect Ionic Auth Connect が使用したプロバイダ ID の同じものを使用したい場合は、

await SocialLoginAuthConnect.initialize({
  authConnect: {
    auth0: {
      domain: 'https://your-tenant.auth0.com',
      clientId: 'your-auth0-client-id',
      redirectUrl: 'myapp://oauth/auth0',
      audience: 'https://your-api.example.com',
    },
    azure: {
      tenantId: 'common',
      clientId: 'your-azure-client-id',
      redirectUrl: 'myapp://oauth/azure',
    },
    cognito: {
      domain: 'https://your-domain.auth.region.amazoncognito.com',
      clientId: 'your-cognito-client-id',
      redirectUrl: 'myapp://oauth/cognito',
    },
    okta: {
      issuer: 'https://dev-12345.okta.com/oauth2/default',
      clientId: 'your-okta-client-id',
      redirectUrl: 'myapp://oauth/okta',
    },
    onelogin: {
      issuer: 'https://your-tenant.onelogin.com/oidc/2',
      clientId: 'your-onelogin-client-id',
      redirectUrl: 'myapp://oauth/onelogin',
    },
  },
});

サポートされているプロバイダ ID

auth0
azure
cognito
okta
onelogin

const result = await SocialLoginAuthConnect.login({
  provider: 'auth0',
});

const status = await SocialLoginAuthConnect.isLoggedIn({
  provider: 'auth0',
});

const code = await SocialLoginAuthConnect.getAuthorizationCode({
  provider: 'auth0',
});

await SocialLoginAuthConnect.logout({
  provider: 'auth0',
});

プロバイダ固有のプリセット例

Auth0プリセット例

await SocialLoginAuthConnect.initialize({
  authConnect: {
    auth0: {
      domain: 'https://your-tenant.auth0.com',
      clientId: 'your-auth0-client-id',
      redirectUrl: 'myapp://oauth/auth0',
      audience: 'https://your-api.example.com',
    },
  },
});

const auth0Result = await SocialLoginAuthConnect.login({
  provider: 'auth0',
});

console.log(auth0Result.result.idToken);

Azureプリセット例

await SocialLoginAuthConnect.initialize({
  authConnect: {
    azure: {
      tenantId: 'common',
      clientId: 'your-azure-client-id',
      redirectUrl: 'myapp://oauth/azure',
    },
  },
});

const azureResult = await SocialLoginAuthConnect.login({
  provider: 'azure',
});

console.log(azureResult.result.resourceData);

Cognitoプリセット例

await SocialLoginAuthConnect.initialize({
  authConnect: {
    cognito: {
      domain: 'https://your-domain.auth.region.amazoncognito.com',
      clientId: 'your-cognito-client-id',
      redirectUrl: 'myapp://oauth/cognito',
    },
  },
});

const cognitoResult = await SocialLoginAuthConnect.login({
  provider: 'cognito',
});

console.log(cognitoResult.result.idToken);

Okta presetの例

await SocialLoginAuthConnect.initialize({
  authConnect: {
    okta: {
      issuer: 'https://dev-12345.okta.com/oauth2/default',
      clientId: 'your-okta-client-id',
      redirectUrl: 'myapp://oauth/okta',
    },
  },
});

const oktaResult = await SocialLoginAuthConnect.login({
  provider: 'okta',
});

console.log(oktaResult.result.resourceData);

OneLogin presetの例

await SocialLoginAuthConnect.initialize({
  authConnect: {
    onelogin: {
      issuer: 'https://your-tenant.onelogin.com/oidc/2',
      clientId: 'your-onelogin-client-id',
      redirectUrl: 'myapp://oauth/onelogin',
    },
  },
});

const oneloginResult = await SocialLoginAuthConnect.login({
  provider: 'onelogin',
});

console.log(oneloginResult.result.idToken);

エンドポイントのオーバーライド

各プレセットは、デフォルトのOAuth2構成を作成します。 domain または issuer。ご利用のテナントがカスタムエンドポイントを使用している場合、直接オーバーライドしてください:

await SocialLoginAuthConnect.initialize({
  authConnect: {
    onelogin: {
      issuer: 'https://your-tenant.onelogin.com/oidc/2',
      clientId: 'your-onelogin-client-id',
      redirectUrl: 'myapp://oauth/onelogin',
      authorizationBaseUrl: 'https://your-tenant.onelogin.com/oidc/2/auth',
      accessTokenEndpoint: 'https://your-tenant.onelogin.com/oidc/2/token',
      resourceUrl: 'https://your-tenant.onelogin.com/oidc/2/me',
      logoutUrl: 'https://your-tenant.onelogin.com/oidc/2/logout',
    },
  },
});

直接OAuth2構成

__CAPGO_KEEP_0__の設定が必要ない場合は、一般的なOAuth2ドキュメントで直接プロバイダを設定する。

OAuth2およびOIDCプロバイダガイド

移行に関する注意

互換性レイヤーはOAuth2ベースです プロバイダの名前は保持されますが、Ionicのネイティブ実装の詳細はありません。
リフレッシュトークンはスコープに依存しています リフレッシュトークンが必要な場合は、リクエスト offline_access またはプロバイダ固有のエクイバレントを使用してください。
カスタムエンドポイントはプリセットを上書きできます プリセットが近いですが、正確ではない場合、異なるエンドポイントのみを上書きしてください。
直接 oauth2 エントリが勝つ 両方を定義すると、 authConnect.auth0 と oauth2.auth0, どちらも直接 oauth2 configが優先されます。

Ionic Auth Connect を使用している場合 Ionic Auth Connect の移行から @capgo/capacitor-social-login に進む 認証とアカウントフローの計画と接続に使用する場合 @capgo/capacitor-social-login を使用する Using @capgo/capacitor-social-login のネイティブ機能 Using @capgo/capacitor-social-login の @capgo/capacitor-social-login の実装詳細 @capgo/capacitor-social-login @capgo/capacitor-passkey 実装詳細のために@capgo/capacitor-パスキーで @capgo/capacitor-ネイティブ・バイオメトリック実装詳細のために@capgo/capacitor-ネイティブ・バイオメトリック、 2要素認証実装詳細のために2要素認証。