Skip to main content
アプリケーションのカスタムトークン交換を設定するには、次の操作が必要です。

前提条件

カスタムトークン交換を設定する前に、アプリケーションが以下の前提条件を満たしていることを確認してください。

アプリケーションでカスタムトークン交換を有効にする

カスタムトークン交換は複数のアプリケーションで有効にできます。デフォルトでは無効になっています。有効にするには、次の手順を実行します。
  1. アプリケーション > アプリケーション に移動し、対象のアプリケーションを選択します。
  2. 設定 タブを選択します。
  3. カスタムトークン交換 を見つけてオンにします。
  4. 保存 を選択します。
アプリケーションでカスタムトークン交換を有効にしたら、そのアプリケーションでカスタムトークン交換に使用する接続も有効にします。
インポートモードが ON のカスタム DB は、setUserById() 操作でのみサポートされます。
後で /oauth/token エンドポイントを呼び出す際に使用するため、アプリケーションの client_idclient_secret を控えておきます。

カスタムトークン交換プロファイルを設定する

各カスタムトークン交換プロファイルは、subject_token_type と、特定のユースケースのコードロジックを含む Action との間に 1 対 1 のマッピングを定義します。 特定の subject_token_type 値を含む /oauth/token エンドポイントへのカスタムトークン交換リクエストは、対応するカスタムトークンプロファイルにマッピングされ、処理のために関連付けられた Action にルーティングされます。 Custom Token Exchange の Event オブジェクトと API オブジェクトを使用して、プロファイルに関連付けられた Action を作成します。Action では、次の処理を行う必要があります。
  • subject_token_type に基づいて subject_token をデコードし、検証します。これにより、トランザクションにおけるユーザー情報を取得できます。
  • トランザクションに適用する必要がある認可ポリシーを適用します。
トランザクションを続行できることを確認したら、ユーザーを設定します。すると Auth0 は、このユーザーに対してユーザー認証の一環として、アクセストークン、ID トークン、リフレッシュトークンを発行します。 Custom Token Exchange の Action の例については、Example Use Cases and Code Samples を参照してください。
subject_token_type は、https:// または urn で始まる一意の URI である必要があります。次の名前空間は予約されているため使用できません: http://auth0.com, https://auth0.com, http://okta.com, https://okta.com, urn:ietf, urn:auth0, urn:okta
  1. Authentication > カスタムトークン交換に移動し、Create Profileを選択します。
  2. Create Profileダイアログで、以下を行います。
    • プロファイルのNameを入力します。
    • 一意のSubject Token Typeを入力します。
    • このプロファイルに関連付けるActionの設定方法を選択します。
      • Start from scratch: 新しいActionのNameを入力します。プロファイルを作成すると、Auth0によりカスタムトークン交換トリガーに紐付けられた空のActionが作成されます。
      • Create from Template: Action Templateを選択します。Auth0により、テンプレートのコードがあらかじめ入力された新しいActionが作成されます。
      • Use existing: カスタムトークン交換トリガーにすでに紐付けられている既存のActionを選択します。
  3. Createを選択します。Auth0によりプロファイルが作成され、新しいActionまたはテンプレートからActionを作成することを選択した場合は、そのActionも作成されます。その後、プロファイルのDetailsページが表示されます。
  4. Detailsページで、以下を行います。
    • 必要に応じて、プロファイルのNameまたはSubject Token Typeを編集します。
    • 必要に応じて、関連付けられたActionのNameを編集します。
    • インラインコードエディターで、関連付けられたActionのコードを編集します。下書きを保存するにはSaveを、Actionの新しいバージョンをデプロイするにはDeployを選択します。
プロファイルの作成後は、関連付けるActionを変更できません。

カスタムトークン交換プロファイルを管理する

  1. Authentication > Custom Token Exchange に移動すると、各プロファイルの NameSubject Token TypeAction ID を含むカスタムトークン交換プロファイルの一覧が表示されます。
  2. プロファイルを選択して Details ページを開くと、NameSubject Token Type、および関連付けられた Action の Name とコードを編集できます (上記の「カスタムトークン交換プロファイルを設定する」を参照) 。
  3. プロファイルを削除するには、一覧でプロファイルの横にあるオプションメニュー (3点アイコン) を選択し、Delete を選択します。
カスタムトークン交換プロファイルに関連付けられた Action を単独で削除することはできません。先にプロファイルを削除し、その Action が不要になった場合は削除してください。