メニューに進む
Capgo - Capacitor アプリ向けリアルタイム更新 Capgo

Keycloak

GitHub

概要

「概要」のセクション

Keycloakは、組み込みの汎用OAuth2プロバイダーを通じて機能します。Keycloakには新しいネイティブプロバイダーが必要ありません。KeycloakクライアントをOpenID Connectクライアントとして設定し、 provider: 'oauth2' 安定した providerId例えば keycloak.

Keycloakクライアント設定

Keycloakのドメインで、使用する__CAPGO_KEEP_0__アプリのクライアントを作成または開きます:

承認Capacitorフローを使用します。

  1. Use the authorization code flow.
  2. アプリ設定でPKCEを有効にします。
  3. アプリで使用するすべてのリダイレクトURIを登録する必要があります。例えば myapp://oauth/keycloak モバイル用とHTTPSのコールバックURLをプロダクション用に。
  4. スコープとして openid profile emailを追加します。ただし、ドメインとクライアントがリフレッシュトークンを発行するように設定されている場合にのみ。 offline_access Issuer URLはデプロイメント依存です。現在のKeycloakのデプロイメントでは、

でレルムのメタデータを公開していますが、一部のデプロイメントでは追加のベースパスが含まれています。レルムのOpenIDエンドポイントの構成からIssuer URLを表示してください。 https://keycloak.example.com/realms/my-realm/.well-known/openid-configurationOIDCディスカバリーエクサンプル

「OIDCディスカバリーエクサンプル」

を優先します。そうすることでプラグインは、レルムのメタデータから認可、トークン、ログアウトエンドポイントを自動的に検出できます。

「」 issuerUrl を使用します。

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


const keycloakIssuer = 'https://keycloak.example.com/realms/my-realm';


await SocialLogin.initialize({
  oauth2: {
    keycloak: {
      appId: 'your-keycloak-client-id',
      issuerUrl: keycloakIssuer,
      redirectUrl: 'myapp://oauth/keycloak',
      scope: 'openid profile email',
      pkceEnabled: true,
      resourceUrl: `${keycloakIssuer}/protocol/openid-connect/userinfo`,
    },
  },
});


const result = await SocialLogin.login({
  provider: 'oauth2',
  options: {
    providerId: 'keycloak',
  },
});


console.log(result.result.idToken);
console.log(result.result.accessToken?.token);
console.log(result.result.resourceData);

リフレッシュトークン用に、以下の条件を満たす場合にのみリクエスト offline_access Keycloakのドメインとクライアントがこのアプリケーションに対してリフレッシュトークンを許可している場合

await SocialLogin.initialize({
  oauth2: {
    keycloak: {
      appId: 'your-keycloak-client-id',
      issuerUrl: keycloakIssuer,
      redirectUrl: 'myapp://oauth/keycloak',
      scope: 'openid profile email offline_access',
      pkceEnabled: true,
    },
  },
});

手動エンドポイントフォールバック

セクション「手動エンドポイントフォールバック」

OIDCディスカバリがブロックされている場合や、デプロイメントがアプリケーションにメタデータを公開していない場合、エンドポイントを直接設定する。ベースURLは、Keycloakのデプロイメントが公開しているものと同じでなければなりません。

const keycloakRealmUrl = 'https://keycloak.example.com/realms/my-realm';


await SocialLogin.initialize({
  oauth2: {
    keycloak: {
      appId: 'your-keycloak-client-id',
      authorizationBaseUrl: `${keycloakRealmUrl}/protocol/openid-connect/auth`,
      accessTokenEndpoint: `${keycloakRealmUrl}/protocol/openid-connect/token`,
      redirectUrl: 'myapp://oauth/keycloak',
      scope: 'openid profile email',
      pkceEnabled: true,
      resourceUrl: `${keycloakRealmUrl}/protocol/openid-connect/userinfo`,
      logoutUrl: `${keycloakRealmUrl}/protocol/openid-connect/logout`,
    },
  },
});

Auth Connect互換性

セクション「Auth Connect互換性」

KeycloakはAuth ConnectのプリセットプロバイダIDの一覧に含まれていません。すでに SocialLoginAuthConnectを使用している場合は、ジェネリック oauth2 プロバイダーとログイン provider: 'oauth2' プラス providerId: 'keycloak'.

詳細は Keycloak OpenID Connect エンドポイントのリファレンス 発見とエンドポイントのパスについて

セクション：関連するドキュメント

Keycloak から続けて

セクション：Keycloak から続けて

Keycloakを使用している場合 Keycloak 認証とアカウントフローの計画に使用している場合、Keycloakを Using @capgo/capacitor-social-login for the native capability in Using @capgo/capacitor-social-login, @capgo/capacitor-social-login for the implementation detail in @capgo/capacitor-social-login, @capgo/capacitor-passkey for the implementation detail in @capgo/capacitor-passkey, @capgo/capacitor-native-biometric for the implementation detail in @capgo/capacitor-native-biometric, and Two-factor authentication 2要素認証の実装詳細について。