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プロバイダー から返されます。これは、ユーザーが認証された後、Rules が実行される前に生成されます。ユーザー認証時のイベントの順序上、Rule 内でユーザーのユーザープロファイルに加えた変更は、同じ Rule 内でその変更を user オブジェクトにも保存した場合にのみ、現在の user オブジェクトで利用できます。

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

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

​

プロパティ

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

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