制限事項
- 有効なOAuth 2.0/OIDCパラメーターのみが受け付けられます。
- すべてのＩｄＰがアップストリームパラメーターに対応しているわけではありません。実装を進める前に、特定のIdPと確認してください。
- IdPは、アップストリームパラメーターに対応していません。
静的パラメーター
オプションオブジェクトでupstream_paramsオブジェクトをIdPに送信したいパラメーターとともに渡します。
例：WordPress
blogパラメーターを渡せ、ユーザーがログインした際、特定のブログへのアクセスを自動的に要求します。詳細は、WordPressのOAuth 2.0ドキュメンテーションをお読みください。
この例に従うのであれば、稼働中のWordPressソーシャル接続が必要になります。
接続を取得する
optionsオブジェクトの既存の値を取得します：
optionsオブジェクトは、次のようになります：
接続を更新する（静的）
オプションオブジェクトをコピーし、blogフィールドを次の属性としてupstream_paramsオブジェクトを追加します：
optionsオブジェクトを次の通りにして呼び出します：
これで、ユーザーがこの接続と認証するたびに、Wordpress認証エンドポイントへの要求には、クエリパラメーターとなるblog=myblog.wordpress.comが含まれるようになります。
動的パラメーター
オプションオブジェクトでupstream_paramsオブジェクトをIdPに送信したいパラメーターとともに渡し、エイリアス属性にマッピングされるパラメーターのフィールドを指定します。
後ほどXの例で再び説明しますが、オプションオブジェクトの一例を掲載します：
利用可能なフィールド
エイリアス属性に利用可能なフィールドは以下の通りです：
acr_valuesオーディエンスclient_id表示するid_token_hintlogin_hintmax_agepromptresourceresponse_moderesponse_typeui_locales
例：X
screen_nameのパラメーターをOAuth認証エンドポイントに渡せます。screen_nameパラメーターがログイン画面のユーザーネーム入力ボックスを指定の値で事前入力します。詳細については、「XのAPIリファレンス」をお読みください。
この例に従うのであれば、稼働中のTwitterソーシャル接続が必要になります。
接続を取得する
optionsオブジェクトの既存の値を取得します：
optionsオブジェクトは、次のようになります：
接続を更新する（動的）
オプションオブジェクトをコピーし、screen_nameフィールドを次の属性としてupstream_paramsオブジェクトを追加し、alias属性をlogin_hintに設定します：
optionsオブジェクトを次の通りにして呼び出します：
ログインエンドポイントを呼び出す
login_hintパラメーターにメールアドレスを渡せます：
この値は、続いてXの認証エンドポイントにscreen_nameパラメーターとして渡されます。