RulesとHooksのサポート終了(EOL)日は2026年11月18日 であり、2023年10月16 日の時点で作成された新しいテナントは使用できなくなります。Hooksが有効な既存のテナントは、サポート終了までHooksを利用できます。今後はActionsに移行して、Auth0の機能を拡張することを強くお勧めします。Actionsを使用すると、豊富な情報やインラインドキュメント、パブリック
npm
パッケージにアクセスして、外部統合を使って全体的な拡張エクスペリエンスを強化することができます。Actionsの詳細については、「Auth0 Actionsの仕組みを理解する」をお読みください。当社では、移行の参考資料として、RulesからActionsへの移行とHooksからActionsへの移行に関するガイドを提供しています。また、専用の「Actionsへの移行」ページでは、機能の比較やActionsのデモ、その他のリソースを掲載して、円滑な移行をサポートしています。RulesとHooksの廃止の詳細については、当社のブログ記事「RulesとHooksの提供終了について」をお読みください。user
オブジェクトはIDプロバイダーから返され、ログイン済みユーザーについての情報が保管されます。ユーザーの認証時、ルールの実行前に生成されます。ユーザー認証ではイベントに順序があるため、ルール内からユーザープロファイルに対して実行された変更内容は、その同じルール内からユーザーオブジェクトに対して変更内容を保存すると、現在のユーザーオブジェクトでのみ使用可能になります。
認証トランザクションフローの詳細については、「ルールを作成する」にある「ルールの仕組み」セクションをお読みください。
ユーザーオブジェクトのルートプロパティと
app_metadata
内のプロパティには、一意の名前を使用します。app_metadata
内のプロパティがユーザーオブジェクトにマージされるため、app_metadata
内のプロパティと同じ名前を持つルートプロパティは、ルールの実行時に値が上書きされる可能性があります。プロパティ
以下のプロパティはuser
オブジェクトで使用することができます。
プロパティ | データタイプ | 説明 |
---|---|---|
user.app_metadata | オブジェクト | サポートプラン、セキュリティロール、アクセス制御グループなどのユーザーアクセスに影響するユーザーについての情報を保存するカスタムフィールドです。デフォルトでは、undefined です。詳細はメタデータをご覧ください。 |
user.created_at | 日時 | ユーザープロファイルが最初に作成された日時を示すタイムスタンプ。 |
user.email | テキスト | (一意)ユーザーのメールアドレス。 |
user.email_verified | ブール値 | ユーザーがメールアドレスを確認済みかどうかを示します。 |
user.family_name | テキスト | ユーザーの姓。 |
user.given_name | テキスト | ユーザーの名。 |
user.identities | 配列(オブジェクト) | ユーザーを最初に認証したIDプロバイダーから取得された情報を格納します。ユーザーはプロファイルを複数のIDプロバイダーにリンクすることもできますが、その場合にはそれらのアイデンティティーもこの配列に含まれます。個別のIDプロバイダーオブジェクトのコンテンツはプロバイダーによって異なりますが、一般的には次のものを含みます:
|
user.last_password_reset | 日時 | ユーザーパスワードがリセット/変更された最終日時を示すタイムスタンプ。ユーザーの作成時に、このフィールドは存在しません。このフィールドは、データベース接続でのみ利用できます。 |
user.multifactor | 配列(テキスト) | ユーザーが登録された多要素認証()プロバイダーのリスト。この配列は、ユーザーがMFAに登録されたときと管理者がユーザーのMFA登録をリセットするときに更新されます。 |
user.name | テキスト | ユーザーの氏名。 |
user.nickname | テキスト | ユーザーのニックネーム。 |
user.permissions | テキスト | 認可拡張機能を使用した場合にユーザーのIDトークンに割り当てられる許可。 |
user.phone_number | テキスト | ユーザーの電話番号。SMS接続のあるユーザーに対してのみ有効です。 |
user.phone_verified | ブール値 | ユーザーが電話番号を確認済みかどうかを示します。SMS接続のあるユーザーに対してのみ有効です。 |
user.picture | テキスト | ユーザーのプロファイル写真 を指すURL。 |
user.updated_at | 日時 | ユーザーのプロファイルが最後に更新/変更された日時を示すタイムスタンプ。last_login の変更は更新と見なされます。そのため、ほとんどの場合、updated_at はlast_login に一致します。 |
user.user_id | テキスト | (一意)ユーザーの一意のプライマリID。 |
user.user_metadata | オブジェクト | 勤務先住所、自宅住所、ユーザーの設定など、ユーザーのアクセスに影響を与えないユーザーの情報を保存するカスタムフィールド。詳細はメタデータをご覧ください。 |
user.username | テキスト | (一意)ユーザーのユーザー名。 |