17.8. 管理コンソールを使用したインポートとエクスポート
管理コンソールを使用してレルムをインポートおよびエクスポートすることもできます。この機能は、前のセクションで説明した他の CLI オプションとは異なります。管理コンソールで使用できるのは、レルムを 部分的に エクスポートする機能だけであるためです。この場合、現在のレルム設定と、クライアント、ロール、グループなどの一部のリソースをエクスポートできます。この方法では、そのレルムのユーザーをエクスポートすることは できません。
管理コンソールのエクスポートを使用する場合、レルムと選択したリソースが、常に realm-export.json という名前のファイルにエクスポートされます。また、パスワードやクライアントシークレットなどの機密の高い値が、すべて * 記号でマスクされます。
管理コンソールを使用してレルムをエクスポートするには、次の手順を実行します。
- レルムを選択します。
- メニューで Realm Settings をクリックします。
レルム設定画面の右上隅にある Action メニューに移動し、Partial export を選択します。
レルム設定とともにリソースのリストが表示されます。
- エクスポートするリソースを選択します。
- Export をクリックします。
管理コンソールからのレルムのエクスポートは、サーバー間のバックアップやデータ転送には適していません。サーバー間のバックアップまたはデータ転送には、CLI エクスポートのみを使用できます。
レルムに多数のグループ、ロール、およびクライアントが含まれている場合、この操作により、サーバーがしばらくの間、ユーザーの要求に応答しなくなる可能性があります。特に本番環境ではこの機能を使用してください。
同様の方法で、以前にエクスポートしたレルムをインポートすることもできます。以下の手順を実行します。
- メニューで Realm Settings をクリックします。
レルム設定画面の右上隅にある Action メニューに移動し、Partial import を選択します。
インポートするファイルを選択できるプロンプトが表示されます。このファイルに基づいて、レルム設定とともにインポートできるリソースが表示されます。
- Import をクリックします。
インポートするリソースがすでに存在する場合の Red Hat build of Keycloak の動作を制御することもできます。以下のオプションがあります。
- Fail import
- インポートを中断します。
- Skip
- プロセスを中断せずに重複リソースをスキップします。
- Overwrite
- 既存のリソースをインポートするリソースに置き換えます。
管理コンソールの部分的なインポートでは、CLI export コマンドによって作成されたファイルもインポートできます。つまり、CLI で作成した完全なエクスポートを、管理コンソールを使用してインポートできます。ファイルにユーザーが含まれている場合、そのユーザーも現在のレルムにインポートできます。
