アプリケーションメタデータを設定する

Auth0 Dashboard の Applications Advanced Settings で、アプリケーションメタデータ（client_metadata と clientMetadata）を設定、更新、削除する方法について説明します。

アプリケーションメタデータは省略可能で、各アプリケーションに設定できるカスタマイズ可能なキーと値 (各最大 255 文字) で構成されます。メタデータは Client オブジェクトでは client_metadata として、Rules では context.clientMetadata として公開されます。たとえば、アプリケーションのホームページ URL を保存できます (このフィールドは、Auth0 のアプリケーション設定にはデフォルトでは用意されていません) 。

クライアントメタデータは、アプリケーション (クライアント) のプロパティの一部として保存されます。データ型、フィールド名、保存上の制限の詳細については、Metadata Field Names and Data Types を参照してください。

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

シークレットの保存場所は、そのシークレットの適用範囲によって異なります。

• アプリケーションごとに 1 つだけシークレットがありますか。その場合は、client_metadata が適しています。
• システム全体で同じシークレットですか (つまり、すべてのアプリケーションまたは多数のアプリケーションで共通) 。その場合は、Rule の設定値のほうが適している可能性があります。
• ユーザーごとに異なるシークレットですか。その場合は、app_metadata に保存するほうが適している可能性があります。

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

既存のアプリケーションでは、このプロパティに値は設定されていません。

アプリケーションメタデータには Actions からアクセスできます。

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

… または Rules では:

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

Dashboard または Management API を使用して、アプリケーションのメタデータを参照したり追加したりできます。Management API を使用してクライアントのメタデータを管理する方法については、Management API を使用したメタデータの管理 を参照してください。

​

アプリケーションメタデータのキーと値のペアを追加する

1. Dashboard > Applications > Applications に移動し、アプリケーションを選択します。

2. 下にスクロールして、Advanced Settings をクリックします。

3. アプリケーションメタデータ タブで、キーの名前と値を入力して、Add をクリックします。

   

4. Save Changes をクリックします。

​

アプリケーションのメタデータの値を更新する

1. Dashboard > Applications > Applications に移動し、アプリケーションを選択します。
2. 下にスクロールして、Advanced Settings をクリックします。
3. アプリケーションメタデータ タブで、変更するキー名と新しい値を入力し、Add をクリックします。
4. Save Changes をクリックします。

​

アプリケーションのメタデータを削除する

1. Dashboard > Applications > Applications に移動し、対象のアプリケーションを選択します。
2. 下にスクロールして Advanced Settings をクリックします。
3. アプリケーションメタデータ タブで、削除するキーと値のペアを見つけてごみ箱アイコンをクリックします。
4. 削除を確認します。
5. Save Changes をクリックします。

​

詳細

• メタデータのフィールド名とデータ型
• Management API を使用したメタデータの管理
• Rules を使用したメタデータの管理
• クライアントシークレットのローテーション