Rules を使用したメタデータの管理

Rules を使用して、アプリメタデータ、ユーザーメタデータ、クライアントメタデータを管理する方法を説明します。

Rules と Hooks のサポート終了 (EOL) 日は 2026年11月18日 です。また、2023年10月16日 以降に作成された新しいテナントでは、これらは利用できません。既存のテナントで有効な Hooks を使用している場合は、サポート終了日まで Hooks へのアクセスが維持されます。

Auth0 の拡張には、Actions の使用を強くお勧めします。Actions では、豊富な型情報、インラインドキュメント、公開 npm パッケージを利用できるほか、外部統合に接続して拡張機能全体の利用体験を向上させることができます。Actions の機能の詳細については、Understand How Auth0 Actions Work を参照してください。

移行を支援するために、Rules から Actions への移行 と Hooks から Actions への移行 のガイドを提供しています。また、機能比較、Actions のデモ、その他の移行に役立つリソースをまとめた専用ページ Move to Actions も用意しています。

Rules と Hooks の非推奨化について詳しくは、ブログ記事 Preparing for Rules and Hooks End of Life を参照してください。

Auth0 Rules を使用すると、メタデータの読み取り、更新、削除を行えます。以降のセクションでは、ユーザーとその情報を次の JSON スニペットで表した例を使用します。

{
  "user_id": "jdoe",
  "email": "[e-mail]",
  "app_metadata": {
    "roles": [ "writer" ]
  },
  "user_metadata": {
    "preferences": {
      "color": "blue"
    }
  }
}

​

メタデータを読み取る

Management API を Rules と組み合わせて使用すると、メタデータを読み取れます。また、user_metadata で次のようなプロファイル関連情報を検索することもできます。

• name
• nickname
• given_name
• family_name

デフォルトでは、Auth0 以外の IDプロバイダー (Google、Facebook、X など) から提供されるユーザープロファイル属性は、ユーザーがログインするたびに IDプロバイダーから更新されるため、直接編集できません。IDプロバイダー由来の属性の詳細については、ユーザープロファイル更新用の IDプロバイダー接続を構成する を参照してください。

Normalized User Profile の name、nickname、given_name、family_name、または picture のルート属性を編集できるようにするには、接続の Auth0 との同期を構成 して、ユーザー属性がユーザープロファイルの作成時にのみ IDプロバイダーから更新されるようにする必要があります。これにより、これらのルート属性を個別に、または一括インポートで編集できるようになります。

例として、メールアドレス [e-mail] を持つユーザーに次のメタデータが保存されているとします。

{
    "email": "[e-mail]",
    "user_metadata": {
        "hobby": "surfing"
    },
    "app_metadata": {
        "plan": "full"
    }
}

上記のメタデータ例を使用すると、次のように、Auth0 Rules または Management API の呼び出しでデータセット内の特定の項目を参照できます。

console.log(user.email); // "[e-mail]"
console.log(user.user_metadata.hobby); // "surfing"
console.log(user.app_metadata.plan); // "full"

有効な JSON スニペットであれば、どれでもメタデータとして使用できます。ただし、user.app_metadata はデフォルトで Undefined である点に注意してください。

使用可能なメタデータを読み取るには、適切なユーザー プロパティにアクセスする必要があります。

​

アプリのメタデータを読み取る

ユーザーのロールに基づいて判断できます。

function(user, context, callback){
  user.app_metadata = user.app_metadata || {};
  if (user.app_metadata.roles.indexOf('writer')){
    // 実行するコード
  }
  ...
}

​

ユーザーメタデータを読み取る

色の好みなど、特定の設定に基づいて判断できます。

function(user, context, callback){
  user.user_metadata = user.user_metadata || {};
  if (user.user_metadata.preferences.color === 'black'){
    // 実行するコード
  }
  ...
}

​

アプリケーションメタデータ (clientMetadata) の読み取り

アプリケーションメタデータ (clientMetadata) は、context オブジェクトの省略可能なトップレベルプロパティです。既存のアプリケーションでは、このプロパティの値は設定されていません。

function(user, context, callback){
  context.clientMetadata = context.clientMetadata || {};
  if (context.clientMetadata.usersuppliedkey1 === 'black'){
    // このコードはユーザーに対して実行されません
  }
  ...
}

​

メタデータを更新する

Rules を使用して、Auth0 が IdP から受信した SAML 属性を user_metadata または app_metadata にマッピングします。

​

アプリ メタデータを更新する

ユーザーに管理者ロールを追加するには:

function(user, context, callback){
  user.app_metadata = user.app_metadata || {};
  // レスポンスに含まれるapp_metadataを更新する
  user.app_metadata.roles = user.app_metadata.roles || [];
  user.app_metadata.roles.push('administrator');

  // app_metadataの更新を永続化する
  auth0.users.updateAppMetadata(user.user_id, user.app_metadata)
    .then(function(){
      callback(null, user, context);
    })
    .catch(function(err){
      callback(err);
    });
}

これにより、ユーザープロフィールの詳細は次のような JSON 表現になります。

{
  "user_id": "jdoe",
  "email": "[e-mail]",
  "app_metadata": {
    "roles": [ "writer", "administrator" ]
  },
  "user_metadata": {
    "preferences": {
      "color": "blue"
    }
  }
}

​

ユーザーメタデータを更新する

ユーザーの fontSize 設定をユーザープロフィールに追加するには、

function(user, context, callback){
  user.user_metadata = user.user_metadata || {};
  // レスポンスに含まれる user_metadata を更新する
  user.user_metadata.preferences = user.user_metadata.preferences || {};
  user.user_metadata.preferences.fontSize = 12;

  // user_metadata の更新を永続化する
  auth0.users.updateUserMetadata(user.user_id, user.user_metadata)
    .then(function(){
      callback(null, user, context);
    })
    .catch(function(err){
      callback(err);
    });
}

これにより、ユーザープロフィールの詳細は次のような JSON 表現になります。

{
  "user_id": "jdoe",
  "email": "[e-mail]",
  "app_metadata": {
    "roles": [ "writer" ]
  },
  "user_metadata": {
    "preferences": {
      "color": "blue",
      "fontSize": 12
    }
  }
}

​

app_metadata と user_metadata を同時に更新する

Rule の処理時間を短縮するには、同じ Rule 内で app_metadata と user_metadata の両方を更新できます。

function(user, context, callback){

  var q = require('q');

  user.app_metadata = user.app_metadata || {};
  user.user_metadata = user.user_metadata || {};
  // レスポンスに含まれる user_metadata を更新する
  user.user_metadata.preferences = user.user_metadata.preferences || {};
  user.user_metadata.preferences.fontSize = 12;

  // レスポンスに含まれる app_metadata を更新する
  user.app_metadata.roles = user.app_metadata.roles || [];
  user.app_metadata.roles.push('admin');

  // app_metadata の更新を永続化する
  var appMetadataPromise  = auth0.users.updateAppMetadata(user.user_id, user.app_metadata);

  // user_metadata の更新を永続化する
  var userMetadataPromise = auth0.users.updateUserMetadata(user.user_id, user.user_metadata);

  // q ライブラリを使用してすべての Promise の完了を待機する
  q.all([userMetadataPromise, appMetadataPromise])
    .then(function(){
      callback(null, user, context);
    })
    .catch(function(err){
      callback(err);
    });
}

これにより、ユーザープロフィールの詳細は次のような JSON 表現になります:

{
  "user_id": "jdoe",
  "email": "[e-mail]",
  "app_metadata": {
    "roles": [ "writer", "admin" ]
  },
  "user_metadata": {
    "preferences": {
      "color": "blue",
      "fontSize": 12
    }
  }
}

​

メタデータの削除

​

アプリメタデータ のプロパティと値を削除する

プロパティを削除するには、対象のプロパティの値を null に設定します。

​

ユーザーのロールを削除する例

ユーザーのロールを削除するには、次のサンプルのRuleを使用します。

function(user, context, callback){
  user.app_metadata = user.app_metadata || {};
  // レスポンスに含まれる app_metadata を更新する
  user.app_metadata.roles = null;

  // app_metadata の更新を永続化する
  auth0.users.updateAppMetadata(user.user_id, user.app_metadata)
    .then(function(){
      callback(null, user, context);
    })
    .catch(function(err){
      callback(err);
    });
}

これにより、ユーザープロフィールは次の JSON 表現になります。

{
  "user_id": "jdoe",
  "email": "[e-mail]",
  "app_metadata": { },
  "user_metadata": {
    "preferences": {
      "color": "blue"
    }
  }
}

​

単一のプロパティ値を削除する例

プロパティの値を 1 つだけ削除するには、その値を削除します。たとえば、ユーザープロフィールから writer ロールを削除するには:

function(user, context, callback){
  user.app_metadata = user.app_metadata || {};
  user.app_metadata.roles = user.app_metadata.roles || [];

  var index = user.app_metadata.roles.indexOf('writer');

  if (index !== -1){
    // レスポンスに含まれるapp_metadataを更新する
    user.app_metadata.roles.splice(index, 1);
  }

  // app_metadataの更新を永続化する
  auth0.users.updateAppMetadata(user.user_id, user.app_metadata)
    .then(function(){
      callback(null, user, context);
    })
    .catch(function(err){
      callback(err);
    });
}

その結果、ユーザープロフィールは次のような JSON 表現になります：

{
  "user_id": "google-oauth2|1234",
  "email": "[e-mail]",
  "app_metadata": {
    "roles": [ ]
  },
  "user_metadata": {
    "preferences": {
      "color": "blue"
    }
  }
}

roles プロパティは引き続き存在しますが、値は含まれていないことに注意してください。

​

ユーザーメタデータのプロパティと値を削除する

ユーザーの色設定を削除するには:

function(user, context, callback){
  user.user_metadata = user.user_metadata || {};
  // レスポンスに含まれる user_metadata を更新する
  user.user_metadata.preferences = user.user_metadata.preferences || {};
  delete user.user_metadata.preferences.color;

  // user_metadata の更新を永続化する
  auth0.users.updateUserMetadata(user.user_id, user.user_metadata)
    .then(function(){
      callback(null, user, context);
    })
    .catch(function(err){
      callback(err);
  });
}

これにより、ユーザープロフィールの詳細は次のような JSON 表現になります。

{
  "user_id": "jdoe",
  "email": "[e-mail]",
  "app_metadata": {
    "roles": [ "writer" ]
  },
  "user_metadata": {
    "preferences": { }
  }
}

​

詳細情報

• Rules で Management API を使用する
• Rules における Context オブジェクトのプロパティ
• Auth0 Rules