ID プロバイダーにパラメーターを渡す

認可リクエスト時に Auth0 アプリケーションからクエリパラメーターを渡して、ソーシャルまたはエンタープライズ ID プロバイダーのログイン動作を制御する方法について説明します。

認証時に、Identity Provider (IdP) へプロバイダー固有のパラメーターを渡せます。これらの値は、接続ごとに固定することも、ユーザーごとに動的に設定することもできます。

​

制限事項

この設定では、以下の制限事項にご注意ください。

• 受け付けられるのは、有効な OAuth 2.0/OIDC パラメーターのみです。
• すべての IdP がアップストリームパラメーターに対応しているわけではありません。実装を進める前に、対象の IdP に確認してください。
• SAML IdP はアップストリームパラメーターに対応していません。

​

静的パラメーター

静的パラメーターを使用すると、ユーザーのログイン時に標準のパラメーターセットを IdP に送信するよう接続を設定できます。

静的パラメーターを設定するには、Auth0 の Management API の Create a connection または Update a connection エンドポイントを呼び出し、IdP に送信するパラメーターを options オブジェクト内の upstream_params オブジェクトに渡します。

​

例: WordPress

WordPress では、OAuth 2.0 の認可エンドポイントに任意の blog パラメータを指定でき、ユーザーのログイン時に指定したブログへのアクセスを自動的に要求できます。詳しくは、WordPress の OAuth 2.0 ドキュメントをお読みください。

この例に沿って進めるには、利用可能な WordPress Social connection が必要です。

​

接続を取得する

Management API の Get a connection エンドポイントを呼び出して、options オブジェクトの現在の値を取得します。

options オブジェクトは次のようになります。

{
  "options": {
    "client_id": "", 
    "profile": true, 
    "scope": ["profile"]
  }
}

​

接続を更新する (静的)

既存の options オブジェクトをコピーし、blog フィールドを属性に持つ upstream_params オブジェクトを追加します。

{
  "options": {
    "client_id": "", 
    "profile": true, 
    "scope": ["profile"],
    "upstream_params": {
      "blog": {"value":"myblog.wordpress.com"}
    }
  }
}

リクエスト本文に options オブジェクトを含めて、Management API の Update a connection エンドポイントを呼び出します。

これで、ユーザーがこの接続で認証されるたびに、WordPress の認可エンドポイントへのリクエストにクエリパラメータ blog=myblog.wordpress.com が含まれるようになります。

​

動的パラメータ

動的パラメータを使用すると、ユーザーのログイン時に、ユーザーごとに異なる値を持つ一連のパラメータを IdP に送信するよう接続を設定できます。

動的パラメータを設定するには、Auth0 Management API の Create a connection または Update a connection エンドポイントを呼び出し、IdP に送信するパラメータを options オブジェクト内の upstream_params オブジェクトとして渡したうえで、alias 属性を使ってそのパラメータのマッピング先となるフィールドを指定します。

以下は options オブジェクトのサンプルです。この後の X の例でもう一度取り上げます。

{
  "options": {
    "upstream_params": {
      "screen_name": {
        "alias": "login_hint"
      }
    }
  }
}

​

利用可能なフィールド

alias 属性で使用できるフィールドは次のとおりです。

• acr_values
• audience
• client_id
• display
• id_token_hint
• login_hint
• max_age
• prompt
• resource
• response_mode
• response_type
• ui_locales

​

例: X

X では、OAuth 認可エンドポイントに任意の screen_name パラメータを渡せます。screen_name パラメータを使うと、ログイン画面のユーザー名入力欄に、指定した値があらかじめ入力されます。詳しくは、X の API リファレンスを参照してください。

この例に沿って進めるには、利用可能な X Social connection が必要です。

​

接続を取得する

既存の options オブジェクトの値を取得するには、Management API の Get a connection エンドポイントを呼び出します。

options オブジェクトは、次のようになります。

"options": {
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET",
  "profile": true
}

​

接続を更新する (動的)

既存のoptionsオブジェクトをコピーし、screen_nameフィールドを属性として含むupstream_paramsオブジェクトを追加してから、alias属性をlogin_hintに設定します:

{
  "options": {
    "client_id": "", 
    "profile": true, 
    "scope": ["profile"],
    "upstream_params": {
      "screen_name": {
        "alias": "login_hint"
      }
    }
  }
}

リクエスト本文に options オブジェクトを指定して、Management API の Update a connection エンドポイントを呼び出します。

​

ログインエンドポイントを呼び出す

ユーザーの Authentication API の Login endpoint を呼び出す際は、login_hint パラメーターにそのユーザーのメールアドレスを渡すことができます。

この値は、screen_name パラメータとして X の認可エンドポイントに渡されます。

https://api.x.com/oauth/authorize
  ?oauth_token={yourXAuthToken}
  &screen_name=[e-mail]