2.9. Keycloak JS

Keycloak JS ライブラリーは、Red Hat build of Keycloak サーバーから静的で提供されることはなくなりました。これは、以下の URL が利用できなくなったことを意味します。

さらに、これらの URL のライブラリーにリンクした keycloakJsUrl プロパティーが管理コンソールテーマから削除されました。カスタムテーマがこのプロパティーを使用してライブラリーを含めていた場合は、別の方法を使用してテーマを更新し、ライブラリーを組み込む必要があります。

NPM などのパッケージマネージャーを使用して、プロジェクトにライブラリーを追加する必要があります。ライブラリーは、NPM レジストリー では keycloak-js として利用できます。これは、以下のコマンドを使用してインストールできます。

npm install keycloak-js

または、サーバーの配布に、keycloak-js-26.0.0.tgz アーカイブにライブラリーのコピーが含まれます。そこからプロジェクトにライブラリーをコピーできます。ビルドせずにブラウザーでライブラリーを直接使用する場合は、ライブラリーを独自にホストする必要があります。パッケージマネージャーは、今後もライブラリーの更新を容易にするため、プロジェクトにライブラリーを含めるための推奨される方法です。

以前は、設定を渡さずに Keycloak インスタンスを作成することができました。設定は、含まれている keycloak.js スクリプトのパスに基づいて、keycloak.json ファイルからサーバーから自動的にロードされます。ライブラリーはサーバーから静的に提供されなくなったため、この機能は削除されました。Keycloak インスタンスを構築する場合は、設定を明示的に渡す必要があります。

// Before
const keycloak = new Keycloak();

// After
const keycloak = new Keycloak({
    url: "http://keycloak-server",
    realm: "my-realm",
    clientId: "my-app"
});

// Alternatively, you can pass a URL to a `keycloak.json` file.
// Note this is not reccomended as it creates additional network requests, and is prone to change in the future.
const keycloak = new Keycloak('http://keycloak-server/path/to/keycloak.json');

Keycloak JS は、Web Crypto API を使用して、PKCE をサポートするために必要な SHA-256 ダイジェストを計算するようになりました。この API の非同期性質により、以下のパブリックメソッドが常に Promise を返すようになりました。

これらのメソッドを待機するようにコードを更新する ようにして ください。

// Before
keycloak.login();
const loginUrl = keycloak.createLoginUrl();
const registerUrl = keycloak.createRegisterUrl();

// After
await keycloak.login();
const loginUrl = await keycloak.createLoginUrl();
const registerUrl = await keycloak.createRegisterUrl();

これらのメソッドを待つために、必ずコード を 更新してください。

提供されたビルド時のオプションが、最後に最適化された Red Hat build of Keycloak ビルド中にサーバーイメージに永続化された値とは異なる場合、Red Hat build of Keycloak は起動に失敗します。以前は、このような場合、警告メッセージが表示されていました。

basic という名前の新しいクライアントスコープはレルムのデフォルトクライアントスコープとして追加されるため、新規に作成されるすべてのクライアントに追加されます。クライアントスコープは、移行時に既存のすべてのクライアントにも自動的に追加されます。

このスコープには、次の要求の事前設定されたプロトコルマッパーが含まれます。

これにより、軽量アクセストークンの要求数を減らすためにさらに役立ちますが、常に自動的に追加された要求を設定することができます。