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

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

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

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

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

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

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

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

既存のアプリケーションでは、このプロパティの値は空です。

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の処理を続ける
}

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

​

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

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

2. 下にスクロールして 詳細設定 をクリックします。

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

   

4. 変更を保存 をクリックします。

​

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

1. Auth0 Dashboard > アプリケーション > アプリケーション に移動し、対象のアプリケーションを選択します。
2. 下にスクロールして 詳細設定 をクリックします。
3. アプリケーションメタデータ タブで、変更したいキーの名前と新しい値を入力し、追加 をクリックします。
4. 変更を保存 をクリックします。

​

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

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

​

詳しくはこちら

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