12.3. 内部トークンから外部トークンへの交換
レルムトークンを、外部 ID プロバイダーによって作成された外部トークンと交換できます。この外部 ID プロバイダーは、管理コンソールの ID プロバイダー セクション内で設定する必要があります。現時点で、OAuth/OpenID Connect ベースの外部 ID プロバイダーのみがサポートされます。これには、すべてのソーシャルプロバイダーが含まれます。Red Hat build of Keycloak は外部プロバイダーへのバックチャネル交換を実行しません。そのため、アカウントがリンクされていない場合は、外部トークンを取得できなくなります。これらの条件の 1 つの外部トークンを取得できるようにするには、以下の条件を満たしている必要があります。
- ユーザーは、少なくとも 1 回、外部 ID プロバイダーを使用してログインしている必要があります。
- ユーザーは、ユーザーアカウントサービスを使用して、外部 ID プロバイダーとリンクされている必要があります。
- このユーザーアカウントは、クライアント起点のアカウントリンク API を使用して、外部の ID プロバイダー経由でリンクされました。
最後に、外部 ID プロバイダーがトークンを保存するように設定されている必要があります。または、上記のアクションの 1 つが、交換する内部トークンと同じユーザーセッションで実行されている必要があります。
アカウントがリンクされていない場合、交換応答には、アカウントを確立するために使用できるリンクが含まれます。詳細は、リクエストの作成 セクションで説明されています。
12.3.1. 交換のパーミッションの付与 リンクのコピーリンクがクリップボードにコピーされました!
内部から外部へのトークン交換要求は、外部 ID プロバイダーとトークンを交換できるパーミッションを呼び出し元のクライアントに付与するまで、403、Forbidden 応答で拒否されます。クライアントにパーミッションを付与するには、ID プロバイダーの設定ページの Permissions タブに移動します。
図12.6 ID プロバイダーパーミッション
手順
Permissions Enabled を On に切り替えます。
図12.7 ID プロバイダーパーミッション
ページには、token-exchange のリンクが表示されます。
リンクをクリックして、パーミッションの定義を開始します。
このセットアップページが表示されます。
図12.8 アイデンティティープロバイダー交換のパーミッション設定
- 画面上部のブレッドクラムで Client details をクリックします。
Policies タブをクリックして、クライアントポリシーを作成します。
図12.9 クライアントポリシーの作成
- トークン交換を要求する認証されたクライアントである、開始クライアントを入力します。
ID プロバイダーの token-exchange パーミッションに戻り、定義したクライアントポリシーを追加します。
図12.10 クライアントポリシーの適用
これでクライアントを呼び出すパーミッションがある。これを正しく行わないと、エクスチェンジを作成しようとすると、403 Forbidden 応答が返されます。
12.3.2. リクエストの作成 リンクのコピーリンクがクリップボードにコピーされました!
クライアントが既存の内部トークンを外部に交換する場合には、requested_issuer パラメーターを指定します。このパラメーターは、設定済みのアイデンティティープロバイダーのエイリアスである必要があります。
curl -X POST \
-d "client_id=starting-client" \
-d "client_secret=the client secret" \
--data-urlencode "grant_type=urn:ietf:params:oauth:grant-type:token-exchange" \
-d "subject_token=...." \
--data-urlencode "requested_token_type=urn:ietf:params:oauth:token-type:access_token" \
-d "requested_issuer=google" \
http://localhost:8080/realms/myrealm/protocol/openid-connect/token
subject_token パラメーターは、ターゲットレルムのアクセストークンである必要があります。requested_token_type パラメーターは urn:ietf:params:oauth:token-type:access_token であるか、空欄のままにする必要があります。現時点では、他の要求されたトークンタイプはサポートされません。以下は、この呼び出しから返される正常な JSON 応答の例です。
{
"access_token" : "....",
"expires_in" : 3600
"account-link-url" : "https://...."
}
外部 ID プロバイダーが何らかの理由でリンクされていない場合、以下の JSON ドキュメントで HTTP 400 応答コードが表示されます。
{
"error" : "....",
"error_description" : "..."
"account-link-url" : "https://...."
}
error 要求は、token_expired または not_linked のいずれかになります。クライアントが クライアント起点のアカウントリンク を実行できるように、account-link-url 要求が提供されます。ほとんど (あるいはすべて) のプロバイダーでは、ブラウザー OAuth プロトコルを使用したリンクが必要です。account-link-url では、単に redirect_uri クエリーパラメーターを追加し、ブラウザーに転送してリンクを実行できます。