第6章 CLI を使用したクライアント登録の自動化
クライアント登録 CLI は、アプリケーション開発者が、Red Hat build of Keycloak と統合する際に、セルフサービス方式で新しいクライアントを設定するためのコマンドラインインターフェイス (CLI) ツールです。これは、Red Hat build of Keycloak クライアント登録 REST エンドポイントと対話するように特別に設計されています。
Red Hat build of Keycloak を使用できるようにするには、すべてのアプリケーションでクライアント設定を作成または取得する必要があります。通常、一意のホスト名でホストされる新規アプリケーションごとに新規クライアントを設定します。アプリケーションが Red Hat build of Keycloak と対話する場合、Red Hat build of Keycloak がログインページ、シングルサインオン (SSO) セッション管理、およびその他のサービスを提供できるように、アプリケーションはクライアント ID で自身を識別します。
クライアント登録 CLI を使用してコマンドラインからアプリケーションクライアントを設定できます。また、これをシェルスクリプトで使用できます。
特定のユーザーが Client Registration CLI を使用できるようにするには、通常、Red Hat build of Keycloak 管理者は、管理コンソールを使用して、適切なロールを持つ新しいユーザーを設定するか、新しいクライアントとクライアントシークレットを設定して、Client Registration REST API へのアクセスを許可します。
6.1. クライアント登録 CLI で使用する新しい一般ユーザーの設定
手順
-
管理コンソール (例: http://localhost:8080/admin) に
adminとしてログインします。 - 管理するレルムを選択します。
- 既存のユーザーを使用する場合は、そのユーザーを選択して編集します。それ以外の場合は、新しいユーザーを作成します。
-
Role Mapping、Assign role を選択します。オプションリストから、Filter by clients をクリックします。検索バーに
manage-clientsと入力します。ロールを選択します。または、マスターレルムを使用している場合は、NAME-realm のロールを選択します。NAMEはターゲットレルムの名前です。他のレルムへのアクセスをマスターレルムのユーザーに付与できます。 - Assign をクリックすると、フルセットのクライアント管理パーミッションが付与されます。別のオプションとして、読み取り専用 view-clients または create-client を選択して、新規クライアントを作成します。
Available Roles、manage-client を選択して、フルセットのクライアント管理パーミッションを付与します。別のオプションとして、読み取り専用 view-clients または create-client を選択して、新規クライアントを作成します。
注記これらのパーミッションにより、初期アクセストークン または 登録アクセストークン を使用せずに操作を実行することができます。
realm-management ロールをユーザーに割り当てることはできません。この場合、ユーザーは引き続きクライアント登録 CLI でログインできますが、初期アクセストークンなしでは使用することはできません。トークンなしで操作を実行しようとすると、403 Forbidden エラーが発生します。
管理者は、管理コンソールの Initial Access Token タブ Clients エリアから初期アクセストークンを発行できます。
