アプリケーション (クライアント) メタデータを設定する方法

クライアントメタデータは、アプリケーション (クライアント) のプロパティの一部として保存される任意のフィールドです。各アプリケーションに設定できるカスタマイズ可能なキーと値で構成されます。たとえば、アプリケーションのホームページ URL を保存できます (これは Auth0 がアプリケーション設定でデフォルトでは提供していないフィールドです) 。

クライアントシークレットの保存場所

シークレットをどこに保存するかは、そのシークレットの適用範囲によって異なります。

アプリケーションごとに 1 つだけシークレットが必要ですか？その場合は client_metadata が適しています。
システム全体で同じシークレットですか (つまり、すべてまたは多数のアプリケーションで共通) ？その場合は、ルールの設定値のほうが適しているかもしれません。
ユーザーごとに異なるシークレットですか？その場合は、ユーザープロファイルの app_metadata に保存するほうが適しているかもしれません。

ID トークン内のクレームは暗号化されないため、使用するフローによっては、ユーザーがトークンを取得して内容を確認できる可能性があります。そのため、Auth0 はこの方法でシークレットを保存することを推奨していません。

アプリケーションメタデータを構成する

アプリケーションメタデータは、Auth0 Dashboardまたはを使用して設定できます。

Auth0 Dashboard
Management API

Dashboard > Applications > Applicationsに移動して、アプリケーションを選択します。
**［Settings (設定) ］タブでページの下部までスクロールし、［Advanced Settings (詳細設定) ］**を選択してセクションを展開します。
**［Application Metadata (アプリケーションメタデータ) ］**タブでは、次の操作を行えます。
- キーと値を入力して**［+ Add (＋追加) ］**を選択すると、メタデータを追加できます。
- 更新したいキーと新しい値を入力して**［+ Add (＋追加) ］**を選択すると、メタデータを更新できます。
- キーと値のペアの横にあるゴミ箱アイコンを選択すると、メタデータを削除できます。
完了したら、**［Save Changes (変更を保存) ］**を選択します。

POST /api/v2/ applicationsエンドポイントで新しいアプリケーションを作成するときにclientMetadataオブジェクトを含めると、初期メタデータを設定できます。既存のアプリケーションのクライアントメタデータは、PATCH /api/v2/clients/{id}エンドポイントで設定できます。その際は、clientMetadata propertyを含むアプリケーションオブジェクトを渡します。このプロパティには、変更したいメタデータを含むオブジェクトを値として指定します。たとえば、次の本文でPATCH /api/v2/client/myclientid123を呼び出すとします。

{ "client_metadata": { "example_key": "example_value" } }

すると、メタデータは次のようになります。

Example metadata

{
  "name": "example_client",
  "client_metadata": {
    "example_key": "example_value"
  }
  ...
}

既存のメタデータの値を更新するには、同様のPATCH呼び出しで、キーに更新後の値を指定します。前の例に続けて、次の本文でPATCHを呼び出すとします。

{ "client_metadata": { "example_key": "updated_value" } }

すると、メタデータは次のようになります。

Updated metadata

{
  "name": "example_client",
  "client_metadata": {
    "example_key": "updated_value"
  }
  ...
}

クライアントメタデータを削除するには、同様のPATCH呼び出しで、キーの値にnullを指定します。

アプリケーションメタデータを表示する

メタデータは Client オブジェクトでは client_metadata、ルールでは context.clientMetadata として参照できます。アプリケーションメタデータには Actions からアクセスできます。

exports.onExecutePostLogin = async (event, api) => {
  if (event.client.metadata.SKIP_VERIFICATION === "yes"){
    return;
  }
  // ... このActionを続ける
}

… またはルール:

function applicationMetadataExample (user, context, callback){
  context.clientMetadata = context.clientMetadata || {};
  if (context.clientMetadata.SKIP_VERIFICATION === "yes"){
    return callback();
  }
  // ... このRuleの処理を続ける
}

クライアントメタデータは、Management API の GET /api/v2/clients および GET /api/v2/client/{id} エンドポイントのレスポンスにも含まれます。

制限事項

client_metadata フィールドに設定できるキーは最大10個です。
client_metadata のキーと値は、それぞれ最大255文字までです。
client_metadata のキーと値には、UTF-8の特殊文字を使用できません。

クイックスタート

Auth0の概要

Auth0を設定する