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

概要

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

これがどうして機能するのか

プラグインには、Auth Connectの互換性のあるラッパーとして名付けられた SocialLoginAuthConnect です。これは、Ionic Auth ConnectのプロバイダーIDを、組み込みのOAuth2エンジンにマップするので、名前として auth0, azure、 okta.

、を使用できます。

npm install @capgo/capacitor-social-login
npx cap sync

置き換え

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

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

Providersを初期化

Capacitorの authConnect presetsを使用すると、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 プリセット例

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 example

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);

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

または 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',
    },
  },
});

各プリセットは、

__CAPGO_KEEP_0__ に直接の設定をしない場合は、一般的な OAuth2 ドキュメントに同じプロバイダーを直接設定してください。

• OAuth2 と OIDC プロバイダー ガイド

移行に関する注意

1. 互換性レイヤーは OAuth2 ベースです プロバイダー名は保持し、Ionic のネイティブ実装の詳細は削除します。

2. リフレッシュトークンはスコープに依存します リフレッシュトークンが必要な場合は、リクエスト offline_access またはプロバイダー固有のエクイバレントを使用してください。

3. カスタムエンドポイントはプリセットを上書きできます プリセットが近いですが、正確ではありません。上書きするエンドポイントは、異なる部分のみを上書きしてください。

4. 直接 oauth2 エントリが勝つ 両方の定義があれば authConnect.auth0 そして oauth2.auth0, 直接 oauth2 configが優先される。

関連するドキュメント

• ソーシャルログインのスタート
• OAuth2とOIDCプロバイダー
• Ionic Auth Connectから移行
• Ionic Enterpriseプラグインの移行ソリューション

Ionic Auth 接続移行から @capgo/capacitor-social-login に進む

あなたが使用している場合 Ionic Auth 接続移行から @capgo/capacitor-social-login を使用して 認証とアカウントフローの計画と実行に使用する場合、@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-social-login を接続する @capgo/capacitor-social-login を使用して @capgo/capacitor-social-login のネイティブ機能を使用する場合 @capgo/capacitor-social-login @capgo/capacitor-passkey @capgo/capacitor-passkey の実装詳細 @capgo/capacitor-native-biometric Ionic Auth 接続移行から @capgo/capacitor-social-login に進む Capacitorの実装詳細は@capgo/capacitor-native-biometricにあります。 2要素認証 Capacitorの実装詳細は2要素認証にあります。