Rules における User オブジェクトのプロパティ

ログイン中のユーザーに関する情報を格納し、ID プロバイダーから返される user オブジェクトのプロパティについて説明します。

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 をご覧ください。

user オブジェクトには、ID プロバイダー から返される、ログイン中のユーザーに関する情報が格納されます。これは、ユーザーの認証時に、ルールが実行される前に生成されます。認証時のイベントの順序上、ルール内でユーザー プロファイルに加えた変更は、同じルール内でその変更を user オブジェクトにも保存した場合にのみ、現在の user オブジェクトで利用できます。

認証トランザクション フローの詳細については、Create Rules の「How rules work」セクションを参照してください。

user オブジェクトのルート プロパティ、および app_metadata 内のプロパティには一意の名前を使用してください。app_metadata 内のプロパティは user オブジェクトにマージされるため、app_metadata 内のプロパティと同じ名前のルート プロパティは、ルールの実行時に値が上書きされる可能性があります。

​

プロパティ

user オブジェクトでは、次のプロパティを使用できます。

プロパティ	データ型	説明
user.app_metadata	オブジェクト	サポートプラン、セキュリティロール、アクセス制御グループなど、ユーザーのアクセスに影響する情報を格納するカスタムフィールドです。デフォルトでは undefined です。詳しくは、Metadata を参照してください。
user.created_at	日時	ユーザープロファイルが最初に作成された日時を示すタイムスタンプです。
user.email	テキスト	(一意) ユーザーのメールアドレスです。
user.email_verified	真偽値	ユーザーがメールアドレスを確認済みかどうかを示します。
user.family_name	テキスト	ユーザーの姓です。
user.given_name	テキスト	ユーザーの名です。
user.identities	配列 (オブジェクト)	ユーザーが最初に認証した ID プロバイダーから取得した情報が含まれます。ユーザーは自分のプロファイルを複数の ID プロバイダーにリンクすることもでき、その場合、それらの ID もこの配列に含まれます。個々の ID プロバイダーオブジェクトの内容はプロバイダーによって異なりますが、通常は次の項目が含まれます。 connection (テキスト) : ユーザーの認証に使用された Auth0 コネクションの名前。 isSocial (真偽値) : コネクションがソーシャル接続かどうかを示します。 provider (テキスト) : Facebook、Google、SAML、または独自のプロバイダーなど、ユーザーを認証するエンティティの名前。 user_id (テキスト) : このコネクション/プロバイダーにおけるユーザーの一意識別子。最初にリンクされた user_id が、そのユーザーの主要な一意識別子になります。 profileData (オブジェクト) : コネクションに関連付けられたユーザー情報。プロファイルがリンクされている場合は、セカンダリアカウントに関連付けられたユーザー情報がここに格納されます。 場合によっては、プロバイダーで使用する API のアクセストークンも含まれます。
user.last_password_reset	日時	ユーザーのパスワードが最後にリセットまたは変更された日時を示すタイムスタンプです。ユーザー作成時には、このフィールドは存在しません。このプロパティは Database コネクションでのみ使用できます。
user.multifactor	配列 (テキスト)	ユーザーが登録している多要素認証 (MFA) プロバイダーの一覧です。この配列は、ユーザーが MFA に登録したときと、管理者がユーザーの MFA 登録をリセットしたときに更新されます。
user.name	テキスト	ユーザーのフルネームです。
user.nickname	テキスト	ユーザーのニックネームです。
user.permissions	テキスト	Authorization Extension を使用している場合に、ユーザーの ID トークンに割り当てられる権限です。
user.phone_number	テキスト	ユーザーの電話番号です。SMS コネクションを使用しているユーザーに対してのみ有効です。
user.phone_verified	真偽値	ユーザーが電話番号を確認済みかどうかを示します。SMS コネクションを使用しているユーザーに対してのみ有効です。
user.picture	テキスト	ユーザーのプロファイル画像を示す URL です。
user.updated_at	日時	ユーザーのプロファイルが最後に更新または変更された日時を示すタイムスタンプです。last_login への変更は更新と見なされるため、多くの場合、updated_at は last_login と一致します。
user.user_id	テキスト	(一意) ユーザーの主要な一意識別子です。
user.user_metadata	オブジェクト	勤務先住所、自宅住所、ユーザー設定など、ユーザーがアクセスできるもの・できないものには影響しない情報を格納するカスタムフィールドです。詳しくは、Metadata を参照してください。
user.username	テキスト	(一意) ユーザー名です。