ユーザープロファイルにおけるメタデータの仕組みを理解する

Auth0 のユーザー、アプリケーション、クライアントのメタデータについて説明します。メタデータを使用して、アイデンティティプロバイダーに由来しない情報を保存する方法を学びます。

Auth0 には、Auth0 ユーザープロファイルにメタデータを保存するための包括的な仕組みがあります。メタデータを使用すると、次のことができます。

• ユーザープロファイルにアプリケーション固有のデータを保存する。
• 特定の操作がユーザーに対して実行されたかどうかを記録する。
• 負荷の高い処理の結果をユーザープロファイルにキャッシュし、今後のログインで再利用できるようにする。
• アイデンティティプロバイダー に由来しない情報や、アイデンティティプロバイダーが提供する情報を上書きする情報を保存する。

メタデータは、ユーザーのログインフローの一部として変更できます。

接続の同期を設定すると、ユーザーのルート属性がアイデンティティプロバイダーによって更新されるのを、ユーザープロファイルの作成時のみに制限できます。その後、ルート属性は個別に、または一括インポートによって編集できます。詳しくは、ユーザープロファイル更新のための Identity Provider 接続の設定 をご覧ください。

​

メタデータの種類

Auth0 では、特定の種類の情報を保存するために 3 種類のメタデータを使用します。

Metadata Type	Field Name	Description
ユーザー情報	user_metadata	ユーザーの中核的な機能に影響しない、設定などのユーザー属性を保存します。このデータは、Management API を使用してフォームを作成した場合、ログイン中のユーザーが編集できます。そのため、安全なデータストアとして使用するべきではありません。
アクセス情報	app_metadata	permissions、Auth0 のプラン、外部 ID など、ユーザーの機能へのアクセスに影響する情報を保存します。このデータはユーザーが編集できません。また、このフィールドに保存できる内容には制限があります。
アプリケーション情報	Client オブジェクト内の client_metadata、ルール内の context.clientMetadata、および post-login Actions 内の event.client.metadata	アプリケーション (OIDC OAuth 2.0 の用語では クライアント) に関する情報を保存します。たとえば、アプリケーションのホームページ URL です (Auth0 がアプリケーション設定で設定しない任意の値) 。

​

メタデータを管理

ルール、Authentication API、Management API、Auth0 Dashboard、および Lock ライブラリを使用して、メタデータを作成および更新できます。

カスタム DB スクリプトとカスタムソーシャル接続の fetchUserProfile スクリプトでは、metadata オブジェクトを使用してメタデータを作成および更新できます。

​

Actions を使用する

Actions は、Auth0 プラットフォーム内の特定のタイミングで実行される、セキュアでテナントごとに分離されたバージョン管理済みの Node.js 関数です。Actions を使うと、カスタムロジックで Auth0 の機能をカスタマイズおよび拡張できます。また、ユーザープロファイルを拡張することもできます。

たとえば、カスタムクレームを使って user_metadata のプロパティを ID トークン にコピーする post-login Action を作成できます。これにより、Authentication API の Get User Info エンドポイントを通じて、ユーザーの user_metadata を取得できるようになります。

詳しくは、post-login Action トリガーでユーザーメタデータを管理するをご覧ください。

​

Management API を使用する

ユーザーは、適切なスコープを持つアクセストークンを取得し、次の Management API エンドポイントを使用して、user_metadata の表示、作成、更新や、MFA 設定の削除を行えます。

タスク	エンドポイント	スコープ
表示	GET /api/v2/users/{id}	read:current_user
作成	PATCH /api/v2/users/{id}	create:current_user_metadata
更新	PATCH /api/v2/users/{id}	update:current_user_metadata
削除	DELETE /api/v2/users/{id}/multifactor/{provider}	update:users

Auth0 Management API を呼び出すにはアクセストークンが必要です。詳しくは、Access Tokens for the Management API および Get Management API Tokens for SPAs をご覧ください。

​

Auth0 Dashboardを使用する

キーと値のペアを含むアプリケーション メタデータを設定するには、Auth0 Dashboardを使用します。詳しくは、アプリケーション メタデータを設定するをご覧ください。

​

Lock ライブラリを使用する

Lock ライブラリを使用して、user_metadata を定義、追加、読み取り、更新できます。user_metadata のプロパティは、他のユーザープロファイルのプロパティと同じ方法で読み取ります。たとえば、次のコードスニペットは user_metadata.hobby に関連付けられた値を取得し、その値をページ上の要素に割り当てます。

// 認証時に取得したaccessTokenを使用してgetUserInfoを呼び出す
lock.getUserInfo(accessToken, function(error, profile) {
  if (!error) {
    document.getElementById('hobby').textContent = profile.user_metadata.hobby;
  }
});

additionalSignUpFields を使用すると、ユーザーのサインアップフォームにカスタムフィールドを追加できます。ユーザーがカスタムフィールドにデータを入力すると、Auth0 はその値をそのユーザーの user_metadata に保存します。サインアップ時に user_metadata を追加する方法について詳しくは、Additional Signup Fields を参照してください。

​

カスタムデータベース接続とメタデータ

カスタムデータベース接続を使用している場合は、Authentication API の /dbconnections/signup エンドポイントを使用して、ユーザーの user_metadata を設定できます。カスタムのサインアップ処理でメタデータを扱う方法について詳しくは、Custom Signupをご覧ください。

Authentication API の /dbconnections/signup エンドポイントで user_metadata フィールドを設定する場合、設定できるのは最大 10 個の文字列フィールド、合計 500 文字までです。

​

カスタムメールとメタデータ

Auth0 のメールをカスタマイズするために使用する情報は、メタデータに保存できます。たとえば、ユーザー自身がフィールドの値を変更できるようにしたい場合は user_metadata.lang を使用し、その情報を基にメールの言語をカスタマイズします。詳しくは、メールテンプレートをカスタマイズをご覧ください。

​

詳細情報

• メタデータのフィールド名とデータ型
• ルールでメタデータを管理する
• Management APIでメタデータを管理する
• Lockでメタデータを管理する
• アプリケーションメタデータを設定する
• post-login Action トリガーでユーザーメタデータを管理する